summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim-Philipp Müller <tim@centricular.net>2012-12-16 15:25:03 +0000
committerTim-Philipp Müller <tim@centricular.net>2012-12-16 16:36:39 +0000
commit8a3b116d1f53448cbac1fe0fdeb3d9265833ff96 (patch)
treeb9301975ac6be274207e4061ec81b05d5cde6d4a
parent3295b5d79100c9a4378a12057af5bb4208439338 (diff)
downloadgstreamer-plugins-good-8a3b116d1f53448cbac1fe0fdeb3d9265833ff96.tar.gz
docs: add rtpmux and rtpdtmfmux to plugin docs
https://bugzilla.gnome.org/show_bug.cgi?id=629117
-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.txt31
-rw-r--r--docs/plugins/gst-plugins-good-plugins.args40
-rw-r--r--docs/plugins/gst-plugins-good-plugins.hierarchy2
-rw-r--r--docs/plugins/inspect/plugin-rtpmanager.xml48
-rw-r--r--gst/rtpmanager/gstrtpdtmfmux.c2
7 files changed, 126 insertions, 1 deletions
diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am
index 8722b31cd..86eb4d48c 100644
--- a/docs/plugins/Makefile.am
+++ b/docs/plugins/Makefile.am
@@ -171,6 +171,8 @@ EXTRA_HFILES = \
$(top_srcdir)/gst/rtpmanager/gstrtpptdemux.h \
$(top_srcdir)/gst/rtpmanager/gstrtpsession.h \
$(top_srcdir)/gst/rtpmanager/gstrtpssrcdemux.h \
+ $(top_srcdir)/gst/rtpmanager/gstrtpmux.h \
+ $(top_srcdir)/gst/rtpmanager/gstrtpdtmfmux.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 67c76f74d..9467da123 100644
--- a/docs/plugins/gst-plugins-good-plugins-docs.sgml
+++ b/docs/plugins/gst-plugins-good-plugins-docs.sgml
@@ -134,7 +134,9 @@
<xi:include href="xml/element-rtpjpegpay.xml" />
<xi:include href="xml/element-rtspsrc.xml" />
<xi:include href="xml/element-rtpbin.xml" />
+ <xi:include href="xml/element-rtpdtmfmux.xml" />
<xi:include href="xml/element-rtpjitterbuffer.xml" />
+ <xi:include href="xml/element-rtpmux.xml" />
<xi:include href="xml/element-rtpptdemux.xml" />
<xi:include href="xml/element-rtpsession.xml" />
<xi:include href="xml/element-rtpssrcdemux.xml" />
diff --git a/docs/plugins/gst-plugins-good-plugins-sections.txt b/docs/plugins/gst-plugins-good-plugins-sections.txt
index a87c62156..708188570 100644
--- a/docs/plugins/gst-plugins-good-plugins-sections.txt
+++ b/docs/plugins/gst-plugins-good-plugins-sections.txt
@@ -2269,6 +2269,37 @@ gst_rippletv_get_type
</SECTION>
<SECTION>
+<FILE>element-rtpdtmfmux</FILE>
+<TITLE>rtpdtmfmux</TITLE>
+GstRTPDTMFMux
+<SUBSECTION Standard>
+GST_IS_RTP_DTMF_MUX
+GST_IS_RTP_DTMF_MUX_CLASS
+GST_TYPE_RTP_DTMF_MUX
+GstRTPDTMFMuxClass
+GST_RTP_DTMF_MUX
+GST_RTP_DTMF_MUX_CLASS
+gst_rtp_dtmf_mux_get_type
+gst_rtp_dtmf_mux_plugin_init
+</SECTION>
+
+<SECTION>
+<FILE>element-rtpmux</FILE>
+<TITLE>rtpmux</TITLE>
+GstRTPMux
+<SUBSECTION Standard>
+GST_IS_RTP_MUX
+GST_IS_RTP_MUX_CLASS
+GST_RTP_MUX
+GST_RTP_MUX_CLASS
+GST_RTP_MUX_GET_CLASS
+GST_TYPE_RTP_MUX
+GstRTPMuxClass
+gst_rtp_mux_get_type
+gst_rtp_mux_plugin_init
+</SECTION>
+
+<SECTION>
<FILE>element-scaletempo</FILE>
<TITLE>scaletempo</TITLE>
GstScaletempo
diff --git a/docs/plugins/gst-plugins-good-plugins.args b/docs/plugins/gst-plugins-good-plugins.args
index 1abe7039e..dae6e3076 100644
--- a/docs/plugins/gst-plugins-good-plugins.args
+++ b/docs/plugins/gst-plugins-good-plugins.args
@@ -23448,3 +23448,43 @@
<DEFAULT>30</DEFAULT>
</ARG>
+<ARG>
+<NAME>GstRTPMux::seqnum</NAME>
+<TYPE>guint</TYPE>
+<RANGE></RANGE>
+<FLAGS>r</FLAGS>
+<NICK>Sequence number</NICK>
+<BLURB>The RTP sequence number of the last processed packet.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstRTPMux::seqnum-offset</NAME>
+<TYPE>gint</TYPE>
+<RANGE>>= G_MAXULONG</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Sequence number Offset</NICK>
+<BLURB>Offset to add to all outgoing seqnum (-1 = random).</BLURB>
+<DEFAULT>-1</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstRTPMux::ssrc</NAME>
+<TYPE>guint</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>SSRC</NICK>
+<BLURB>The SSRC of the packets (-1 == random).</BLURB>
+<DEFAULT>4294967295</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstRTPMux::timestamp-offset</NAME>
+<TYPE>gint</TYPE>
+<RANGE>>= G_MAXULONG</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Timestamp Offset</NICK>
+<BLURB>Offset to add to all outgoing timestamps (-1 = random).</BLURB>
+<DEFAULT>-1</DEFAULT>
+</ARG>
+
diff --git a/docs/plugins/gst-plugins-good-plugins.hierarchy b/docs/plugins/gst-plugins-good-plugins.hierarchy
index 06ab38046..faa70c12d 100644
--- a/docs/plugins/gst-plugins-good-plugins.hierarchy
+++ b/docs/plugins/gst-plugins-good-plugins.hierarchy
@@ -243,6 +243,8 @@ GObject
GstRtpVRawPay
GstRtpVorbisPay
GstRTPDec
+ GstRTPMux
+ GstRTPDTMFMux
GstRndBufferSize
GstRtpJitterBuffer
GstRtpPtDemux
diff --git a/docs/plugins/inspect/plugin-rtpmanager.xml b/docs/plugins/inspect/plugin-rtpmanager.xml
index bac11ac4c..dc640f376 100644
--- a/docs/plugins/inspect/plugin-rtpmanager.xml
+++ b/docs/plugins/inspect/plugin-rtpmanager.xml
@@ -55,6 +55,33 @@
</pads>
</element>
<element>
+ <name>rtpdtmfmux</name>
+ <longname>RTP muxer</longname>
+ <class>Codec/Muxer</class>
+ <description>mixes RTP DTMF streams into other RTP streams</description>
+ <author>Zeeshan Ali &lt;first.last@nokia.com&gt;</author>
+ <pads>
+ <caps>
+ <name>priority_sink_%u</name>
+ <direction>sink</direction>
+ <presence>request</presence>
+ <details>application/x-rtp</details>
+ </caps>
+ <caps>
+ <name>sink_%u</name>
+ <direction>sink</direction>
+ <presence>request</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>rtpjitterbuffer</name>
<longname>RTP packet jitter-buffer</longname>
<class>Filter/Network/RTP</class>
@@ -82,6 +109,27 @@
</pads>
</element>
<element>
+ <name>rtpmux</name>
+ <longname>RTP muxer</longname>
+ <class>Codec/Muxer</class>
+ <description>multiplex N rtp streams into one</description>
+ <author>Zeeshan Ali &lt;first.last@nokia.com&gt;</author>
+ <pads>
+ <caps>
+ <name>sink_%u</name>
+ <direction>sink</direction>
+ <presence>request</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>rtpptdemux</name>
<longname>RTP Demux</longname>
<class>Demux/Network/RTP</class>
diff --git a/gst/rtpmanager/gstrtpdtmfmux.c b/gst/rtpmanager/gstrtpdtmfmux.c
index 1ec4b89db..e0f6bf4d2 100644
--- a/gst/rtpmanager/gstrtpdtmfmux.c
+++ b/gst/rtpmanager/gstrtpdtmfmux.c
@@ -30,7 +30,7 @@
* @see_also: rtpdtmfsrc, dtmfsrc, rtpmux
*
* The RTP "DTMF" Muxer muxes multiple RTP streams into a valid RTP
- * stream. It does exactly what it's parent (#rtpmux) does, except
+ * stream. It does exactly what its parent (#rtpmux) does, except
* that it prevent buffers coming over a regular sink_%%u pad from going through
* for the duration of buffers that came in a priority_sink_%%u pad.
*