mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-12-18 14:26:43 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs: add new RTP elements to docs

Browse source
This commit is contained in:
Tim-Philipp Müller 2015-07-07 20:25:47 +01:00
parent 4ed4d0b84c
commit 5314ee3fa4
5 changed files with 135 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/plugins/gst-plugins-good-plugins-docs.sgml
View file

@ -153,6 +153,8 @@
<xi:include href="xml/element-rtpj2kpay.xml" />
<xi:include href="xml/element-rtpjitterbuffer.xml" />
<xi:include href="xml/element-rtpjpegpay.xml" />
<xi:include href="xml/element-rtpklvdepay.xml" />
<xi:include href="xml/element-rtpklvpay.xml" />
<xi:include href="xml/element-rtpL16depay.xml" />
<xi:include href="xml/element-rtpL16pay.xml" />
<xi:include href="xml/element-rtpmux.xml" />

32
docs/plugins/gst-plugins-good-plugins-sections.txt
View file

@ -1774,6 +1774,38 @@ gst_rtp_h261_pay_plugin_init
gst_rtp_h261_pay_get_type
</SECTION>
<SECTION>
<FILE>element-rtpklvdepay</FILE>
<TITLE>rtpklvdepay</TITLE>
GstRtpKlvDepay
<SUBSECTION Standard>
GstRtpKlvDepayClass
GST_RTP_KLV_DEPAY
GST_RTP_KLV_DEPAY_CAST
GST_IS_RTP_KLV_DEPAY
GST_RTP_KLV_DEPAY_CLASS
GST_IS_RTP_KLV_DEPAY_CLASS
GST_TYPE_RTP_KLV_DEPAY
<SUBSECTION Private>
gst_rtp_klv_depay_get_type
</SECTION>
<SECTION>
<FILE>element-rtpklvpay</FILE>
<TITLE>rtpklvpay</TITLE>
GstRtpKlvPay
<SUBSECTION Standard>
GstRtpKlvPayClass
GST_RTP_KLV_PAY
GST_RTP_KLV_PAY_CAST
GST_IS_RTP_KLV_PAY
GST_RTP_KLV_PAY_CLASS
GST_IS_RTP_KLV_PAY_CLASS
GST_TYPE_RTP_KLV_PAY
<SUBSECTION Private>
gst_rtp_klv_pay_get_type
</SECTION>
<SECTION>
<FILE>element-rtpL16depay</FILE>
<TITLE>rtpL16depay</TITLE>

16
docs/plugins/gst-plugins-good-plugins.args
View file

@ -994,7 +994,7 @@
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Use pipeline clock</NICK>
<BLURB>Use the pipeline running-time to set the NTP time in the RTCP SR messages.</BLURB>
<BLURB>Use the pipeline running-time to set the NTP time in the RTCP SR messages(DEPRECATED: Use ntp-time-source property).</BLURB>
<DEFAULT>FALSE</DEFAULT>
</ARG>
@ -1048,6 +1048,16 @@
<DEFAULT></DEFAULT>
</ARG>
<ARG>
<NAME>GstRTSPSrc::ntp-time-source</NAME>
<TYPE>GstRTSPSrcNtpTimeSource</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>NTP Time Source</NICK>
<BLURB>NTP time source for RTCP packets.</BLURB>
<DEFAULT>NTP time based on realtime clock</DEFAULT>
</ARG>
<ARG>
<NAME>GstRTPDec::skip</NAME>
<TYPE>gint</TYPE>
@ -21344,7 +21354,7 @@
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Use pipeline clock</NICK>
<BLURB>Use the pipeline running-time to set the NTP time in the RTCP SR messages (DEPRECATED: Use ntp-source property).</BLURB>
<BLURB>Use the pipeline running-time to set the NTP time in the RTCP SR messages (DEPRECATED: Use ntp-time-source property).</BLURB>
<DEFAULT>FALSE</DEFAULT>
</ARG>
@ -21674,7 +21684,7 @@
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Use pipeline clock</NICK>
<BLURB>Use the pipeline running-time to set the NTP time in the RTCP SR messages (DEPRECATED: Use ntp-source property).</BLURB>
<BLURB>Use the pipeline running-time to set the NTP time in the RTCP SR messages (DEPRECATED: Use ntp-time-source property).</BLURB>
<DEFAULT>FALSE</DEFAULT>
</ARG>

4
docs/plugins/gst-plugins-good-plugins.hierarchy
View file

@ -197,11 +197,13 @@ GObject
GstRtpG726Depay
GstRtpG729Depay
GstRtpGSTDepay
GstRtpH261Depay
GstRtpH263Depay
GstRtpH263PDepay
GstRtpH264Depay
GstRtpJ2KDepay
GstRtpJPEGDepay
GstRtpKlvDepay
GstRtpL16Depay
GstRtpL24Depay
GstRtpMP1SDepay
@ -245,11 +247,13 @@ GObject
GstRtpAMRPay
GstRtpCELTPay
GstRtpGSTPay
GstRtpH261Pay
GstRtpH263PPay
GstRtpH263Pay
GstRtpH264Pay
GstRtpJ2KPay
GstRtpJPEGPay
GstRtpKlvPay
GstRtpMP4APay
GstRtpMP4GPay
GstRtpMP4VPay

84
docs/plugins/inspect/plugin-rtp.xml
View file

@ -576,6 +576,48 @@
</caps>
</pads>
</element>
<element>
<name>rtph261depay</name>
<longname>RTP H261 depayloader</longname>
<class>Codec/Depayloader/Network/RTP</class>
<description>Extracts H261 video from RTP packets (RFC 4587)</description>
<author>Stian Selnes &lt;stian@pexip.com&gt;</author>
<pads>
<caps>
<name>sink</name>
<direction>sink</direction>
<presence>always</presence>
<details>application/x-rtp, media=(string)video, payload=(int)31, clock-rate=(int)90000, encoding-name=(string)H261; application/x-rtp, media=(string)video, payload=(int)[ 96, 127 ], clock-rate=(int)90000, encoding-name=(string)H261</details>
</caps>
<caps>
<name>src</name>
<direction>source</direction>
<presence>always</presence>
<details>video/x-h261</details>
</caps>
</pads>
</element>
<element>
<name>rtph261pay</name>
<longname>RTP H261 packet payloader</longname>
<class>Codec/Payloader/Network/RTP</class>
<description>Payload-encodes H261 video in RTP packets (RFC 4587)</description>
<author>Stian Selnes &lt;stian@pexip.com&gt;</author>
<pads>
<caps>
<name>sink</name>
<direction>sink</direction>
<presence>always</presence>
<details>video/x-h261</details>
</caps>
<caps>
<name>src</name>
<direction>source</direction>
<presence>always</presence>
<details>application/x-rtp, media=(string)video, payload=(int)31, clock-rate=(int)90000, encoding-name=(string)H261; application/x-rtp, media=(string)video, payload=(int)[ 96, 127 ], clock-rate=(int)90000, encoding-name=(string)H261</details>
</caps>
</pads>
</element>
<element>
<name>rtph263depay</name>
<longname>RTP H263 depayloader</longname>
@ -828,6 +870,48 @@
</caps>
</pads>
</element>
<element>
<name>rtpklvdepay</name>
<longname>RTP KLV Depayloader</longname>
<class>Codec/Depayloader/Network</class>
<description>Extracts KLV (SMPTE ST 336) metadata from RTP packets</description>
<author>Tim-Philipp Müller &lt;tim@centricular.com&gt;</author>
<pads>
<caps>
<name>sink</name>
<direction>sink</direction>
<presence>always</presence>
<details>application/x-rtp, media=(string)application, clock-rate=(int)[ 1, 2147483647 ], encoding-name=(string)SMPTE336M</details>
</caps>
<caps>
<name>src</name>
<direction>source</direction>
<presence>always</presence>
<details>meta/x-klv, parsed=(boolean)true</details>
</caps>
</pads>
</element>
<element>
<name>rtpklvpay</name>
<longname>RTP KLV Payloader</longname>
<class>Codec/Payloader/Network</class>
<description>Payloads KLV (SMPTE ST 336) metadata as RTP packets</description>
<author>Tim-Philipp Müller &lt;tim@centricular.com&gt;</author>
<pads>
<caps>
<name>sink</name>
<direction>sink</direction>
<presence>always</presence>
<details>meta/x-klv, parsed=(boolean)true</details>
</caps>
<caps>
<name>src</name>
<direction>source</direction>
<presence>always</presence>
<details>application/x-rtp, media=(string)application, clock-rate=(int)[ 1, 2147483647 ], encoding-name=(string)SMPTE336M</details>
</caps>
</pads>
</element>
<element>
<name>rtpmp1sdepay</name>
<longname>RTP MPEG1 System Stream depayloader</longname>