summaryrefslogtreecommitdiff
path: root/sys
diff options
context:
space:
mode:
authorStefan Kost <ensonic@users.sourceforge.net>2008-06-16 07:30:34 +0000
committerTim-Philipp Müller <tim.muller@collabora.co.uk>2010-05-11 19:02:53 +0100
commitf8c76291dab70061f37173443174b854f27ead0d (patch)
treecc306f3f24013e4352de4177ec6231d88db4ac80 /sys
parentadda5d485990712a895e72f4ce2d6e3d74273878 (diff)
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.
Diffstat (limited to 'sys')
-rw-r--r--sys/oss4/oss4-mixer.c5
-rw-r--r--sys/oss4/oss4-sink.c22
-rw-r--r--sys/oss4/oss4-source.c12
3 files changed, 13 insertions, 26 deletions
diff --git a/sys/oss4/oss4-mixer.c b/sys/oss4/oss4-mixer.c
index e54ecfdda..6baa893e5 100644
--- a/sys/oss4/oss4-mixer.c
+++ b/sys/oss4/oss4-mixer.c
@@ -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.
diff --git a/sys/oss4/oss4-sink.c b/sys/oss4/oss4-sink.c
index 45cc2c571..a909759a8 100644
--- a/sys/oss4/oss4-sink.c
+++ b/sys/oss4/oss4-sink.c
@@ -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
diff --git a/sys/oss4/oss4-source.c b/sys/oss4/oss4-source.c
index fd934bdd4..78fba4a27 100644
--- a/sys/oss4/oss4-source.c
+++ b/sys/oss4/oss4-source.c
@@ -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