diff options
author | Thomas Vander Stichele <thomas@apestaart.org> | 2005-09-15 14:35:04 +0000 |
---|---|---|
committer | Thomas Vander Stichele <thomas@apestaart.org> | 2005-09-15 14:35:04 +0000 |
commit | b0d322c5f5206d1ab637e226a9f93cdb93b91a61 (patch) | |
tree | 75fcc5ddae2b84cbbf6798a96b1320d8a80518b8 /docs/plugins | |
parent | b6bc76642a3a7fbea56fc4724cbb866362e4e2ae (diff) |
only scanobj stuff from our source module. Not sure yet if that's correct, given the hierarchy stuff :)
Original commit message from CVS:
* common/gstdoc-scangobj:
* common/gtk-doc-plugins.mak:
* docs/libs/Makefile.am:
* 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/gst-plugins-base-plugins.signals:
only scanobj stuff from our source module. Not sure yet
if that's correct, given the hierarchy stuff :)
Diffstat (limited to 'docs/plugins')
-rw-r--r-- | docs/plugins/gst-plugins-base-plugins.args | 774 | ||||
-rw-r--r-- | docs/plugins/gst-plugins-base-plugins.hierarchy | 94 | ||||
-rw-r--r-- | docs/plugins/gst-plugins-base-plugins.interfaces | 14 | ||||
-rw-r--r-- | docs/plugins/gst-plugins-base-plugins.prerequisites | 6 | ||||
-rw-r--r-- | docs/plugins/gst-plugins-base-plugins.signals | 32 |
5 files changed, 374 insertions, 546 deletions
diff --git a/docs/plugins/gst-plugins-base-plugins.args b/docs/plugins/gst-plugins-base-plugins.args index 0ca4e1ca..bc43d8bf 100644 --- a/docs/plugins/gst-plugins-base-plugins.args +++ b/docs/plugins/gst-plugins-base-plugins.args @@ -1,321 +1,101 @@ <ARG> -<NAME>GstVorbisEnc::bitrate</NAME> -<TYPE>gint</TYPE> -<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> -<DEFAULT>-1</DEFAULT> -</ARG> - -<ARG> -<NAME>GstVorbisEnc::last-message</NAME> -<TYPE>gchararray</TYPE> -<RANGE></RANGE> -<FLAGS>r</FLAGS> -<NICK>last-message</NICK> -<BLURB>The last status message.</BLURB> -<DEFAULT>NULL</DEFAULT> -</ARG> - -<ARG> -<NAME>GstVorbisEnc::managed</NAME> -<TYPE>gboolean</TYPE> -<RANGE></RANGE> -<FLAGS>rw</FLAGS> -<NICK>Managed</NICK> -<BLURB>Enable bitrate management engine.</BLURB> -<DEFAULT>FALSE</DEFAULT> -</ARG> - -<ARG> -<NAME>GstVorbisEnc::max-bitrate</NAME> -<TYPE>gint</TYPE> -<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> -<DEFAULT>-1</DEFAULT> -</ARG> - -<ARG> -<NAME>GstVorbisEnc::min-bitrate</NAME> +<NAME>GstXvImageSink::brightness</NAME> <TYPE>gint</TYPE> -<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> -<DEFAULT>-1</DEFAULT> -</ARG> - -<ARG> -<NAME>GstVorbisEnc::quality</NAME> -<TYPE>gfloat</TYPE> -<RANGE>[-0.1,1]</RANGE> -<FLAGS>rw</FLAGS> -<NICK>Quality</NICK> -<BLURB>Specify quality instead of specifying a particular bitrate.</BLURB> -<DEFAULT>0.3</DEFAULT> -</ARG> - -<ARG> -<NAME>GstTheoraDec::crop</NAME> -<TYPE>gboolean</TYPE> -<RANGE></RANGE> +<RANGE>[-1000,1000]</RANGE> <FLAGS>rw</FLAGS> -<NICK>Crop</NICK> -<BLURB>Crop the image to the visible region.</BLURB> -<DEFAULT>TRUE</DEFAULT> +<NICK>Brightness</NICK> +<BLURB>The brightness of the video.</BLURB> +<DEFAULT>0</DEFAULT> </ARG> <ARG> -<NAME>GstTheoraEnc::bitrate</NAME> +<NAME>GstXvImageSink::contrast</NAME> <TYPE>gint</TYPE> -<RANGE>[0,2000]</RANGE> +<RANGE>[-1000,1000]</RANGE> <FLAGS>rw</FLAGS> -<NICK>Bitrate</NICK> -<BLURB>Compressed video bitrate (kbps).</BLURB> +<NICK>Contrast</NICK> +<BLURB>The contrast of the video.</BLURB> <DEFAULT>0</DEFAULT> </ARG> <ARG> -<NAME>GstTheoraEnc::border</NAME> -<TYPE>GstTheoraEncBorderMode</TYPE> -<RANGE></RANGE> -<FLAGS>rw</FLAGS> -<NICK>Border</NICK> -<BLURB>Border color to add when sizes not multiple of 16.</BLURB> -<DEFAULT>BORDER_BLACK</DEFAULT> -</ARG> - -<ARG> -<NAME>GstTheoraEnc::center</NAME> -<TYPE>gboolean</TYPE> -<RANGE></RANGE> -<FLAGS>rw</FLAGS> -<NICK>Center</NICK> -<BLURB>Center image when sizes not multiple of 16.</BLURB> -<DEFAULT>TRUE</DEFAULT> -</ARG> - -<ARG> -<NAME>GstTheoraEnc::keyframe-auto</NAME> -<TYPE>gboolean</TYPE> +<NAME>GstXvImageSink::display</NAME> +<TYPE>gchararray</TYPE> <RANGE></RANGE> <FLAGS>rw</FLAGS> -<NICK>Keyframe Auto</NICK> -<BLURB>Automatic keyframe detection.</BLURB> -<DEFAULT>TRUE</DEFAULT> -</ARG> - -<ARG> -<NAME>GstTheoraEnc::keyframe-force</NAME> -<TYPE>gint</TYPE> -<RANGE>[1,32768]</RANGE> -<FLAGS>rw</FLAGS> -<NICK>Keyframe force</NICK> -<BLURB>Force keyframe every N frames.</BLURB> -<DEFAULT>64</DEFAULT> -</ARG> - -<ARG> -<NAME>GstTheoraEnc::keyframe-freq</NAME> -<TYPE>gint</TYPE> -<RANGE>[1,32768]</RANGE> -<FLAGS>rw</FLAGS> -<NICK>Keyframe frequency</NICK> -<BLURB>Keyframe frequency.</BLURB> -<DEFAULT>64</DEFAULT> -</ARG> - -<ARG> -<NAME>GstTheoraEnc::keyframe-mindistance</NAME> -<TYPE>gint</TYPE> -<RANGE>[1,32768]</RANGE> -<FLAGS>rw</FLAGS> -<NICK>Keyframe mindistance</NICK> -<BLURB>Keyframe mindistance.</BLURB> -<DEFAULT>8</DEFAULT> -</ARG> - -<ARG> -<NAME>GstTheoraEnc::keyframe-threshold</NAME> -<TYPE>gint</TYPE> -<RANGE>[0,32768]</RANGE> -<FLAGS>rw</FLAGS> -<NICK>Keyframe threshold</NICK> -<BLURB>Keyframe threshold.</BLURB> -<DEFAULT>80</DEFAULT> -</ARG> - -<ARG> -<NAME>GstTheoraEnc::noise-sensitivity</NAME> -<TYPE>gint</TYPE> -<RANGE>[0,32768]</RANGE> -<FLAGS>rw</FLAGS> -<NICK>Noise sensitivity</NICK> -<BLURB>Noise sensitivity.</BLURB> -<DEFAULT>1</DEFAULT> +<NICK>Display</NICK> +<BLURB>X Display name.</BLURB> +<DEFAULT>NULL</DEFAULT> </ARG> <ARG> -<NAME>GstTheoraEnc::quality</NAME> +<NAME>GstXvImageSink::hue</NAME> <TYPE>gint</TYPE> -<RANGE>[0,63]</RANGE> +<RANGE>[-1000,1000]</RANGE> <FLAGS>rw</FLAGS> -<NICK>Quality</NICK> -<BLURB>Video quality.</BLURB> -<DEFAULT>16</DEFAULT> +<NICK>Hue</NICK> +<BLURB>The hue of the video.</BLURB> +<DEFAULT>0</DEFAULT> </ARG> <ARG> -<NAME>GstTheoraEnc::quick</NAME> -<TYPE>gboolean</TYPE> +<NAME>GstXvImageSink::pixel-aspect-ratio</NAME> +<TYPE>gchararray</TYPE> <RANGE></RANGE> <FLAGS>rw</FLAGS> -<NICK>Quick</NICK> -<BLURB>Quick encoding.</BLURB> -<DEFAULT>TRUE</DEFAULT> +<NICK>Pixel Aspect Ratio</NICK> +<BLURB>The pixel aspect ratio of the device.</BLURB> +<DEFAULT>"1/1"</DEFAULT> </ARG> <ARG> -<NAME>GstTheoraEnc::sharpness</NAME> +<NAME>GstXvImageSink::saturation</NAME> <TYPE>gint</TYPE> -<RANGE>[0,2]</RANGE> +<RANGE>[-1000,1000]</RANGE> <FLAGS>rw</FLAGS> -<NICK>Sharpness</NICK> -<BLURB>Sharpness.</BLURB> +<NICK>Saturation</NICK> +<BLURB>The saturation of the video.</BLURB> <DEFAULT>0</DEFAULT> </ARG> <ARG> -<NAME>GstOggMux::max-delay</NAME> -<TYPE>guint64</TYPE> -<RANGE></RANGE> -<FLAGS>rw</FLAGS> -<NICK>Max delay</NICK> -<BLURB>Maximum delay in multiplexing streams.</BLURB> -<DEFAULT>500000000</DEFAULT> -</ARG> - -<ARG> -<NAME>GstOggMux::max-page-delay</NAME> -<TYPE>guint64</TYPE> -<RANGE></RANGE> -<FLAGS>rw</FLAGS> -<NICK>Max page delay</NICK> -<BLURB>Maximum delay for sending out a page.</BLURB> -<DEFAULT>500000000</DEFAULT> -</ARG> - -<ARG> -<NAME>GstGnomeVFSSrc::handle</NAME> -<TYPE>gpointer</TYPE> -<RANGE></RANGE> -<FLAGS>rw</FLAGS> -<NICK>GnomeVFSHandle</NICK> -<BLURB>Handle for GnomeVFS.</BLURB> -<DEFAULT></DEFAULT> -</ARG> - -<ARG> -<NAME>GstGnomeVFSSrc::iradio-genre</NAME> -<TYPE>gchararray</TYPE> -<RANGE></RANGE> -<FLAGS>r</FLAGS> -<NICK>iradio-genre</NICK> -<BLURB>Genre of the stream.</BLURB> -<DEFAULT>NULL</DEFAULT> -</ARG> - -<ARG> -<NAME>GstGnomeVFSSrc::iradio-mode</NAME> +<NAME>GstXvImageSink::synchronous</NAME> <TYPE>gboolean</TYPE> <RANGE></RANGE> <FLAGS>rw</FLAGS> -<NICK>iradio-mode</NICK> -<BLURB>Enable internet radio mode (extraction of icecast/audiocast metadata).</BLURB> +<NICK>Synchronous</NICK> +<BLURB>When enabled, runs the X display in synchronous mode. (used only for debugging).</BLURB> <DEFAULT>FALSE</DEFAULT> </ARG> <ARG> -<NAME>GstGnomeVFSSrc::iradio-name</NAME> -<TYPE>gchararray</TYPE> -<RANGE></RANGE> -<FLAGS>r</FLAGS> -<NICK>iradio-name</NICK> -<BLURB>Name of the stream.</BLURB> -<DEFAULT>NULL</DEFAULT> -</ARG> - -<ARG> -<NAME>GstGnomeVFSSrc::iradio-title</NAME> -<TYPE>gchararray</TYPE> -<RANGE></RANGE> -<FLAGS>r</FLAGS> -<NICK>iradio-title</NICK> -<BLURB>Name of currently playing song.</BLURB> -<DEFAULT>NULL</DEFAULT> -</ARG> - -<ARG> -<NAME>GstGnomeVFSSrc::iradio-url</NAME> -<TYPE>gchararray</TYPE> -<RANGE></RANGE> -<FLAGS>r</FLAGS> -<NICK>iradio-url</NICK> -<BLURB>Homepage URL for radio stream.</BLURB> -<DEFAULT>NULL</DEFAULT> -</ARG> - -<ARG> -<NAME>GstGnomeVFSSrc::location</NAME> +<NAME>GstXImageSink::display</NAME> <TYPE>gchararray</TYPE> <RANGE></RANGE> <FLAGS>rw</FLAGS> -<NICK>File Location</NICK> -<BLURB>Location of the file to read.</BLURB> +<NICK>Display</NICK> +<BLURB>X Display name.</BLURB> <DEFAULT>NULL</DEFAULT> </ARG> <ARG> -<NAME>GstAlsaSrc::device</NAME> +<NAME>GstXImageSink::pixel-aspect-ratio</NAME> <TYPE>gchararray</TYPE> <RANGE></RANGE> <FLAGS>rw</FLAGS> -<NICK>Device</NICK> -<BLURB>ALSA device, as defined in an asound configuration file.</BLURB> -<DEFAULT>"default"</DEFAULT> -</ARG> - -<ARG> -<NAME>GstAlsaSrc::device-name</NAME> -<TYPE>gchararray</TYPE> -<RANGE></RANGE> -<FLAGS>r</FLAGS> -<NICK>Device name</NICK> -<BLURB>Human-readable name of the sound device.</BLURB> -<DEFAULT>""</DEFAULT> +<NICK>Pixel Aspect Ratio</NICK> +<BLURB>The pixel aspect ratio of the device.</BLURB> +<DEFAULT>"1/1"</DEFAULT> </ARG> <ARG> -<NAME>GstAlsaSink::device</NAME> -<TYPE>gchararray</TYPE> +<NAME>GstXImageSink::synchronous</NAME> +<TYPE>gboolean</TYPE> <RANGE></RANGE> <FLAGS>rw</FLAGS> -<NICK>Device</NICK> -<BLURB>ALSA device, as defined in an asound configuration file.</BLURB> -<DEFAULT>"default"</DEFAULT> -</ARG> - -<ARG> -<NAME>GstAlsaSink::device-name</NAME> -<TYPE>gchararray</TYPE> -<RANGE></RANGE> -<FLAGS>r</FLAGS> -<NICK>Device name</NICK> -<BLURB>Human-readable name of the sound device.</BLURB> -<DEFAULT>""</DEFAULT> +<NICK>Synchronous</NICK> +<BLURB>When enabled, runs the X display in synchronous mode. (used only for debugging).</BLURB> +<DEFAULT>FALSE</DEFAULT> </ARG> <ARG> @@ -359,123 +139,53 @@ </ARG> <ARG> -<NAME>GstXvImageSink::brightness</NAME> -<TYPE>gint</TYPE> -<RANGE>[-1000,1000]</RANGE> -<FLAGS>rw</FLAGS> -<NICK>Brightness</NICK> -<BLURB>The brightness of the video.</BLURB> -<DEFAULT>0</DEFAULT> -</ARG> - -<ARG> -<NAME>GstXvImageSink::contrast</NAME> -<TYPE>gint</TYPE> -<RANGE>[-1000,1000]</RANGE> -<FLAGS>rw</FLAGS> -<NICK>Contrast</NICK> -<BLURB>The contrast of the video.</BLURB> -<DEFAULT>0</DEFAULT> -</ARG> - -<ARG> -<NAME>GstXvImageSink::display</NAME> -<TYPE>gchararray</TYPE> -<RANGE></RANGE> -<FLAGS>rw</FLAGS> -<NICK>Display</NICK> -<BLURB>X Display name.</BLURB> -<DEFAULT>NULL</DEFAULT> -</ARG> - -<ARG> -<NAME>GstXvImageSink::hue</NAME> -<TYPE>gint</TYPE> -<RANGE>[-1000,1000]</RANGE> -<FLAGS>rw</FLAGS> -<NICK>Hue</NICK> -<BLURB>The hue of the video.</BLURB> -<DEFAULT>0</DEFAULT> -</ARG> - -<ARG> -<NAME>GstXvImageSink::pixel-aspect-ratio</NAME> -<TYPE>gchararray</TYPE> -<RANGE></RANGE> -<FLAGS>rw</FLAGS> -<NICK>Pixel Aspect Ratio</NICK> -<BLURB>The pixel aspect ratio of the device.</BLURB> -<DEFAULT>"1/1"</DEFAULT> -</ARG> - -<ARG> -<NAME>GstXvImageSink::saturation</NAME> +<NAME>GstAudioresample::filter-length</NAME> <TYPE>gint</TYPE> -<RANGE>[-1000,1000]</RANGE> -<FLAGS>rw</FLAGS> -<NICK>Saturation</NICK> -<BLURB>The saturation of the video.</BLURB> -<DEFAULT>0</DEFAULT> +<RANGE>>= 0</RANGE> +<FLAGS>rwx</FLAGS> +<NICK>filter_length</NICK> +<BLURB>filter_length.</BLURB> +<DEFAULT>16</DEFAULT> </ARG> <ARG> -<NAME>GstXvImageSink::synchronous</NAME> +<NAME>GstVolume::mute</NAME> <TYPE>gboolean</TYPE> <RANGE></RANGE> <FLAGS>rw</FLAGS> -<NICK>Synchronous</NICK> -<BLURB>When enabled, runs the X display in synchronous mode. (used only for debugging).</BLURB> +<NICK>mute</NICK> +<BLURB>mute.</BLURB> <DEFAULT>FALSE</DEFAULT> </ARG> <ARG> -<NAME>GstXImageSink::display</NAME> -<TYPE>gchararray</TYPE> -<RANGE></RANGE> -<FLAGS>rw</FLAGS> -<NICK>Display</NICK> -<BLURB>X Display name.</BLURB> -<DEFAULT>NULL</DEFAULT> -</ARG> - -<ARG> -<NAME>GstXImageSink::pixel-aspect-ratio</NAME> -<TYPE>gchararray</TYPE> -<RANGE></RANGE> +<NAME>GstVolume::volume</NAME> +<TYPE>gdouble</TYPE> +<RANGE>[0,4]</RANGE> <FLAGS>rw</FLAGS> -<NICK>Pixel Aspect Ratio</NICK> -<BLURB>The pixel aspect ratio of the device.</BLURB> -<DEFAULT>"1/1"</DEFAULT> +<NICK>volume</NICK> +<BLURB>volume.</BLURB> +<DEFAULT>1</DEFAULT> </ARG> <ARG> -<NAME>GstXImageSink::synchronous</NAME> -<TYPE>gboolean</TYPE> +<NAME>GstVideoTestSrc::pattern</NAME> +<TYPE>GstVideoTestSrcPattern</TYPE> <RANGE></RANGE> <FLAGS>rw</FLAGS> -<NICK>Synchronous</NICK> -<BLURB>When enabled, runs the X display in synchronous mode. (used only for debugging).</BLURB> -<DEFAULT>FALSE</DEFAULT> +<NICK>Pattern</NICK> +<BLURB>Type of test pattern to generate.</BLURB> +<DEFAULT>snow</DEFAULT> </ARG> <ARG> -<NAME>GstVolume::mute</NAME> -<TYPE>gboolean</TYPE> +<NAME>GstVideoTestSrc::timestamp-offset</NAME> +<TYPE>gint64</TYPE> <RANGE></RANGE> <FLAGS>rw</FLAGS> -<NICK>mute</NICK> -<BLURB>mute.</BLURB> -<DEFAULT>FALSE</DEFAULT> -</ARG> - -<ARG> -<NAME>GstVolume::volume</NAME> -<TYPE>gdouble</TYPE> -<RANGE>[0,4]</RANGE> -<FLAGS>rw</FLAGS> -<NICK>volume</NICK> -<BLURB>volume.</BLURB> -<DEFAULT>1</DEFAULT> +<NICK>Timestamp offset</NICK> +<BLURB>An offset added to timestamps set on buffers (in ns).</BLURB> +<DEFAULT>0</DEFAULT> </ARG> <ARG> @@ -549,26 +259,6 @@ </ARG> <ARG> -<NAME>GstVideoTestSrc::pattern</NAME> -<TYPE>GstVideoTestSrcPattern</TYPE> -<RANGE></RANGE> -<FLAGS>rw</FLAGS> -<NICK>Pattern</NICK> -<BLURB>Type of test pattern to generate.</BLURB> -<DEFAULT>snow</DEFAULT> -</ARG> - -<ARG> -<NAME>GstVideoTestSrc::timestamp-offset</NAME> -<TYPE>gint64</TYPE> -<RANGE></RANGE> -<FLAGS>rw</FLAGS> -<NICK>Timestamp offset</NICK> -<BLURB>An offset added to timestamps set on buffers (in ns).</BLURB> -<DEFAULT>0</DEFAULT> -</ARG> - -<ARG> <NAME>GstTCPClientSink::host</NAME> <TYPE>gchararray</TYPE> <RANGE></RANGE> @@ -919,16 +609,6 @@ </ARG> <ARG> -<NAME>GstAudioresample::filter-length</NAME> -<TYPE>gint</TYPE> -<RANGE>>= 0</RANGE> -<FLAGS>rwx</FLAGS> -<NICK>filter_length</NICK> -<BLURB>filter_length.</BLURB> -<DEFAULT>16</DEFAULT> -</ARG> - -<ARG> <NAME>GstAudiorate::add</NAME> <TYPE>guint64</TYPE> <RANGE></RANGE> @@ -979,142 +659,322 @@ </ARG> <ARG> -<NAME>GstQueue::block-timeout</NAME> -<TYPE>guint64</TYPE> -<RANGE></RANGE> +<NAME>GstVorbisEnc::bitrate</NAME> +<TYPE>gint</TYPE> +<RANGE>[-1,250001]</RANGE> <FLAGS>rw</FLAGS> -<NICK>Timeout for Block</NICK> -<BLURB>Nanoseconds until blocked queue times out and returns filler event. Value of -1 disables timeout.</BLURB> -<DEFAULT>18446744073709551615</DEFAULT> +<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> +<DEFAULT>-1</DEFAULT> </ARG> <ARG> -<NAME>GstQueue::current-level-buffers</NAME> -<TYPE>guint</TYPE> +<NAME>GstVorbisEnc::last-message</NAME> +<TYPE>gchararray</TYPE> <RANGE></RANGE> <FLAGS>r</FLAGS> -<NICK>Current level (buffers)</NICK> -<BLURB>Current number of buffers in the queue.</BLURB> -<DEFAULT>0</DEFAULT> +<NICK>last-message</NICK> +<BLURB>The last status message.</BLURB> +<DEFAULT>NULL</DEFAULT> </ARG> <ARG> -<NAME>GstQueue::current-level-bytes</NAME> -<TYPE>guint</TYPE> +<NAME>GstVorbisEnc::managed</NAME> +<TYPE>gboolean</TYPE> <RANGE></RANGE> -<FLAGS>r</FLAGS> -<NICK>Current level (kB)</NICK> -<BLURB>Current amount of data in the queue (bytes).</BLURB> -<DEFAULT>0</DEFAULT> +<FLAGS>rw</FLAGS> +<NICK>Managed</NICK> +<BLURB>Enable bitrate management engine.</BLURB> +<DEFAULT>FALSE</DEFAULT> </ARG> <ARG> -<NAME>GstQueue::current-level-time</NAME> -<TYPE>guint64</TYPE> -<RANGE></RANGE> -<FLAGS>r</FLAGS> -<NICK>Current level (ns)</NICK> -<BLURB>Current amount of data in the queue (in ns).</BLURB> -<DEFAULT>0</DEFAULT> +<NAME>GstVorbisEnc::max-bitrate</NAME> +<TYPE>gint</TYPE> +<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> +<DEFAULT>-1</DEFAULT> </ARG> <ARG> -<NAME>GstQueue::leaky</NAME> -<TYPE>GstQueueLeaky</TYPE> -<RANGE></RANGE> +<NAME>GstVorbisEnc::min-bitrate</NAME> +<TYPE>gint</TYPE> +<RANGE>[-1,250001]</RANGE> <FLAGS>rw</FLAGS> -<NICK>Leaky</NICK> -<BLURB>Where the queue leaks, if at all.</BLURB> -<DEFAULT>0</DEFAULT> +<NICK>Minimum Bitrate</NICK> +<BLURB>Specify a minimum bitrate (in bps). Useful for encoding for a fixed-size channel. (-1 == disabled).</BLURB> +<DEFAULT>-1</DEFAULT> </ARG> <ARG> -<NAME>GstQueue::max-size-buffers</NAME> -<TYPE>guint</TYPE> +<NAME>GstVorbisEnc::quality</NAME> +<TYPE>gfloat</TYPE> +<RANGE>[-0.1,1]</RANGE> +<FLAGS>rw</FLAGS> +<NICK>Quality</NICK> +<BLURB>Specify quality instead of specifying a particular bitrate.</BLURB> +<DEFAULT>0.3</DEFAULT> +</ARG> + +<ARG> +<NAME>GstTheoraDec::crop</NAME> +<TYPE>gboolean</TYPE> <RANGE></RANGE> <FLAGS>rw</FLAGS> -<NICK>Max. size (buffers)</NICK> -<BLURB>Max. number of buffers in the queue (0=disable).</BLURB> +<NICK>Crop</NICK> +<BLURB>Crop the image to the visible region.</BLURB> +<DEFAULT>TRUE</DEFAULT> +</ARG> + +<ARG> +<NAME>GstTheoraEnc::bitrate</NAME> +<TYPE>gint</TYPE> +<RANGE>[0,2000]</RANGE> +<FLAGS>rw</FLAGS> +<NICK>Bitrate</NICK> +<BLURB>Compressed video bitrate (kbps).</BLURB> <DEFAULT>0</DEFAULT> </ARG> <ARG> -<NAME>GstQueue::max-size-bytes</NAME> -<TYPE>guint</TYPE> +<NAME>GstTheoraEnc::border</NAME> +<TYPE>GstTheoraEncBorderMode</TYPE> <RANGE></RANGE> <FLAGS>rw</FLAGS> -<NICK>Max. size (kB)</NICK> -<BLURB>Max. amount of data in the queue (bytes, 0=disable).</BLURB> -<DEFAULT>0</DEFAULT> +<NICK>Border</NICK> +<BLURB>Border color to add when sizes not multiple of 16.</BLURB> +<DEFAULT>BORDER_BLACK</DEFAULT> </ARG> <ARG> -<NAME>GstQueue::max-size-time</NAME> -<TYPE>guint64</TYPE> +<NAME>GstTheoraEnc::center</NAME> +<TYPE>gboolean</TYPE> <RANGE></RANGE> <FLAGS>rw</FLAGS> -<NICK>Max. size (ns)</NICK> -<BLURB>Max. amount of data in the queue (in ns, 0=disable).</BLURB> -<DEFAULT>0</DEFAULT> +<NICK>Center</NICK> +<BLURB>Center image when sizes not multiple of 16.</BLURB> +<DEFAULT>TRUE</DEFAULT> </ARG> <ARG> -<NAME>GstQueue::may-deadlock</NAME> +<NAME>GstTheoraEnc::keyframe-auto</NAME> <TYPE>gboolean</TYPE> <RANGE></RANGE> <FLAGS>rw</FLAGS> -<NICK>May Deadlock</NICK> -<BLURB>The queue may deadlock if it's full and not PLAYING.</BLURB> +<NICK>Keyframe Auto</NICK> +<BLURB>Automatic keyframe detection.</BLURB> <DEFAULT>TRUE</DEFAULT> </ARG> <ARG> -<NAME>GstQueue::min-threshold-buffers</NAME> -<TYPE>guint</TYPE> +<NAME>GstTheoraEnc::keyframe-force</NAME> +<TYPE>gint</TYPE> +<RANGE>[1,32768]</RANGE> +<FLAGS>rw</FLAGS> +<NICK>Keyframe force</NICK> +<BLURB>Force keyframe every N frames.</BLURB> +<DEFAULT>64</DEFAULT> +</ARG> + +<ARG> +<NAME>GstTheoraEnc::keyframe-freq</NAME> +<TYPE>gint</TYPE> +<RANGE>[1,32768]</RANGE> +<FLAGS>rw</FLAGS> +<NICK>Keyframe frequency</NICK> +<BLURB>Keyframe frequency.</BLURB> +<DEFAULT>64</DEFAULT> +</ARG> + +<ARG> +<NAME>GstTheoraEnc::keyframe-mindistance</NAME> +<TYPE>gint</TYPE> +<RANGE>[1,32768]</RANGE> +<FLAGS>rw</FLAGS> +<NICK>Keyframe mindistance</NICK> +<BLURB>Keyframe mindistance.</BLURB> +<DEFAULT>8</DEFAULT> +</ARG> + +<ARG> +<NAME>GstTheoraEnc::keyframe-threshold</NAME> +<TYPE>gint</TYPE> +<RANGE>[0,32768]</RANGE> +<FLAGS>rw</FLAGS> +<NICK>Keyframe threshold</NICK> +<BLURB>Keyframe threshold.</BLURB> +<DEFAULT>80</DEFAULT> +</ARG> + +<ARG> +<NAME>GstTheoraEnc::noise-sensitivity</NAME> +<TYPE>gint</TYPE> +<RANGE>[0,32768]</RANGE> +<FLAGS>rw</FLAGS> +<NICK>Noise sensitivity</NICK> +<BLURB>Noise sensitivity.</BLURB> +<DEFAULT>1</DEFAULT> +</ARG> + +<ARG> +<NAME>GstTheoraEnc::quality</NAME> +<TYPE>gint</TYPE> +<RANGE>[0,63]</RANGE> +<FLAGS>rw</FLAGS> +<NICK>Quality</NICK> +<BLURB>Video quality.</BLURB> +<DEFAULT>16</DEFAULT> +</ARG> + +<ARG> +<NAME>GstTheoraEnc::quick</NAME> +<TYPE>gboolean</TYPE> <RANGE></RANGE> <FLAGS>rw</FLAGS> -<NICK>Min. threshold (buffers)</NICK> -<BLURB>Min. number of buffers in the queue to allow reading (0=disable).</BLURB> +<NICK>Quick</NICK> +<BLURB>Quick encoding.</BLURB> +<DEFAULT>TRUE</DEFAULT> +</ARG> + +<ARG> +<NAME>GstTheoraEnc::sharpness</NAME> +<TYPE>gint</TYPE> +<RANGE>[0,2]</RANGE> +<FLAGS>rw</FLAGS> +<NICK>Sharpness</NICK> +<BLURB>Sharpness.</BLURB> <DEFAULT>0</DEFAULT> </ARG> <ARG> -<NAME>GstQueue::min-threshold-bytes</NAME> -<TYPE>guint</TYPE> +<NAME>GstGnomeVFSSrc::handle</NAME> +<TYPE>gpointer</TYPE> <RANGE></RANGE> <FLAGS>rw</FLAGS> -<NICK>Min. threshold (kB)</NICK> -<BLURB>Min. amount of data in the queue to allow reading (bytes, 0=disable).</BLURB> -<DEFAULT>0</DEFAULT> +<NICK>GnomeVFSHandle</NICK> +<BLURB>Handle for GnomeVFS.</BLURB> +<DEFAULT></DEFAULT> </ARG> <ARG> -<NAME>GstQueue::min-threshold-time</NAME> -<TYPE>guint64</TYPE> +<NAME>GstGnomeVFSSrc::iradio-genre</NAME> +<TYPE>gchararray</TYPE> +<RANGE></RANGE> +<FLAGS>r</FLAGS> +<NICK>iradio-genre</NICK> +<BLURB>Genre of the stream.</BLURB> +<DEFAULT>NULL</DEFAULT> +</ARG> + +<ARG> +<NAME>GstGnomeVFSSrc::iradio-mode</NAME> +<TYPE>gboolean</TYPE> <RANGE></RANGE> <FLAGS>rw</FLAGS> -<NICK>Min. threshold (ns)</NICK> -<BLURB>Min. amount of data in the queue to allow reading (in ns, 0=disable).</BLURB> -<DEFAULT>0</DEFAULT> +<NICK>iradio-mode</NICK> +<BLURB>Enable internet radio mode (extraction of icecast/audiocast metadata).</BLURB> +<DEFAULT>FALSE</DEFAULT> +</ARG> + +<ARG> +<NAME>GstGnomeVFSSrc::iradio-name</NAME> +<TYPE>gchararray</TYPE> +<RANGE></RANGE> +<FLAGS>r</FLAGS> +<NICK>iradio-name</NICK> +<BLURB>Name of the stream.</BLURB> +<DEFAULT>NULL</DEFAULT> +</ARG> + +<ARG> +<NAME>GstGnomeVFSSrc::iradio-title</NAME> +<TYPE>gchararray</TYPE> +<RANGE></RANGE> +<FLAGS>r</FLAGS> +<NICK>iradio-title</NICK> +<BLURB>Name of currently playing song.</BLURB> +<DEFAULT>NULL</DEFAULT> +</ARG> + +<ARG> +<NAME>GstGnomeVFSSrc::iradio-url</NAME> +<TYPE>gchararray</TYPE> +<RANGE></RANGE> +<FLAGS>r</FLAGS> +<NICK>iradio-url</NICK> +<BLURB>Homepage URL for radio stream.</BLURB> +<DEFAULT>NULL</DEFAULT> </ARG> <ARG> -<NAME>GstPipeline::delay</NAME> +<NAME>GstGnomeVFSSrc::location</NAME> +<TYPE>gchararray</TYPE> +<RANGE></RANGE> +<FLAGS>rw</FLAGS> +<NICK>File Location</NICK> +<BLURB>Location of the file to read.</BLURB> +<DEFAULT>NULL</DEFAULT> +</ARG> + +<ARG> +<NAME>GstOggMux::max-delay</NAME> <TYPE>guint64</TYPE> <RANGE></RANGE> <FLAGS>rw</FLAGS> -<NICK>Delay</NICK> -<BLURB>Expected delay needed for elements to spin up to PLAYING in nanoseconds.</BLURB> -<DEFAULT>0</DEFAULT> +<NICK>Max delay</NICK> +<BLURB>Maximum delay in multiplexing streams.</BLURB> +<DEFAULT>500000000</DEFAULT> </ARG> <ARG> -<NAME>GstPipeline::play-timeout</NAME> +<NAME>GstOggMux::max-page-delay</NAME> <TYPE>guint64</TYPE> <RANGE></RANGE> <FLAGS>rw</FLAGS> -<NICK>Play Timeout</NICK> -<BLURB>Max timeout for going to PLAYING in nanoseconds.</BLURB> -<DEFAULT>2000000000</DEFAULT> +<NICK>Max page delay</NICK> +<BLURB>Maximum delay for sending out a page.</BLURB> +<DEFAULT>500000000</DEFAULT> +</ARG> + +<ARG> +<NAME>GstAlsaSrc::device</NAME> +<TYPE>gchararray</TYPE> +<RANGE></RANGE> +<FLAGS>rw</FLAGS> +<NICK>Device</NICK> +<BLURB>ALSA device, as defined in an asound configuration file.</BLURB> +<DEFAULT>"default"</DEFAULT> +</ARG> + +<ARG> +<NAME>GstAlsaSrc::device-name</NAME> +<TYPE>gchararray</TYPE> +<RANGE></RANGE> +<FLAGS>r</FLAGS> +<NICK>Device name</NICK> +<BLURB>Human-readable name of the sound device.</BLURB> +<DEFAULT>""</DEFAULT> +</ARG> + +<ARG> +<NAME>GstAlsaSink::device</NAME> +<TYPE>gchararray</TYPE> +<RANGE></RANGE> +<FLAGS>rw</FLAGS> +<NICK>Device</NICK> +<BLURB>ALSA device, as defined in an asound configuration file.</BLURB> +<DEFAULT>"default"</DEFAULT> +</ARG> + +<ARG> +<NAME>GstAlsaSink::device-name</NAME> +<TYPE>gchararray</TYPE> +<RANGE></RANGE> +<FLAGS>r</FLAGS> +<NICK>Device name</NICK> +<BLURB>Human-readable name of the sound device.</BLURB> +<DEFAULT>""</DEFAULT> </ARG> diff --git a/docs/plugins/gst-plugins-base-plugins.hierarchy b/docs/plugins/gst-plugins-base-plugins.hierarchy index ff0d3ff9..34b88e4e 100644 --- a/docs/plugins/gst-plugins-base-plugins.hierarchy +++ b/docs/plugins/gst-plugins-base-plugins.hierarchy @@ -10,56 +10,33 @@ GObject GstPlayBin GstDecodeBin GstQueue - GstVorbisTag - GstVorbisEnc - GstVorbisDec - GstVorbisParse - GstTheoraDec - GstTheoraEnc - GstOggDemux - GstOggMux - GstOgmParse - GstOgmAudioParse - GstOgmVideoParse - GstOgmTextParse - GstOggParse - GstVisual - GstVisualbumpscope - GstVisualcorona - GstVisualG-Force - GstVisualjakdaw - GstVisualjess - GstVisuallv_analyzer - GstVisuallv_scope - GstVisualoinksie - GstVisualplazma + GstBaseSink + GstVideoSink + GstXvImageSink + GstXImageSink + GstMultiFdSink + GstTCPServerSink + GstBaseAudioSink + GstAudioSink + GstAlsaSink GstBaseSrc - GstGnomeVFSSrc GstPushSrc - GstBaseAudioSrc - GstAudioSrc - GstAlsaSrc GstV4lElement GstV4lSrc GstVideoTestSrc GstTCPClientSrc GstTCPServerSrc + GstBaseAudioSrc + GstAudioSrc + GstAlsaSrc GstSineSrc - GstAlsaMixerElement - GstBaseSink - GstBaseAudioSink - GstAudioSink - GstAlsaSink - GstVideoSink - GstXvImageSink - GstXImageSink - GstMultiFdSink - GstTCPServerSink + GstGnomeVFSSrc + GstVorbisTag GstBaseTransform + GstAudioresample GstVolume GstVideoscale GstFFMpegColorspace - GstAudioresample GstAudioConvert GstVideorate GstTCPClientSink @@ -67,12 +44,40 @@ GObject GstAudiorate GstBufferFramesConvert GstAdder + GstVorbisEnc + GstVorbisDec + GstVorbisParse + GstTheoraDec + GstTheoraEnc + GstVisual + GstVisualbumpscope + GstVisualcorona + GstVisualG-Force + GstVisualjakdaw + GstVisualjess + GstVisuallv_analyzer + GstVisuallv_scope + GstVisualoinksie + GstVisualplazma + GstOggDemux + GstOggMux + GstOgmParse + GstOgmAudioParse + GstOgmVideoParse + GstOgmTextParse + GstOggParse + GstAlsaMixerElement GstPadTemplate GstPluginFeature GstElementFactory GstTypeFindFactory GstIndexFactory GstSignalObject + GstColorBalanceChannel + GstTunerNorm + GstTunerChannel + GstMixerTrack + GstMixerOptions BonoboObject BonoboMonikerContext BonoboForeignObject @@ -83,19 +88,14 @@ GObject LinkServer GIOPServer GConfClient - GstMixerTrack - GstMixerOptions - GstTunerNorm - GstTunerChannel - GstColorBalanceChannel GInterface GstChildProxy GstURIHandler - GstTagSetter GstImplementsInterface - GstMixer - GstTuner + GstNavigation GstXOverlay GstColorBalance + GstTuner GstPropertyProbe - GstNavigation + GstTagSetter + GstMixer diff --git a/docs/plugins/gst-plugins-base-plugins.interfaces b/docs/plugins/gst-plugins-base-plugins.interfaces index c61ae5cf..4482c863 100644 --- a/docs/plugins/gst-plugins-base-plugins.interfaces +++ b/docs/plugins/gst-plugins-base-plugins.interfaces @@ -3,13 +3,13 @@ GstPipeline GstChildProxy GstPlayBaseBin GstChildProxy GstPlayBin GstChildProxy GstDecodeBin GstChildProxy +GstXvImageSink GstColorBalance GstImplementsInterface GstNavigation GstXOverlay +GstXImageSink GstImplementsInterface GstNavigation GstXOverlay +GstV4lElement GstColorBalance GstImplementsInterface GstXOverlay GstTuner GstPropertyProbe +GstV4lSrc GstColorBalance GstImplementsInterface GstXOverlay GstTuner GstPropertyProbe +GstAlsaSrc GstImplementsInterface GstMixer +GstGnomeVFSSrc GstURIHandler GstVorbisTag GstTagSetter +GstVolume GstImplementsInterface GstMixer GstVorbisEnc GstTagSetter -GstGnomeVFSSrc GstURIHandler -GstAlsaSrc GstImplementsInterface GstMixer -GstV4lElement GstImplementsInterface GstTuner GstXOverlay GstColorBalance GstPropertyProbe -GstV4lSrc GstImplementsInterface GstTuner GstXOverlay GstColorBalance GstPropertyProbe GstAlsaMixerElement GstImplementsInterface GstMixer -GstXvImageSink GstImplementsInterface GstXOverlay GstColorBalance GstNavigation -GstXImageSink GstImplementsInterface GstXOverlay GstNavigation -GstVolume GstImplementsInterface GstMixer diff --git a/docs/plugins/gst-plugins-base-plugins.prerequisites b/docs/plugins/gst-plugins-base-plugins.prerequisites index 6c9f71a9..59103b10 100644 --- a/docs/plugins/gst-plugins-base-plugins.prerequisites +++ b/docs/plugins/gst-plugins-base-plugins.prerequisites @@ -1,7 +1,7 @@ GstChildProxy GstObject -GstTagSetter GstElement GstImplementsInterface GstElement -GstMixer GstImplementsInterface GstElement -GstTuner GstImplementsInterface GstElement GstXOverlay GstImplementsInterface GstElement GstColorBalance GstImplementsInterface GstElement +GstTuner GstImplementsInterface GstElement +GstTagSetter GstElement +GstMixer GstImplementsInterface GstElement diff --git a/docs/plugins/gst-plugins-base-plugins.signals b/docs/plugins/gst-plugins-base-plugins.signals index 65c0d306..4b4e0eee 100644 --- a/docs/plugins/gst-plugins-base-plugins.signals +++ b/docs/plugins/gst-plugins-base-plugins.signals @@ -63,35 +63,3 @@ GstPad *arg1 GstCaps *arg2 </SIGNAL> -<SIGNAL> -<NAME>GstQueue::overrun</NAME> -<RETURNS>void</RETURNS> -GstQueue *gstqueue -</SIGNAL> - -<SIGNAL> -<NAME>GstQueue::running</NAME> -<RETURNS>void</RETURNS> -GstQueue *gstqueue -</SIGNAL> - -<SIGNAL> -<NAME>GstQueue::underrun</NAME> -<RETURNS>void</RETURNS> -GstQueue *gstqueue -</SIGNAL> - -<SIGNAL> -<NAME>GstBin::element-added</NAME> -<RETURNS>void</RETURNS> -GstBin *gstbin -GstElement *arg1 -</SIGNAL> - -<SIGNAL> -<NAME>GstBin::element-removed</NAME> -<RETURNS>void</RETURNS> -GstBin *gstbin -GstElement *arg1 -</SIGNAL> - |