summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorStefan Kost <ensonic@users.sourceforge.net>2008-05-28 14:07:21 +0000
committerStefan Kost <ensonic@users.sourceforge.net>2008-05-28 14:07:21 +0000
commit9c17a6006f1d1dbe921fddbe4b7315b5a3714bcc (patch)
treeb111e3ef26d8a8e8de70e690e6f78322688adeb8 /docs
parent9e26e8b6b4869e42a44082cf1502f80e027591d0 (diff)
Rename audiovoice to audiokaraoke and add it to the docs.
Original commit message from CVS: * docs/plugins/Makefile.am: * docs/plugins/gst-plugins-good-plugins-docs.sgml: * docs/plugins/gst-plugins-good-plugins-sections.txt: * docs/plugins/gst-plugins-good-plugins.args: * docs/plugins/gst-plugins-good-plugins.hierarchy: * docs/plugins/inspect/plugin-audiofx.xml: * gst/audiofx/Makefile.am: * gst/audiofx/audiofx.c: * gst/audiofx/audiokaraoke.c: * gst/audiofx/audiokaraoke.h: * gst/audiofx/audiovoice.c: * gst/audiofx/audiovoice.h: Rename audiovoice to audiokaraoke and add it to the docs.
Diffstat (limited to 'docs')
-rw-r--r--docs/plugins/Makefile.am1
-rw-r--r--docs/plugins/gst-plugins-good-plugins-docs.sgml1
-rw-r--r--docs/plugins/gst-plugins-good-plugins-sections.txt16
-rw-r--r--docs/plugins/gst-plugins-good-plugins.args40
-rw-r--r--docs/plugins/gst-plugins-good-plugins.hierarchy1
-rw-r--r--docs/plugins/inspect/plugin-audiofx.xml21
6 files changed, 80 insertions, 0 deletions
diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am
index e8dd002f..00d31b85 100644
--- a/docs/plugins/Makefile.am
+++ b/docs/plugins/Makefile.am
@@ -102,6 +102,7 @@ EXTRA_HFILES = \
$(top_srcdir)/gst/audiofx/audioamplify.h \
$(top_srcdir)/gst/audiofx/audiodynamic.h \
$(top_srcdir)/gst/audiofx/audioinvert.h \
+ $(top_srcdir)/gst/audiofx/audiokaraoke.h \
$(top_srcdir)/gst/audiofx/audiopanorama.h \
$(top_srcdir)/gst/audiofx/audiocheblimit.h \
$(top_srcdir)/gst/audiofx/audiochebband.h \
diff --git a/docs/plugins/gst-plugins-good-plugins-docs.sgml b/docs/plugins/gst-plugins-good-plugins-docs.sgml
index add34ba7..1dea9b96 100644
--- a/docs/plugins/gst-plugins-good-plugins-docs.sgml
+++ b/docs/plugins/gst-plugins-good-plugins-docs.sgml
@@ -24,6 +24,7 @@
<xi:include href="xml/element-audiodynamic.xml" />
<xi:include href="xml/element-audioinvert.xml" />
<xi:include href="xml/element-audiopanorama.xml" />
+ <xi:include href="xml/element-audiokaraoke.xml" />
<xi:include href="xml/element-autoaudiosink.xml" />
<xi:include href="xml/element-autovideosink.xml" />
<xi:include href="xml/element-avidemux.xml" />
diff --git a/docs/plugins/gst-plugins-good-plugins-sections.txt b/docs/plugins/gst-plugins-good-plugins-sections.txt
index 120bad21..b30bc3c6 100644
--- a/docs/plugins/gst-plugins-good-plugins-sections.txt
+++ b/docs/plugins/gst-plugins-good-plugins-sections.txt
@@ -136,6 +136,22 @@ gst_audio_invert_get_type
</SECTION>
<SECTION>
+<FILE>element-audiokaraoke</FILE>
+<TITLE>audiokaraoke</TITLE>
+GstAudioKaraoke
+<SUBSECTION Standard>
+GstAudioKaraokeClass
+GstAudioKaraokeProcessFunc
+GST_AUDIO_KARAOKE
+GST_AUDIO_KARAOKE_CLASS
+GST_AUDIO_KARAOKE_GET_CLASS
+GST_IS_AUDIO_KARAOKE
+GST_IS_AUDIO_KARAOKE_CLASS
+GST_TYPE_AUDIO_KARAOKE
+gst_audio_karaoke_get_type
+</SECTION>
+
+<SECTION>
<FILE>element-audiopanorama</FILE>
<TITLE>audiopanorama</TITLE>
GstAudioPanorama
diff --git a/docs/plugins/gst-plugins-good-plugins.args b/docs/plugins/gst-plugins-good-plugins.args
index d6255b01..cdf8444d 100644
--- a/docs/plugins/gst-plugins-good-plugins.args
+++ b/docs/plugins/gst-plugins-good-plugins.args
@@ -19208,3 +19208,43 @@
<DEFAULT>TRUE</DEFAULT>
</ARG>
+<ARG>
+<NAME>GstAudioKaraoke::filter-band</NAME>
+<TYPE>gfloat</TYPE>
+<RANGE>[0,441]</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Filter Band</NICK>
+<BLURB>The Frequency band of the filter.</BLURB>
+<DEFAULT>220</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstAudioKaraoke::filter-width</NAME>
+<TYPE>gfloat</TYPE>
+<RANGE>[0,100]</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Filter Width</NICK>
+<BLURB>The Frequency width of the filter.</BLURB>
+<DEFAULT>100</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstAudioKaraoke::level</NAME>
+<TYPE>gfloat</TYPE>
+<RANGE>[0,1]</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Level</NICK>
+<BLURB>Level of the effect (1.0 = full).</BLURB>
+<DEFAULT>1</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstAudioKaraoke::mono-level</NAME>
+<TYPE>gfloat</TYPE>
+<RANGE>[0,1]</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Mono Level</NICK>
+<BLURB>Level of the mono channel (1.0 = full).</BLURB>
+<DEFAULT>1</DEFAULT>
+</ARG>
+
diff --git a/docs/plugins/gst-plugins-good-plugins.hierarchy b/docs/plugins/gst-plugins-good-plugins.hierarchy
index acad396e..ecedf9ff 100644
--- a/docs/plugins/gst-plugins-good-plugins.hierarchy
+++ b/docs/plugins/gst-plugins-good-plugins.hierarchy
@@ -45,6 +45,7 @@ GObject
GstAudioPanorama
GstAudioFilter
GstAudioInvert
+ GstAudioKaraoke
GstAudioAmplify
GstAudioDynamic
GstAudioChebLimit
diff --git a/docs/plugins/inspect/plugin-audiofx.xml b/docs/plugins/inspect/plugin-audiofx.xml
index a005d516..f9cceb98 100644
--- a/docs/plugins/inspect/plugin-audiofx.xml
+++ b/docs/plugins/inspect/plugin-audiofx.xml
@@ -115,6 +115,27 @@
</pads>
</element>
<element>
+ <name>audiokaraoke</name>
+ <longname>AudioKaraoke</longname>
+ <class>Filter/Effect/Audio</class>
+ <description>Removes voice from sound</description>
+ <author>Wim Taymans &lt;wim.taymans@gmail.com&gt;</author>
+ <pads>
+ <caps>
+ <name>src</name>
+ <direction>source</direction>
+ <presence>always</presence>
+ <details>audio/x-raw-int, depth=(int)16, width=(int)16, endianness=(int)1234, signed=(boolean)true, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]; audio/x-raw-float, width=(int)32, endianness=(int)1234, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</details>
+ </caps>
+ <caps>
+ <name>sink</name>
+ <direction>sink</direction>
+ <presence>always</presence>
+ <details>audio/x-raw-int, depth=(int)16, width=(int)16, endianness=(int)1234, signed=(boolean)true, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]; audio/x-raw-float, width=(int)32, endianness=(int)1234, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</details>
+ </caps>
+ </pads>
+ </element>
+ <element>
<name>audiopanorama</name>
<longname>Stereo positioning</longname>
<class>Filter/Effect/Audio</class>