summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTim-Philipp Müller <tim.muller@collabora.co.uk>2013-01-15 17:44:33 +0000
committerTim-Philipp Müller <tim.muller@collabora.co.uk>2013-01-15 17:45:30 +0000
commitf307c6d491ce2bed4793883167e7a16a57ab5c05 (patch)
treef3ac212226b6ba4ffffa68f908b42f150c79c3db /docs
parent9f7a9497731556ab9249354d697e949a9b3e24d9 (diff)
docs: add sbcparse and rtpsbcpay to plugin 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.txt28
-rw-r--r--docs/plugins/gst-plugins-good-plugins.args9
-rw-r--r--docs/plugins/gst-plugins-good-plugins.hierarchy2
-rw-r--r--docs/plugins/inspect/plugin-audioparsers.xml21
-rw-r--r--docs/plugins/inspect/plugin-rtp.xml21
6 files changed, 83 insertions, 0 deletions
diff --git a/docs/plugins/gst-plugins-good-plugins-docs.sgml b/docs/plugins/gst-plugins-good-plugins-docs.sgml
index d055cc4072..08513fb39c 100644
--- a/docs/plugins/gst-plugins-good-plugins-docs.sgml
+++ b/docs/plugins/gst-plugins-good-plugins-docs.sgml
@@ -129,6 +129,7 @@
<xi:include href="xml/element-rtpdec.xml" />
<xi:include href="xml/element-rtpj2kpay.xml" />
<xi:include href="xml/element-rtpjpegpay.xml" />
+ <xi:include href="xml/element-rtpsbcpay.xml" />
<xi:include href="xml/element-rtspsrc.xml" />
<xi:include href="xml/element-rtpbin.xml" />
<xi:include href="xml/element-rtpdtmfmux.xml" />
@@ -137,6 +138,7 @@
<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-sbcparse.xml" />
<xi:include href="xml/element-scaletempo.xml" />
<xi:include href="xml/element-shagadelictv.xml" />
<xi:include href="xml/element-shapewipe.xml" />
diff --git a/docs/plugins/gst-plugins-good-plugins-sections.txt b/docs/plugins/gst-plugins-good-plugins-sections.txt
index 656d40554b..d57749aaae 100644
--- a/docs/plugins/gst-plugins-good-plugins-sections.txt
+++ b/docs/plugins/gst-plugins-good-plugins-sections.txt
@@ -1602,6 +1602,20 @@ gst_rtp_jpeg_pay_get_type
</SECTION>
<SECTION>
+<FILE>element-rtpsbcpay</FILE>
+<TITLE>rtpsbcpay</TITLE>
+GstRtpSBCPay
+<SUBSECTION Standard>
+GstRtpSBCPayClass
+GST_RTP_SBC_PAY
+GST_RTP_SBC_PAY_CLASS
+GST_IS_RTP_SBC_PAY
+GST_IS_RTP_SBC_PAY_CLASS
+GST_TYPE_RTP_SBC_PAY
+gst_rtp_sbc_pay_get_type
+</SECTION>
+
+<SECTION>
<FILE>element-rtspsrc</FILE>
<TITLE>rtspsrc</TITLE>
GstRTSPSrc
@@ -1628,6 +1642,20 @@ gst_rtspsrc_get_type
</SECTION>
<SECTION>
+<FILE>element-sbcparse</FILE>
+<TITLE>sbcparse</TITLE>
+GstSbcParse
+<SUBSECTION Standard>
+GstSbcParseClass
+GST_SBC_PARSE
+GST_SBC_PARSE_CLASS
+GST_IS_SBC_PARSE
+GST_IS_SBC_PARSE_CLASS
+GST_TYPE_SBC_PARSE
+gst_sbc_parse_get_type
+</SECTION>
+
+<SECTION>
<FILE>element-shapewipe</FILE>
<TITLE>shapewipe</TITLE>
GstShapeWipe
diff --git a/docs/plugins/gst-plugins-good-plugins.args b/docs/plugins/gst-plugins-good-plugins.args
index c2eb2a6fc8..c104fb600d 100644
--- a/docs/plugins/gst-plugins-good-plugins.args
+++ b/docs/plugins/gst-plugins-good-plugins.args
@@ -23508,3 +23508,12 @@
<DEFAULT>-1</DEFAULT>
</ARG>
+<ARG>
+<NAME>GstRtpSBCPay::min-frames</NAME>
+<TYPE>gint</TYPE>
+<RANGE>>= G_MAXULONG</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>minimum frame number</NICK>
+<BLURB>Minimum quantity of frames to send in one packet (-1 for maximum allowed by the mtu).</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
diff --git a/docs/plugins/gst-plugins-good-plugins.hierarchy b/docs/plugins/gst-plugins-good-plugins.hierarchy
index 51c6241cad..002db2f169 100644
--- a/docs/plugins/gst-plugins-good-plugins.hierarchy
+++ b/docs/plugins/gst-plugins-good-plugins.hierarchy
@@ -38,6 +38,7 @@ GObject
GstDcaParse
GstFlacParse
GstMpegAudioParse
+ GstSbcParse
GstWavpackParse
GstBaseSink
GstAudioBaseSink
@@ -238,6 +239,7 @@ GObject
GstRtpMP4GPay
GstRtpMP4VPay
GstRtpMPAPay
+ GstRtpSBCPay
GstRtpSPEEXPay
GstRtpTheoraPay
GstRtpVP8Pay
diff --git a/docs/plugins/inspect/plugin-audioparsers.xml b/docs/plugins/inspect/plugin-audioparsers.xml
index 5f1b324f67..1e9cacccba 100644
--- a/docs/plugins/inspect/plugin-audioparsers.xml
+++ b/docs/plugins/inspect/plugin-audioparsers.xml
@@ -136,6 +136,27 @@
</pads>
</element>
<element>
+ <name>sbcparse</name>
+ <longname>SBC audio parser</longname>
+ <class>Codec/Parser/Audio</class>
+ <description>Parses an SBC bluetooth audio stream</description>
+ <author>Tim-Philipp Müller &lt;tim.muller@collabora.co.uk&gt;</author>
+ <pads>
+ <caps>
+ <name>sink</name>
+ <direction>sink</direction>
+ <presence>always</presence>
+ <details>audio/x-sbc</details>
+ </caps>
+ <caps>
+ <name>src</name>
+ <direction>source</direction>
+ <presence>always</presence>
+ <details>audio/x-sbc, parsed=(boolean)true, channels=(int)[ 1, 2 ], rate=(int){ 16000, 32000, 44100, 48000 }</details>
+ </caps>
+ </pads>
+ </element>
+ <element>
<name>wavpackparse</name>
<longname>Wavpack audio stream parser</longname>
<class>Codec/Parser/Audio</class>
diff --git a/docs/plugins/inspect/plugin-rtp.xml b/docs/plugins/inspect/plugin-rtp.xml
index ca7a48b676..ad847a731c 100644
--- a/docs/plugins/inspect/plugin-rtp.xml
+++ b/docs/plugins/inspect/plugin-rtp.xml
@@ -1207,6 +1207,27 @@
</pads>
</element>
<element>
+ <name>rtpsbcpay</name>
+ <longname>RTP packet payloader</longname>
+ <class>Codec/Payloader/Network</class>
+ <description>Payload SBC audio as RTP packets</description>
+ <author>Thiago Sousa Santos &lt;thiagoss@lcc.ufcg.edu.br&gt;</author>
+ <pads>
+ <caps>
+ <name>sink</name>
+ <direction>sink</direction>
+ <presence>always</presence>
+ <details>audio/x-sbc, rate=(int){ 16000, 32000, 44100, 48000 }, channels=(int)[ 1, 2 ], mode=(string){ mono, dual, stereo, joint }, blocks=(int){ 4, 8, 12, 16 }, subbands=(int){ 4, 8 }, allocation=(string){ snr, loudness }, bitpool=(int)[ 2, 64 ]</details>
+ </caps>
+ <caps>
+ <name>src</name>
+ <direction>source</direction>
+ <presence>always</presence>
+ <details>application/x-rtp, media=(string)audio, payload=(int)[ 96, 127 ], clock-rate=(int){ 16000, 32000, 44100, 48000 }, encoding-name=(string)SBC</details>
+ </caps>
+ </pads>
+ </element>
+ <element>
<name>rtpsirendepay</name>
<longname>RTP Siren packet depayloader</longname>
<class>Codec/Depayloader/Network/RTP</class>