summaryrefslogtreecommitdiff
path: root/gst/stereo/gststereo.c
diff options
context:
space:
mode:
authorStefan Kost <ensonic@users.sourceforge.net>2008-07-10 18:51:11 +0000
committerStefan Kost <ensonic@users.sourceforge.net>2008-07-10 18:51:11 +0000
commit95bc489351ed0985aab4f775a09d345ebdd11b73 (patch)
tree1a33c4f85eeee69f237187c20e400596e8955f34 /gst/stereo/gststereo.c
parent7420b9748ee6ce8fe08e2b8b4183b10fa1feb0ef (diff)
downloadgstreamer-plugins-bad-95bc489351ed0985aab4f775a09d345ebdd11b73.tar.gz
Document one more.
Original commit message from CVS: * docs/plugins/Makefile.am: * docs/plugins/gst-plugins-bad-plugins-docs.sgml: * docs/plugins/gst-plugins-bad-plugins-sections.txt: * docs/plugins/gst-plugins-bad-plugins.args: * docs/plugins/gst-plugins-bad-plugins.hierarchy: * docs/plugins/gst-plugins-bad-plugins.interfaces: * docs/plugins/gst-plugins-bad-plugins.prerequisites: * docs/plugins/gst-plugins-bad-plugins.signals: * docs/plugins/inspect/plugin-stereo.xml: * gst/stereo/gststereo.c: Document one more.
Diffstat (limited to 'gst/stereo/gststereo.c')
-rw-r--r--gst/stereo/gststereo.c12
1 files changed, 12 insertions, 0 deletions
diff --git a/gst/stereo/gststereo.c b/gst/stereo/gststereo.c
index 405449e2a..2dafc75f9 100644
--- a/gst/stereo/gststereo.c
+++ b/gst/stereo/gststereo.c
@@ -21,6 +21,18 @@
* the process of copying it over that the xmms people probably won't want
* any credit for it ;-)
*/
+/**
+ * SECTION:element-stereo
+ *
+ * Create a wide stereo effect.
+ *
+ * <refsect2>
+ * <title>Example pipelines</title>
+ * |[
+ * gst-launch -v filesrc location=sine.ogg ! oggdemux ! vorbisdec ! audioconvert ! stereo ! audioconvert ! audioresample ! alsasink
+ * ]| Play an Ogg/Vorbis file.
+ * </refsect2>
+ */
#ifdef HAVE_CONFIG_H
#include "config.h"