diff options
| author | Sebastian Dröge <slomo@circular-chaos.org> | 2006-08-23 08:52:50 +0000 |
|---|---|---|
| committer | Tim-Philipp Müller <tim@centricular.net> | 2006-08-23 08:52:50 +0000 |
| commit | 7381b4940caefc0335f14478a34f2faf979131df (patch) | |
| tree | 17b286ef713b6a3507129f5d193c34ff967a00ab /ext/wavpack/gstwavpackenc.c | |
| parent | d3c716b694b065ca6884499cb75f808f21a07f26 (diff) | |
| download | gst-plugins-bad-7381b4940caefc0335f14478a34f2faf979131df.tar.gz gst-plugins-bad-7381b4940caefc0335f14478a34f2faf979131df.tar.bz2 gst-plugins-bad-7381b4940caefc0335f14478a34f2faf979131df.zip | |
Add docs for wavpack elements (#352476).
Original commit message from CVS:
Patch by: Sebastian Dröge <slomo at circular-chaos.org>
* docs/plugins/Makefile.am:
* docs/plugins/gst-plugins-bad-plugins-docs.sgml:
* docs/plugins/gst-plugins-bad-plugins-sections.txt:
* docs/plugins/gst-plugins-bad-plugins.hierarchy:
* docs/plugins/inspect/plugin-wavpack.xml:
* ext/wavpack/gstwavpackdec.c:
* ext/wavpack/gstwavpackdec.h:
* ext/wavpack/gstwavpackenc.c:
* ext/wavpack/gstwavpackenc.h:
* ext/wavpack/gstwavpackparse.c:
* ext/wavpack/gstwavpackparse.h:
Add docs for wavpack elements (#352476).
Diffstat (limited to 'ext/wavpack/gstwavpackenc.c')
| -rw-r--r-- | ext/wavpack/gstwavpackenc.c | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/ext/wavpack/gstwavpackenc.c b/ext/wavpack/gstwavpackenc.c index 9eaf45c6..19ad0923 100644 --- a/ext/wavpack/gstwavpackenc.c +++ b/ext/wavpack/gstwavpackenc.c @@ -19,6 +19,37 @@ * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-wavpackenc + * + * <refsect2> + * Wavpackenc encodes raw audio into a framed Wavpack stream. + * <ulink url="http://www.wavpack.com/">Wavpack</ulink> is an open-source + * audio codec that features both lossless and lossy encoding. + * <title>Example launch line</title> + * <para> + * <programlisting> + * gst-launch audiotestsrc num-buffers=500 ! wavpackenc ! filesink location=sinewave.wv + * </programlisting> + * This pipeline encodes audio from audiotestsrc into a Wavpack file. + * </para> + * <para> + * <programlisting> + * gst-launch cdda://1 ! wavpackenc ! filesink location=track1.wv + * </programlisting> + * This pipeline encodes audio from an audio CD into a Wavpack file using + * lossless encoding (the file output will be fairly large). + * </para> + * <para> + * <programlisting> + * gst-launch cdda://1 ! wavpackenc bitrate=128000 ! filesink location=track1.wv + * </programlisting> + * This pipeline encodes audio from an audio CD into a Wavpack file using + * lossy encoding at a certain bitrate (the file will be fairly small). + * </para> + * </refsect2> + */ + /* * TODO: - add multichannel handling. channel_mask is: * front left |