some documentation for audioconvert

Original commit message from CVS:
some documentation for audioconvert
This commit is contained in:
Thomas Vander Stichele 2005-09-23 14:41:31 +00:00
parent a716f40cd7
commit d9d1b4a934
2 changed files with 26 additions and 1 deletions

2
common

@ -1 +1 @@
Subproject commit cd4da6a319d9f92d28f7b8a3b412577e6de50b64
Subproject commit 345fd9851051274dd758a19bbe33dbb561b4d303

View file

@ -21,6 +21,31 @@
* Boston, MA 02111-1307, USA.
*/
/**
* SECTION:element-audioconvert
*
* <refsect2>
* Audioconvert converts raw audio buffers between various possible formats.
* It supports integer to float conversion, widht/depth conversion,
* signedness and endianness conversion.
* <title>Example launch line</title>
* <para>
* <programlisting>
* gst-launch -v -m sinesrc ! audioconvert ! audio/x-raw-int,channels=2,width=8,depth=8 ! level ! fakesink silent=TRUE
* </programlisting>
* This pipeline converts audio to 8-bit. The level element shows that
* the output levels still match the one for a sine wave.
* </para>
* <para>
* <programlisting>
* gst-launch -v -m sinesrc ! audioconvert ! vorbisenc ! fakesink silent=TRUE
* </programlisting>
* The vorbis encoder takes float audio data instead of the integer data
* generated by sinesrc.
* </para>
* </refsect2>
*/
/*
* design decisions:
* - audioconvert converts buffers in a set of supported caps. If it supports