summaryrefslogtreecommitdiff
path: root/ext/faad
diff options
context:
space:
mode:
authorMark Nauwelaerts <mark.nauwelaerts@collabora.co.uk>2010-02-11 21:57:49 +0100
committerMark Nauwelaerts <mark.nauwelaerts@collabora.co.uk>2010-02-11 22:22:52 +0100
commit68b644a43703d0b80d615895838e3047eb0bf15a (patch)
tree07f9441c0079141b7b5729699b22b3994095bea8 /ext/faad
parent4312ec8b40b8a1b4a018c15637d3eff68fd80329 (diff)
downloadgstreamer-plugins-bad-68b644a43703d0b80d615895838e3047eb0bf15a.tar.gz
faad: add documentation
Diffstat (limited to 'ext/faad')
-rw-r--r--ext/faad/gstfaad.c17
1 files changed, 17 insertions, 0 deletions
diff --git a/ext/faad/gstfaad.c b/ext/faad/gstfaad.c
index 55553532f..de9f32b87 100644
--- a/ext/faad/gstfaad.c
+++ b/ext/faad/gstfaad.c
@@ -18,6 +18,23 @@
* Boston, MA 02111-1307, USA.
*/
+/**
+ * SECTION:element-faad
+ * @seealso: faac
+ *
+ * faad decodes AAC (MPEG-4 part 3) stream.
+ *
+ * <refsect2>
+ * <title>Example launch lines</title>
+ * <programlisting>
+ * gst-launch filesrc location=example.mp4 ! qtdemux ! faad ! audioconvert ! audioresample ! autoaudiosink
+ * </programlisting>
+ * <programlisting>
+ * gst-launch filesrc location=example.adts ! faad ! audioconvert ! audioresample ! autoaudiosink
+ * </programlisting>
+ * </refsect2>
+ */
+
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif