summaryrefslogtreecommitdiffstats
path: root/ext
diff options
context:
space:
mode:
authorThomas Vander Stichele <thomas@apestaart.org>2005-11-25 22:14:47 +0000
committerThomas Vander Stichele <thomas@apestaart.org>2005-11-25 22:14:47 +0000
commit044dd6626f9ad21ee6d47d0a18084f8c7b5c0373 (patch)
tree799fda145d94eb014933c24d243021b0120c3986 /ext
parent0a68fafa430aa4503b32abc107c0c4582aa9227d (diff)
document flacdec
Original commit message from CVS: document flacdec
Diffstat (limited to 'ext')
-rw-r--r--ext/flac/gstflacdec.c24
1 files changed, 24 insertions, 0 deletions
diff --git a/ext/flac/gstflacdec.c b/ext/flac/gstflacdec.c
index 485cfade..5f534253 100644
--- a/ext/flac/gstflacdec.c
+++ b/ext/flac/gstflacdec.c
@@ -17,6 +17,30 @@
* Boston, MA 02111-1307, USA.
*/
+/**
+ * SECTION:element-flacdec
+ * @seealso: flacenc
+ *
+ * <refsect2>
+ * <para>
+ * flacdec decodes FLAC streams.
+ * <ulink url="http://flac.sourceforge.net/">FLAC</ulink>
+ * is a Free Lossless Audio Codec.
+ * </para>
+ * <title>Example launch line</title>
+ * <para>
+ * <programlisting>
+ * gst-launch filesrc location=media/small/dark.441-16-s.flac ! flacdec ! autoaudiosink
+ * </programlisting>
+ * </para>
+ * </refsect2>
+ */
+
+/*
+ * FIXME: this pipeline doesn't work, but we want to use it as example
+ * gst-launch gnomevfssrc location=http://gstreamer.freedesktop.org/media/small/dark.441-16-s.flac ! flacdec ! autoaudiosink
+ */
+
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif