summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJulien Isorce <julien.isorce@collabora.co.uk>2013-11-01 16:41:43 +0000
committerWim Taymans <wtaymans@redhat.com>2014-01-03 20:48:30 +0100
commit70d3ff2f79642edf58e528967f646179cb58d3db (patch)
tree134736a1e80da2f3465296cfafacd75edb2b9116 /docs
parent94e4cd203b5a294c0bf055c3edbf06060b3b2270 (diff)
rtprtxsend/rtprtxreceive: generate gtk doc
Diffstat (limited to 'docs')
-rw-r--r--docs/plugins/Makefile.am2
-rw-r--r--docs/plugins/gst-plugins-good-plugins-docs.sgml2
-rw-r--r--docs/plugins/gst-plugins-good-plugins-sections.txt28
-rw-r--r--docs/plugins/gst-plugins-good-plugins.args90
-rw-r--r--docs/plugins/gst-plugins-good-plugins.hierarchy2
-rw-r--r--docs/plugins/inspect/plugin-rtpmanager.xml42
6 files changed, 166 insertions, 0 deletions
diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am
index cf2750a7e..7c125adff 100644
--- a/docs/plugins/Makefile.am
+++ b/docs/plugins/Makefile.am
@@ -174,6 +174,8 @@ EXTRA_HFILES = \
$(top_srcdir)/gst/rtpmanager/gstrtpssrcdemux.h \
$(top_srcdir)/gst/rtpmanager/gstrtpmux.h \
$(top_srcdir)/gst/rtpmanager/gstrtpdtmfmux.h \
+ $(top_srcdir)/gst/rtpmanager/gstrtprtxsend.h \
+ $(top_srcdir)/gst/rtpmanager/gstrtprtxreceive.h \
$(top_srcdir)/gst/rtsp/gstrtpdec.h \
$(top_srcdir)/gst/rtsp/gstrtspsrc.h \
$(top_srcdir)/gst/shapewipe/gstshapewipe.h \
diff --git a/docs/plugins/gst-plugins-good-plugins-docs.sgml b/docs/plugins/gst-plugins-good-plugins-docs.sgml
index f4ac3217d..d48bf00e1 100644
--- a/docs/plugins/gst-plugins-good-plugins-docs.sgml
+++ b/docs/plugins/gst-plugins-good-plugins-docs.sgml
@@ -148,6 +148,8 @@
<xi:include href="xml/element-rtpptdemux.xml" />
<xi:include href="xml/element-rtpsession.xml" />
<xi:include href="xml/element-rtpssrcdemux.xml" />
+ <xi:include href="xml/element-rtprtxsend.xml" />
+ <xi:include href="xml/element-rtprtxreceive.xml" />
<xi:include href="xml/element-sbcparse.xml" />
<xi:include href="xml/element-scaletempo.xml" />
<xi:include href="xml/element-shagadelictv.xml" />
diff --git a/docs/plugins/gst-plugins-good-plugins-sections.txt b/docs/plugins/gst-plugins-good-plugins-sections.txt
index de8f4b830..807f4b39c 100644
--- a/docs/plugins/gst-plugins-good-plugins-sections.txt
+++ b/docs/plugins/gst-plugins-good-plugins-sections.txt
@@ -977,6 +977,34 @@ GST_IS_RTP_SSRC_DEMUX_CLASS
</SECTION>
<SECTION>
+<FILE>element-rtprtxsend</FILE>
+<TITLE>rtprtxsend</TITLE>
+GstRtpRtxSend
+<SUBSECTION Standard>
+GstRtpRtxSendClass
+GST_RTP_RTX_SEND
+GST_IS_RTP_RTX_SEND
+GST_TYPE_RTP_RTX_SEND
+gst_rtp_rtx_send_get_type
+GST_RTP_RTX_SEND_CLASS
+GST_IS_RTP_RTX_SEND_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>element-rtprtxreceive</FILE>
+<TITLE>rtprtxreceive</TITLE>
+GstRtpRtxReceive
+<SUBSECTION Standard>
+GstRtpRtxReceiveClass
+GST_RTP_RTX_RECEIVE
+GST_IS_RTP_RTX_RECEIVE
+GST_TYPE_RTP_RTX_RECEIVE
+gst_rtp_rtx_receive_get_type
+GST_RTP_RTX_RECEIVE_CLASS
+GST_IS_RTP_RTX_RECEIVE_CLASS
+</SECTION>
+
+<SECTION>
<FILE>element-icydemux</FILE>
<TITLE>icydemux</TITLE>
GstICYDemux
diff --git a/docs/plugins/gst-plugins-good-plugins.args b/docs/plugins/gst-plugins-good-plugins.args
index d91b2c8cf..6bdc4a575 100644
--- a/docs/plugins/gst-plugins-good-plugins.args
+++ b/docs/plugins/gst-plugins-good-plugins.args
@@ -21489,6 +21489,96 @@
</ARG>
<ARG>
+<NAME>GstRtpRtxSend::rtx-payload-type</NAME>
+<TYPE>guint</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>RTX Payload Type</NICK>
+<BLURB>Payload type of the retransmission stream (fmtp in SDP).</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstRtpRtxSend::max-size-time</NAME>
+<TYPE>guint</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Max Size Times</NICK>
+<BLURB>Amount of ms to queue (0 = unlimited).</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstRtpRtxSend::max-size-packets</NAME>
+<TYPE>guint</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Max Size Packets</NICK>
+<BLURB>Amount of packets to queue (0 = unlimited).</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstRtpRtxSend::num-rtx-requests</NAME>
+<TYPE>guint</TYPE>
+<RANGE></RANGE>
+<FLAGS>r</FLAGS>
+<NICK>Num RTX Requests</NICK>
+<BLURB>Number of retransmission events received.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstRtpRtxSend::num-rtx-packets</NAME>
+<TYPE>guint</TYPE>
+<RANGE></RANGE>
+<FLAGS>r</FLAGS>
+<NICK>Num RTX Packet</NICK>
+<BLURB>Number of retransmission packets sent.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstRtpRtxReceive::rtx-payload-types</NAME>
+<TYPE>string</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Colon separated list of payload format type</NICK>
+<BLURB>Set through SDP (fmtp), it helps to detect restransmission streams.</BLURB>
+<DEFAULT>""</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstRtpRtxReceive::num-rtx-requests</NAME>
+<TYPE>guint</TYPE>
+<RANGE></RANGE>
+<FLAGS>r</FLAGS>
+<NICK>Num RTX Requests</NICK>
+<BLURB>Number of retransmission events received.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstRtpRtxReceive::num-rtx-packets</NAME>
+<TYPE>guint</TYPE>
+<RANGE></RANGE>
+<FLAGS>r</FLAGS>
+<NICK>Num RTX Packet</NICK>
+<BLURB>Number of retransmission packets received.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstRtpRtxReceive::num-rtx-assoc-packets</NAME>
+<TYPE>guint</TYPE>
+<RANGE></RANGE>
+<FLAGS>r</FLAGS>
+<NICK>Num RTX Associated Packets</NICK>
+<BLURB>correctly associated with retransmission requests.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
<NAME>GstV4l2Sink::device</NAME>
<TYPE>gchar*</TYPE>
<RANGE></RANGE>
diff --git a/docs/plugins/gst-plugins-good-plugins.hierarchy b/docs/plugins/gst-plugins-good-plugins.hierarchy
index b612c8113..eecaeaeb7 100644
--- a/docs/plugins/gst-plugins-good-plugins.hierarchy
+++ b/docs/plugins/gst-plugins-good-plugins.hierarchy
@@ -260,6 +260,8 @@ GObject
GstRtpPtDemux
GstRtpSession
GstRtpSsrcDemux
+ GstRtpRtxSend
+ GstRtpRtxReceive
GstSMPTE
GstShapeWipe
GstTagDemux
diff --git a/docs/plugins/inspect/plugin-rtpmanager.xml b/docs/plugins/inspect/plugin-rtpmanager.xml
index 747348451..79d41739b 100644
--- a/docs/plugins/inspect/plugin-rtpmanager.xml
+++ b/docs/plugins/inspect/plugin-rtpmanager.xml
@@ -255,5 +255,47 @@
</caps>
</pads>
</element>
+ <element>
+ <name>rtprtxsend</name>
+ <longname>RTP Retransmission Sender</longname>
+ <class>Codec</class>
+ <description>Retransmit RTP packets when needed, according to RFC4588</description>
+ <author>Julien Isorce &lt;julien.isorce@gmail.com&gt;</author>
+ <pads>
+ <caps>
+ <name>sink</name>
+ <direction>sink</direction>
+ <presence>always</presence>
+ <details>application/x-rtp</details>
+ </caps>
+ <caps>
+ <name>src</name>
+ <direction>source</direction>
+ <presence>always</presence>
+ <details>application/x-rtp</details>
+ </caps>
+ </pads>
+ </element>
+ <element>
+ <name>rtprtxreceive</name>
+ <longname>RTP Retransmission Receiver</longname>
+ <class>Codec</class>
+ <description>Receive retransmitted RTP packets according to RFC4588</description>
+ <author>Julien Isorce &lt;julien.isorce@gmail.com&gt;</author>
+ <pads>
+ <caps>
+ <name>sink</name>
+ <direction>sink</direction>
+ <presence>always</presence>
+ <details>application/x-rtp</details>
+ </caps>
+ <caps>
+ <name>src</name>
+ <direction>source</direction>
+ <presence>always</presence>
+ <details>application/x-rtp</details>
+ </caps>
+ </pads>
+ </element>
</elements>
</plugin> \ No newline at end of file