Commit c514656e authored by Sebastian Dröge's avatar Sebastian Dröge 🍵
Browse files

Update documentation of speexresample for the new element name.

Original commit message from CVS:
* docs/plugins/gst-plugins-base-plugins.args:
* docs/plugins/gst-plugins-base-plugins.hierarchy:
* docs/plugins/gst-plugins-base-plugins.interfaces:
* docs/plugins/gst-plugins-base-plugins.prerequisites:
* docs/plugins/inspect/plugin-videorate.xml:
* gst/speexresample/gstspeexresample.c:
Update documentation of speexresample for the new element name.
parent f2eebf3f
2008-11-28 Sebastian Dröge <sebastian.droege@collabora.co.uk>
* docs/plugins/gst-plugins-base-plugins.args:
* docs/plugins/gst-plugins-base-plugins.hierarchy:
* docs/plugins/gst-plugins-base-plugins.interfaces:
* docs/plugins/gst-plugins-base-plugins.prerequisites:
* docs/plugins/inspect/plugin-videorate.xml:
* gst/speexresample/gstspeexresample.c:
Update documentation of speexresample for the new element name.
2008-11-28 Sebastian Dröge <sebastian.droege@collabora.co.uk>
 
* gst/speexresample/README:
......@@ -338,6 +338,126 @@
<DEFAULT>ITU-R Rec. BT.601</DEFAULT>
</ARG>
<ARG>
<NAME>GstVideoTestSrc::k0</NAME>
<TYPE>gint</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Zoneplate zero order phase</NICK>
<BLURB>Zoneplate zero order phase, for generating plain fields or phase offsets.</BLURB>
<DEFAULT>0</DEFAULT>
</ARG>
<ARG>
<NAME>GstVideoTestSrc::kt</NAME>
<TYPE>gint</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Zoneplate 1st order t phase</NICK>
<BLURB>Zoneplate 1st order t phase, for generating phase rotation as a function of time.</BLURB>
<DEFAULT>0</DEFAULT>
</ARG>
<ARG>
<NAME>GstVideoTestSrc::kt2</NAME>
<TYPE>gint</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Zoneplate 2nd order t phase</NICK>
<BLURB>Zoneplate 2nd order t phase, t*t/256 cycles per picture.</BLURB>
<DEFAULT>0</DEFAULT>
</ARG>
<ARG>
<NAME>GstVideoTestSrc::kx</NAME>
<TYPE>gint</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Zoneplate 1st order x phase</NICK>
<BLURB>Zoneplate 1st order x phase, for generating constant horizontal frequencies.</BLURB>
<DEFAULT>0</DEFAULT>
</ARG>
<ARG>
<NAME>GstVideoTestSrc::kx2</NAME>
<TYPE>gint</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Zoneplate 2nd order x phase</NICK>
<BLURB>Zoneplate 2nd order x phase, normalised to kx2/256 cycles per horizontal pixel at width/2 from origin.</BLURB>
<DEFAULT>0</DEFAULT>
</ARG>
<ARG>
<NAME>GstVideoTestSrc::kxt</NAME>
<TYPE>gint</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Zoneplate x*t product phase</NICK>
<BLURB>Zoneplate x*t product phase, normalised to kxy/256 cycles per vertical pixel at width/2 from origin.</BLURB>
<DEFAULT>0</DEFAULT>
</ARG>
<ARG>
<NAME>GstVideoTestSrc::kxy</NAME>
<TYPE>gint</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Zoneplate x*y product phase</NICK>
<BLURB>Zoneplate x*t product phase.</BLURB>
<DEFAULT>0</DEFAULT>
</ARG>
<ARG>
<NAME>GstVideoTestSrc::ky</NAME>
<TYPE>gint</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Zoneplate 1st order y phase</NICK>
<BLURB>Zoneplate 1st order y phase, for generating contant vertical frequencies.</BLURB>
<DEFAULT>0</DEFAULT>
</ARG>
<ARG>
<NAME>GstVideoTestSrc::ky2</NAME>
<TYPE>gint</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Zoneplate 2nd order y phase</NICK>
<BLURB>Zoneplate 2nd order y phase, normailsed to ky2/256 cycles per vertical pixel at height/2 from origin.</BLURB>
<DEFAULT>0</DEFAULT>
</ARG>
<ARG>
<NAME>GstVideoTestSrc::kyt</NAME>
<TYPE>gint</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Zoneplate y*t product phase</NICK>
<BLURB>Zoneplate y*t product phase.</BLURB>
<DEFAULT>0</DEFAULT>
</ARG>
<ARG>
<NAME>GstVideoTestSrc::xoffset</NAME>
<TYPE>gint</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Zoneplate 2nd order products x offset</NICK>
<BLURB>Zoneplate 2nd order products x offset.</BLURB>
<DEFAULT>0</DEFAULT>
</ARG>
<ARG>
<NAME>GstVideoTestSrc::yoffset</NAME>
<TYPE>gint</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Zoneplate 2nd order products y offset</NICK>
<BLURB>Zoneplate 2nd order products y offset.</BLURB>
<DEFAULT>0</DEFAULT>
</ARG>
<ARG>
<NAME>GstVideoscale::method</NAME>
<TYPE>GstVideoscaleMethod</TYPE>
......@@ -521,7 +641,7 @@
<ARG>
<NAME>GstMultiFdSink::buffers-max</NAME>
<TYPE>gint</TYPE>
<RANGE>>= G_MAXULONG</RANGE>
<RANGE>>= -1</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Buffers max</NICK>
<BLURB>max number of buffers to queue for a client (-1 = no limit).</BLURB>
......@@ -541,7 +661,7 @@
<ARG>
<NAME>GstMultiFdSink::buffers-soft-max</NAME>
<TYPE>gint</TYPE>
<RANGE>>= G_MAXULONG</RANGE>
<RANGE>>= -1</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Buffers soft max</NICK>
<BLURB>Recover client when going over this limit (-1 = no limit).</BLURB>
......@@ -631,7 +751,7 @@
<ARG>
<NAME>GstMultiFdSink::buffers-min</NAME>
<TYPE>gint</TYPE>
<RANGE>>= G_MAXULONG</RANGE>
<RANGE>>= -1</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Buffers min</NICK>
<BLURB>min number of buffers to queue (-1 = as few as possible).</BLURB>
......@@ -661,7 +781,7 @@
<ARG>
<NAME>GstMultiFdSink::bytes-min</NAME>
<TYPE>gint</TYPE>
<RANGE>>= G_MAXULONG</RANGE>
<RANGE>>= -1</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Bytes min</NICK>
<BLURB>min number of bytes to queue (-1 = as little as possible).</BLURB>
......@@ -671,7 +791,7 @@
<ARG>
<NAME>GstMultiFdSink::time-min</NAME>
<TYPE>gint64</TYPE>
<RANGE>>= G_MAXULONG</RANGE>
<RANGE>>= -1</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Time min</NICK>
<BLURB>min number of time to queue (-1 = as little as possible).</BLURB>
......@@ -691,7 +811,7 @@
<ARG>
<NAME>GstMultiFdSink::units-max</NAME>
<TYPE>gint64</TYPE>
<RANGE>>= G_MAXULONG</RANGE>
<RANGE>>= -1</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Units max</NICK>
<BLURB>max number of units to queue (-1 = no limit).</BLURB>
......@@ -701,7 +821,7 @@
<ARG>
<NAME>GstMultiFdSink::units-soft-max</NAME>
<TYPE>gint64</TYPE>
<RANGE>>= G_MAXULONG</RANGE>
<RANGE>>= -1</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Units soft max</NICK>
<BLURB>Recover client when going over this limit (-1 = no limit).</BLURB>
......@@ -711,7 +831,7 @@
<ARG>
<NAME>GstMultiFdSink::qos-dscp</NAME>
<TYPE>gint</TYPE>
<RANGE>[G_MAXULONG,63]</RANGE>
<RANGE>[-1,63]</RANGE>
<FLAGS>rw</FLAGS>
<NICK>QoS diff srv code point</NICK>
<BLURB>Quality of Service, differentiated services code point (-1 default).</BLURB>
......@@ -861,7 +981,7 @@
<ARG>
<NAME>GstVorbisEnc::bitrate</NAME>
<TYPE>gint</TYPE>
<RANGE>[G_MAXULONG,250001]</RANGE>
<RANGE>[-1,250001]</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Target Bitrate</NICK>
<BLURB>Attempt to encode at a bitrate averaging this (in bps). This uses the bitrate management engine, and is not recommended for most users. Quality is a better alternative. (-1 == disabled).</BLURB>
......@@ -891,7 +1011,7 @@
<ARG>
<NAME>GstVorbisEnc::max-bitrate</NAME>
<TYPE>gint</TYPE>
<RANGE>[G_MAXULONG,250001]</RANGE>
<RANGE>[-1,250001]</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Maximum Bitrate</NICK>
<BLURB>Specify a maximum bitrate (in bps). Useful for streaming applications. (-1 == disabled).</BLURB>
......@@ -901,7 +1021,7 @@
<ARG>
<NAME>GstVorbisEnc::min-bitrate</NAME>
<TYPE>gint</TYPE>
<RANGE>[G_MAXULONG,250001]</RANGE>
<RANGE>[-1,250001]</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Minimum Bitrate</NICK>
<BLURB>Specify a minimum bitrate (in bps). Useful for encoding for a fixed-size channel. (-1 == disabled).</BLURB>
......@@ -1721,7 +1841,7 @@
<ARG>
<NAME>GstCdParanoiaSrc::read-speed</NAME>
<TYPE>gint</TYPE>
<RANGE>>= G_MAXULONG</RANGE>
<RANGE>>= -1</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Read speed</NICK>
<BLURB>Read from device at specified speed.</BLURB>
......@@ -1731,7 +1851,7 @@
<ARG>
<NAME>GstCdParanoiaSrc::search-overlap</NAME>
<TYPE>gint</TYPE>
<RANGE>[G_MAXULONG,75]</RANGE>
<RANGE>[-1,75]</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Search overlap</NICK>
<BLURB>Force minimum overlap search during verification to n sectors.</BLURB>
......@@ -1868,6 +1988,26 @@
<DEFAULT></DEFAULT>
</ARG>
<ARG>
<NAME>GstURIDecodeBin::buffer-duration</NAME>
<TYPE>gint64</TYPE>
<RANGE>>= -1</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Buffer duration (ns)</NICK>
<BLURB>Buffer duration when buffering network streams.</BLURB>
<DEFAULT>-1</DEFAULT>
</ARG>
<ARG>
<NAME>GstURIDecodeBin::buffer-size</NAME>
<TYPE>gint</TYPE>
<RANGE>>= -1</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Buffer size (bytes)</NICK>
<BLURB>Buffer size when buffering network streams.</BLURB>
<DEFAULT>-1</DEFAULT>
</ARG>
<ARG>
<NAME>GstQueue2::current-level-buffers</NAME>
<TYPE>guint</TYPE>
......@@ -2021,7 +2161,7 @@
<ARG>
<NAME>GstPlayBin2::current-audio</NAME>
<TYPE>gint</TYPE>
<RANGE>>= G_MAXULONG</RANGE>
<RANGE>>= -1</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Current audio</NICK>
<BLURB>Currently playing audio stream (-1 = auto).</BLURB>
......@@ -2031,7 +2171,7 @@
<ARG>
<NAME>GstPlayBin2::current-text</NAME>
<TYPE>gint</TYPE>
<RANGE>>= G_MAXULONG</RANGE>
<RANGE>>= -1</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Current Text</NICK>
<BLURB>Currently playing text stream (-1 = auto).</BLURB>
......@@ -2041,7 +2181,7 @@
<ARG>
<NAME>GstPlayBin2::current-video</NAME>
<TYPE>gint</TYPE>
<RANGE>>= G_MAXULONG</RANGE>
<RANGE>>= -1</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Current Video</NICK>
<BLURB>Currently playing video stream (-1 = auto).</BLURB>
......@@ -2198,6 +2338,26 @@
<DEFAULT>FALSE</DEFAULT>
</ARG>
<ARG>
<NAME>GstPlayBin2::buffer-duration</NAME>
<TYPE>gint64</TYPE>
<RANGE>>= -1</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Buffer duration (ns)</NICK>
<BLURB>Buffer duration when buffering network streams.</BLURB>
<DEFAULT>-1</DEFAULT>
</ARG>
<ARG>
<NAME>GstPlayBin2::buffer-size</NAME>
<TYPE>gint</TYPE>
<RANGE>>= -1</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Buffer size (bytes)</NICK>
<BLURB>Buffer size when buffering network streams.</BLURB>
<DEFAULT>-1</DEFAULT>
</ARG>
<ARG>
<NAME>GstGioSink::location</NAME>
<TYPE>gchar*</TYPE>
......
......@@ -15,57 +15,57 @@ GObject
GstDecodeBin
GstDecodeBin2
GstURIDecodeBin
GstOggDemux
GstOggMux
GstOgmParse
GstOgmAudioParse
GstOgmVideoParse
GstOgmTextParse
GstOggParse
GstOggAviParse
GstBaseSink
GstGioBaseSink
GstGioSink
GstGioStreamSink
GstBaseAudioSink
GstAudioSink
GstAlsaSink
GstGnomeVFSSink
GstVideoSink
GstXvImageSink
GstXImageSink
GstTCPClientSink
GstMultiFdSink
GstTCPServerSink
GstTextOverlay
GstTimeOverlay
GstClockOverlay
GstTextRender
GstBaseSrc
GstGioBaseSrc
GstGioSrc
GstGioStreamSrc
GstPushSrc
GstCddaBaseSrc
GstCdParanoiaSrc
GstBaseAudioSrc
GstAudioSrc
GstAlsaSrc
GstCddaBaseSrc
GstCdParanoiaSrc
GstV4lElement
GstV4lSrc
GstTCPClientSrc
GstTCPServerSrc
GstVideoTestSrc
GstGnomeVFSSrc
GstGioBaseSrc
GstGioSrc
GstGioStreamSrc
GstAudioTestSrc
GstBaseSink
GstGnomeVFSSink
GstBaseAudioSink
GstAudioSink
GstAlsaSink
GstGioBaseSink
GstGioSink
GstGioStreamSink
GstVideoSink
GstXvImageSink
GstXImageSink
GstTCPClientSink
GstMultiFdSink
GstTCPServerSink
GstVorbisEnc
GstVorbisDec
GstVorbisParse
GstVorbisTag
GstTextOverlay
GstTimeOverlay
GstClockOverlay
GstTextRender
GstAlsaMixerElement
GstTheoraDec
GstTheoraEnc
GstTheoraParse
GstAlsaMixerElement
GstOggDemux
GstOggMux
GstOgmParse
GstOgmAudioParse
GstOgmVideoParse
GstOgmTextParse
GstOggParse
GstOggAviParse
GstVisual
GstVisualjess
GstVisualbumpscope
......@@ -75,22 +75,22 @@ GObject
GstVisuallv_analyzer
GstVisuallv_scope
GstVisualoinksie
GstSubParse
GstSsaParse
GstAudioRate
GstGDPDepay
GstGDPPay
GstStreamSelector
GstQueue2
GstBaseTransform
GstAudioConvert
GstFFMpegCsp
GstSpeexResample
GstAudioFilter
GstVolume
GstFFMpegCsp
GstSpeexResample
GstVideoScale
GstAudioConvert
GstAdder
GstGDPDepay
GstGDPPay
GstStreamSelector
GstQueue2
GstVideoRate
GstAudioRate
GstSubParse
GstSsaParse
GstBus
GstTask
GstClock
......@@ -100,6 +100,15 @@ GObject
GstRegistry
GstRingBuffer
GstSignalObject
PangoFontMap
PangoFcFontMap
PangoFT2FontMap
PangoContext
LinkConnection
GIOPConnection
LinkServer
GIOPServer
GConfClient
GFileMonitor
GLocalDirectoryMonitor
GInotifyDirectoryMonitor
......@@ -118,42 +127,33 @@ GObject
GVfsUriMapper
GVfsUriMapperSmb
GVfsUriMapperHttp
GAppLookupGConf
HalDevice
HalPool
GHalDrive
GHalMount
GHalVolume
GAppLookupGConf
GOutputStream
GInputStream
PangoFontMap
PangoFcFontMap
PangoFT2FontMap
PangoContext
LinkConnection
GIOPConnection
LinkServer
GIOPServer
GConfClient
GstColorBalanceChannel
GstTunerNorm
GstTunerChannel
GstMixerTrack
GstColorBalanceChannel
GstStreamInfo
GstMixerTrack
GInterface
GTypePlugin
GstChildProxy
GstURIHandler
GstTagSetter
GstImplementsInterface
GstMixer
GstPropertyProbe
GFile
GDesktopAppInfoLookup
GDrive
GMount
GVolume
GstTagSetter
GstImplementsInterface
GstMixer
GstPropertyProbe
GstNavigation
GstTuner
GstXOverlay
GstColorBalance
GstTuner
GstNavigation
......@@ -6,25 +6,25 @@ GstPlayBin2 GstChildProxy
GstDecodeBin GstChildProxy
GstDecodeBin2 GstChildProxy
GstURIDecodeBin GstChildProxy
GstGioSink GstURIHandler
GstAlsaSink GstPropertyProbe
GstGnomeVFSSink GstURIHandler
GstXvImageSink GstImplementsInterface GstPropertyProbe GstNavigation GstXOverlay GstColorBalance
GstXImageSink GstImplementsInterface GstNavigation GstXOverlay
GstGioSrc GstURIHandler
GstAlsaSrc GstImplementsInterface GstMixer GstPropertyProbe
GstCddaBaseSrc GstURIHandler
GstCdParanoiaSrc GstURIHandler
GstV4lElement GstImplementsInterface GstPropertyProbe GstXOverlay GstColorBalance GstTuner
GstV4lSrc GstImplementsInterface GstPropertyProbe GstXOverlay GstColorBalance GstTuner
GstAlsaSrc GstImplementsInterface GstMixer GstPropertyProbe
GstV4lElement GstImplementsInterface GstPropertyProbe GstTuner GstXOverlay GstColorBalance
GstV4lSrc GstImplementsInterface GstPropertyProbe GstTuner GstXOverlay GstColorBalance
GstGnomeVFSSrc GstURIHandler
GstGioSrc GstURIHandler
GstGnomeVFSSink GstURIHandler
GstAlsaSink GstPropertyProbe
GstGioSink GstURIHandler
GstXvImageSink GstImplementsInterface GstPropertyProbe GstXOverlay GstColorBalance GstNavigation
GstXImageSink GstImplementsInterface GstXOverlay GstNavigation
GstVorbisEnc GstTagSetter
GstVorbisTag GstTagSetter
GstAlsaMixerElement GstImplementsInterface GstMixer GstPropertyProbe
GstVolume GstImplementsInterface GstMixer
GTypeModule GTypePlugin
GIOModule GTypePlugin
GAppLookupGConf GDesktopAppInfoLookup
GHalDrive GDrive
GHalMount GMount
GHalVolume GVolume
GAppLookupGConf GDesktopAppInfoLookup
GstChildProxy GstObject
GstTagSetter GstObject GstElement
GstImplementsInterface GstObject GstElement
GstMixer GstObject GstImplementsInterface GstElement
GFile GObject
GDesktopAppInfoLookup GObject
GDrive GObject
GMount GObject
GVolume GObject
GstTagSetter GstObject GstElement
GstImplementsInterface GstObject GstElement
GstMixer GstObject GstImplementsInterface GstElement
GstTuner GstObject GstImplementsInterface GstElement
GstXOverlay GstObject GstImplementsInterface GstElement
GstColorBalance GstObject GstImplementsInterface GstElement
GstTuner GstObject GstImplementsInterface GstElement
......@@ -20,13 +20,13 @@
<name>src</name>
<direction>source</direction>
<presence>always</presence>
<details>video/x-raw-yuv; video/x-raw-rgb</details>
<details>video/x-raw-yuv; video/x-raw-rgb; image/jpeg; image/png</details>
</caps>
<caps>
<name>sink</name>
<direction>sink</direction>
<presence>always</presence>
<details>video/x-raw-yuv; video/x-raw-rgb</details>
<details>video/x-raw-yuv; video/x-raw-rgb; image/jpeg; image/png</details>
</caps>
</pads>
</element>
......
......@@ -20,15 +20,15 @@
*/
/**
* SECTION:element-speexresample
* SECTION:element-audioresample
*
* speexresample resamples raw audio buffers to different sample rates using
* audioresample resamples raw audio buffers to different sample rates using
* a configurable windowing function to enhance quality.
*
* <refsect2>
* <title>Example launch line</title>
* |[
* gst-launch -v filesrc location=sine.ogg ! oggdemux ! vorbisdec ! audioconvert ! speexresample ! audio/x-raw-int, rate=8000 ! alsasink
* gst-launch -v filesrc location=sine.ogg ! oggdemux ! vorbisdec ! audioconvert ! audioresample ! audio/x-raw-int, rate=8000 ! alsasink
* ]| Decode an Ogg/Vorbis downsample to 8Khz and play sound through alsa.
* To create the Ogg/Vorbis file refer to the documentation of vorbisenc.
* </refsect2>
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment