docs: update docs

This commit is contained in:
Tim-Philipp Müller 2011-11-11 01:29:33 +00:00
parent 82ae672bad
commit 3ab8c7b0d0
17 changed files with 95 additions and 124 deletions

View file

@ -472,7 +472,7 @@
<NAME>GstLameMP3Enc::bitrate</NAME>
<TYPE>gint</TYPE>
<RANGE>[8,320]</RANGE>
<FLAGS>rw</FLAGS>
<FLAGS>rwx</FLAGS>
<NICK>Bitrate (kb/s)</NICK>
<BLURB>Bitrate in kbit/sec (Only valid if target is bitrate, for CBR one of 8, 16, 24, 32, 40, 48, 56, 64, 80, 96, 112, 128, 160, 192, 224, 256 or 320).</BLURB>
<DEFAULT>128</DEFAULT>
@ -482,7 +482,7 @@
<NAME>GstLameMP3Enc::cbr</NAME>
<TYPE>gboolean</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<FLAGS>rwx</FLAGS>
<NICK>CBR</NICK>
<BLURB>Enforce constant bitrate encoding (Only valid if target is bitrate).</BLURB>
<DEFAULT>FALSE</DEFAULT>
@ -492,7 +492,7 @@
<NAME>GstLameMP3Enc::encoding-engine-quality</NAME>
<TYPE>GstLameMP3EncEncodingEngineQuality</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<FLAGS>rwx</FLAGS>
<NICK>Encoding Engine Quality</NICK>
<BLURB>Quality/speed of the encoding engine, this does not affect the bitrate!.</BLURB>
<DEFAULT>Standard</DEFAULT>
@ -502,7 +502,7 @@
<NAME>GstLameMP3Enc::mono</NAME>
<TYPE>gboolean</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<FLAGS>rwx</FLAGS>
<NICK>Mono</NICK>
<BLURB>Enforce mono encoding.</BLURB>
<DEFAULT>FALSE</DEFAULT>
@ -512,7 +512,7 @@
<NAME>GstLameMP3Enc::quality</NAME>
<TYPE>gfloat</TYPE>
<RANGE>[0,9.999]</RANGE>
<FLAGS>rw</FLAGS>
<FLAGS>rwx</FLAGS>
<NICK>Quality</NICK>
<BLURB>VBR Quality from 0 to 10, 0 being the best (Only valid if target is quality).</BLURB>
<DEFAULT>4</DEFAULT>
@ -522,7 +522,7 @@
<NAME>GstLameMP3Enc::target</NAME>
<TYPE>GstLameMP3EncTarget</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<FLAGS>rwx</FLAGS>
<NICK>Target</NICK>
<BLURB>Optimize for quality or bitrate.</BLURB>
<DEFAULT>Quality</DEFAULT>
@ -711,7 +711,7 @@
<ARG>
<NAME>GstTwoLame::psymodel</NAME>
<TYPE>gint</TYPE>
<RANGE>[-1,4]</RANGE>
<RANGE>[G_MAXULONG,4]</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Psychoacoustic Model</NICK>
<BLURB>Psychoacoustic model used to encode the audio.</BLURB>
@ -881,7 +881,7 @@
<ARG>
<NAME>GstX264Enc::key-int-max</NAME>
<TYPE>guint</TYPE>
<RANGE><= G_MAXLONG</RANGE>
<RANGE><= G_MAXINT</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Key-frame maximal interval</NICK>
<BLURB>Maximal distance between two key-frames (0 for automatic).</BLURB>
@ -1011,10 +1011,10 @@
<ARG>
<NAME>GstX264Enc::subme</NAME>
<TYPE>guint</TYPE>
<RANGE>[1,6]</RANGE>
<RANGE>[1,10]</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Subpixel Motion Estimation</NICK>
<BLURB>Subpixel motion estimation and partition decision quality: 1=fast, 6=best.</BLURB>
<BLURB>Subpixel motion estimation and partition decision quality: 1=fast, 10=best.</BLURB>
<DEFAULT>1</DEFAULT>
</ARG>
@ -1101,7 +1101,7 @@
<ARG>
<NAME>GstX264Enc::sync-lookahead</NAME>
<TYPE>gint</TYPE>
<RANGE>[-1,250]</RANGE>
<RANGE>[G_MAXULONG,250]</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Sync Lookahead</NICK>
<BLURB>Number of buffer frames for threaded lookahead (-1 for automatic).</BLURB>
@ -1124,7 +1124,7 @@
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>H.264 profile</NICK>
<BLURB>Apply restrictions to meet H.264 Profile constraints. This will override other properties if necessary.</BLURB>
<BLURB>Apply restrictions to meet H.264 Profile constraints. This will override other properties if necessary. This will only be used if downstream elements do not specify a profile in their caps (DEPRECATED).</BLURB>
<DEFAULT>main</DEFAULT>
</ARG>

View file

@ -1,61 +1,52 @@
GObject
GstObject
GstBus
GstClock
GstElement
AC3IEC
GstA52Dec
GstASFDemux
GstAmrnbDec
GstAmrnbEnc
GstAmrwbDec
GstBaseRTPDepayload
GstRtpAsfDepay
GstBaseSrc
GstPushSrc
GstCddaBaseSrc
GstCdioCddaSrc
GstDvdReadSrc
GstPNMSrc
GstBin
GstPipeline
GstDvdLpcmDec
GstDvdSubDec
GstDvdSubParse
GstLame
GstLameMP3Enc
GstMPEGAudioParse
GstMPEGParse
GstMPEGDemux
GstDVDDemux
GstMad
GstMpeg2dec
GstRDTDepay
GstRDTManager
GstRMDemux
GstRTSPReal
GstRTSPWMS
GstRealAudioDemux
GstSidDec
GstSynaesthesia
GstTwoLame
GstX264Enc
GstXingMux
GstPad
GstPadTemplate
GstPlugin
GstPluginFeature
GstElementFactory
GstIndexFactory
GstTypeFindFactory
GstRegistry
GstTask
GstTaskPool
GstSignalObject
GInitiallyUnowned
GstObject
GstBus
GstClock
GstElement
GstA52Dec
GstASFDemux
GstAudioDecoder
GstAmrnbDec
GstAmrwbDec
GstAudioEncoder
GstAmrnbEnc
GstLameMP3Enc
GstTwoLame
GstBaseRTPDepayload
GstRtpAsfDepay
GstBaseSrc
GstPushSrc
GstDvdReadSrc
GstPNMSrc
GstBin
GstPipeline
GstDvdLpcmDec
GstDvdSubDec
GstDvdSubParse
GstMad
GstMpeg2dec
GstRDTDepay
GstRDTManager
GstRMDemux
GstRTSPReal
GstRTSPWMS
GstRealAudioDemux
GstSidDec
GstX264Enc
GstPad
GstPadTemplate
GstPlugin
GstPluginFeature
GstElementFactory
GstIndexFactory
GstTypeFindFactory
GstRegistry
GstTask
GstTaskPool
GInterface
GTypePlugin
GstChildProxy
GstPreset
GstRTSPExtension
GstTagSetter
GstURIHandler

View file

@ -1,4 +1,5 @@
GstAmrnbEnc GstPreset
GstAudioEncoder GstPreset
GstBin GstChildProxy
GstCddaBaseSrc GstURIHandler
GstCdioCddaSrc GstURIHandler

View file

@ -3,7 +3,7 @@
<description>Decodes ATSC A/52 encoded audio streams</description>
<filename>../../ext/a52dec/.libs/libgsta52dec.so</filename>
<basename>libgsta52dec.so</basename>
<version>0.10.18.1</version>
<version>0.11.0.1</version>
<license>GPL</license>
<source>gst-plugins-ugly</source>
<package>GStreamer Ugly Plug-ins git</package>
@ -26,7 +26,7 @@
<name>src</name>
<direction>source</direction>
<presence>always</presence>
<details>audio/x-raw-float, endianness=(int)1234, width=(int)32, rate=(int)[ 4000, 96000 ], channels=(int)[ 1, 6 ]</details>
<details>audio/x-raw, format=(string)F32LE, rate=(int)[ 4000, 96000 ], channels=(int)[ 1, 6 ]</details>
</caps>
</pads>
</element>

View file

@ -3,7 +3,7 @@
<description>Adaptive Multi-Rate Narrow-Band</description>
<filename>../../ext/amrnb/.libs/libgstamrnb.so</filename>
<basename>libgstamrnb.so</basename>
<version>0.10.18.1</version>
<version>0.11.0.1</version>
<license>unknown</license>
<source>gst-plugins-ugly</source>
<package>GStreamer Ugly Plug-ins git</package>
@ -26,7 +26,7 @@
<name>src</name>
<direction>source</direction>
<presence>always</presence>
<details>audio/x-raw-int, width=(int)16, depth=(int)16, signed=(boolean)true, endianness=(int)1234, rate=(int)8000, channels=(int)1</details>
<details>audio/x-raw, format=(string)S16LE, rate=(int)8000, channels=(int)1</details>
</caps>
</pads>
</element>
@ -41,7 +41,7 @@
<name>sink</name>
<direction>sink</direction>
<presence>always</presence>
<details>audio/x-raw-int, width=(int)16, depth=(int)16, signed=(boolean)true, endianness=(int)1234, rate=(int)8000, channels=(int)1</details>
<details>audio/x-raw, format=(string)S16LE, rate=(int)8000, channels=(int)1</details>
</caps>
<caps>
<name>src</name>

View file

@ -3,7 +3,7 @@
<description>Adaptive Multi-Rate Wide-Band Decoder</description>
<filename>../../ext/amrwbdec/.libs/libgstamrwbdec.so</filename>
<basename>libgstamrwbdec.so</basename>
<version>0.10.18.1</version>
<version>0.11.0.1</version>
<license>unknown</license>
<source>gst-plugins-ugly</source>
<package>GStreamer Ugly Plug-ins git</package>
@ -26,7 +26,7 @@
<name>src</name>
<direction>source</direction>
<presence>always</presence>
<details>audio/x-raw-int, width=(int)16, depth=(int)16, signed=(boolean)true, endianness=(int)1234, rate=(int)16000, channels=(int)1</details>
<details>audio/x-raw, format=(string)S16LE, rate=(int)16000, channels=(int)1</details>
</caps>
</pads>
</element>

View file

@ -3,7 +3,7 @@
<description>Demuxes and muxes audio and video in Microsofts ASF format</description>
<filename>../../gst/asfdemux/.libs/libgstasf.so</filename>
<basename>libgstasf.so</basename>
<version>0.10.18.1</version>
<version>0.11.0.1</version>
<license>LGPL</license>
<source>gst-plugins-ugly</source>
<package>GStreamer Ugly Plug-ins git</package>
@ -23,13 +23,13 @@
<details>video/x-ms-asf</details>
</caps>
<caps>
<name>audio_%02d</name>
<name>audio_%u</name>
<direction>source</direction>
<presence>sometimes</presence>
<details>ANY</details>
</caps>
<caps>
<name>video_%02d</name>
<name>video_%u</name>
<direction>source</direction>
<presence>sometimes</presence>
<details>ANY</details>

View file

@ -3,7 +3,7 @@
<description>Decode DVD LPCM frames into standard PCM</description>
<filename>../../gst/dvdlpcmdec/.libs/libgstdvdlpcmdec.so</filename>
<basename>libgstdvdlpcmdec.so</basename>
<version>0.10.18.1</version>
<version>0.11.0.1</version>
<license>LGPL</license>
<source>gst-plugins-ugly</source>
<package>GStreamer Ugly Plug-ins git</package>
@ -26,7 +26,7 @@
<name>src</name>
<direction>source</direction>
<presence>always</presence>
<details>audio/x-raw-int, width=(int){ 16, 24 }, rate=(int){ 32000, 44100, 48000, 96000 }, channels=(int)[ 1, 8 ], endianness=(int){ 4321 }, depth=(int){ 16, 24 }, signed=(boolean){ true }</details>
<details>audio/x-raw, format=(string){ S16BE, S24BE }, rate=(int){ 32000, 44100, 48000, 96000 }, channels=(int)[ 1, 8 ]</details>
</caps>
</pads>
</element>

View file

@ -3,7 +3,7 @@
<description>Access a DVD with dvdread</description>
<filename>../../ext/dvdread/.libs/libgstdvdread.so</filename>
<basename>libgstdvdread.so</basename>
<version>0.10.18.1</version>
<version>0.11.0.1</version>
<license>GPL</license>
<source>gst-plugins-ugly</source>
<package>GStreamer Ugly Plug-ins git</package>

View file

@ -3,7 +3,7 @@
<description>DVD subtitle parser and decoder</description>
<filename>../../gst/dvdsub/.libs/libgstdvdsub.so</filename>
<basename>libgstdvdsub.so</basename>
<version>0.10.18.1</version>
<version>0.11.0.1</version>
<license>LGPL</license>
<source>gst-plugins-ugly</source>
<package>GStreamer Ugly Plug-ins git</package>
@ -26,7 +26,7 @@
<name>src</name>
<direction>source</direction>
<presence>always</presence>
<details>video/x-raw-yuv, format=(fourcc)AYUV, width=(int)720, height=(int)576, framerate=(fraction)0/1; video/x-raw-rgb, width=(int)720, height=(int)576, framerate=(fraction)0/1, bpp=(int)32, endianness=(int)4321, red_mask=(int)16711680, green_mask=(int)65280, blue_mask=(int)255, alpha_mask=(int)-16777216, depth=(int)32</details>
<details>video/x-raw, format=(string){ AYUV, ARGB }, width=(int)720, height=(int)576, framerate=(fraction)0/1</details>
</caps>
</pads>
</element>

View file

@ -3,33 +3,12 @@
<description>Encode MP3s with LAME</description>
<filename>../../ext/lame/.libs/libgstlame.so</filename>
<basename>libgstlame.so</basename>
<version>0.10.18.1</version>
<version>0.11.0.1</version>
<license>LGPL</license>
<source>gst-plugins-ugly</source>
<package>GStreamer Ugly Plug-ins git</package>
<origin>Unknown package origin</origin>
<elements>
<element>
<name>lame</name>
<longname>L.A.M.E. mp3 encoder</longname>
<class>Codec/Encoder/Audio</class>
<description>High-quality free MP3 encoder (deprecated)</description>
<author>Erik Walthinsen &lt;omega@cse.ogi.edu&gt;, Wim Taymans &lt;wim@fluendo.com&gt;</author>
<pads>
<caps>
<name>sink</name>
<direction>sink</direction>
<presence>always</presence>
<details>audio/x-raw-int, endianness=(int)1234, signed=(boolean)true, width=(int)16, depth=(int)16, rate=(int){ 8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000 }, channels=(int)[ 1, 2 ]</details>
</caps>
<caps>
<name>src</name>
<direction>source</direction>
<presence>always</presence>
<details>audio/mpeg, mpegversion=(int)1, layer=(int)3, rate=(int){ 8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000 }, channels=(int)[ 1, 2 ]</details>
</caps>
</pads>
</element>
<element>
<name>lamemp3enc</name>
<longname>L.A.M.E. mp3 encoder</longname>
@ -41,7 +20,7 @@
<name>sink</name>
<direction>sink</direction>
<presence>always</presence>
<details>audio/x-raw-int, endianness=(int)1234, signed=(boolean)true, width=(int)16, depth=(int)16, rate=(int){ 8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000 }, channels=(int)[ 1, 2 ]</details>
<details>audio/x-raw, format=(string)S16LE, rate=(int){ 8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000 }, channels=(int)[ 1, 2 ]</details>
</caps>
<caps>
<name>src</name>

View file

@ -3,7 +3,7 @@
<description>mp3 decoding based on the mad library</description>
<filename>../../ext/mad/.libs/libgstmad.so</filename>
<basename>libgstmad.so</basename>
<version>0.10.18.1</version>
<version>0.11.0.1</version>
<license>GPL</license>
<source>gst-plugins-ugly</source>
<package>GStreamer Ugly Plug-ins git</package>
@ -26,7 +26,7 @@
<name>src</name>
<direction>source</direction>
<presence>always</presence>
<details>audio/x-raw-int, endianness=(int)1234, signed=(boolean)true, width=(int)32, depth=(int)32, rate=(int){ 8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000 }, channels=(int)[ 1, 2 ]</details>
<details>audio/x-raw, format=(string)S32LE, rate=(int){ 8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000 }, channels=(int)[ 1, 2 ]</details>
</caps>
</pads>
</element>

View file

@ -3,7 +3,7 @@
<description>LibMpeg2 decoder</description>
<filename>../../ext/mpeg2dec/.libs/libgstmpeg2dec.so</filename>
<basename>libgstmpeg2dec.so</basename>
<version>0.10.18.1</version>
<version>0.11.0.1</version>
<license>GPL</license>
<source>gst-plugins-ugly</source>
<package>GStreamer Ugly Plug-ins git</package>
@ -14,7 +14,7 @@
<longname>mpeg1 and mpeg2 video decoder</longname>
<class>Codec/Decoder/Video</class>
<description>Uses libmpeg2 to decode MPEG video streams</description>
<author>Wim Taymans &lt;wim.taymans@chello.be&gt;</author>
<author>Wim Taymans &lt;wim.taymans@gmail.com&gt;</author>
<pads>
<caps>
<name>sink</name>
@ -26,7 +26,7 @@
<name>src</name>
<direction>source</direction>
<presence>always</presence>
<details>video/x-raw-yuv, format=(fourcc){ YV12, I420, Y42B, Y444 }, width=(int)[ 16, 4096 ], height=(int)[ 16, 4096 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</details>
<details>video/x-raw, format=(string){ I420, Y42B, Y444 }, width=(int)[ 16, 4096 ], height=(int)[ 16, 4096 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</details>
</caps>
</pads>
</element>

View file

@ -3,7 +3,7 @@
<description>RealMedia support plugins</description>
<filename>../../gst/realmedia/.libs/libgstrmdemux.so</filename>
<basename>libgstrmdemux.so</basename>
<version>0.10.18.1</version>
<version>0.11.0.1</version>
<license>LGPL</license>
<source>gst-plugins-ugly</source>
<package>GStreamer Ugly Plug-ins git</package>
@ -74,25 +74,25 @@
<author>Wim Taymans &lt;wim@fluendo.com&gt;</author>
<pads>
<caps>
<name>recv_rtcp_sink_%d</name>
<name>recv_rtcp_sink_%u</name>
<direction>sink</direction>
<presence>request</presence>
<details>application/x-rtcp</details>
</caps>
<caps>
<name>recv_rtp_sink_%d</name>
<name>recv_rtp_sink_%u</name>
<direction>sink</direction>
<presence>request</presence>
<details>application/x-rdt</details>
</caps>
<caps>
<name>recv_rtp_src_%d_%d_%d</name>
<name>recv_rtp_src_%u_%u_%u</name>
<direction>source</direction>
<presence>sometimes</presence>
<details>application/x-rdt</details>
</caps>
<caps>
<name>rtcp_src_%d</name>
<name>rtcp_src_%u</name>
<direction>source</direction>
<presence>request</presence>
<details>application/x-rtcp</details>
@ -113,13 +113,13 @@
<details>application/vnd.rn-realmedia</details>
</caps>
<caps>
<name>audio_%02d</name>
<name>audio_%u</name>
<direction>source</direction>
<presence>sometimes</presence>
<details>ANY</details>
</caps>
<caps>
<name>video_%02d</name>
<name>video_%u</name>
<direction>source</direction>
<presence>sometimes</presence>
<details>ANY</details>

View file

@ -3,7 +3,7 @@
<description>Uses libsidplay to decode .sid files</description>
<filename>../../ext/sidplay/.libs/libgstsid.so</filename>
<basename>libgstsid.so</basename>
<version>0.10.18.1</version>
<version>0.11.0.1</version>
<license>GPL</license>
<source>gst-plugins-ugly</source>
<package>GStreamer Ugly Plug-ins git</package>
@ -26,7 +26,7 @@
<name>src</name>
<direction>source</direction>
<presence>always</presence>
<details>audio/x-raw-int, endianness=(int)1234, signed=(boolean){ true, false }, width=(int){ 8, 16 }, depth=(int){ 8, 16 }, rate=(int)[ 8000, 48000 ], channels=(int)[ 1, 2 ]</details>
<details>audio/x-raw, format=(string){ S8, U8, S16LE, U16LE }, rate=(int)[ 8000, 48000 ], channels=(int)[ 1, 2 ]</details>
</caps>
</pads>
</element>

View file

@ -3,14 +3,14 @@
<description>Encode MP2s with TwoLAME</description>
<filename>../../ext/twolame/.libs/libgsttwolame.so</filename>
<basename>libgsttwolame.so</basename>
<version>0.10.18.1</version>
<version>0.11.0.1</version>
<license>LGPL</license>
<source>gst-plugins-ugly</source>
<package>GStreamer Ugly Plug-ins git</package>
<origin>Unknown package origin</origin>
<elements>
<element>
<name>twolame</name>
<name>twolamemp2enc</name>
<longname>TwoLAME mp2 encoder</longname>
<class>Codec/Encoder/Audio</class>
<description>High-quality free MP2 encoder</description>
@ -20,7 +20,7 @@
<name>sink</name>
<direction>sink</direction>
<presence>always</presence>
<details>audio/x-raw-float, endianness=(int)1234, width=(int)32, rate=(int){ 16000, 22050, 24000, 32000, 44100, 48000 }, channels=(int)[ 1, 2 ]; audio/x-raw-int, endianness=(int)1234, signed=(boolean)true, width=(int)16, depth=(int)16, rate=(int){ 16000, 22050, 24000, 32000, 44100, 48000 }, channels=(int)[ 1, 2 ]</details>
<details>audio/x-raw, format=(string){ F32LE, S16LE }, rate=(int){ 16000, 22050, 24000, 32000, 44100, 48000 }, channels=(int)[ 1, 2 ]</details>
</caps>
<caps>
<name>src</name>

View file

@ -3,7 +3,7 @@
<description>libx264-based H264 plugins</description>
<filename>../../ext/x264/.libs/libgstx264.so</filename>
<basename>libgstx264.so</basename>
<version>0.10.18.1</version>
<version>0.11.0.1</version>
<license>GPL</license>
<source>gst-plugins-ugly</source>
<package>GStreamer Ugly Plug-ins git</package>
@ -20,13 +20,13 @@
<name>sink</name>
<direction>sink</direction>
<presence>always</presence>
<details>video/x-raw-yuv, format=(fourcc){ I420, YV12 }, framerate=(fraction)[ 0/1, 2147483647/1 ], width=(int)[ 16, 2147483647 ], height=(int)[ 16, 2147483647 ]</details>
<details>video/x-raw, format=(string){ I420, YV12 }, framerate=(fraction)[ 0/1, 2147483647/1 ], width=(int)[ 16, 2147483647 ], height=(int)[ 16, 2147483647 ]</details>
</caps>
<caps>
<name>src</name>
<direction>source</direction>
<presence>always</presence>
<details>video/x-h264, framerate=(fraction)[ 0/1, 2147483647/1 ], width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], stream-format=(string){ byte-stream, avc }, alignment=(string){ au }</details>
<details>video/x-h264, framerate=(fraction)[ 0/1, 2147483647/1 ], width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], stream-format=(string){ byte-stream, avc }, alignment=(string){ au }, profile=(string){ high-10, high, main, constrained-baseline, high-10-intra }</details>
</caps>
</pads>
</element>