Final round of doc updates.

Original commit message from CVS:
* gst/rtpmanager/gstrtpjitterbuffer.c:
* gst/speed/gstspeed.c:
* gst/speexresample/gstspeexresample.c:
* gst/videosignal/gstvideoanalyse.c:
* gst/videosignal/gstvideodetect.c:
* gst/videosignal/gstvideomark.c:
* sys/dvb/gstdvbsrc.c:
* sys/oss4/oss4-mixer.c:
* sys/oss4/oss4-sink.c:
* sys/oss4/oss4-source.c:
* sys/wininet/gstwininetsrc.c:
Final round of doc updates.
This commit is contained in:
Stefan Kost 2008-06-16 07:30:34 +00:00 committed by Tim-Philipp Müller
parent adda5d4859
commit f8c76291da
3 changed files with 13 additions and 26 deletions

View file

@ -20,13 +20,12 @@
/**
* SECTION:element-oss4mixer
*
* <refsect2>
* <para>
* This element lets you adjust sound input and output levels with the
* Open Sound System (OSS) version 4. It supports the GstMixer interface, which
* can be used to obtain a list of available mixer tracks. Set the mixer
* element to READY state before using the GstMixer interface on it.
* </para>
*
* <refsect2>
* <title>Example pipelines</title>
* <para>
* oss4mixer can&apos;t be used in a sensible way in gst-launch.

View file

@ -19,32 +19,24 @@
/**
* SECTION:element-oss4sink
*
* <refsect2>
* <para>
* This element lets you output sound using the Open Sound System (OSS)
* version 4.
* </para>
* <para>
*
* Note that you should almost always use generic audio conversion elements
* like audioconvert and audioresample in front of an audiosink to make sure
* your pipeline works under all circumstances (those conversion elements will
* act in passthrough-mode if no conversion is necessary).
* </para>
*
* <refsect2>
* <title>Example pipelines</title>
* <para>
* <programlisting>
* |[
* gst-launch -v audiotestsrc ! audioconvert ! volume volume=0.1 ! oss4sink
* </programlisting>
* will output a sine wave (continuous beep sound) to your sound card (with
* ]| will output a sine wave (continuous beep sound) to your sound card (with
* a very low volume as precaution).
* </para>
* <para>
* <programlisting>
* |[
* gst-launch -v filesrc location=music.ogg ! decodebin ! audioconvert ! audioresample ! oss4sink
* </programlisting>
* will play an Ogg/Vorbis audio file and output it using the Open Sound System
* ]| will play an Ogg/Vorbis audio file and output it using the Open Sound System
* version 4.
* </para>
* </refsect2>
*
* Since: 0.10.7

View file

@ -20,20 +20,16 @@
/**
* SECTION:element-oss4src
*
* <refsect2>
* <para>
* This element lets you record sound using the Open Sound System (OSS)
* version 4.
* </para>
*
* <refsect2>
* <title>Example pipelines</title>
* <para>
* <programlisting>
* |[
* gst-launch -v oss4src ! queue ! audioconvert ! vorbisenc ! oggmux ! filesink location=mymusic.ogg
* </programlisting>
* will record sound from your sound card using OSS4 and encode it to an
* ]| will record sound from your sound card using OSS4 and encode it to an
* Ogg/Vorbis file (this will only work if your mixer settings are right
* and the right inputs areenabled etc.)
* </para>
* </refsect2>
*
* Since: 0.10.7