diff options
| author | Mark Nauwelaerts <mark.nauwelaerts@collabora.co.uk> | 2010-02-11 21:57:49 +0100 |
|---|---|---|
| committer | Mark Nauwelaerts <mark.nauwelaerts@collabora.co.uk> | 2010-02-11 22:22:52 +0100 |
| commit | 68b644a43703d0b80d615895838e3047eb0bf15a (patch) | |
| tree | 07f9441c0079141b7b5729699b22b3994095bea8 | |
| parent | 4312ec8b40b8a1b4a018c15637d3eff68fd80329 (diff) | |
| download | gstreamer-plugins-bad-68b644a43703d0b80d615895838e3047eb0bf15a.tar.gz | |
faad: add documentation
| -rw-r--r-- | docs/plugins/Makefile.am | 1 | ||||
| -rw-r--r-- | docs/plugins/gst-plugins-bad-plugins-docs.sgml | 1 | ||||
| -rw-r--r-- | docs/plugins/gst-plugins-bad-plugins-sections.txt | 14 | ||||
| -rw-r--r-- | ext/faad/gstfaad.c | 17 |
4 files changed, 33 insertions, 0 deletions
diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am index 32553aedd..b9e3456ae 100644 --- a/docs/plugins/Makefile.am +++ b/docs/plugins/Makefile.am @@ -98,6 +98,7 @@ EXTRA_HFILES = \ $(top_srcdir)/ext/dts/gstdtsdec.h \ $(top_srcdir)/ext/ivorbis/vorbisdec.h \ $(top_srcdir)/ext/faac/gstfaac.h \ + $(top_srcdir)/ext/faad/gstfaad.h \ $(top_srcdir)/ext/jack/gstjackaudiosrc.h \ $(top_srcdir)/ext/jack/gstjackaudiosink.h \ $(top_srcdir)/ext/kate/gstkateenc.h \ diff --git a/docs/plugins/gst-plugins-bad-plugins-docs.sgml b/docs/plugins/gst-plugins-bad-plugins-docs.sgml index de312d44a..4cbe7b330 100644 --- a/docs/plugins/gst-plugins-bad-plugins-docs.sgml +++ b/docs/plugins/gst-plugins-bad-plugins-docs.sgml @@ -43,6 +43,7 @@ <xi:include href="xml/element-dvbsrc.xml" /> <xi:include href="xml/element-dvdspu.xml" /> <xi:include href="xml/element-faac.xml" /> + <xi:include href="xml/element-faad.xml" /> <xi:include href="xml/element-festival.xml" /> <xi:include href="xml/element-flacparse.xml" /> <xi:include href="xml/element-fpsdisplaysink.xml" /> diff --git a/docs/plugins/gst-plugins-bad-plugins-sections.txt b/docs/plugins/gst-plugins-bad-plugins-sections.txt index b60dba484..4cf934a62 100644 --- a/docs/plugins/gst-plugins-bad-plugins-sections.txt +++ b/docs/plugins/gst-plugins-bad-plugins-sections.txt @@ -419,6 +419,20 @@ gst_faac_get_type </SECTION> <SECTION> +<FILE>element-faad</FILE> +<TITLE>faad</TITLE> +GstFaad +<SUBSECTION Standard> +GstFaadClass +GST_TYPE_FAAD +GST_FAAD +GST_IS_FAAD +GST_FAAD_CLASS +GST_IS_FAAD_CLASS +gst_faad_get_type +</SECTION> + +<SECTION> <FILE>element-festival</FILE> <TITLE>festival</TITLE> GstFestival 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 |