summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorStefan Kost <ensonic@users.sf.net>2011-05-19 23:25:24 +0300
committerStefan Kost <ensonic@users.sf.net>2011-05-19 23:25:24 +0300
commitea1c48ab849a7a92ab96ed7623c428c8b50f1356 (patch)
tree042dd60f0b698b244c3b101a6f32d735a55d67fc /docs
parent3b3a52e175bf90fa0710881e9b94ab59e60931cf (diff)
docs: update plugin introspection data
Now more files are merged and produced in a canonical fashion, which hopefully creates less or no delta in the future.
Diffstat (limited to 'docs')
-rw-r--r--docs/plugins/gst-plugins-base-plugins.args72
-rw-r--r--docs/plugins/gst-plugins-base-plugins.hierarchy199
-rw-r--r--docs/plugins/gst-plugins-base-plugins.interfaces38
-rw-r--r--docs/plugins/gst-plugins-base-plugins.prerequisites9
4 files changed, 173 insertions, 145 deletions
diff --git a/docs/plugins/gst-plugins-base-plugins.args b/docs/plugins/gst-plugins-base-plugins.args
index 04f3a6398..ffb6e3fa8 100644
--- a/docs/plugins/gst-plugins-base-plugins.args
+++ b/docs/plugins/gst-plugins-base-plugins.args
@@ -711,7 +711,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>
@@ -731,7 +731,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>
@@ -821,7 +821,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>
@@ -851,7 +851,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>
@@ -861,7 +861,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>
@@ -881,7 +881,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>
@@ -891,7 +891,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>
@@ -901,7 +901,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>
@@ -1081,7 +1081,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>
@@ -1111,7 +1111,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>
@@ -1121,7 +1121,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>
@@ -1679,6 +1679,26 @@
</ARG>
<ARG>
+<NAME>GstVideoRate::average-period</NAME>
+<TYPE>guint64</TYPE>
+<RANGE><= G_MAXINT64</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Period over which to average</NICK>
+<BLURB>Period over which to average the framerate (in ns) (0 = disabled).</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstVideoRate::drop-only</NAME>
+<TYPE>gboolean</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Only Drop</NICK>
+<BLURB>Only drop frames, no duplicates are produced.</BLURB>
+<DEFAULT>FALSE</DEFAULT>
+</ARG>
+
+<ARG>
<NAME>GstAudioRate::add</NAME>
<TYPE>guint64</TYPE>
<RANGE></RANGE>
@@ -2201,7 +2221,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>
@@ -2211,7 +2231,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>
@@ -2221,7 +2241,7 @@
<ARG>
<NAME>GstCdParanoiaSrc::cache-size</NAME>
<TYPE>gint</TYPE>
-<RANGE>>= G_MAXULONG</RANGE>
+<RANGE>>= -1</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Cache size</NICK>
<BLURB>Set CD cache size to n sectors (-1 = auto).</BLURB>
@@ -2451,7 +2471,7 @@
<ARG>
<NAME>GstURIDecodeBin::buffer-duration</NAME>
<TYPE>gint64</TYPE>
-<RANGE>>= G_MAXULONG</RANGE>
+<RANGE>>= -1</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Buffer duration (ns)</NICK>
<BLURB>Buffer duration when buffering streams (-1 default value).</BLURB>
@@ -2461,7 +2481,7 @@
<ARG>
<NAME>GstURIDecodeBin::buffer-size</NAME>
<TYPE>gint</TYPE>
-<RANGE>>= G_MAXULONG</RANGE>
+<RANGE>>= -1</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Buffer size (bytes)</NICK>
<BLURB>Buffer size when buffering streams (-1 default value).</BLURB>
@@ -2501,7 +2521,7 @@
<ARG>
<NAME>GstURIDecodeBin::ring-buffer-max-size</NAME>
<TYPE>guint64</TYPE>
-<RANGE><= G_MAXUINT</RANGE>
+<RANGE><= G_MAXULONG</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Max. ring buffer size (bytes)</NICK>
<BLURB>Max. amount of data in the ring buffer (bytes, 0 = ring buffer disabled).</BLURB>
@@ -2671,7 +2691,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>
@@ -2681,7 +2701,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>
@@ -2691,7 +2711,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>
@@ -2841,7 +2861,7 @@
<ARG>
<NAME>GstPlayBin2::buffer-duration</NAME>
<TYPE>gint64</TYPE>
-<RANGE>>= G_MAXULONG</RANGE>
+<RANGE>>= -1</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Buffer duration (ns)</NICK>
<BLURB>Buffer duration when buffering network streams.</BLURB>
@@ -2851,7 +2871,7 @@
<ARG>
<NAME>GstPlayBin2::buffer-size</NAME>
<TYPE>gint</TYPE>
-<RANGE>>= G_MAXULONG</RANGE>
+<RANGE>>= -1</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Buffer size (bytes)</NICK>
<BLURB>Buffer size when buffering network streams.</BLURB>
@@ -2891,7 +2911,7 @@
<ARG>
<NAME>GstPlayBin2::ring-buffer-max-size</NAME>
<TYPE>guint64</TYPE>
-<RANGE><= G_MAXUINT</RANGE>
+<RANGE><= G_MAXULONG</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Max. ring buffer size (bytes)</NICK>
<BLURB>Max. amount of data in the ring buffer (bytes, 0 = ring buffer disabled).</BLURB>
@@ -3231,7 +3251,7 @@
<ARG>
<NAME>GstAppSrc::max-latency</NAME>
<TYPE>gint64</TYPE>
-<RANGE>>= G_MAXULONG</RANGE>
+<RANGE>>= -1</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Max Latency</NICK>
<BLURB>The maximum latency (-1 = unlimited).</BLURB>
@@ -3241,7 +3261,7 @@
<ARG>
<NAME>GstAppSrc::min-latency</NAME>
<TYPE>gint64</TYPE>
-<RANGE>>= G_MAXULONG</RANGE>
+<RANGE>>= -1</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Min Latency</NICK>
<BLURB>The minimum latency (-1 = default).</BLURB>
@@ -3251,7 +3271,7 @@
<ARG>
<NAME>GstAppSrc::size</NAME>
<TYPE>gint64</TYPE>
-<RANGE>>= G_MAXULONG</RANGE>
+<RANGE>>= -1</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Size</NICK>
<BLURB>The size of the data stream in bytes (-1 if unknown).</BLURB>
diff --git a/docs/plugins/gst-plugins-base-plugins.hierarchy b/docs/plugins/gst-plugins-base-plugins.hierarchy
index 8351e3758..89307df88 100644
--- a/docs/plugins/gst-plugins-base-plugins.hierarchy
+++ b/docs/plugins/gst-plugins-base-plugins.hierarchy
@@ -1,132 +1,137 @@
GObject
+ GInputStream
+ GOutputStream
+ GstColorBalanceChannel
+ GstMixerTrack
GstObject
- GstPad
- GstPadTemplate
- GstPluginFeature
- GstElementFactory
- GstTypeFindFactory
- GstIndexFactory
+ GstBus
+ GstClock
+ GstSystemClock
+ GstAudioClock
GstElement
- GstBin
- GstPipeline
- GstPlayBaseBin
- GstPlayBin
- GstPlayBin2
- GstDecodeBin2
- GstURIDecodeBin
- GstDecodeBin
- GstPlaySink
- GstSubtitleOverlay
- GstEncodeBin
- GstVorbisEnc
- GstVorbisDec
- GstVorbisParse
- GstVorbisTag
- GstVisual
- GstVisualjess
- GstVisualbumpscope
- GstVisualcorona
- GstVisualinfinite
- GstVisualjakdaw
- GstVisuallv_analyzer
- GstVisuallv_scope
- GstVisualoinksie
- GstBaseSrc
- GstPushSrc
- GstCddaBaseSrc
- GstCdParanoiaSrc
- GstBaseAudioSrc
- GstAudioSrc
- GstAlsaSrc
- GstVideoTestSrc
- GstTCPClientSrc
- GstTCPServerSrc
- GstGioBaseSrc
- GstGioSrc
- GstGioStreamSrc
- GstGnomeVFSSrc
- GstAppSrc
- GstAudioTestSrc
+ GstAdder
+ GstAlsaMixerElement
+ GstAudioRate
GstBaseSink
- GstGioBaseSink
- GstGioSink
- GstGioStreamSink
+ GstAppSink
GstBaseAudioSink
GstAudioSink
GstAlsaSink
+ GstGioBaseSink
+ GstGioSink
+ GstGioStreamSink
GstGnomeVFSSink
+ GstMultiFdSink
+ GstTCPServerSink
+ GstTCPClientSink
GstVideoSink
GstXImageSink
GstXvImageSink
- GstAppSink
- GstTCPClientSink
- GstMultiFdSink
- GstTCPServerSink
- GstTextOverlay
- GstTimeOverlay
- GstClockOverlay
- GstTextRender
- GstAlsaMixerElement
- GstTheoraDec
- GstTheoraEnc
- GstTheoraParse
- GstOggDemux
- GstOggMux
- GstOgmParse
- GstOgmAudioParse
- GstOgmVideoParse
- GstOgmTextParse
- GstOggParse
- GstOggAviParse
- GstAdder
+ GstBaseSrc
+ GstAppSrc
+ GstAudioTestSrc
+ GstGioBaseSrc
+ GstGioSrc
+ GstGioStreamSrc
+ GstGnomeVFSSrc
+ GstPushSrc
+ GstBaseAudioSrc
+ GstAudioSrc
+ GstAlsaSrc
+ GstCddaBaseSrc
+ GstCdParanoiaSrc
+ GstTCPClientSrc
+ GstTCPServerSrc
+ GstV4lElement
+ GstV4lSrc
+ GstVideoTestSrc
GstBaseTransform
- GstVideoFilter
- GstVideoScale
- GstFFMpegCsp
+ GstAudioConvert
GstAudioFilter
GstVolume
- GstAudioConvert
GstAudioResample
- GstVideoRate
- GstStreamSelector
+ GstVideoFilter
+ GstFFMpegCsp
+ GstVideoScale
+ GstBin
+ GstDecodeBin
+ GstDecodeBin2
+ GstEncodeBin
+ GstPipeline
+ GstPlayBaseBin
+ GstPlayBin
+ GstPlayBin2
+ GstPlaySink
+ GstSubtitleOverlay
+ GstURIDecodeBin
GstGDPDepay
GstGDPPay
- GstSubParse
+ GstOggAviParse
+ GstOggDemux
+ GstOggMux
+ GstOggParse
+ GstOgmParse
+ GstOgmAudioParse
+ GstOgmTextParse
+ GstOgmVideoParse
GstSsaParse
- GstAudioRate
- GstBus
- GstTask
- GstTaskPool
- GstClock
- GstSystemClock
- GstAudioClock
+ GstStreamSelector
+ GstSubParse
+ GstTextOverlay
+ GstClockOverlay
+ GstTimeOverlay
+ GstTextRender
+ GstTheoraDec
+ GstTheoraEnc
+ GstTheoraParse
+ GstVideoRate
+ GstVisual
+ GstVisualbumpscope
+ GstVisualcorona
+ GstVisualgforce
+ GstVisualinfinite
+ GstVisualjakdaw
+ GstVisualjess
+ GstVisuallv_scope
+ GstVisualoinksie
+ GstVorbisDec
+ GstVorbisEnc
+ GstVorbisParse
+ GstVorbisTag
+ GstPad
+ GstPadTemplate
GstPlugin
+ GstPluginFeature
+ GstElementFactory
+ GstIndexFactory
+ GstTypeFindFactory
GstRegistry
GstRingBuffer
- GstAudioSrcRingBuffer
GstAudioSinkRingBuffer
+ GstAudioSrcRingBuffer
+ GstTask
+ GstTaskPool
GstSignalObject
- GstMixerTrack
GstStreamInfo
- GstColorBalanceChannel
+ GstTunerChannel
+ GstTunerNorm
+ PangoContext
PangoFontMap
PangoFcFontMap
PangoCairoFcFontMap
- PangoContext
- GInputStream
- GOutputStream
GInterface
+ GFile
GTypePlugin
GstChildProxy
- GstURIHandler
- GstTagSetter
- GstPreset
+ GstColorBalance
GstImplementsInterface
GstMixer
- GstPropertyProbe
GstNavigation
- GstXOverlay
- GstColorBalance
+ GstPreset
+ GstPropertyProbe
GstStreamVolume
+ GstTagSetter
+ GstTuner
+ GstURIHandler
+ GstXOverlay
PangoCairoFontMap
- GFile
diff --git a/docs/plugins/gst-plugins-base-plugins.interfaces b/docs/plugins/gst-plugins-base-plugins.interfaces
index 772e582a9..8f393f45c 100644
--- a/docs/plugins/gst-plugins-base-plugins.interfaces
+++ b/docs/plugins/gst-plugins-base-plugins.interfaces
@@ -1,30 +1,32 @@
+GstAlsaMixerElement GstImplementsInterface GstMixer GstPropertyProbe
+GstAlsaSink GstPropertyProbe
+GstAlsaSrc GstImplementsInterface GstMixer GstPropertyProbe
+GstAppSink GstURIHandler
+GstAppSrc GstURIHandler
GstBin GstChildProxy
+GstCdParanoiaSrc GstURIHandler
+GstCddaBaseSrc GstURIHandler
+GstDecodeBin GstChildProxy
+GstDecodeBin2 GstChildProxy
+GstEncodeBin GstChildProxy
+GstGioSink GstURIHandler
+GstGioSrc GstURIHandler
+GstGnomeVFSSink GstURIHandler
+GstGnomeVFSSrc GstURIHandler
+GstOggMux GstPreset
GstPipeline GstChildProxy
GstPlayBaseBin GstChildProxy
GstPlayBin GstChildProxy
GstPlayBin2 GstChildProxy GstStreamVolume
-GstDecodeBin2 GstChildProxy
-GstURIDecodeBin GstChildProxy
-GstDecodeBin GstChildProxy
GstPlaySink GstChildProxy
GstSubtitleOverlay GstChildProxy
-GstEncodeBin GstChildProxy
+GstTheoraEnc GstPreset
+GstURIDecodeBin GstChildProxy
+GstV4lElement GstImplementsInterface GstTuner GstXOverlay GstColorBalance GstPropertyProbe
+GstV4lSrc GstImplementsInterface GstTuner GstXOverlay GstColorBalance GstPropertyProbe
+GstVolume GstImplementsInterface GstMixer GstStreamVolume
GstVorbisEnc GstTagSetter GstPreset
GstVorbisTag GstTagSetter
-GstCddaBaseSrc GstURIHandler
-GstCdParanoiaSrc GstURIHandler
-GstAlsaSrc GstImplementsInterface GstMixer GstPropertyProbe
-GstGioSrc GstURIHandler
-GstGnomeVFSSrc GstURIHandler
-GstAppSrc GstURIHandler
-GstGioSink GstURIHandler
-GstAlsaSink GstPropertyProbe
-GstGnomeVFSSink GstURIHandler
GstXImageSink GstImplementsInterface GstNavigation GstXOverlay
GstXvImageSink GstImplementsInterface GstNavigation GstXOverlay GstColorBalance GstPropertyProbe
-GstAppSink GstURIHandler
-GstAlsaMixerElement GstImplementsInterface GstMixer GstPropertyProbe
-GstTheoraEnc GstPreset
-GstOggMux GstPreset
-GstVolume GstImplementsInterface GstMixer GstStreamVolume
PangoCairoFcFontMap PangoCairoFontMap
diff --git a/docs/plugins/gst-plugins-base-plugins.prerequisites b/docs/plugins/gst-plugins-base-plugins.prerequisites
index e81698ca2..d111b2eca 100644
--- a/docs/plugins/gst-plugins-base-plugins.prerequisites
+++ b/docs/plugins/gst-plugins-base-plugins.prerequisites
@@ -1,9 +1,10 @@
+GFile GObject
GstChildProxy GstObject
-GstTagSetter GstElement
+GstColorBalance GstImplementsInterface GstElement
GstImplementsInterface GstElement
GstMixer GstImplementsInterface GstElement
-GstXOverlay GstImplementsInterface GstElement
-GstColorBalance GstImplementsInterface GstElement
GstStreamVolume GObject
+GstTagSetter GstElement
+GstTuner GstImplementsInterface GstElement
+GstXOverlay GstImplementsInterface GstElement
PangoCairoFontMap PangoFontMap
-GFile GObject