summaryrefslogtreecommitdiffstats
path: root/gst/equalizer/gstiirequalizer3bands.c
diff options
context:
space:
mode:
authorSebastian Dröge <slomo@circular-chaos.org>2007-11-11 13:55:27 +0000
committerSebastian Dröge <slomo@circular-chaos.org>2007-11-11 13:55:27 +0000
commit0ada8ac4157fd5428e75bba57d6df9a43e2fe21e (patch)
tree80d4b73e3d017fb724fc0b038c95b7cc0bf8e19f /gst/equalizer/gstiirequalizer3bands.c
parente086f2c148f7b00ae1d7046eca5c9385c3763acf (diff)
downloadgst-plugins-bad-0ada8ac4157fd5428e75bba57d6df9a43e2fe21e.tar.gz
gst-plugins-bad-0ada8ac4157fd5428e75bba57d6df9a43e2fe21e.tar.bz2
gst-plugins-bad-0ada8ac4157fd5428e75bba57d6df9a43e2fe21e.zip
gst/equalizer/: And continue to update docs. Also include some sample code for the n-band equalizer in the docs.
Original commit message from CVS: * gst/equalizer/gstiirequalizer10bands.c: * gst/equalizer/gstiirequalizer3bands.c: * gst/equalizer/gstiirequalizernbands.c: And continue to update docs. Also include some sample code for the n-band equalizer in the docs.
Diffstat (limited to 'gst/equalizer/gstiirequalizer3bands.c')
-rw-r--r--gst/equalizer/gstiirequalizer3bands.c8
1 files changed, 5 insertions, 3 deletions
diff --git a/gst/equalizer/gstiirequalizer3bands.c b/gst/equalizer/gstiirequalizer3bands.c
index e2229dd7..f1e11d50 100644
--- a/gst/equalizer/gstiirequalizer3bands.c
+++ b/gst/equalizer/gstiirequalizer3bands.c
@@ -19,17 +19,19 @@
/**
* SECTION:element-equalizer-3bands
+ * @short_description: 3-band equalizer
*
* <refsect2>
- * <title>Example launch line</title>
* <para>
- * The 3 band equalizer element changes the frequency spectrum of the audio data.
+ * The 3-band equalizer element allows to change the gain of a low frequency,
+ * medium frequency and high frequency band.
* </para>
+ * <title>Example launch line</title>
* <para>
* <programlisting>
* gst-launch filesrc location=song.ogg ! oggdemux ! vorbisdec ! audioconvert ! equalizer-3bands band1=6.0 ! alsasink
* </programlisting>
- * This raises the volume of the 2nd band which is at 1110 Hz by 6 db.
+ * This raises the volume of the 2nd band, which is at 1110 Hz, by 6 db.
* </para>
* </refsect2>
*/