rtprtxsend/rtprtxreceive: generate gtk doc
authorJulien Isorce <julien.isorce@collabora.co.uk>
Fri, 1 Nov 2013 16:41:43 +0000 (16:41 +0000)
committerWim Taymans <wtaymans@redhat.com>
Fri, 3 Jan 2014 19:48:30 +0000 (20:48 +0100)
docs/plugins/Makefile.am
docs/plugins/gst-plugins-good-plugins-docs.sgml
docs/plugins/gst-plugins-good-plugins-sections.txt
docs/plugins/gst-plugins-good-plugins.args
docs/plugins/gst-plugins-good-plugins.hierarchy
docs/plugins/inspect/plugin-rtpmanager.xml

index cf2750a7e6325f42ebf4abb953b16ac285a0a513..7c125adffdd18a2d5784f50a311c5b623c6409cf 100644 (file)
@@ -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 \
index f4ac3217de6f191ec0cf8be5f353c96592135880..d48bf00e105ad1d0136804fe85a8c60bea181f78 100644 (file)
     <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" />
index de8f4b8303c1e199cf86baf9536a350fd4ccc362..807f4b39ceea4cc652b42c9ffe754ac32a2a23a6 100644 (file)
@@ -976,6 +976,34 @@ GST_RTP_SSRC_DEMUX_CLASS
 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>
index d91b2c8cf903f5377320e21ba6ff90f98163b57b..6bdc4a575cb84481ceda968f626dda98a42a1f3b 100644 (file)
 <DEFAULT>2</DEFAULT>
 </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>
index b612c81134f4b790efef35bfd283fd9d7629e7eb..eecaeaeb79c000ce5fda7c64fa27a7ffac0bb8a1 100644 (file)
@@ -260,6 +260,8 @@ GObject
         GstRtpPtDemux
         GstRtpSession
         GstRtpSsrcDemux
+        GstRtpRtxSend
+        GstRtpRtxReceive
         GstSMPTE
         GstShapeWipe
         GstTagDemux
index 74734845179f1a5e5f30e0c8b55656b2e7d7dcf2..79d41739b4ac2965ba8f70fd0928c04f2aa35714 100644 (file)
         </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