document flacdec

Original commit message from CVS:
document flacdec
parent 0a68fafa
2005-11-25 Thomas Vander Stichele <thomas at apestaart dot org>
* docs/plugins/Makefile.am:
* docs/plugins/gst-plugins-good-plugins-docs.sgml:
* docs/plugins/gst-plugins-good-plugins-sections.txt:
* ext/flac/gstflacdec.c:
document flacdec
2005-11-25 Thomas Vander Stichele <thomas at apestaart dot org>
* docs/plugins/Makefile.am:
......
......@@ -78,7 +78,8 @@ EXTRA_HFILES = \
$(top_srcdir)/gst/autodetect/gstautovideosink.h \
$(top_srcdir)/gst/level/gstlevel.h \
$(top_srcdir)/gst/goom/gstgoom.h \
$(top_srcdir)/ext/cairo/gsttimeoverlay.h
$(top_srcdir)/ext/cairo/gsttimeoverlay.h \
$(top_srcdir)/ext/flac/gstflacdec.h
# example code that needs to be converted to xml and placed in xml/
EXAMPLE_CFILES = \
......
......@@ -15,6 +15,7 @@
<xi:include href="xml/element-autoaudiosink.xml" />
<xi:include href="xml/element-autovideosink.xml" />
<xi:include href="xml/element-cairotimeoverlay.xml" />
<xi:include href="xml/element-flacdec.xml" />
<xi:include href="xml/element-goom.xml" />
<xi:include href="xml/element-level.xml" />
</chapter>
......
......@@ -22,6 +22,14 @@ GstCairoTimeOverlay
GstCairoTimeOverlayClass
</SECTION>
<SECTION>
<FILE>element-flacdec</FILE>
GstFlacDec
<TITLE>flacdec</TITLE>
<SUBSECTION Standard>
GstFlacDecClass
</SECTION>
<SECTION>
<FILE>element-goom</FILE>
GstGoom
......
......@@ -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
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment