summaryrefslogtreecommitdiffstats
path: root/ext/wavpack/gstwavpackparse.c
diff options
context:
space:
mode:
Diffstat (limited to 'ext/wavpack/gstwavpackparse.c')
-rw-r--r--ext/wavpack/gstwavpackparse.c17
1 files changed, 17 insertions, 0 deletions
diff --git a/ext/wavpack/gstwavpackparse.c b/ext/wavpack/gstwavpackparse.c
index af46f7a7..ca894ec9 100644
--- a/ext/wavpack/gstwavpackparse.c
+++ b/ext/wavpack/gstwavpackparse.c
@@ -21,6 +21,23 @@
* Boston, MA 02111-1307, USA.
*/
+/**
+ * SECTION:element-wavpackparse
+ *
+ * <refsect2>
+ * Wavpackparse takes raw, unframed Wavpack streams and splits them into
+ * single Wavpack chunks with information like bit depth and the position
+ * in the stream.
+ * <title>Example launch line</title>
+ * <para>
+ * <programlisting>
+ * gst-launch filesrc location=test.wv ! wavpackparse ! wavpackdec ! fakesink
+ * </programlisting>
+ * This pipeline decodes the Wavpack file test.wv into raw audio buffers.
+ * </para>
+ * </refsect2>
+ */
+
#include <gst/gst.h>
#include <math.h>