diff options
author | Stefan Kost <ensonic@users.sourceforge.net> | 2007-07-03 09:18:22 +0000 |
---|---|---|
committer | Stefan Kost <ensonic@users.sourceforge.net> | 2007-07-03 09:18:22 +0000 |
commit | 2aa5ce3111f28f30498c223eb2e8996bfe6e61c3 (patch) | |
tree | dc282275ff0282b67d955ed645e936976db09753 /ext | |
parent | ab20a46f5ad3287c8f1ea0594f899c240ac961ff (diff) | |
download | gst-plugins-bad-2aa5ce3111f28f30498c223eb2e8996bfe6e61c3.tar.gz gst-plugins-bad-2aa5ce3111f28f30498c223eb2e8996bfe6e61c3.tar.bz2 gst-plugins-bad-2aa5ce3111f28f30498c223eb2e8996bfe6e61c3.zip |
Also document AMR-WB elements.
Original commit message from CVS:
* docs/plugins/Makefile.am:
* docs/plugins/gst-plugins-bad-plugins-docs.sgml:
* docs/plugins/gst-plugins-bad-plugins-sections.txt:
* ext/amrwb/gstamrwbdec.c:
* ext/amrwb/gstamrwbenc.c:
* ext/amrwb/gstamrwbparse.c:
Also document AMR-WB elements.
Diffstat (limited to 'ext')
-rw-r--r-- | ext/amrwb/gstamrwbdec.c | 17 | ||||
-rw-r--r-- | ext/amrwb/gstamrwbenc.c | 20 | ||||
-rw-r--r-- | ext/amrwb/gstamrwbparse.c | 17 |
3 files changed, 52 insertions, 2 deletions
diff --git a/ext/amrwb/gstamrwbdec.c b/ext/amrwb/gstamrwbdec.c index 57de2c7a..9324fad5 100644 --- a/ext/amrwb/gstamrwbdec.c +++ b/ext/amrwb/gstamrwbdec.c @@ -17,9 +17,22 @@ * Boston, MA 02111-1307, USA. */ -/* - * library can be found at http://www.penguin.cz/~utx/amr +/** + * SECTION:element-amrwbdec + * @see_also: #GstAmrwbEnc, #GstAmrwbParse + * + * <refsect2> + * <para> + * This is an AMR wideband decoder based on the + * <ulink url="http://www.penguin.cz/~utx/amr">reference codec implementation</ulink>. + * </para> + * <title>Example launch line</title> + * <para> + * <programlisting> * gst-launch filesrc location=abc.amr ! amrwbparse ! amrwbdec ! audioresample ! audioconvert ! alsasink + * </programlisting> + * </para> + * </refsect2> */ #ifdef HAVE_CONFIG_H diff --git a/ext/amrwb/gstamrwbenc.c b/ext/amrwb/gstamrwbenc.c index 52f303cd..2e342d30 100644 --- a/ext/amrwb/gstamrwbenc.c +++ b/ext/amrwb/gstamrwbenc.c @@ -17,6 +17,26 @@ * Boston, MA 02111-1307, USA. */ + /** + * SECTION:element-amrwbenc + * @see_also: #GstAmrwbDec, #GstAmrwbParse + * + * <refsect2> + * <para> + * This is an AMR wideband encoder based on the + * <ulink url="http://www.penguin.cz/~utx/amr">reference codec implementation</ulink>. + * </para> + * <title>Example launch line</title> + * <para> + * <programlisting> + * gst-launch filesrc location=abc.wav ! wavparse ! audioresample ! audioconvert ! amrwbenc ! filesink location=abc.amr + * </programlisting> + * </para> + * Please not that the above stream misses the header, that is needed to play + * the stream. + * </refsect2> + */ + #ifdef HAVE_CONFIG_H #include "config.h" #endif diff --git a/ext/amrwb/gstamrwbparse.c b/ext/amrwb/gstamrwbparse.c index d5afc6df..2054fc25 100644 --- a/ext/amrwb/gstamrwbparse.c +++ b/ext/amrwb/gstamrwbparse.c @@ -17,6 +17,23 @@ * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-amrwbparse + * @see_also: #GstAmrwbDec, #GstAmrwbEnc + * + * <refsect2> + * <para> + * This is an AMR wideband parser. + * </para> + * <title>Example launch line</title> + * <para> + * <programlisting> + * gst-launch filesrc location=abc.amr ! amrwbparse ! amrwbdec ! audioresample ! audioconvert ! alsasink + * </programlisting> + * </para> + * </refsect2> + */ + #ifdef HAVE_CONFIG_H #include "config.h" #endif |