summaryrefslogtreecommitdiff
path: root/gst/audioconvert
diff options
context:
space:
mode:
authorTim-Philipp Müller <tim@centricular.com>2015-05-09 22:33:26 +0100
committerTim-Philipp Müller <tim@centricular.com>2015-05-10 11:38:19 +0100
commitec5c93f1690323a0a162f7e1401d4d16c83e4a3d (patch)
tree2c6cdd92ee31e26bf73d17bdc285e195dbff8173 /gst/audioconvert
parentbf683b9a6c08ea126ae1eb810f4fc9c35c83b48b (diff)
docs: update element example pipelines
- gst-launch -> gst-launch-1.0 - use autoaudiosink and audiovideosink more often - review pipeline examples and descriptions
Diffstat (limited to 'gst/audioconvert')
-rw-r--r--gst/audioconvert/gstaudioconvert.c11
1 files changed, 7 insertions, 4 deletions
diff --git a/gst/audioconvert/gstaudioconvert.c b/gst/audioconvert/gstaudioconvert.c
index a4195e08f..09a686044 100644
--- a/gst/audioconvert/gstaudioconvert.c
+++ b/gst/audioconvert/gstaudioconvert.c
@@ -26,18 +26,21 @@
*
* Audioconvert converts raw audio buffers between various possible formats.
* It supports integer to float conversion, width/depth conversion,
- * signedness and endianness conversion and channel transformations.
+ * signedness and endianness conversion and channel transformations
+ * (ie. upmixing and downmixing), as well as dithering and noise-shaping.
*
* <refsect2>
* <title>Example launch line</title>
* |[
- * gst-launch -v -m audiotestsrc ! audioconvert ! audio/x-raw,format=S8,channels=2 ! level ! fakesink silent=TRUE
+ * gst-launch-1.0 -v -m audiotestsrc ! audioconvert ! audio/x-raw,format=S8,channels=2 ! level ! fakesink silent=TRUE
* ]| This pipeline converts audio to 8-bit. The level element shows that
* the output levels still match the one for a sine wave.
* |[
- * gst-launch -v -m audiotestsrc ! audioconvert ! vorbisenc ! fakesink silent=TRUE
+ * gst-launch-1.0 -v -m uridecodebin uri=file:///path/to/audio.flac ! audioconvert ! vorbisenc ! oggmux ! filesink location=audio.ogg
* ]| The vorbis encoder takes float audio data instead of the integer data
- * generated by audiotestsrc.
+ * output by most other audio elements. This pipeline decodes a FLAC audio file
+ * (or any other audio file for which decoders are installed) and re-encodes
+ * it into an Ogg/Vorbis audio file.
* </refsect2>
*/