From 2affd3d48339e41809f5aa342ce2af370c143b80 Mon Sep 17 00:00:00 2001 From: Stefan Kost Date: Fri, 13 Jun 2008 11:59:23 +0000 Subject: docs/plugins/: docs/plugins/inspect/plugin-mythtv.xml Original commit message from CVS: * docs/plugins/Makefile.am: * docs/plugins/gst-plugins-bad-plugins-docs.sgml: * docs/plugins/gst-plugins-bad-plugins-sections.txt: * docs/plugins/gst-plugins-bad-plugins.args: * docs/plugins/gst-plugins-bad-plugins.hierarchy: * docs/plugins/gst-plugins-bad-plugins.interfaces: * docs/plugins/gst-plugins-bad-plugins.prerequisites: * docs/plugins/gst-plugins-bad-plugins.signals: * docs/plugins/inspect/plugin-alsaspdif.xml: * docs/plugins/inspect/plugin-amrwb.xml: * docs/plugins/inspect/plugin-app.xml: * docs/plugins/inspect/plugin-bayer.xml: * docs/plugins/inspect/plugin-bz2.xml: * docs/plugins/inspect/plugin-cdaudio.xml: * docs/plugins/inspect/plugin-cdxaparse.xml: * docs/plugins/inspect/plugin-dtsdec.xml: * docs/plugins/inspect/plugin-dvb.xml: * docs/plugins/inspect/plugin-dvdspu.xml: * docs/plugins/inspect/plugin-faac.xml: * docs/plugins/inspect/plugin-faad.xml: * docs/plugins/inspect/plugin-fbdevsink.xml: * docs/plugins/inspect/plugin-festival.xml: * docs/plugins/inspect/plugin-filter.xml: * docs/plugins/inspect/plugin-flvdemux.xml: * docs/plugins/inspect/plugin-freeze.xml: * docs/plugins/inspect/plugin-gsm.xml: * docs/plugins/inspect/plugin-gstinterlace.xml: * docs/plugins/inspect/plugin-gstrtpmanager.xml: * docs/plugins/inspect/plugin-h264parse.xml: * docs/plugins/inspect/plugin-interleave.xml: * docs/plugins/inspect/plugin-jack.xml: * docs/plugins/inspect/plugin-ladspa.xml: * docs/plugins/inspect/plugin-metadata.xml: * docs/plugins/inspect/plugin-mms.xml: * docs/plugins/inspect/plugin-modplug.xml: * docs/plugins/inspect/plugin-mpeg2enc.xml: * docs/plugins/inspect/plugin-mpeg4videoparse.xml: * docs/plugins/inspect/plugin-mpegtsparse.xml: * docs/plugins/inspect/plugin-mpegvideoparse.xml: * docs/plugins/inspect/plugin-musepack.xml: * docs/plugins/inspect/plugin-musicbrainz.xml: * docs/plugins/inspect/plugin-mve.xml: * docs/plugins/inspect/plugin-mythtv.xml * docs/plugins/inspect/plugin-nas.xml: * docs/plugins/inspect/plugin-neon.xml: * docs/plugins/inspect/plugin-nsfdec.xml: * docs/plugins/inspect/plugin-nuvdemux.xml: * docs/plugins/inspect/plugin-oss4.xml * docs/plugins/inspect/plugin-rawparse.xml: * docs/plugins/inspect/plugin-real.xml: * docs/plugins/inspect/plugin-replaygain.xml: * docs/plugins/inspect/plugin-rfbsrc.xml: * docs/plugins/inspect/plugin-sdl.xml: * docs/plugins/inspect/plugin-sdp.xml: * docs/plugins/inspect/plugin-selector.xml: * docs/plugins/inspect/plugin-sndfile.xml: * docs/plugins/inspect/plugin-soundtouch.xml: * docs/plugins/inspect/plugin-spcdec.xml: * docs/plugins/inspect/plugin-speed.xml: * docs/plugins/inspect/plugin-speexresample.xml: * docs/plugins/inspect/plugin-stereo.xml: * docs/plugins/inspect/plugin-subenc.xml * docs/plugins/inspect/plugin-timidity.xml: * docs/plugins/inspect/plugin-tta.xml: * docs/plugins/inspect/plugin-vcdsrc.xml: * docs/plugins/inspect/plugin-videosignal.xml: * docs/plugins/inspect/plugin-vmnc.xml: * docs/plugins/inspect/plugin-wildmidi.xml: * docs/plugins/inspect/plugin-x264.xml: * docs/plugins/inspect/plugin-xvid.xml: * docs/plugins/inspect/plugin-y4menc.xml: * ext/amrwb/gstamrwbdec.c: * ext/amrwb/gstamrwbenc.c: * ext/amrwb/gstamrwbparse.c: * ext/dc1394/gstdc1394.c: * ext/directfb/dfbvideosink.c: * ext/ivorbis/vorbisdec.c: * ext/jack/gstjackaudiosink.c: * ext/mpeg2enc/gstmpeg2enc.cc: * ext/mplex/gstmplex.cc: * ext/musicbrainz/gsttrm.c: * ext/mythtv/gstmythtvsrc.c: * ext/theora/theoradec.c: * ext/timidity/gsttimidity.c: * ext/timidity/gstwildmidi.c: * gst-libs/gst/app/gstappsink.c: * gst/deinterlace/gstdeinterlace.c: * gst/dvdspu/gstdvdspu.c: * gst/festival/gstfestival.c: * gst/freeze/gstfreeze.c: * gst/interleave/deinterleave.c: * gst/interleave/interleave.c: * gst/modplug/gstmodplug.cc: * gst/nuvdemux/gstnuvdemux.c: Add missing elements to docs. Fix doc-markup: use convinience syntax for examples (produces valid docbook), add several refsec2 when we have several titles. Fix some types. --- ext/amrwb/gstamrwbdec.c | 13 +++++-------- ext/amrwb/gstamrwbenc.c | 13 +++++-------- ext/amrwb/gstamrwbparse.c | 11 ++++------- ext/dc1394/gstdc1394.c | 13 +++++-------- ext/directfb/dfbvideosink.c | 25 +++++++++++-------------- ext/ivorbis/vorbisdec.c | 13 +++++-------- ext/jack/gstjackaudiosink.c | 40 ++++++++++++++++------------------------ ext/mpeg2enc/gstmpeg2enc.cc | 28 ++++++++++------------------ ext/mplex/gstmplex.cc | 12 ++++-------- ext/musicbrainz/gsttrm.c | 22 +++++++--------------- ext/mythtv/gstmythtvsrc.c | 27 +++++++++------------------ ext/theora/theoradec.c | 12 ++++-------- ext/timidity/gsttimidity.c | 12 ++++-------- ext/timidity/gstwildmidi.c | 12 ++++-------- 14 files changed, 93 insertions(+), 160 deletions(-) (limited to 'ext') diff --git a/ext/amrwb/gstamrwbdec.c b/ext/amrwb/gstamrwbdec.c index 525b49c3..54e8a830 100644 --- a/ext/amrwb/gstamrwbdec.c +++ b/ext/amrwb/gstamrwbdec.c @@ -21,17 +21,14 @@ * SECTION:element-amrwbdec * @see_also: #GstAmrwbEnc, #GstAmrwbParse * - * - * - * This is an AMR wideband decoder based on the + * AMR wideband decoder based on the * reference codec implementation. - * + * + * * Example launch line - * - * + * |[ * gst-launch filesrc location=abc.amr ! amrwbparse ! amrwbdec ! audioresample ! audioconvert ! alsasink - * - * + * ]| * */ diff --git a/ext/amrwb/gstamrwbenc.c b/ext/amrwb/gstamrwbenc.c index 33b3dc73..6551b67b 100644 --- a/ext/amrwb/gstamrwbenc.c +++ b/ext/amrwb/gstamrwbenc.c @@ -21,17 +21,14 @@ * SECTION:element-amrwbenc * @see_also: #GstAmrwbDec, #GstAmrwbParse * - * - * - * This is an AMR wideband encoder based on the + * AMR wideband encoder based on the * reference codec implementation. - * + * + * * Example launch line - * - * + * |[ * gst-launch filesrc location=abc.wav ! wavparse ! audioresample ! audioconvert ! amrwbenc ! filesink location=abc.amr - * - * + * ]| * Please not that the above stream misses the header, that is needed to play * the stream. * diff --git a/ext/amrwb/gstamrwbparse.c b/ext/amrwb/gstamrwbparse.c index f7a7e274..cd162d58 100644 --- a/ext/amrwb/gstamrwbparse.c +++ b/ext/amrwb/gstamrwbparse.c @@ -21,16 +21,13 @@ * SECTION:element-amrwbparse * @see_also: #GstAmrwbDec, #GstAmrwbEnc * - * - * * This is an AMR wideband parser. - * + * + * * Example launch line - * - * + * |[ * gst-launch filesrc location=abc.amr ! amrwbparse ! amrwbdec ! audioresample ! audioconvert ! alsasink - * - * + * ]| * */ diff --git a/ext/dc1394/gstdc1394.c b/ext/dc1394/gstdc1394.c index 7eb26607..7cae5bdf 100644 --- a/ext/dc1394/gstdc1394.c +++ b/ext/dc1394/gstdc1394.c @@ -21,17 +21,14 @@ /** * SECTION:element-dc1394 * - * - * Example launch line - * * Source for IIDC (Instrumentation & Industrial Digital Camera) firewire * cameras. - * - * - * + * + * + * Example launch line + * |[ * gst-launch -v dc1394 camera-number=0 ! xvimagesink - * - * + * ]| * */ diff --git a/ext/directfb/dfbvideosink.c b/ext/directfb/dfbvideosink.c index bc715a59..6251803e 100644 --- a/ext/directfb/dfbvideosink.c +++ b/ext/directfb/dfbvideosink.c @@ -20,8 +20,6 @@ /** * SECTION:element-dfbvideosink * - * - * * DfbVideoSink renders video frames using the * DirectFB library. * Rendering can happen in two different modes : @@ -47,19 +45,19 @@ * * * Embedded: this mode will render video frames in a - * surface provided by the + * #GstDfbVideoSink:surface provided by the * application developer. This is a more advanced usage of the element and * it is required to integrate video playback in existing * DirectFB applications. * * * When using this mode the element just renders to the - * surface provided by the + * #GstDfbVideoSink:surface provided by the * application, that means it won't handle navigation events and won't resize - * the surface to fit video + * the #GstDfbVideoSink:surface to fit video * frames geometry. Application has to implement the necessary code to grab * informations about the negotiated geometry and resize there - * surface accordingly. + * #GstDfbVideoSink:surface accordingly. * * * @@ -67,20 +65,19 @@ * optimize memory allocation time and handle reverse negotiation. Indeed if * you insert an element like videoscale in the pipeline the video sink will * negotiate with it to try get a scaled video for either the fullscreen layout - * or the application provided external - * surface. - * + * or the application provided external #GstDfbVideoSink:surface. + * + * * Example application * * * + * + * * Example pipelines - * - * Here is a test pipeline to test the colorbalance interface : - * + * |[ * gst-launch -v videotestsrc ! dfbvideosink hue=20000 saturation=40000 brightness=25000 - * - * + * ]| test the colorbalance interface implementation in dfbvideosink * */ diff --git a/ext/ivorbis/vorbisdec.c b/ext/ivorbis/vorbisdec.c index 75e05336..325c46a3 100644 --- a/ext/ivorbis/vorbisdec.c +++ b/ext/ivorbis/vorbisdec.c @@ -24,20 +24,17 @@ * SECTION:element-ivorbisdec * @see_also: vorbisenc, oggdemux * - * - * * This element decodes a Vorbis stream to raw int audio. * Vorbis is a royalty-free * audio codec maintained by the Xiph.org * Foundation. - * + * + * * Example pipelines - * - * + * |[ * gst-launch -v filesrc location=sine.ogg ! oggdemux ! vorbisdec ! audioconvert ! alsasink - * - * Decode an Ogg/Vorbis. To create an Ogg/Vorbis file refer to the documentation of vorbisenc. - * + * ]| Decode an Ogg/Vorbis. To create an Ogg/Vorbis file refer to the + * documentation of vorbisenc. * * * Last reviewed on 2006-03-01 (0.10.4) diff --git a/ext/jack/gstjackaudiosink.c b/ext/jack/gstjackaudiosink.c index 5710eda6..05571b2c 100644 --- a/ext/jack/gstjackaudiosink.c +++ b/ext/jack/gstjackaudiosink.c @@ -23,41 +23,33 @@ * SECTION:element-jackaudiosink * @see_also: #GstBaseAudioSink, #GstRingBuffer * - * - * * A Sink that outputs data to Jack ports. - * - * + * * It will create N Jack ports named out_<name>_<num> where * <name> is the element name and <num> is starting from 1. * Each port corresponds to a gstreamer channel. - * - * + * * The samplerate as exposed on the caps is always the same as the samplerate of * the jack server. - * - * - * When the ::connect property is set to auto, this element will try to connect - * each output port to a random physical jack input pin. In this mode, the sink - * will expose the number of physical channels on its pad caps. - * - * - * When the ::connect property is set to none, the element will accept any - * number of input channels and will create (but not connect) an output port for - * each channel. - * - * + * + * When the #GstJackAudioSink:connect property is set to auto, this element + * will try to connect each output port to a random physical jack input pin. In + * this mode, the sink will expose the number of physical channels on its pad + * caps. + * + * When the #GstJackAudioSink:connect property is set to none, the element will + * accept any number of input channels and will create (but not connect) an + * output port for each channel. + * * The element will generate an error when the Jack server is shut down when it * was PAUSED or PLAYING. This element does not support dynamic rate and buffer * size changes at runtime. - * + * + * * Example launch line - * - * + * |[ * gst-launch audiotestsrc ! jackaudiosink - * - * Play a sine wave to using jack. - * + * ]| Play a sine wave to using jack. * * * Last reviewed on 2006-11-30 (0.10.4) diff --git a/ext/mpeg2enc/gstmpeg2enc.cc b/ext/mpeg2enc/gstmpeg2enc.cc index 24a582f5..87902da9 100644 --- a/ext/mpeg2enc/gstmpeg2enc.cc +++ b/ext/mpeg2enc/gstmpeg2enc.cc @@ -24,40 +24,32 @@ * SECTION:element-mpeg2enc * @see_also: mpeg2dec * - * - * * This element encodes raw video into an MPEG ?? stream using the * mjpegtools library. * Documentation on MPEG encoding in general can be found in the * MJPEG Howto * and on the various available parameters in the documentation * of the mpeg2enc tool in particular, which shares options with this element. - * + * + * * Example pipeline - * - * + * |[ * gst-launch-0.10 videotestsrc num-buffers=1000 ! mpeg2enc ! filesink location=videotestsrc.m1v - * - * This example pipeline will encode a test video source to a an - * MPEG1 elementary stream (with Generic MPEG1 profile). - * + * ]| This example pipeline will encode a test video source to a an MPEG1 + * elementary stream (with Generic MPEG1 profile). * - * Likely, the format property + * Likely, the #GstMpeg2enc:format property * is most important, as it selects the type of MPEG stream that is produced. * In particular, default property values are dependent on the format, * and can even be forcibly restrained to certain pre-sets (and thereby ignored). * Note that the (S)VCD profiles also restrict the image size, so some scaling * may be needed to accomodate this. The so-called generic profiles (as used * in the example above) allow most parameters to be adjusted. - * - * gst-launch-0.10 videotestsrc num-buffers=1000 ! videoscale \ - * ! mpeg2enc format=1 norm=p ! filesink location=videotestsrc.m1v - * - * (write everything in one line, without the backslash characters) - * This will produce an MPEG1 profile stream according to VCD2.0 specifications - * for PAL norm (as the image height - * is dependent on video norm). * + * |[ + * gst-launch-0.10 videotestsrc num-buffers=1000 ! videoscale ! mpeg2enc format=1 norm=p ! filesink location=videotestsrc.m1v + * ]| This will produce an MPEG1 profile stream according to VCD2.0 specifications + * for PAL #GstMpeg2enc:norm (as the image height is dependent on video norm). * */ diff --git a/ext/mplex/gstmplex.cc b/ext/mplex/gstmplex.cc index e9535fe8..297bdcdd 100644 --- a/ext/mplex/gstmplex.cc +++ b/ext/mplex/gstmplex.cc @@ -24,8 +24,6 @@ * SECTION:element-mplex * @see_also: mpeg2enc * - * - * * This element is an audio/video multiplexer for MPEG-1/2 video streams * and (un)compressed audio streams such as AC3, MPEG layer I/II/III. * It is based on the mjpegtools library. @@ -33,15 +31,13 @@ * MJPEG Howto * and the man-page of the mplex tool documents the properties of this element, * which are shared with the mplex tool. - * + * + * * Example pipeline - * - * + * |[ * gst-launch -v videotestsrc num-buffers=1000 ! mpeg2enc ! mplex ! filesink location=videotestsrc.mpg - * - * This example pipeline will encode a test video source to a an + * ]| This example pipeline will encode a test video source to an * MPEG1 elementary stream and multiplexes this to an MPEG system stream. - * * * If several streams are being multiplexed, there should (as usual) be * a queue in each stream, and due to mplex' buffering the capacities of these diff --git a/ext/musicbrainz/gsttrm.c b/ext/musicbrainz/gsttrm.c index a4441f26..a4883b35 100644 --- a/ext/musicbrainz/gsttrm.c +++ b/ext/musicbrainz/gsttrm.c @@ -21,35 +21,27 @@ /** * SECTION:element-trm * - * - * * GstTRM computes MusicBrainz * TRM identifiers for audio streams using libmusicbrainz. - * - * + * * A TRM identifier is something like an 'acoustic fingerprint', the aim is * to uniquely identify the same song regardless of which source it comes from * or which audio format the stream is in. - * - * + * * The TRM element will collect about 30 seconds of audio and let * libmusicbrainz calculate a preliminary audio signature from that. That audio * signature will then be sent over the internet to a musicbrainz.org server * which will calculate the TRM for that signature. - * - * + * * The TRM element will post a tag message with a #GST_TAG_MUSICBRAINZ_TRMID * tag on the bus once the TRM has been calculated (and also send a tag event * with that information downstream). - * + * + * * Example pipeline - * - * Here is a test pipeline to test the TRM element: - * + * |[ * gst-launch -m filesrc location=somefile.ogg ! decodebin ! audioconvert ! trm ! fakesink - * - * this should (among many other things) print the tag message with the TRM ID. - * + * ]| calculate the TRM and print the tag message with the TRM ID. * */ diff --git a/ext/mythtv/gstmythtvsrc.c b/ext/mythtv/gstmythtvsrc.c index 60a445f0..894d9b68 100644 --- a/ext/mythtv/gstmythtvsrc.c +++ b/ext/mythtv/gstmythtvsrc.c @@ -17,47 +17,38 @@ /** * SECTION:element-mythtvsrc + * @see_also: nuvdemux * - * - * * MythTVSrc allows to access a remote MythTV backend streaming Video/Audio server, * and to render audio and video content through a TCP/IP connection to a specific * port on this server, and based on a known MythTV protocol that is based on * some message passing, such as REQUEST_BLOCK on a specified number of bytes, to get * some chunk of remote file data. * You should pass the information aboute the remote MythTV backend server - * through the location property. - * + * through the #GstMythtvSrc:location property. + * + * * Examples * * If you want to get the LiveTV content (set channel, TV tuner, RemoteEncoder, - * Recorder), - * put the following URI: - * - * + * Recorder), use the following URI: + * * myth://xxx.xxx.xxx.xxx:6543/livetv?channel=BBC * * - * This URI will say to the gmyth library to configure the Recorder instance (used to - * change the channel, start the TV multimedia content transmition, etc.), using + * This URI will configure the Recorder instance (used to change the channel, + * start the TV multimedia content transmition, etc.), using * the IP address (xxx.xxx.xxx.xxx) and port number (6543) of the MythTV backend * server, and setting the channel name to "BBC". * * To get a already recorded the MythTV NUV file, put the following URI: - * * * myth://xxx.xxx.xxx.xxx:6543/filename.nuv * - * - * This URI will say to the gmyth library to configure the Recorder instance (used to - * change the channel, start the TV multimedia content transmition, etc.), using - * the IP address (xxx.xxx.xxx.xxx) and port number (6543) of the MythTV backend - * server, and setting the channel name to "BBC". * * Another possible way to use the LiveTV content, and just in the case you want to * use the mysql database, put the location URI in the following format: - * - * + * * myth://mythtv:mythtv@xxx.xxx.xxx.xxx:6543/?mythconverg&channel=9 * * diff --git a/ext/theora/theoradec.c b/ext/theora/theoradec.c index 4a46c826..afb0841e 100644 --- a/ext/theora/theoradec.c +++ b/ext/theora/theoradec.c @@ -22,21 +22,17 @@ * SECTION:element-theoradecexp * @see_also: theoradec, theoraenc, oggdemux * - * - * * This element decodes theora streams into raw video using the theora-exp * decoder * Theora is a royalty-free * video codec maintained by the Xiph.org * Foundation, based on the VP3 codec. - * - * - * + * + * * Example pipeline - * + * |[ * gst-launch -v filesrc location=videotestsrc.ogg ! oggdemux ! theoraexpdec ! xvimagesink - * - * This example pipeline will demux an ogg stream and decode the theora video, + * ]| This example pipeline will demux an ogg stream and decode the theora video, * displaying it on screen. * */ diff --git a/ext/timidity/gsttimidity.c b/ext/timidity/gsttimidity.c index 7dd89e90..09c2e778 100644 --- a/ext/timidity/gsttimidity.c +++ b/ext/timidity/gsttimidity.c @@ -23,18 +23,14 @@ * SECTION:element-timidity * @see_also: wildmidi * - * - * * This element renders midi-files as audio streams using * Timidity. - * - * - * + * + * * Example pipeline - * + * |[ * gst-launch filesrc location=song.mid ! timidity ! alsasink - * - * This example pipeline will parse the midi and render to raw audio which is + * ]| This example pipeline will parse the midi and render to raw audio which is * played via alsa. * */ diff --git a/ext/timidity/gstwildmidi.c b/ext/timidity/gstwildmidi.c index cded0d77..b8f72aa8 100644 --- a/ext/timidity/gstwildmidi.c +++ b/ext/timidity/gstwildmidi.c @@ -23,21 +23,17 @@ * SECTION:element-wildmidi * @see_also: timidity * - * - * * This element renders midi-files as audio streams using * Wildmidi. * It offers better sound quality compared to the timidity element. Wildmidi * uses the same sound-patches as timidity (it tries the path in $WILDMIDI_CFG, * $HOME/.wildmidirc and /etc/wildmidi.cfg) - * - * - * + * + * * Example pipeline - * + * |[ * gst-launch filesrc location=song.mid ! wildmidi ! alsasink - * - * This example pipeline will parse the midi and render to raw audio which is + * ]| This example pipeline will parse the midi and render to raw audio which is * played via alsa. * */ -- cgit v1.2.1