summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTim-Philipp Müller <tim@centricular.com>2015-07-07 20:25:47 +0100
committerTim-Philipp Müller <tim@centricular.com>2015-07-07 20:26:47 +0100
commit5314ee3fa4fc3e68de953c255f6a95dc9f5ffffb (patch)
tree6b67c2c1fbe237854f5f8049260c5e5261594cb4 /docs
parent4ed4d0b84c6110af22b3831ca4fcd3775459f034 (diff)
docs: add new RTP elements to docs
Diffstat (limited to 'docs')
-rw-r--r--docs/plugins/gst-plugins-good-plugins-docs.sgml2
-rw-r--r--docs/plugins/gst-plugins-good-plugins-sections.txt32
-rw-r--r--docs/plugins/gst-plugins-good-plugins.args16
-rw-r--r--docs/plugins/gst-plugins-good-plugins.hierarchy4
-rw-r--r--docs/plugins/inspect/plugin-rtp.xml84
5 files changed, 135 insertions, 3 deletions
diff --git a/docs/plugins/gst-plugins-good-plugins-docs.sgml b/docs/plugins/gst-plugins-good-plugins-docs.sgml
index 5cb5c060f3..ba5036ce48 100644
--- a/docs/plugins/gst-plugins-good-plugins-docs.sgml
+++ b/docs/plugins/gst-plugins-good-plugins-docs.sgml
@@ -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" />
diff --git a/docs/plugins/gst-plugins-good-plugins-sections.txt b/docs/plugins/gst-plugins-good-plugins-sections.txt
index d477796de2..5dce3001bf 100644
--- a/docs/plugins/gst-plugins-good-plugins-sections.txt
+++ b/docs/plugins/gst-plugins-good-plugins-sections.txt
@@ -1775,6 +1775,38 @@ 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>
GstRtpL16Depay
diff --git a/docs/plugins/gst-plugins-good-plugins.args b/docs/plugins/gst-plugins-good-plugins.args
index 73cf080a0c..295efd26ed 100644
--- a/docs/plugins/gst-plugins-good-plugins.args
+++ b/docs/plugins/gst-plugins-good-plugins.args
@@ -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>
@@ -1049,6 +1049,16 @@
</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>
<RANGE></RANGE>
@@ -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>
diff --git a/docs/plugins/gst-plugins-good-plugins.hierarchy b/docs/plugins/gst-plugins-good-plugins.hierarchy
index c259c7983d..9d588e1c37 100644
--- a/docs/plugins/gst-plugins-good-plugins.hierarchy
+++ b/docs/plugins/gst-plugins-good-plugins.hierarchy
@@ -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
diff --git a/docs/plugins/inspect/plugin-rtp.xml b/docs/plugins/inspect/plugin-rtp.xml
index 5ab964dd1d..c968c8213b 100644
--- a/docs/plugins/inspect/plugin-rtp.xml
+++ b/docs/plugins/inspect/plugin-rtp.xml
@@ -577,6 +577,48 @@
</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>
<class>Codec/Depayloader/Network/RTP</class>
@@ -829,6 +871,48 @@
</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>
<class>Codec/Depayloader/Network/RTP</class>