summaryrefslogtreecommitdiffstats
path: root/sys
diff options
context:
space:
mode:
authorStefan Kost <ensonic@users.sourceforge.net>2008-06-16 07:30:34 +0000
committerStefan Kost <ensonic@users.sourceforge.net>2008-06-16 07:30:34 +0000
commitb62583b216f04d8b03346897c11f8e239104dd59 (patch)
treeac834a4bf071f43c9af2169c00e3518b46d96976 /sys
parent68993006c374a92474db6e908f7d3c13981bfed9 (diff)
downloadgst-plugins-bad-b62583b216f04d8b03346897c11f8e239104dd59.tar.gz
gst-plugins-bad-b62583b216f04d8b03346897c11f8e239104dd59.tar.bz2
gst-plugins-bad-b62583b216f04d8b03346897c11f8e239104dd59.zip
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/dvb/gstdvbsrc.c24
-rw-r--r--sys/oss4/oss4-mixer.c5
-rw-r--r--sys/oss4/oss4-sink.c22
-rw-r--r--sys/oss4/oss4-source.c12
-rw-r--r--sys/wininet/gstwininetsrc.c6
5 files changed, 23 insertions, 46 deletions
diff --git a/sys/dvb/gstdvbsrc.c b/sys/dvb/gstdvbsrc.c
index 72a7db7a..5176ab61 100644
--- a/sys/dvb/gstdvbsrc.c
+++ b/sys/dvb/gstdvbsrc.c
@@ -61,28 +61,20 @@ static GstElementDetails dvbsrc_details = {
/**
* SECTION:element-dvbsrc
*
- * <refsect2>
* dvbsrc can be used to capture video from DVB cards, DVB-T, DVB-S or DVB-T.
+ * <refsect2>
* <title>Example launch line</title>
- * <para>
- * <programlisting>
+ * |[
* gst-launch dvbsrc modulation="QAM 64" trans-mode=8k bandwidth=8MHz frequency=514000000 code-rate-lp=AUTO code-rate-hp=2/3 guard=4 hierarchy=0 ! flutsdemux crc-check=false name=demux ! queue max-size-buffers=0 max-size-time=0 ! flumpeg2vdec ! xvimagesink sync=false demux. ! queue max-size-buffers=0 max-size-time=0 ! flump3dec ! alsasink sync=false
- * </programlisting>
- * This pipeline captures a full transport stream from dvb card 0 that is a DVB-T card at tuned frequency 514000000 with other parameters as seen in the
+ * ]| Captures a full transport stream from dvb card 0 that is a DVB-T card at tuned frequency 514000000 with other parameters as seen in the
* pipeline and outputs the first tv program on the transport stream. The reason the sinks have to be set to have sync=false is due to bug #340482.
- * </para>
- * <para>
- * <programlisting>
+ * |[
* gst-launch dvbsrc modulation="QAM 64" trans-mode=8k bandwidth=8 frequency=514000000 code-rate-lp=AUTO code-rate-hp=2/3 guard=4 hierarchy=0 pids=256:257 ! flutsdemux crc-check=false name=demux es-pids=256:257 ! queue max-size-buffers=0 max-size-time=0 ! flumpeg2vdec ! xvimagesink sync=false demux. ! queue max-size-buffers=0 max-size-time=0 ! flump3dec ! alsasink sync=false
- * </programlisting>
- * This pipeline captures a partial transport stream from dvb card 0 that is a DVB-T card for a program at tuned frequency 514000000 and pids of 256:257 with other parameters as seen in the pipeline and outputs the program with the pids 256 and 257. The reason the sinks have to be set to
- * have sync=false is due to bug #340482.
- * </para>
- * <para>
- * <programlisting>
+ * ]| Captures a partial transport stream from dvb card 0 that is a DVB-T card for a program at tuned frequency 514000000 and pids of 256:257 with other parameters as seen in the pipeline and outputs the program with the pids 256 and 257. The reason the sinks have to be set to
+ * have sync=false is due to bug #340482 (FIXME: wrong bug number?).
+ * |[
* gst-launch dvbsrc polarity="h" frequency=11302000 srate=27500 diseqc-src=0 pids=102:103 ! queue max-size-buffers=0 max-size-time=0 ! flumpeg2vdec ! xvimagesink sync=false demux. ! queue max-size-buffers=0 max-size-time=0 ! flump3dec ! alsasink sync=false
- * </programlisting>
- * This pipeline captures a partial transport stream from dvb card 0 that is a DVB-S card for a program at tuned frequency 11302000 Hz, symbol rate of 27500 kHz and pids of 256:257 and outputs the program with the pids 256 and 257. The reason the sinks have to be set to have sync=false is due to bug #340482.
+ * ]| Captures a partial transport stream from dvb card 0 that is a DVB-S card for a program at tuned frequency 11302000 Hz, symbol rate of 27500 kHz and pids of 256:257 and outputs the program with the pids 256 and 257. The reason the sinks have to be set to have sync=false is due to bug #340482.
* </para>
* </refsect2>
*/
diff --git a/sys/oss4/oss4-mixer.c b/sys/oss4/oss4-mixer.c
index e54ecfdd..6baa893e 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 45cc2c57..a909759a 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 fd934bdd..78fba4a2 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
diff --git a/sys/wininet/gstwininetsrc.c b/sys/wininet/gstwininetsrc.c
index ea194d30..4f6d4843 100644
--- a/sys/wininet/gstwininetsrc.c
+++ b/sys/wininet/gstwininetsrc.c
@@ -22,11 +22,9 @@
*
* <refsect2>
* <title>Example launch line</title>
- * <para>
- * <programlisting>
+ * |[
* gst-launch-0.10 -v wininetsrc location="http://71.83.57.210:9000" ! application/x-icy,metadata-interval=0 ! icydemux ! mad ! audioconvert ! directsoundsink
- * </programlisting>
- * </para>
+ * ]| receive mp3 audio over http and play it back.
* </refsect2>
*/