audioparsers: update some documentation

This commit is contained in:
Mark Nauwelaerts 2010-12-03 18:11:56 +01:00
parent 8f0e2346c7
commit f64f03264f
3 changed files with 16 additions and 29 deletions

View file

@ -24,24 +24,17 @@
* @short_description: AAC parser * @short_description: AAC parser
* @see_also: #GstAmrParse * @see_also: #GstAmrParse
* *
* This is an AAC parser which handles both ADIF and ADTS stream formats.
*
* As ADIF format is not framed, it is not seekable and stream duration cannot
* be determined either. However, ADTS format AAC clips can be seeked, and parser
* can also estimate playback position and clip duration.
*
* <refsect2> * <refsect2>
* <para>
* This is an AAC parser. It can handle both ADIF and ADTS stream formats.
* The parser inherits from #GstBaseParse and therefore in only needs to
* implement AAC-specific functionality.
* </para>
* <para>
* As ADIF format is not framed, it is not seekable. From the same reason
* stream duration cannot be calculated either. Instead, AAC clips that are
* in ADTS format can be seeked, and parser also is able to calculate their
* playback position and clip duration.
* </para>
* <title>Example launch line</title> * <title>Example launch line</title>
* <para> * |[
* <programlisting>
* gst-launch filesrc location=abc.aac ! aacparse ! faad ! audioresample ! audioconvert ! alsasink * gst-launch filesrc location=abc.aac ! aacparse ! faad ! audioresample ! audioconvert ! alsasink
* </programlisting> * ]|
* </para>
* </refsect2> * </refsect2>
*/ */

View file

@ -24,16 +24,13 @@
* @short_description: AC3 parser * @short_description: AC3 parser
* @see_also: #GstAmrParse, #GstAACParse * @see_also: #GstAmrParse, #GstAACParse
* *
* <refsect2>
* <para>
* This is an AC3 parser. * This is an AC3 parser.
* </para> *
* <refsect2>
* <title>Example launch line</title> * <title>Example launch line</title>
* <para> * |[
* <programlisting>
* gst-launch filesrc location=abc.ac3 ! ac3parse ! a52dec ! audioresample ! audioconvert ! autoaudiosink * gst-launch filesrc location=abc.ac3 ! ac3parse ! a52dec ! audioresample ! audioconvert ! autoaudiosink
* </programlisting> * ]|
* </para>
* </refsect2> * </refsect2>
*/ */

View file

@ -25,17 +25,14 @@
* @short_description: AMR parser * @short_description: AMR parser
* @see_also: #GstAmrnbDec, #GstAmrnbEnc * @see_also: #GstAmrnbDec, #GstAmrnbEnc
* *
* <refsect2>
* <para>
* This is an AMR parser capable of handling both narrow-band and wideband * This is an AMR parser capable of handling both narrow-band and wideband
* formats. * formats.
* </para> *
* <refsect2>
* <title>Example launch line</title> * <title>Example launch line</title>
* <para> * |[
* <programlisting>
* gst-launch filesrc location=abc.amr ! amrparse ! amrdec ! audioresample ! audioconvert ! alsasink * gst-launch filesrc location=abc.amr ! amrparse ! amrdec ! audioresample ! audioconvert ! alsasink
* </programlisting> * ]|
* </para>
* </refsect2> * </refsect2>
*/ */