diff options
| author | Carlos Rafael Giani <dv@pseudoterminal.org> | 2012-10-24 00:36:42 +0200 |
|---|---|---|
| committer | Tim-Philipp Müller <tim.muller@collabora.co.uk> | 2012-10-24 13:43:23 +0100 |
| commit | a84677a7a0eba120f087eac4e487ba4f744ed5cc (patch) | |
| tree | 868ed26a03e381238fc9e21a8c4d48283f1be29d | |
| parent | 8ba422839a3bd602a42f01140ca820e6b752055b (diff) | |
| download | gstreamer-plugins-bad-a84677a7a0eba120f087eac4e487ba4f744ed5cc.tar.gz | |
mpg123: added gtkdoc section
https://bugzilla.gnome.org/show_bug.cgi?id=686595
| -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/mpg123/gstmpg123audiodec.c | 14 |
3 files changed, 29 insertions, 0 deletions
diff --git a/docs/plugins/gst-plugins-bad-plugins-docs.sgml b/docs/plugins/gst-plugins-bad-plugins-docs.sgml index 833cce3be..a640f15f2 100644 --- a/docs/plugins/gst-plugins-bad-plugins-docs.sgml +++ b/docs/plugins/gst-plugins-bad-plugins-docs.sgml @@ -64,6 +64,7 @@ <xi:include href="xml/element-modplug.xml" /> <xi:include href="xml/element-mpeg2enc.xml" /> <xi:include href="xml/element-mplex.xml" /> + <xi:include href="xml/element-mpg123audiodec.xml" /> <xi:include href="xml/element-pcapparse.xml" /> <xi:include href="xml/element-pinch.xml" /> <xi:include href="xml/element-pyramidsegment.xml" /> diff --git a/docs/plugins/gst-plugins-bad-plugins-sections.txt b/docs/plugins/gst-plugins-bad-plugins-sections.txt index 238083e04..219a603a3 100644 --- a/docs/plugins/gst-plugins-bad-plugins-sections.txt +++ b/docs/plugins/gst-plugins-bad-plugins-sections.txt @@ -973,6 +973,20 @@ gst_mplex_get_type </SECTION> <SECTION> +<FILE>element-mpg123audiodec</FILE> +<TITLE>mpg123audiodec</TITLE> +GstMpg123AudioDec +<SUBSECTION Standard> +GstMpg123AudioDecClass +GST_MPG123_AUDIO_DEC +GST_MPG123_AUDIO_DEC_CLASS +GST_IS_MPG123_AUDIO_DEC +GST_IS_MPG123_AUDIO_DEC_CLASS +GST_TYPE_MPG123_AUDIO_DEC +gst_mpg123_audio_dec_get_type +</SECTION> + +<SECTION> <FILE>element-mythtvsrc</FILE> <TITLE>mythtvsrc</TITLE> GstMythtvSrc diff --git a/ext/mpg123/gstmpg123audiodec.c b/ext/mpg123/gstmpg123audiodec.c index 5052eaba1..16bcfce06 100644 --- a/ext/mpg123/gstmpg123audiodec.c +++ b/ext/mpg123/gstmpg123audiodec.c @@ -16,6 +16,20 @@ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */ +/** + * SECTION: element-mpg123audiodec + * @see_also: lamemp3enc, mad + * + * Audio decoder for MPEG-1 layer 1/2/3 audio data. + * + * <refsect2> + * <title>Example pipelines</title> + * |[ + * gst-launch filesrc location=music.mp3 ! mpegaudioparse ! mpg123audiodec ! audioconvert ! audioresample ! autoaudiosink + * ]| Decode and play the mp3 file + * </refsect2> + */ + #ifdef HAVE_CONFIG_H #include <config.h> #endif |