diff options
| author | Mark Nauwelaerts <mark.nauwelaerts@collabora.co.uk> | 2010-12-03 18:11:56 +0100 |
|---|---|---|
| committer | Mark Nauwelaerts <mark.nauwelaerts@collabora.co.uk> | 2010-12-03 18:23:20 +0100 |
| commit | f64f03264fc2032c6ce68e1c0ae4a23ff218da10 (patch) | |
| tree | c4455933008f35e2f4497176102c923a53768e31 | |
| parent | 8f0e2346c7aef59c41df80d58a8af8d37e38e763 (diff) | |
audioparsers: update some documentation
| -rw-r--r-- | gst/audioparsers/gstaacparse.c | 23 | ||||
| -rw-r--r-- | gst/audioparsers/gstac3parse.c | 11 | ||||
| -rw-r--r-- | gst/audioparsers/gstamrparse.c | 11 |
3 files changed, 16 insertions, 29 deletions
diff --git a/gst/audioparsers/gstaacparse.c b/gst/audioparsers/gstaacparse.c index 005f1bdd3..4dd2dc761 100644 --- a/gst/audioparsers/gstaacparse.c +++ b/gst/audioparsers/gstaacparse.c @@ -24,24 +24,17 @@ * @short_description: AAC parser * @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> - * <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> - * <para> - * <programlisting> + * |[ * gst-launch filesrc location=abc.aac ! aacparse ! faad ! audioresample ! audioconvert ! alsasink - * </programlisting> - * </para> + * ]| * </refsect2> */ diff --git a/gst/audioparsers/gstac3parse.c b/gst/audioparsers/gstac3parse.c index 2ce112bf3..96e9a911e 100644 --- a/gst/audioparsers/gstac3parse.c +++ b/gst/audioparsers/gstac3parse.c @@ -24,16 +24,13 @@ * @short_description: AC3 parser * @see_also: #GstAmrParse, #GstAACParse * - * <refsect2> - * <para> * This is an AC3 parser. - * </para> + * + * <refsect2> * <title>Example launch line</title> - * <para> - * <programlisting> + * |[ * gst-launch filesrc location=abc.ac3 ! ac3parse ! a52dec ! audioresample ! audioconvert ! autoaudiosink - * </programlisting> - * </para> + * ]| * </refsect2> */ diff --git a/gst/audioparsers/gstamrparse.c b/gst/audioparsers/gstamrparse.c index 6fb797ebb..a182e765b 100644 --- a/gst/audioparsers/gstamrparse.c +++ b/gst/audioparsers/gstamrparse.c @@ -25,17 +25,14 @@ * @short_description: AMR parser * @see_also: #GstAmrnbDec, #GstAmrnbEnc * - * <refsect2> - * <para> * This is an AMR parser capable of handling both narrow-band and wideband * formats. - * </para> + * + * <refsect2> * <title>Example launch line</title> - * <para> - * <programlisting> + * |[ * gst-launch filesrc location=abc.amr ! amrparse ! amrdec ! audioresample ! audioconvert ! alsasink - * </programlisting> - * </para> + * ]| * </refsect2> */ |