rtprtxsend/rtprtxreceive: generate gtk doc

This commit is contained in:
Julien Isorce 2013-11-01 16:41:43 +00:00 committed by Wim Taymans
parent 94e4cd203b
commit 70d3ff2f79
6 changed files with 166 additions and 0 deletions

View file

@ -174,6 +174,8 @@ EXTRA_HFILES = \
$(top_srcdir)/gst/rtpmanager/gstrtpssrcdemux.h \ $(top_srcdir)/gst/rtpmanager/gstrtpssrcdemux.h \
$(top_srcdir)/gst/rtpmanager/gstrtpmux.h \ $(top_srcdir)/gst/rtpmanager/gstrtpmux.h \
$(top_srcdir)/gst/rtpmanager/gstrtpdtmfmux.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/gstrtpdec.h \
$(top_srcdir)/gst/rtsp/gstrtspsrc.h \ $(top_srcdir)/gst/rtsp/gstrtspsrc.h \
$(top_srcdir)/gst/shapewipe/gstshapewipe.h \ $(top_srcdir)/gst/shapewipe/gstshapewipe.h \

View file

@ -148,6 +148,8 @@
<xi:include href="xml/element-rtpptdemux.xml" /> <xi:include href="xml/element-rtpptdemux.xml" />
<xi:include href="xml/element-rtpsession.xml" /> <xi:include href="xml/element-rtpsession.xml" />
<xi:include href="xml/element-rtpssrcdemux.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-sbcparse.xml" />
<xi:include href="xml/element-scaletempo.xml" /> <xi:include href="xml/element-scaletempo.xml" />
<xi:include href="xml/element-shagadelictv.xml" /> <xi:include href="xml/element-shagadelictv.xml" />

View file

@ -976,6 +976,34 @@ GST_RTP_SSRC_DEMUX_CLASS
GST_IS_RTP_SSRC_DEMUX_CLASS GST_IS_RTP_SSRC_DEMUX_CLASS
</SECTION> </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> <SECTION>
<FILE>element-icydemux</FILE> <FILE>element-icydemux</FILE>
<TITLE>icydemux</TITLE> <TITLE>icydemux</TITLE>

View file

@ -21488,6 +21488,96 @@
<DEFAULT>2</DEFAULT> <DEFAULT>2</DEFAULT>
</ARG> </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> <ARG>
<NAME>GstV4l2Sink::device</NAME> <NAME>GstV4l2Sink::device</NAME>
<TYPE>gchar*</TYPE> <TYPE>gchar*</TYPE>

View file

@ -260,6 +260,8 @@ GObject
GstRtpPtDemux GstRtpPtDemux
GstRtpSession GstRtpSession
GstRtpSsrcDemux GstRtpSsrcDemux
GstRtpRtxSend
GstRtpRtxReceive
GstSMPTE GstSMPTE
GstShapeWipe GstShapeWipe
GstTagDemux GstTagDemux

View file

@ -255,5 +255,47 @@
</caps> </caps>
</pads> </pads>
</element> </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> </elements>
</plugin> </plugin>