faad: add documentation

This commit is contained in:
Mark Nauwelaerts 2010-02-11 21:57:49 +01:00
parent 4312ec8b40
commit 68b644a437
4 changed files with 33 additions and 0 deletions

View file

@ -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 \

View file

@ -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" />

View file

@ -418,6 +418,20 @@ GST_IS_FAAC_CLASS
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>

View file

@ -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