gnomemm r1540 - in gstreamermm/trunk: . gstreamer/src gstreamerbase/src
- From: jaalburqu svn gnome org
- To: svn-commits-list gnome org
- Subject: gnomemm r1540 - in gstreamermm/trunk: . gstreamer/src gstreamerbase/src
- Date: Thu, 29 May 2008 02:44:26 +0000 (UTC)
Author: jaalburqu
Date: Thu May 29 02:44:25 2008
New Revision: 1540
URL: http://svn.gnome.org/viewvc/gnomemm?rev=1540&view=rev
Log:
2008-05-28 Josà Alburquerque <jaalburqu svn gnome org>
* gstreamer/src/gst_docs.xml:
* gstreamerbase/src/gstbase_docs.xml: Filed GStreamer minor doc bug
#535285 to fix Gst::ElementFactory::get_uri_type() GST_URI_UNKNOWN
reference which was quickly fixed so regenerated docs.
* gstreamer/src/tagsetter.hg: Added default value for merge_tags()
mode parameter.
Modified:
gstreamermm/trunk/ChangeLog
gstreamermm/trunk/gstreamer/src/gst_docs.xml
gstreamermm/trunk/gstreamer/src/tagsetter.hg
gstreamermm/trunk/gstreamerbase/src/gstbase_docs.xml
Modified: gstreamermm/trunk/gstreamer/src/gst_docs.xml
==============================================================================
--- gstreamermm/trunk/gstreamer/src/gst_docs.xml (original)
+++ gstreamermm/trunk/gstreamer/src/gst_docs.xml Thu May 29 02:44:25 2008
@@ -178,7 +178,7 @@
<function name="gst_clock_get_master">
<description>
-Get the master clock that @clock is slaved to or NULL when the clock is
+Get the master clock that @clock is slaved to or %NULL when the clock is
not slaved to any master clock.
@@ -189,8 +189,8 @@
</parameter_description>
</parameter>
</parameters>
-<return> a master #GstClock or NULL when this clock is not slaved to a master
-clock. Unref after usage.
+<return> a master #GstClock or %NULL when this clock is not slaved to a
+master clock. Unref after usage.
MT safe.
</return>
@@ -213,21 +213,50 @@
</return>
</function>
-<function name="gst_uri_handler_get_uri_type">
+<function name="gst_type_find_suggest_simple">
<description>
-Gets the type of the given URI handler
+If a #GstTypeFindFunction calls this function it suggests the caps with the
+given probability. A #GstTypeFindFunction may supply different suggestions
+in one call. It is up to the caller of the #GstTypeFindFunction to interpret
+these values.
-Returns #GST_URI_UNKNOWN if the @handler isn't implemented correctly.
+This function is similar to gst_type_find_suggest(), only that instead of
+passing a #GstCaps argument you can create the caps on the fly in the same
+way as you can with gst_caps_new_simple().
+
+Make sure you terminate the list of arguments with a NULL argument and that
+the values passed have the correct type (in terms of width in bytes when
+passed to the vararg function - this applies particularly to gdouble and
+guint64 arguments).
+
+Since: 0.10.20
</description>
<parameters>
-<parameter name="handler">
-<parameter_description> A #GstURIHandler.
+<parameter name="find">
+<parameter_description> The #GstTypeFind object the function was called with
+</parameter_description>
+</parameter>
+<parameter name="probability">
+<parameter_description> The probability in percent that the suggestion is right
+</parameter_description>
+</parameter>
+<parameter name="media_type">
+<parameter_description> the media type of the suggested caps
+</parameter_description>
+</parameter>
+<parameter name="fieldname">
+<parameter_description> first field of the suggested caps, or NULL
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> additional arguments to the suggested caps in the same format as the
+arguments passed to gst_structure_new() (ie. triplets of field name,
+field GType and field value)
</parameter_description>
</parameter>
</parameters>
-<return>#GST_URI_UNKNOWN if the @handler isn't implemented correctly.
-</return>
+<return></return>
</function>
<function name="gst_caps_is_subset">
@@ -990,10 +1019,10 @@
This is a convenience wrapper around gst_parse_launch() to create a
#GstBin from a gst-launch-style pipeline description. See
gst_parse_launch() and the gst-launch man page for details about the
-syntax. Ghost pads on the bin for unconnected source or sink pads
+syntax. Ghost pads on the bin for unlinked source or sink pads
within the bin can automatically be created (but only a maximum of
one ghost pad for each direction will be created; if you expect
-multiple unconnected source pads or multiple unconnected sink pads
+multiple unlinked source pads or multiple unlinked sink pads
and want them all ghosted, you will have to create the ghost pads
yourself).
@@ -1004,10 +1033,9 @@
<parameter_description> command line describing the bin
</parameter_description>
</parameter>
-<parameter name="ghost_unconnected_pads">
+<parameter name="ghost_unlinked_pads">
<parameter_description> whether to automatically create ghost pads
-for unconnected source or sink pads within
-the bin
+for unlinked source or sink pads within the bin
</parameter_description>
</parameter>
<parameter name="err">
@@ -1166,15 +1194,38 @@
</return>
</function>
-<function name="gst_xml_new">
+<function name="gst_parse_launch_full">
<description>
-Create a new GstXML parser object.
+Create a new pipeline based on command line syntax.
+Please note that you might get a return value that is not %NULL even though
+the @error is set. In this case there was a recoverable parsing error and you
+can try to play the pipeline.
</description>
<parameters>
+<parameter name="pipeline_description">
+<parameter_description> the command line describing the pipeline
+</parameter_description>
+</parameter>
+<parameter name="context">
+<parameter_description> a parse context allocated with gst_parse_context_new(), or %NULL
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> parsing options, or #GST_PARSE_FLAG_NONE
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> the error message in case of an erroneous pipeline.
+</parameter_description>
+</parameter>
</parameters>
-<return> a pointer to a new GstXML object.
+<return> a new element on success, %NULL on failure. If more than one toplevel
+element is specified by the @pipeline_description, all elements are put into
+a #GstPipeline, which then is returned.
+
+Since: 0.10.20
</return>
</function>
@@ -1386,25 +1437,64 @@
<return></return>
</function>
-<function name="gst_value_take_mini_object">
+<function name="gst_interpolation_control_source_set_interpolation_mode">
<description>
-Set the contents of a %GST_TYPE_MINI_OBJECT derived #GValue to
- mini_object
-Takes over the ownership of the caller's reference to @mini_object;
-the caller doesn't have to unref it any more.
+Sets the given interpolation mode.
+
+&lt;note&gt;&lt;para&gt;User interpolation is not yet available and quadratic interpolation
+is deprecated and maps to cubic interpolation.&lt;/para&gt;&lt;/note&gt;
+
</description>
<parameters>
-<parameter name="value">
-<parameter_description> a valid #GValue of %GST_TYPE_MINI_OBJECT derived type
+<parameter name="self">
+<parameter_description> the #GstInterpolationControlSource object
</parameter_description>
</parameter>
-<parameter name="mini_object">
-<parameter_description> mini object value to take
+<parameter name="mode">
+<parameter_description> interpolation mode
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the interpolation mode could be set, %FALSE otherwise
+</return>
+</function>
+
+<function name="gst_clock_id_wait">
+<description>
+Perform a blocking wait on @id.
+ id should have been created with gst_clock_new_single_shot_id()
+or gst_clock_new_periodic_id() and should not have been unscheduled
+with a call to gst_clock_id_unschedule().
+
+If the @jitter argument is not %NULL and this function returns #GST_CLOCK_OK
+or #GST_CLOCK_EARLY, it will contain the difference
+against the clock and the time of @id when this method was
+called.
+Positive values indicate how late @id was relative to the clock
+(in which case this function will return #GST_CLOCK_EARLY).
+Negative values indicate how much time was spent waiting on the clock
+before this function returned.
+
+
+</description>
+<parameters>
+<parameter name="id">
+<parameter_description> The #GstClockID to wait on
+</parameter_description>
+</parameter>
+<parameter name="jitter">
+<parameter_description> A pointer that will contain the jitter, can be %NULL.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the result of the blocking wait. #GST_CLOCK_EARLY will be returned
+if the current clock time is past the time of @id, #GST_CLOCK_OK if
+ id was scheduled in time. #GST_CLOCK_UNSCHEDULED if @id was
+unscheduled with gst_clock_id_unschedule().
+
+MT safe.
+</return>
</function>
<function name="gst_query_set_formatsv">
@@ -2027,8 +2117,8 @@
</parameter_description>
</parameter>
</parameters>
-<return> a #GList of #GstPluginFeature of @type. gst_plugin_feature_list_free
-after usage.
+<return> a #GList of #GstPluginFeature of @type. Use
+gst_plugin_feature_list_free() after usage.
MT safe.
</return>
@@ -2079,7 +2169,8 @@
</parameter_description>
</parameter>
</parameters>
-<return> a #GList of #GstPluginFeature. gst_plugin_feature_list_free() after usage.
+<return> a #GList of #GstPluginFeature. Use gst_plugin_feature_list_free()
+after usage.
</return>
</function>
@@ -2753,6 +2844,26 @@
</return>
</function>
+<function name="gst_interpolation_control_source_set_from_list">
+<description>
+Sets multiple timed values at once.
+
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> the #GstInterpolationControlSource object
+</parameter_description>
+</parameter>
+<parameter name="timedvalues">
+<parameter_description> a list with #GstTimedValue items
+</parameter_description>
+</parameter>
+</parameters>
+<return> FALSE if the values couldn't be set, TRUE otherwise.
+</return>
+</function>
+
<function name="gst_type_find_helper_get_range">
<description>
Utility function to do pull-based typefinding. Unlike gst_type_find_helper()
@@ -2885,6 +2996,24 @@
</return>
</function>
+<function name="gst_preset_get_property_names">
+<description>
+Get a the names of the GObject properties that can be used for presets.
+
+
+</description>
+<parameters>
+<parameter name="preset">
+<parameter_description> a #GObject that implements #GstPreset
+</parameter_description>
+</parameter>
+</parameters>
+<return> an array of property names which should be freed with g_strfreev() after use.
+
+Since: 0.10.20
+</return>
+</function>
+
<function name="gst_pipeline_set_new_stream_time">
<description>
Set the new stream time of @pipeline to @time. The stream time is used to
@@ -3529,7 +3658,7 @@
</parameter_description>
</parameter>
</parameters>
-<return> a #GList of #GstPlugin. gst_plugin_list_free after use.
+<return> a #GList of #GstPlugin. Use gst_plugin_list_free() after usage.
MT safe.
</return>
@@ -3817,23 +3946,63 @@
</return>
</function>
-<function name="gst_interpolation_control_source_set_from_list">
+<function name="gst_pad_add_buffer_probe_full">
<description>
-Sets multiple timed values at once.
+Adds a probe that will be called for all buffers passing through a pad. See
+gst_pad_add_data_probe() for more information.
+
+The @notify function is called when the probe is disconnected and usually
+used to free @data.
</description>
<parameters>
-<parameter name="self">
-<parameter_description> the #GstInterpolationControlSource object
+<parameter name="pad">
+<parameter_description> pad to add the buffer probe handler to
</parameter_description>
</parameter>
-<parameter name="timedvalues">
-<parameter_description> a list with #GstTimedValue items
+<parameter name="handler">
+<parameter_description> function to call when buffer are passed over pad
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> data to pass along with the handler
+</parameter_description>
+</parameter>
+<parameter name="notify">
+<parameter_description> function to call when the probe is disconnected, or NULL
</parameter_description>
</parameter>
</parameters>
-<return> FALSE if the values couldn't be set, TRUE otherwise.
+<return> The handler id
+
+Since: 0.10.20
+</return>
+</function>
+
+<function name="gst_bin_find_unlinked_pad">
+<description>
+Recursively looks for elements with an unlinked pad of the given
+direction within the specified bin and returns an unlinked pad
+if one is found, or NULL otherwise. If a pad is found, the caller
+owns a reference to it and should use gst_object_unref() on the
+pad when it is not needed any longer.
+
+
+</description>
+<parameters>
+<parameter name="bin">
+<parameter_description> bin in which to look for elements with unlinked pads
+</parameter_description>
+</parameter>
+<parameter name="direction">
+<parameter_description> whether to look for an unlinked source or sink pad
+</parameter_description>
+</parameter>
+</parameters>
+<return> unlinked pad of the given direction, or NULL.
+
+Since: 0.10.20
</return>
</function>
@@ -3939,12 +4108,12 @@
<function name="gst_task_create">
<description>
-Create a new Task that will repeadedly call the provided @func
+Create a new Task that will repeatedly call the provided @func
with @data as a parameter. Typically the task will run in
a new thread.
The function cannot be changed after the task has been created. You
-must create a new GstTask to change the function.
+must create a new #GstTask to change the function.
</description>
@@ -4800,6 +4969,33 @@
<return></return>
</function>
+<function name="gst_preset_rename_preset">
+<description>
+Renames a preset. If there is already a preset by the @new_name it will be
+overwritten.
+
+
+</description>
+<parameters>
+<parameter name="preset">
+<parameter_description> a #GObject that implements #GstPreset
+</parameter_description>
+</parameter>
+<parameter name="old_name">
+<parameter_description> current preset name
+</parameter_description>
+</parameter>
+<parameter name="new_name">
+<parameter_description> new preset name
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE for success, %FALSE if e.g. there is no preset with @old_name
+
+Since: 0.10.20
+</return>
+</function>
+
<function name="gst_plugin_get_description">
<description>
Get the long descriptive name of the plugin
@@ -4966,6 +5162,25 @@
</return>
</function>
+<function name="gst_query_new_buffering">
+<description>
+Constructs a new query object for querying the buffering status of
+a stream.
+
+
+</description>
+<parameters>
+<parameter name="format">
+<parameter_description> the default #GstFormat for the new query
+</parameter_description>
+</parameter>
+</parameters>
+<return> A #GstQuery
+
+Since: 0.10.20
+</return>
+</function>
+
<function name="gst_iterator_find_custom">
<description>
Find the first element in @it that matches the compare function @func.
@@ -5102,26 +5317,25 @@
</return>
</function>
-<function name="gst_base_src_set_do_timestamp">
+<function name="gst_parse_context_get_missing_elements">
<description>
-Configure @src to automatically timestamp outgoing buffers based on the
-current running_time of the pipeline. This property is mostly useful for live
-sources.
+Retrieve missing elements from a previous run of gst_parse_launch_full()
+or gst_parse_launchv_full(). Will only return results if an error code
+of %GST_PARSE_ERROR_NO_SUCH_ELEMENT was returned.
-Since: 0.10.15
</description>
<parameters>
-<parameter name="src">
-<parameter_description> the source
-</parameter_description>
-</parameter>
-<parameter name="timestamp">
-<parameter_description> enable or disable timestamping
+<parameter name="context">
+<parameter_description> a #GstParseContext
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a NULL-terminated array of element factory name strings of
+missing elements. Free with g_strfreev() when no longer needed.
+
+Since: 0.10.20
+</return>
</function>
<function name="gst_pad_pull_range">
@@ -5501,24 +5715,36 @@
</return>
</function>
-<function name="gst_pad_get_parent_element">
+<function name="gst_query_parse_buffering_stats">
<description>
-Gets the parent of @pad, cast to a #GstElement. If a @pad has no parent or
-its parent is not an element, return NULL.
+Extracts the buffering stats values from @query.
+Since: 0.10.20
</description>
<parameters>
-<parameter name="pad">
-<parameter_description> a pad
+<parameter name="query">
+<parameter_description> A valid #GstQuery of type GST_QUERY_BUFFERING.
+</parameter_description>
+</parameter>
+<parameter name="mode">
+<parameter_description> a buffering mode
+</parameter_description>
+</parameter>
+<parameter name="avg_in">
+<parameter_description> the average input rate
+</parameter_description>
+</parameter>
+<parameter name="avg_out">
+<parameter_description> the average output rate
+</parameter_description>
+</parameter>
+<parameter name="buffering_left">
+<parameter_description> amount of buffering time left
</parameter_description>
</parameter>
</parameters>
-<return> The parent of the pad. The caller has a reference on the parent, so
-unref when you're finished with it.
-
-MT safe.
-</return>
+<return></return>
</function>
<function name="gst_format_to_quark">
@@ -5747,7 +5973,7 @@
observations and @clock is recalibrated.
If this functions returns %TRUE, @r_squared will contain the
-correlation coefficient of the interpollation. A value of 1.0
+correlation coefficient of the interpolation. A value of 1.0
means a perfect regression was performed. This value can
be used to control the sampling frequency of the master and slave
clocks.
@@ -5772,7 +5998,7 @@
</parameter_description>
</parameter>
</parameters>
-<return> TRUE if enough observations were added to run the
+<return> %TRUE if enough observations were added to run the
regression algorithm.
MT safe.
@@ -6072,7 +6298,7 @@
</parameter>
</parameters>
<return> the internal time of the clock. Or GST_CLOCK_TIME_NONE when
-giving wrong input.
+given invalid input.
MT safe.
</return>
@@ -6307,6 +6533,9 @@
This function should only be called with the PREROLL_LOCK held, like when
receiving an EOS event in the ::event vmethod.
+The @time argument should be the running_time of when the EOS should happen
+and will be adjusted with any latency and offset configured in the sink.
+
Since 0.10.15
@@ -6565,15 +6794,37 @@
<return></return>
</function>
-<function name="gst_mini_object_replace">
+<function name="gst_value_set_double_range">
<description>
-Modifies a pointer to point to a new mini-object. The modification
-is done atomically, and the reference counts are updated correctly.
-Either @newdata and the value pointed to by @olddata may be NULL.
+Sets @value to the range specified by @start and @end.
</description>
<parameters>
-<parameter name="olddata">
+<parameter name="value">
+<parameter_description> a GValue initialized to GST_TYPE_DOUBLE_RANGE
+</parameter_description>
+</parameter>
+<parameter name="start">
+<parameter_description> the start of the range
+</parameter_description>
+</parameter>
+<parameter name="end">
+<parameter_description> the end of the range
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="gst_mini_object_replace">
+<description>
+Modifies a pointer to point to a new mini-object. The modification
+is done atomically, and the reference counts are updated correctly.
+Either @newdata and the value pointed to by @olddata may be NULL.
+
+</description>
+<parameters>
+<parameter name="olddata">
<parameter_description> pointer to a pointer to a mini-object to be replaced
</parameter_description>
</parameter>
@@ -6611,6 +6862,38 @@
</return>
</function>
+<function name="gst_message_parse_buffering_stats">
+<description>
+Extracts the buffering stats values from @message.
+
+Since: 0.10.20
+
+</description>
+<parameters>
+<parameter name="message">
+<parameter_description> A valid #GstMessage of type GST_MESSAGE_BUFFERING.
+</parameter_description>
+</parameter>
+<parameter name="mode">
+<parameter_description> a buffering mode
+</parameter_description>
+</parameter>
+<parameter name="avg_in">
+<parameter_description> the average input rate
+</parameter_description>
+</parameter>
+<parameter name="avg_out">
+<parameter_description> the average output rate
+</parameter_description>
+</parameter>
+<parameter name="buffering_left">
+<parameter_description> amount of buffering time left in milliseconds.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
<function name="gst_base_transform_set_qos_enabled">
<description>
Enable or disable QoS handling in the transform.
@@ -6826,6 +7109,22 @@
</return>
</function>
+<function name="gst_parse_context_new">
+<description>
+Allocates a parse context for use with gst_parse_launch_full() or
+gst_parse_launchv_full().
+
+
+</description>
+<parameters>
+</parameters>
+<return> a newly-allocated parse context. Free with gst_parse_context_free()
+when no longer needed.
+
+Since: 0.10.20
+</return>
+</function>
+
<function name="gst_util_uint64_scale_int">
<description>
Scale a guint64 by a factor expressed as a fraction (num/denom), avoiding
@@ -6980,7 +7279,8 @@
</description>
<parameters>
<parameter name="structure">
-<parameter_description> description of the event
+<parameter_description> description of the event. The event will take ownership of the
+structure.
</parameter_description>
</parameter>
</parameters>
@@ -7187,6 +7487,29 @@
</return>
</function>
+<function name="gst_event_has_name">
+<description>
+Checks if @event has the given @name. This function is usually used to
+check the name of a custom event.
+
+
+</description>
+<parameters>
+<parameter name="event">
+<parameter_description> The #GstEvent.
+</parameter_description>
+</parameter>
+<parameter name="name">
+<parameter_description> name to check
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if @name matches the name of the event structure.
+
+Since: 0.10.20
+</return>
+</function>
+
<function name="gst_message_parse_info">
<description>
Extracts the GError and debug string from the GstMessage. The values returned
@@ -7388,41 +7711,25 @@
</return>
</function>
-<function name="gst_clock_id_wait">
+<function name="gst_value_take_mini_object">
<description>
-Perform a blocking wait on @id.
- id should have been created with gst_clock_new_single_shot_id()
-or gst_clock_new_periodic_id() and should not have been unscheduled
-with a call to gst_clock_id_unschedule().
-
-If the @jitter argument is not NULL and this function returns #GST_CLOCK_OK
-or #GST_CLOCK_EARLY, it will contain the difference
-against the clock and the time of @id when this method was
-called.
-Positive values indicate how late @id was relative to the clock
-(in which case this function will return #GST_CLOCK_EARLY).
-Negative values indicate how much time was spent waiting on the clock
-before this function returned.
-
+Set the contents of a %GST_TYPE_MINI_OBJECT derived #GValue to
+ mini_object
+Takes over the ownership of the caller's reference to @mini_object;
+the caller doesn't have to unref it any more.
</description>
<parameters>
-<parameter name="id">
-<parameter_description> The #GstClockID to wait on
+<parameter name="value">
+<parameter_description> a valid #GValue of %GST_TYPE_MINI_OBJECT derived type
</parameter_description>
</parameter>
-<parameter name="jitter">
-<parameter_description> A pointer that will contain the jitter, can be NULL.
+<parameter name="mini_object">
+<parameter_description> mini object value to take
</parameter_description>
</parameter>
</parameters>
-<return> the result of the blocking wait. #GST_CLOCK_EARLY will be returned
-if the current clock time is past the time of @id, #GST_CLOCK_OK if
- id was scheduled in time. #GST_CLOCK_UNSCHEDULED if @id was
-unscheduled with gst_clock_id_unschedule().
-
-MT safe.
-</return>
+<return></return>
</function>
<function name="gst_alloc_trace_print">
@@ -8224,8 +8531,8 @@
<function name="gst_bin_find_unconnected_pad">
<description>
-Recursively looks for elements with an unconnected pad of the given
-direction within the specified bin and returns an unconnected pad
+Recursively looks for elements with an unlinked pad of the given
+direction within the specified bin and returns an unlinked pad
if one is found, or NULL otherwise. If a pad is found, the caller
owns a reference to it and should use gst_object_unref() on the
pad when it is not needed any longer.
@@ -8234,17 +8541,19 @@
</description>
<parameters>
<parameter name="bin">
-<parameter_description> bin in which to look for elements with unconnected pads
+<parameter_description> bin in which to look for elements with unlinked pads
</parameter_description>
</parameter>
<parameter name="direction">
-<parameter_description> whether to look for an unconnected source or sink pad
+<parameter_description> whether to look for an unlinked source or sink pad
</parameter_description>
</parameter>
</parameters>
-<return> unconnected pad of the given direction, or NULL.
+<return> unlinked pad of the given direction, or NULL.
Since: 0.10.3
+
+Deprecated: use gst_bin_find_unlinked_pad() instead.
</return>
</function>
@@ -8346,32 +8655,25 @@
</parameters>
<return> mini object contents of @value
-Since: 0.10.19
+Since: 0.10.20
</return>
</function>
-<function name="gst_controller_unset_all">
+<function name="gst_preset_get_preset_names">
<description>
-Used to remove all time-stamped values of given controller-handled property
-
-Deprecated: Use #GstControlSource, for example #GstInterpolationControlSource
-directly.
+Get a copy of preset names as a NULL terminated string array.
</description>
<parameters>
-<parameter name="self">
-<parameter_description> the controller object which handles the properties
-</parameter_description>
-</parameter>
-<parameter name="property_name">
-<parameter_description> the name of the property to unset
+<parameter name="preset">
+<parameter_description> a #GObject that implements #GstPreset
</parameter_description>
</parameter>
</parameters>
-<return> %FALSE if the values couldn't be unset (ex : properties not handled
-by controller), %TRUE otherwise
-Since: 0.10.5
+<return> list with names, ue g_strfreev() after usage.
+
+Since: 0.10.20
</return>
</function>
@@ -8429,7 +8731,7 @@
<description>
Gets the capabilities this pad can produce or consume.
Note that this method doesn't necessarily return the caps set by
-gst_pad_set_caps() - use #GST_PAD_CAPS for that instead.
+gst_pad_set_caps() - use GST_PAD_CAPS() for that instead.
gst_pad_get_caps returns all possible caps a pad can operate with, using
the pad's get_caps function;
this returns the pad template caps if not explicitly set.
@@ -8821,26 +9123,24 @@
</return>
</function>
-<function name="gst_value_set_double_range">
+<function name="gst_pad_get_parent_element">
<description>
-Sets @value to the range specified by @start and @end.
+Gets the parent of @pad, cast to a #GstElement. If a @pad has no parent or
+its parent is not an element, return NULL.
+
</description>
<parameters>
-<parameter name="value">
-<parameter_description> a GValue initialized to GST_TYPE_DOUBLE_RANGE
-</parameter_description>
-</parameter>
-<parameter name="start">
-<parameter_description> the start of the range
-</parameter_description>
-</parameter>
-<parameter name="end">
-<parameter_description> the end of the range
+<parameter name="pad">
+<parameter_description> a pad
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The parent of the pad. The caller has a reference on the parent, so
+unref when you're finished with it.
+
+MT safe.
+</return>
</function>
<function name="gst_trace_flush">
@@ -8941,6 +9241,59 @@
</return>
</function>
+<function name="gst_pad_add_data_probe_full">
+<description>
+Adds a "data probe" to a pad. This function will be called whenever data
+passes through a pad. In this case data means both events and buffers. The
+probe will be called with the data as an argument, meaning @handler should
+have the same callback signature as the #GstPad::have-data signal.
+Note that the data will have a reference count greater than 1, so it will
+be immutable -- you must not change it.
+
+For source pads, the probe will be called after the blocking function, if any
+(see gst_pad_set_blocked_async()), but before looking up the peer to chain
+to. For sink pads, the probe function will be called before configuring the
+sink with new caps, if any, and before calling the pad's chain function.
+
+Your data probe should return TRUE to let the data continue to flow, or FALSE
+to drop it. Dropping data is rarely useful, but occasionally comes in handy
+with events.
+
+Although probes are implemented internally by connecting @handler to the
+have-data signal on the pad, if you want to remove a probe it is insufficient
+to only call g_signal_handler_disconnect on the returned handler id. To
+remove a probe, use the appropriate function, such as
+gst_pad_remove_data_probe().
+
+The @notify function is called when the probe is disconnected and usually
+used to free @data.
+
+
+</description>
+<parameters>
+<parameter name="pad">
+<parameter_description> pad to add the data probe handler to
+</parameter_description>
+</parameter>
+<parameter name="handler">
+<parameter_description> function to call when data is passed over pad
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> data to pass along with the handler
+</parameter_description>
+</parameter>
+<parameter name="notify">
+<parameter_description> function to call when the probe is disconnected, or NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return> The handler id.
+
+Since: 0.10.20
+</return>
+</function>
+
<function name="gst_element_iterate_pads">
<description>
Retrieves an iterattor of @element's pads. The iterator should
@@ -9068,6 +9421,31 @@
</return>
</function>
+<function name="gst_query_parse_buffering_percent">
+<description>
+Get the percentage of buffered data. This is a value between 0 and 100.
+The @busy indicator is %TRUE when the buffering is in progress.
+
+Since: 0.10.20
+
+</description>
+<parameters>
+<parameter name="query">
+<parameter_description> A valid #GstQuery of type GST_QUERY_BUFFERING.
+</parameter_description>
+</parameter>
+<parameter name="busy">
+<parameter_description> if buffering is busy
+</parameter_description>
+</parameter>
+<parameter name="percent">
+<parameter_description> a buffering percent
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
<function name="gst_structure_get_clock_time">
<description>
Sets the clock time pointed to by @value corresponding to the clock time
@@ -9278,7 +9656,7 @@
follows:
&lt;programlisting&gt;
-time = (internal_time - @internal) * @rate_num / @rate_denom + @external
+time = (internal_time - internal) * rate_num / rate_denom + external
&lt;/programlisting&gt;
This formula is implemented in gst_clock_adjust_unlocked(). Of course, it
@@ -9331,32 +9709,38 @@
<return></return>
</function>
-<function name="gst_value_intersect">
+<function name="gst_query_parse_buffering_range">
<description>
-Calculates the intersection of two values. If the values have
-a non-empty intersection, the value representing the intersection
-is placed in @dest. If the intersection is non-empty, @dest is
-not modified.
+Parse an available query, writing the format into @format, and
+other results into the passed parameters, if the respective parameters
+are non-NULL
+Since: 0.10.20
</description>
<parameters>
-<parameter name="dest">
-<parameter_description> a uninitialized #GValue that will hold the calculated
-intersection value
+<parameter name="query">
+<parameter_description> a GST_QUERY_SEEKING type query #GstQuery
</parameter_description>
</parameter>
-<parameter name="value1">
-<parameter_description> a value to intersect
+<parameter name="format">
+<parameter_description> the format to set for the @segment_start and @segment_end values
</parameter_description>
</parameter>
-<parameter name="value2">
-<parameter_description> another value to intersect
+<parameter name="start">
+<parameter_description> the start to set
+</parameter_description>
+</parameter>
+<parameter name="stop">
+<parameter_description> the stop to set
+</parameter_description>
+</parameter>
+<parameter name="estimated_total">
+<parameter_description> estimated total amount of download time
</parameter_description>
</parameter>
</parameters>
-<return> TRUE if the intersection is non-empty
-</return>
+<return></return>
</function>
<function name="gst_plugin_get_name">
@@ -9434,7 +9818,7 @@
</parameter_description>
</parameter>
</parameters>
-<return> TRUE if the task could be stopped.
+<return> %TRUE if the task could be stopped.
MT safe.
</return>
@@ -9712,7 +10096,7 @@
that the returned time is increasing. This function should be called with the
clock's OBJECT_LOCK held and is mainly used by clock subclasses.
-This function is te reverse of gst_clock_unadjust_unlocked().
+This function is the reverse of gst_clock_unadjust_unlocked().
</description>
@@ -10063,6 +10447,34 @@
</return>
</function>
+<function name="gst_value_intersect">
+<description>
+Calculates the intersection of two values. If the values have
+a non-empty intersection, the value representing the intersection
+is placed in @dest. If the intersection is non-empty, @dest is
+not modified.
+
+
+</description>
+<parameters>
+<parameter name="dest">
+<parameter_description> a uninitialized #GValue that will hold the calculated
+intersection value
+</parameter_description>
+</parameter>
+<parameter name="value1">
+<parameter_description> a value to intersect
+</parameter_description>
+</parameter>
+<parameter name="value2">
+<parameter_description> another value to intersect
+</parameter_description>
+</parameter>
+</parameters>
+<return> TRUE if the intersection is non-empty
+</return>
+</function>
+
<function name="gst_segment_set_seek">
<description>
Update the segment structure with the field values of a seek event (see
@@ -10543,6 +10955,38 @@
</return>
</function>
+<function name="gst_query_set_buffering_stats">
+<description>
+Configures the buffering stats values in @query.
+
+Since: 0.10.20
+
+</description>
+<parameters>
+<parameter name="query">
+<parameter_description> A valid #GstQuery of type GST_QUERY_BUFFERING.
+</parameter_description>
+</parameter>
+<parameter name="mode">
+<parameter_description> a buffering mode
+</parameter_description>
+</parameter>
+<parameter name="avg_in">
+<parameter_description> the average input rate
+</parameter_description>
+</parameter>
+<parameter name="avg_out">
+<parameter_description> the average output rate
+</parameter_description>
+</parameter>
+<parameter name="buffering_left">
+<parameter_description> amount of buffering time left
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
<function name="GstPad">
<description>
Signals that new data is available on the pad. This signal is used
@@ -10937,6 +11381,38 @@
</return>
</function>
+<function name="gst_query_set_buffering_range">
+<description>
+Set the available query result fields in @query.
+
+Since: 0.10.20
+
+</description>
+<parameters>
+<parameter name="query">
+<parameter_description> a #GstQuery
+</parameter_description>
+</parameter>
+<parameter name="format">
+<parameter_description> the format to set for the @start and @stop values
+</parameter_description>
+</parameter>
+<parameter name="start">
+<parameter_description> the start to set
+</parameter_description>
+</parameter>
+<parameter name="stop">
+<parameter_description> the stop to set
+</parameter_description>
+</parameter>
+<parameter name="estimated_total">
+<parameter_description> estimated total amount of download time
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
<function name="gst_query_type_iterate_definitions">
<description>
Get a #GstIterator of all the registered query types. The definitions
@@ -11295,7 +11771,7 @@
</description>
<parameters>
<parameter name="taglist">
-<parameter_description> metadata list
+<parameter_description> metadata list. The event will take ownership of @taglist.
</parameter_description>
</parameter>
</parameters>
@@ -11799,7 +12275,7 @@
</parameter_description>
</parameter>
</parameters>
-<return> TRUE if the task could be joined.
+<return> %TRUE if the task could be joined.
MT safe.
</return>
@@ -12093,31 +12569,6 @@
</return>
</function>
-<function name="gst_buffer_stamp">
-<description>
-Copies additional information (the timestamp, duration, and offset start
-and end) from one buffer to the other.
-
-This function does not copy any buffer flags or caps and is equivalent to
-gst_buffer_copy_metadata(@dest, @src, GST_BUFFER_COPY_TIMESTAMPS).
-
-Deprecated: use gst_buffer_copy_metadata() instead, it provides more
-control.
-
-</description>
-<parameters>
-<parameter name="dest">
-<parameter_description> buffer to stamp
-</parameter_description>
-</parameter>
-<parameter name="src">
-<parameter_description> buffer to stamp from
-</parameter_description>
-</parameter>
-</parameters>
-<return></return>
-</function>
-
<function name="gst_object_check_uniqueness">
<description>
Checks to see if there is any object named @name in @list. This function
@@ -12231,6 +12682,28 @@
<return></return>
</function>
+<function name="gst_preset_load_preset">
+<description>
+Load the given preset.
+
+
+</description>
+<parameters>
+<parameter name="preset">
+<parameter_description> a #GObject that implements #GstPreset
+</parameter_description>
+</parameter>
+<parameter name="name">
+<parameter_description> preset name to load
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE for success, %FALSE if e.g. there is no preset with that @name
+
+Since: 0.10.20
+</return>
+</function>
+
<function name="gst_iterator_filter">
<description>
Create a new iterator from an existing iterator. The new iterator
@@ -13024,6 +13497,41 @@
</return>
</function>
+<function name="gst_parse_launchv_full">
+<description>
+Create a new element based on command line syntax.
+ error will contain an error message if an erroneous pipeline is specified.
+An error does not mean that the pipeline could not be constructed.
+
+
+</description>
+<parameters>
+<parameter name="argv">
+<parameter_description> null-terminated array of arguments
+</parameter_description>
+</parameter>
+<parameter name="context">
+<parameter_description> a parse context allocated with gst_parse_context_new(), or %NULL
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> parsing options, or #GST_PARSE_FLAG_NONE
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> pointer to a #GError (which must be initialised to %NULL)
+</parameter_description>
+</parameter>
+</parameters>
+<return> a new element on success; on failure, either %NULL or a
+partially-constructed bin or element will be returned and @error will be set
+(unless you passed #GST_PARSE_FLAG_FATAL_ERRORS in @flags, then %NULL will
+always be returned on failure)
+
+Since: 0.10.20
+</return>
+</function>
+
<function name="gst_base_transform_is_qos_enabled">
<description>
Queries if the transform will handle QoS.
@@ -13203,6 +13711,38 @@
</return>
</function>
+<function name="gst_preset_set_meta">
+<description>
+Sets a new @value for an existing meta data item or adds a new item. Meta
+data @tag names can be something like e.g. "comment". Supplying %NULL for the
+ value will unset an existing value.
+
+
+</description>
+<parameters>
+<parameter name="preset">
+<parameter_description> a #GObject that implements #GstPreset
+</parameter_description>
+</parameter>
+<parameter name="name">
+<parameter_description> preset name
+</parameter_description>
+</parameter>
+<parameter name="tag">
+<parameter_description> meta data item name
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> new value
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE for success, %FALSE if e.g. there is no preset with that @name
+
+Since: 0.10.20
+</return>
+</function>
+
<function name="gst_element_factory_get_longname">
<description>
Gets the longname for this factory
@@ -13391,6 +13931,28 @@
</return>
</function>
+<function name="gst_uri_has_protocol">
+<description>
+Checks if the protocol of a given valid URI matches @protocol.
+
+
+</description>
+<parameters>
+<parameter name="uri">
+<parameter_description> an URI string
+</parameter_description>
+</parameter>
+<parameter name="protocol">
+<parameter_description> a protocol string (e.g. "http")
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the protocol matches.
+
+Since: 0.10.4
+</return>
+</function>
+
<function name="gst_registry_feature_filter">
<description>
Runs a filter against all features of the plugins in the registry
@@ -13418,7 +13980,8 @@
</parameter_description>
</parameter>
</parameters>
-<return> a GList of plugin features, gst_plugin_feature_list_free after use.
+<return> a #GList of #GstPluginFeature. Use gst_plugin_feature_list_free()
+after usage.
MT safe.
</return>
@@ -13449,7 +14012,8 @@
<function name="gst_uri_protocol_is_valid">
<description>
Tests if the given string is a valid protocol identifier. Protocols
-must consist of alphanumeric characters and not start with a number.
+must consist of alphanumeric characters, '+', '-' and '.' and must
+start with a alphabetic character. See RFC 3986 Section 3.1.
</description>
@@ -13784,6 +14348,23 @@
</return>
</function>
+<function name="gst_uri_handler_get_uri_type">
+<description>
+Gets the type of the given URI handler
+
+Returns #GST_URI_UNKNOWN if the @handler isn't implemented correctly.
+
+</description>
+<parameters>
+<parameter name="handler">
+<parameter_description> A #GstURIHandler.
+</parameter_description>
+</parameter>
+</parameters>
+<return>#GST_URI_UNKNOWN if the @handler isn't implemented correctly.
+</return>
+</function>
+
<function name="gst_pad_set_getrange_function">
<description>
Sets the given getrange function for the pad. The getrange function is
@@ -13860,7 +14441,7 @@
</parameter_description>
</parameter>
</parameters>
-<return> TRUE if the task could be paused.
+<return> %TRUE if the task could be paused.
MT safe.
</return>
@@ -14216,6 +14797,28 @@
</return>
</function>
+<function name="gst_preset_delete_preset">
+<description>
+Delete the given preset.
+
+
+</description>
+<parameters>
+<parameter name="preset">
+<parameter_description> a #GObject that implements #GstPreset
+</parameter_description>
+</parameter>
+<parameter name="name">
+<parameter_description> preset name to remove
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE for success, %FALSE if e.g. there is no preset with that @name
+
+Since: 0.10.20
+</return>
+</function>
+
<function name="gst_element_get_state">
<description>
Gets the state of the element.
@@ -14264,6 +14867,9 @@
<description>
Unconditionally sets the atomic integer to @value.
+Deprecated: Use g_atomic_int_set().
+
+
</description>
<parameters>
<parameter name="atomic_int">
@@ -14390,6 +14996,18 @@
</return>
</function>
+<function name="gst_xml_new">
+<description>
+Create a new GstXML parser object.
+
+
+</description>
+<parameters>
+</parameters>
+<return> a pointer to a new GstXML object.
+</return>
+</function>
+
<function name="gst_pad_peer_get_caps">
<description>
Gets the capabilities of the peer connected to this pad.
@@ -14636,7 +15254,32 @@
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return></return>
+</function>
+
+<function name="gst_controller_unset_all">
+<description>
+Used to remove all time-stamped values of given controller-handled property
+
+Deprecated: Use #GstControlSource, for example #GstInterpolationControlSource
+directly.
+
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> the controller object which handles the properties
+</parameter_description>
+</parameter>
+<parameter name="property_name">
+<parameter_description> the name of the property to unset
+</parameter_description>
+</parameter>
+</parameters>
+<return> %FALSE if the values couldn't be unset (ex : properties not handled
+by controller), %TRUE otherwise
+Since: 0.10.5
+</return>
</function>
<function name="gst_pipeline_auto_clock">
@@ -14822,6 +15465,24 @@
</return>
</function>
+<function name="gst_segment_copy">
+<description>
+Create a copy of given @segment.
+
+
+</description>
+<parameters>
+<parameter name="segment">
+<parameter_description> a #GstSegment
+</parameter_description>
+</parameter>
+</parameters>
+<return> a new #GstSegment, free with gst_segment_free().
+
+Since: 0.10.20
+</return>
+</function>
+
<function name="gst_trace_text_flush">
<description>
Flush any pending trace entries in @trace to the trace file,
@@ -15402,7 +16063,7 @@
</parameter_description>
</parameter>
<parameter name="mutex">
-<parameter_description> The GMutex to use
+<parameter_description> The #GMutex to use
</parameter_description>
</parameter>
</parameters>
@@ -15556,26 +16217,20 @@
</return>
</function>
-<function name="gst_uri_has_protocol">
+<function name="gst_parse_context_free">
<description>
-Checks if the protocol of a given valid URI matches @protocol.
+Frees a parse context previously allocated with gst_parse_context_new().
+Since: 0.10.20
</description>
<parameters>
-<parameter name="uri">
-<parameter_description> an URI string
-</parameter_description>
-</parameter>
-<parameter name="protocol">
-<parameter_description> a protocol string (e.g. "http")
+<parameter name="context">
+<parameter_description> a #GstParseContext
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the protocol matches.
-
-Since: 0.10.4
-</return>
+<return></return>
</function>
<function name="gst_value_get_mini_object">
@@ -15616,6 +16271,38 @@
</return>
</function>
+<function name="gst_preset_get_meta">
+<description>
+Gets the @value for an existing meta data @tag. Meta data @tag names can be
+something like e.g. "comment". Returned values need to be released when done.
+
+
+</description>
+<parameters>
+<parameter name="preset">
+<parameter_description> a #GObject that implements #GstPreset
+</parameter_description>
+</parameter>
+<parameter name="name">
+<parameter_description> preset name
+</parameter_description>
+</parameter>
+<parameter name="tag">
+<parameter_description> meta data item name
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> value
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE for success, %FALSE if e.g. there is no preset with that @name
+or no value for the given @tag
+
+Since: 0.10.20
+</return>
+</function>
+
<function name="gst_tag_list_get_int64_index">
<description>
Gets the value that is at the given index for the given tag in the given
@@ -15661,7 +16348,7 @@
</parameter>
</parameters>
<return> the time of the clock. Or GST_CLOCK_TIME_NONE when
-giving wrong input.
+given invalid input.
MT safe.
</return>
@@ -15670,7 +16357,7 @@
<function name="gst_task_cleanup_all">
<description>
Wait for all tasks to be stopped. This is mainly used internally
-to ensure proper cleanup of internal datastructures in testsuites.
+to ensure proper cleanup of internal data structures in test suites.
MT safe.
@@ -16729,7 +17416,7 @@
This function should be called with the clock's OBJECT_LOCK held and
is mainly used by clock subclasses.
-This function is te reverse of gst_clock_adjust_unlocked().
+This function is the reverse of gst_clock_adjust_unlocked().
</description>
@@ -16791,6 +17478,49 @@
</return>
</function>
+<function name="gst_parse_bin_from_description_full">
+<description>
+This is a convenience wrapper around gst_parse_launch() to create a
+#GstBin from a gst-launch-style pipeline description. See
+gst_parse_launch() and the gst-launch man page for details about the
+syntax. Ghost pads on the bin for unlinked source or sink pads
+within the bin can automatically be created (but only a maximum of
+one ghost pad for each direction will be created; if you expect
+multiple unlinked source pads or multiple unlinked sink pads
+and want them all ghosted, you will have to create the ghost pads
+yourself).
+
+
+</description>
+<parameters>
+<parameter name="bin_description">
+<parameter_description> command line describing the bin
+</parameter_description>
+</parameter>
+<parameter name="ghost_unlinked_pads">
+<parameter_description> whether to automatically create ghost pads
+for unlinked source or sink pads within the bin
+</parameter_description>
+</parameter>
+<parameter name="context">
+<parameter_description> a parse context allocated with gst_parse_context_new(), or %NULL
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> parsing options, or #GST_PARSE_FLAG_NONE
+</parameter_description>
+</parameter>
+<parameter name="err">
+<parameter_description> where to store the error message in case of an error, or NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return> a newly-created bin, or NULL if an error occurred.
+
+Since: 0.10.20
+</return>
+</function>
+
<function name="gst_poll_fd_ctl_write">
<description>
Control whether the descriptor @fd in @set will be monitored for
@@ -16993,7 +17723,7 @@
Gets the internal rate and reference time of @clock. See
gst_clock_set_calibration() for more information.
- internal, @external, @rate_num, and @rate_denom can be left NULL if the
+ internal, @external, @rate_num, and @rate_denom can be left %NULL if the
caller is not interested in the values.
MT safe.
@@ -17483,7 +18213,7 @@
<function name="gst_pipeline_get_bus">
<description>
-Gets the #GstBus of @pipeline.
+Gets the #GstBus of @pipeline. The bus allows applications to receive #GstMessages.
</description>
@@ -18364,6 +19094,40 @@
</return>
</function>
+<function name="gst_pad_add_event_probe_full">
+<description>
+Adds a probe that will be called for all events passing through a pad. See
+gst_pad_add_data_probe() for more information.
+
+The @notify function is called when the probe is disconnected and usually
+used to free @data.
+
+
+</description>
+<parameters>
+<parameter name="pad">
+<parameter_description> pad to add the event probe handler to
+</parameter_description>
+</parameter>
+<parameter name="handler">
+<parameter_description> function to call when events are passed over pad
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> data to pass along with the handler, or NULL
+</parameter_description>
+</parameter>
+<parameter name="notify">
+<parameter_description> function to call when probe is disconnected, or NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return> The handler id
+
+Since: 0.10.20
+</return>
+</function>
+
<function name="gst_dp_crc">
<description>
Calculate a CRC for the given buffer over the given number of bytes.
@@ -19587,26 +20351,26 @@
</return>
</function>
-<function name="gst_interpolation_control_source_set_interpolation_mode">
+<function name="gst_preset_save_preset">
<description>
-Sets the given interpolation mode.
-
-&lt;note&gt;&lt;para&gt;User interpolation is not yet available and quadratic interpolation
-is deprecated and maps to cubic interpolation.&lt;/para&gt;&lt;/note&gt;
+Save the current preset under the given name. If there is already a preset by
+this @name it will be overwritten.
</description>
<parameters>
-<parameter name="self">
-<parameter_description> the #GstInterpolationControlSource object
+<parameter name="preset">
+<parameter_description> a #GObject that implements #GstPreset
</parameter_description>
</parameter>
-<parameter name="mode">
-<parameter_description> interpolation mode
+<parameter name="name">
+<parameter_description> preset name to save
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the interpolation mode could be set, %FALSE otherwise
+<return> %TRUE for success, %FALSE
+
+Since: 0.10.20
</return>
</function>
@@ -19998,14 +20762,29 @@
<return></return>
</function>
-<function name="gst_bin_get_type">
+<function name="gst_buffer_stamp">
<description>
+Copies additional information (the timestamp, duration, and offset start
+and end) from one buffer to the other.
+
+This function does not copy any buffer flags or caps and is equivalent to
+gst_buffer_copy_metadata(@dest, @src, GST_BUFFER_COPY_TIMESTAMPS).
+
+Deprecated: use gst_buffer_copy_metadata() instead, it provides more
+control.
</description>
<parameters>
+<parameter name="dest">
+<parameter_description> buffer to stamp
+</parameter_description>
+</parameter>
+<parameter name="src">
+<parameter_description> buffer to stamp from
+</parameter_description>
+</parameter>
</parameters>
-<return> the type of #GstBin
-</return>
+<return></return>
</function>
<function name="gst_value_register">
@@ -20127,7 +20906,7 @@
<function name="gst_task_start">
<description>
Starts @task. The @task must have a lock associated with it using
-gst_task_set_lock() or thsi function will return FALSE.
+gst_task_set_lock() or this function will return %FALSE.
</description>
@@ -20137,7 +20916,7 @@
</parameter_description>
</parameter>
</parameters>
-<return> TRUE if the task could be started.
+<return> %TRUE if the task could be started.
MT safe.
</return>
@@ -20334,7 +21113,7 @@
<function name="gst_element_factory_get_uri_type">
<description>
-Gets the type of URIs the element supports or GST_URI_UNKNOWN if none.
+Gets the type of URIs the element supports or #GST_URI_UNKNOWN if none.
</description>
@@ -20523,7 +21302,7 @@
<description>
Register a callback on the given #GstClockID @id with the given
function and user_data. When passing a #GstClockID with an invalid
-time to this function, the callback will be called immediatly
+time to this function, the callback will be called immediately
with a time set to GST_CLOCK_TIME_NONE. The callback will
be called when the time of @id has been reached.
@@ -20539,7 +21318,7 @@
</parameter_description>
</parameter>
<parameter name="user_data">
-<parameter_description> User data passed in the calback
+<parameter_description> User data passed in the callback
</parameter_description>
</parameter>
</parameters>
@@ -20581,6 +21360,28 @@
</return>
</function>
+<function name="gst_poll_add_fd">
+<description>
+Add a file descriptor to the file descriptor set.
+
+
+</description>
+<parameters>
+<parameter name="set">
+<parameter_description> a file descriptor set.
+</parameter_description>
+</parameter>
+<parameter name="fd">
+<parameter_description> a file descriptor.
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the file descriptor was successfully added to the set.
+
+Since: 0.10.18
+</return>
+</function>
+
<function name="gst_element_set_index">
<description>
Set @index on the element. The refcount of the index
@@ -20833,7 +21634,7 @@
A clock provider that slaves its clock to a master can get the current
calibration values with gst_clock_get_calibration().
- master can be NULL in which case @clock will not be slaved anymore. It will
+ master can be %NULL in which case @clock will not be slaved anymore. It will
however keep reporting its time adjusted with the last configured rate
and time offsets.
@@ -20849,9 +21650,9 @@
</parameter_description>
</parameter>
</parameters>
-<return> TRUE if the clock is capable of being slaved to a master clock.
+<return> %TRUE if the clock is capable of being slaved to a master clock.
Trying to set a master on a clock without the
-GST_CLOCK_FLAG_CAN_SET_MASTER flag will make this function return FALSE.
+#GST_CLOCK_FLAG_CAN_SET_MASTER flag will make this function return %FALSE.
MT safe.
</return>
@@ -21267,6 +22068,28 @@
</return>
</function>
+<function name="gst_parse_launchv">
+<description>
+Create a new element based on command line syntax.
+ error will contain an error message if an erroneuos pipeline is specified.
+An error does not mean that the pipeline could not be constructed.
+
+
+</description>
+<parameters>
+<parameter name="argv">
+<parameter_description> null-terminated array of arguments
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> pointer to a #GError
+</parameter_description>
+</parameter>
+</parameters>
+<return> a new element on success and %NULL on failure.
+</return>
+</function>
+
<function name="gst_bus_remove_signal_watch">
<description>
Removes a signal watch previously added with gst_bus_add_signal_watch().
@@ -21307,6 +22130,28 @@
</return>
</function>
+<function name="gst_base_src_set_do_timestamp">
+<description>
+Configure @src to automatically timestamp outgoing buffers based on the
+current running_time of the pipeline. This property is mostly useful for live
+sources.
+
+Since: 0.10.15
+
+</description>
+<parameters>
+<parameter name="src">
+<parameter_description> the source
+</parameter_description>
+</parameter>
+<parameter name="timestamp">
+<parameter_description> enable or disable timestamping
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
<function name="gst_pad_proxy_getcaps">
<description>
Calls gst_pad_get_allowed_caps() for every other pad belonging to the
@@ -21861,8 +22706,8 @@
<function name="gst_clock_new_periodic_id">
<description>
Get an ID from @clock to trigger a periodic notification.
-The periodeic notifications will be start at time start_time and
-will then be fired with the given interval. @id should be unreffed
+The periodic notifications will start at time @start_time and
+will then be fired with the given @interval. @id should be unreffed
after usage.
@@ -22575,26 +23420,29 @@
</return>
</function>
-<function name="gst_poll_add_fd">
+<function name="gst_query_set_buffering_percent">
<description>
-Add a file descriptor to the file descriptor set.
+Set the percentage of buffered data. This is a value between 0 and 100.
+The @busy indicator is %TRUE when the buffering is in progress.
+Since: 0.10.20
</description>
<parameters>
-<parameter name="set">
-<parameter_description> a file descriptor set.
+<parameter name="query">
+<parameter_description> A valid #GstQuery of type GST_QUERY_BUFFERING.
</parameter_description>
</parameter>
-<parameter name="fd">
-<parameter_description> a file descriptor.
+<parameter name="busy">
+<parameter_description> if buffering is busy
+</parameter_description>
+</parameter>
+<parameter name="percent">
+<parameter_description> a buffering percent
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the file descriptor was successfully added to the set.
-
-Since: 0.10.18
-</return>
+<return></return>
</function>
<function name="gst_object_suggest_next_sync">
@@ -22616,9 +23464,6 @@
<function name="gst_check_caps_equal">
<description>
- caps1: first caps to compare
- caps2: second caps to compare
-
Compare two caps with gst_caps_is_equal and fail unless they are
equal.
@@ -22626,6 +23471,14 @@
</description>
<parameters>
+<parameter name="caps1">
+<parameter_description> first caps to compare
+</parameter_description>
+</parameter>
+<parameter name="caps2">
+<parameter_description> second caps to compare
+</parameter_description>
+</parameter>
</parameters>
<return></return>
</function>
@@ -22785,26 +23638,36 @@
</return>
</function>
-<function name="gst_parse_launchv">
+<function name="gst_message_set_buffering_stats">
<description>
-Create a new element based on command line syntax.
- error will contain an error message if an erroneuos pipeline is specified.
-An error does not mean that the pipeline could not be constructed.
+Configures the buffering stats values in @message.
+Since: 0.10.20
</description>
<parameters>
-<parameter name="argv">
-<parameter_description> null-terminated array of arguments
+<parameter name="message">
+<parameter_description> A valid #GstMessage of type GST_MESSAGE_BUFFERING.
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> pointer to a #GError
+<parameter name="mode">
+<parameter_description> a buffering mode
+</parameter_description>
+</parameter>
+<parameter name="avg_in">
+<parameter_description> the average input rate
+</parameter_description>
+</parameter>
+<parameter name="avg_out">
+<parameter_description> the average output rate
+</parameter_description>
+</parameter>
+<parameter name="buffering_left">
+<parameter_description> amount of buffering time left in milliseconds
</parameter_description>
</parameter>
</parameters>
-<return> a new element on success and %NULL on failure.
-</return>
+<return></return>
</function>
<function name="gst_debug_category_get_color">
Modified: gstreamermm/trunk/gstreamer/src/tagsetter.hg
==============================================================================
--- gstreamermm/trunk/gstreamer/src/tagsetter.hg (original)
+++ gstreamermm/trunk/gstreamer/src/tagsetter.hg Thu May 29 02:44:25 2008
@@ -55,7 +55,7 @@
public:
//TODO: Add suitable default value for mode?
- _WRAP_METHOD(void merge_tags(const TagList& list, TagMergeMode mode), gst_tag_setter_merge_tags)
+ _WRAP_METHOD(void merge_tags(const TagList& list, TagMergeMode mode=TAG_MERGE_APPEND), gst_tag_setter_merge_tags)
//TODO: Wrap rest of GstTagStetter methods
};
Modified: gstreamermm/trunk/gstreamerbase/src/gstbase_docs.xml
==============================================================================
--- gstreamermm/trunk/gstreamerbase/src/gstbase_docs.xml (original)
+++ gstreamermm/trunk/gstreamerbase/src/gstbase_docs.xml Thu May 29 02:44:25 2008
@@ -76,8 +76,8 @@
<function name="gst_tuner_list_channels">
<description>
-Retrieve a list of channels (e.g. 'composite', 's-video', ...)
-from the given tuner object.
+Retrieve a #GList of #GstTunerChannels available
+(e.g. 'composite', 's-video', ...) from the given tuner object.
</description>
@@ -87,7 +87,8 @@
</parameter_description>
</parameter>
</parameters>
-<return> a list of channels available on this tuner.
+<return> A list of channels available on this tuner. The list is
+owned by the GstTuner and must not be freed.
</return>
</function>
@@ -464,6 +465,22 @@
</return>
</function>
+<function name="gst_tuner_get_channel">
+<description>
+Retrieve the current channel from the tuner.
+
+
+</description>
+<parameters>
+<parameter name="tuner">
+<parameter_description> the #GstTuner (a #GstElement) to get the current channel from.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the current channel of the tuner object.
+</return>
+</function>
+
<function name="gst_missing_decoder_message_new">
<description>
Creates a missing-plugin message for @element to notify the application
@@ -751,18 +768,23 @@
checked using GST_TUNER_CHANNEL_HAS_FLAG (), with the proper flag
being GST_TUNER_CHANNEL_FREQUENCY.
+The frequency is in Hz, with minimum steps indicated by the
+frequency_multiplicator provided in the #GstTunerChannel. The
+valid range is provided in the min_frequency and max_frequency properties
+of the #GstTunerChannel.
+
</description>
<parameters>
<parameter name="tuner">
-<parameter_description> the #Gsttuner (a #GstElement) that owns the given channel.
+<parameter_description> The #Gsttuner (a #GstElement) that owns the given channel.
</parameter_description>
</parameter>
<parameter name="channel">
-<parameter_description> the #GstTunerChannel to set the frequency on.
+<parameter_description> The #GstTunerChannel to set the frequency on.
</parameter_description>
</parameter>
<parameter name="frequency">
-<parameter_description> the frequency to tune in to.
+<parameter_description> The frequency to tune in to.
</parameter_description>
</parameter>
</parameters>
@@ -851,6 +873,8 @@
<function name="gst_video_format_is_rgb">
<description>
+Determine whether the video format is an RGB format.
+
Since: 0.10.16
@@ -930,19 +954,29 @@
<return></return>
</function>
-<function name="gst_sdp_message_phones_len">
+<function name="gst_audio_clock_new">
<description>
-Get the number of phones in @msg.
+Create a new #GstAudioClock instance. Whenever the clock time should be
+calculated it will call @func with @user_data. When @func returns
+#GST_CLOCK_TIME_NONE, the clock will return the last reported time.
</description>
<parameters>
-<parameter name="msg">
-<parameter_description> a #GstSDPMessage
+<parameter name="name">
+<parameter_description> the name of the clock
+</parameter_description>
+</parameter>
+<parameter name="func">
+<parameter_description> a function
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> user data
</parameter_description>
</parameter>
</parameters>
-<return> the number of phones in @msg.
+<return> a new #GstAudioClock casted to a #GstClock.
</return>
</function>
@@ -1128,6 +1162,33 @@
</return>
</function>
+<function name="gst_color_balance_set_value">
+<description>
+Sets the current value of the channel to the passed value, which must
+be between min_value and max_value.
+
+See Also: The #GstColorBalanceChannel::min_value and
+#GstColorBalanceChannel::max_value members of the
+#GstColorBalanceChannel object.
+
+</description>
+<parameters>
+<parameter name="balance">
+<parameter_description> A #GstColorBalance instance
+</parameter_description>
+</parameter>
+<parameter name="channel">
+<parameter_description> A #GstColorBalanceChannel instance
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> The new value for the channel.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
<function name="gst_rtp_buffer_new_take_data">
<description>
Create a new buffer and set the data and size of the buffer to @data and @len
@@ -1248,23 +1309,25 @@
</return>
</function>
-<function name="gst_sdp_message_get_zone">
+<function name="gst_tuner_get_frequency">
<description>
-Get time zone information with index @idx from @msg.
+Retrieve the current frequency from the given channel. As for
+gst_tuner_set_frequency(), the #GstTunerChannel must support frequency
+operations, as indicated by the GST_TUNER_CHANNEL_FREQUENCY flag.
</description>
<parameters>
-<parameter name="msg">
-<parameter_description> a #GstSDPMessage
+<parameter name="tuner">
+<parameter_description> The #GstTuner (a #GstElement) that owns the given channel.
</parameter_description>
</parameter>
-<parameter name="idx">
-<parameter_description> the zone index
+<parameter name="channel">
+<parameter_description> The #GstTunerChannel to retrieve the frequency from.
</parameter_description>
</parameter>
</parameters>
-<return> a #GstSDPZone.
+<return> The current frequency, or 0 on error.
</return>
</function>
@@ -1346,6 +1409,34 @@
</return>
</function>
+<function name="gst_rtsp_connection_set_auth_param">
+<description>
+Setup @conn with authentication directives. This is not necesary for
+methods #GST_RTSP_AUTH_NONE and #GST_RTSP_AUTH_BASIC. For
+#GST_RTSP_AUTH_DIGEST, directives should be taken from the digest challenge
+in the WWW-Authenticate response header and can include realm, domain,
+nonce, opaque, stale, algorithm, qop as per RFC2617.
+
+Since: 0.10.20
+
+</description>
+<parameters>
+<parameter name="conn">
+<parameter_description> a #GstRTSPConnection
+</parameter_description>
+</parameter>
+<parameter name="param">
+<parameter_description> authentication directive
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> value
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
<function name="gst_base_audio_sink_set_slave_method">
<description>
Controls how clock slaving will be performed in @sink.
@@ -1455,20 +1546,23 @@
</return>
</function>
-<function name="gst_missing_plugin_message_get_description">
+<function name="gst_tuner_channel_changed">
<description>
-Returns: a newly-allocated description string, or NULL on error. Free
+Called by elements implementing the #GstTuner interface when the
+current channel changes. Fires the #GstTuner::channel-changed signal.
</description>
<parameters>
-<parameter name="msg">
-<parameter_description> a missing-plugin #GstMessage of type #GST_MESSAGE_ELEMENT
+<parameter name="tuner">
+<parameter_description> A #GstTuner instance
+</parameter_description>
+</parameter>
+<parameter name="channel">
+<parameter_description> A #GstTunerChannel instance
</parameter_description>
</parameter>
</parameters>
-<return> a newly-allocated description string, or NULL on error. Free
-string with g_free() when not needed any longer.
-</return>
+<return></return>
</function>
<function name="gst_sdp_message_add_email">
@@ -1589,22 +1683,6 @@
</return>
</function>
-<function name="gst_Tuner_get_channel">
-<description>
-Retrieve the current channel from the tuner.
-
-
-</description>
-<parameters>
-<parameter name="tuner">
-<parameter_description> the #GstTuner (a #GstElement) to get the current channel from.
-</parameter_description>
-</parameter>
-</parameters>
-<return> the current channel of the tuner object.
-</return>
-</function>
-
<function name="gst_sdp_message_get_connection">
<description>
Get the connection of @msg.
@@ -1698,6 +1776,27 @@
<return></return>
</function>
+<function name="gst_tuner_find_norm_by_name">
+<description>
+Look up a #GstTunerNorm by name.
+
+
+</description>
+<parameters>
+<parameter name="tuner">
+<parameter_description> A #GstTuner instance
+</parameter_description>
+</parameter>
+<parameter name="norm">
+<parameter_description> A string containing the name of a #GstTunerNorm
+</parameter_description>
+</parameter>
+</parameters>
+<return> A #GstTunerNorm, or NULL if no norm with the provided name
+is available.
+</return>
+</function>
+
<function name="gst_rtsp_base64_decode_ip">
<description>
Decode the base64 string pointed to by @data in-place. When @len is not #NULL
@@ -1797,6 +1896,31 @@
<return></return>
</function>
+<function name="gst_tuner_signal_changed">
+<description>
+Called by elements implementing the #GstTuner interface when the
+incoming signal strength changes. Fires the #GstTuner::signal-changed
+signal on the tuner and the #GstTunerChannel::signal-changed signal on
+the channel.
+
+</description>
+<parameters>
+<parameter name="tuner">
+<parameter_description> A #GstTuner instance
+</parameter_description>
+</parameter>
+<parameter name="channel">
+<parameter_description> The current #GstTunerChannel
+</parameter_description>
+</parameter>
+<parameter name="signal">
+<parameter_description> The new signal strength
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
<function name="gst_video_orientation_get_vcenter">
<description>
Get the vertical centering offset from the given object.
@@ -1836,6 +1960,27 @@
<return></return>
</function>
+<function name="gst_tuner_find_channel_by_name">
+<description>
+Look up a #GstTunerChannel by name.
+
+
+</description>
+<parameters>
+<parameter name="tuner">
+<parameter_description> A #GstTuner instance
+</parameter_description>
+</parameter>
+<parameter name="channel">
+<parameter_description> A string containing the name of a #GstTunerChannel
+</parameter_description>
+</parameter>
+</parameters>
+<return> A #GstTunerChannel, or NULL if no channel with the provided name
+is available.
+</return>
+</function>
+
<function name="gst_install_plugins_context_new">
<description>
Creates a new #GstInstallPluginsContext.
@@ -2060,6 +2205,24 @@
</return>
</function>
+<function name="gst_color_balance_list_channels">
+<description>
+Retrieve a list of the available channels.
+
+
+</description>
+<parameters>
+<parameter name="balance">
+<parameter_description> A #GstColorBalance instance
+</parameter_description>
+</parameter>
+</parameters>
+<return> A GList containing pointers to #GstColorBalanceChannel objects.
+The list is owned by the #GstColorBalance instance and must not
+be freed.
+</return>
+</function>
+
<function name="gst_rtp_buffer_get_csrc_count">
<description>
Get the CSRC count of the RTP packet in @buffer.
@@ -2211,33 +2374,6 @@
<return></return>
</function>
-<function name="gst_video_format_from_rgb32_masks">
-<description>
-Converts red, green, blue bit masks into the corresponding
-#GstVideoFormat.
-
-Since: 0.10.16
-
-
-</description>
-<parameters>
-<parameter name="red_mask">
-<parameter_description> red bit mask
-</parameter_description>
-</parameter>
-<parameter name="green_mask">
-<parameter_description> green bit mask
-</parameter_description>
-</parameter>
-<parameter name="blue_mask">
-<parameter_description> blue bit mask
-</parameter_description>
-</parameter>
-</parameters>
-<return> the #GstVideoFormat corresponding to the bit masks
-</return>
-</function>
-
<function name="gst_missing_encoder_message_new">
<description>
Creates a missing-plugin message for @element to notify the application
@@ -2337,24 +2473,24 @@
</return>
</function>
-<function name="gst_rtsp_transport_parse">
+<function name="GstTunerChannel">
<description>
-Parse the RTSP transport string @str into @transport.
+Reports that the signal strength has changed.
+See Also: gst_tuner_signal_strength()
</description>
<parameters>
-<parameter name="str">
-<parameter_description> a transport string
+<parameter name="tunerchannel">
+<parameter_description> The #GstTunerChannel
</parameter_description>
</parameter>
-<parameter name="transport">
-<parameter_description> a #GstRTSPTransport
+<parameter name="signal">
+<parameter_description> The new signal strength (an integer)
</parameter_description>
</parameter>
</parameters>
-<return> a #GstRTSPResult.
-</return>
+<return></return>
</function>
<function name="gst_video_format_to_fourcc">
@@ -2438,6 +2574,33 @@
<return></return>
</function>
+<function name="gst_tuner_signal_strength">
+<description>
+Get the strength of the signal on this channel. Note that this
+requires the current channel to be a "tuning" channel, i.e. a
+channel on which frequency can be set. This can be checked using
+GST_TUNER_CHANNEL_HAS_FLAG (), and the appropriate flag to check
+for is GST_TUNER_CHANNEL_FREQUENCY.
+
+The valid range of the signal strength is indicated in the
+min_signal and max_signal properties of the #GstTunerChannel.
+
+
+</description>
+<parameters>
+<parameter name="tuner">
+<parameter_description> the #GstTuner (a #GstElement) that owns the given channel.
+</parameter_description>
+</parameter>
+<parameter name="channel">
+<parameter_description> the #GstTunerChannel to get the signal strength from.
+</parameter_description>
+</parameter>
+</parameters>
+<return> Signal strength, or 0 on error.
+</return>
+</function>
+
<function name="gst_sdp_media_add_bandwidth">
<description>
Add the bandwidth information with @bwtype and @bandwidth to @media.
@@ -2507,6 +2670,8 @@
<function name="gst_video_format_is_yuv">
<description>
+Determine whether the video format is a YUV format.
+
Since: 0.10.16
@@ -2568,6 +2733,31 @@
</return>
</function>
+<function name="gst_color_balance_get_value">
+<description>
+Retrieve the current value of the indicated channel, between min_value
+and max_value.
+
+See Also: The #GstColorBalanceChannel::min_value and
+#GstColorBalanceChannel::max_value members of the
+#GstColorBalanceChannel object.
+
+
+</description>
+<parameters>
+<parameter name="balance">
+<parameter_description> A #GstColorBalance instance
+</parameter_description>
+</parameter>
+<parameter name="channel">
+<parameter_description> A #GstColorBalanceChannel instance
+</parameter_description>
+</parameter>
+</parameters>
+<return> The current value of the channel.
+</return>
+</function>
+
<function name="gst_sdp_media_get_bandwidth">
<description>
Get the bandwidth at position @idx in @media.
@@ -2772,6 +2962,26 @@
</return>
</function>
+<function name="gst_tuner_norm_changed">
+<description>
+Called by elements implementing the #GstTuner interface when the
+current norm changes. Fires the #GstTuner::norm-changed signal.
+
+
+</description>
+<parameters>
+<parameter name="tuner">
+<parameter_description> A #GstTuner instance
+</parameter_description>
+</parameter>
+<parameter name="norm">
+<parameter_description> A #GstTunerNorm instance
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
<function name="gst_pb_utils_add_codec_description_to_tag_list">
<description>
Adds a codec tag describing the format specified by @caps to @taglist.
@@ -2865,43 +3075,6 @@
</return>
</function>
-<function name="gst_riff_create_video_caps_with_data">
-<description>
-
-</description>
-<parameters>
-<parameter name="codec_fcc">
-<parameter_description> fourCC codec for this codec.
-</parameter_description>
-</parameter>
-<parameter name="strh">
-<parameter_description> pointer to the strh stream header structure.
-</parameter_description>
-</parameter>
-<parameter name="strf">
-<parameter_description> pointer to the strf stream header structure, including any
-data that is within the range of strf.size, but excluding any
-additional data withint this chunk but outside strf.size.
-</parameter_description>
-</parameter>
-<parameter name="strf_data">
-<parameter_description> a #GstBuffer containing the additional data in the strf
-chunk outside reach of strf.size. Ususally a palette.
-</parameter_description>
-</parameter>
-<parameter name="strd_data">
-<parameter_description> a #GstBuffer containing the data in the strd stream header
-chunk. Usually codec initialization data.
-</parameter_description>
-</parameter>
-<parameter name="codec_name">
-<parameter_description> if given, will be filled with a human-readable codec name.
-</parameter_description>
-</parameter>
-</parameters>
-<return></return>
-</function>
-
<function name="gst_sdp_media_new">
<description>
Allocate a new GstSDPMedia and store the result in @media.
@@ -2934,6 +3107,24 @@
</return>
</function>
+<function name="GstColorBalanceChannel">
+<description>
+Fired when the value of the indicated channel has changed.
+
+</description>
+<parameters>
+<parameter name="channel">
+<parameter_description> The #GstColorBalanceChannel
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> The new value
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
<function name="gst_sdp_message_parse_buffer">
<description>
Parse the contents of @size bytes pointed to by @data and store the result in
@@ -3391,6 +3582,26 @@
<return></return>
</function>
+<function name="str_case_equal">
+<description>
+Compares @v1 and @v2 in a case-insensitive manner
+
+
+</description>
+<parameters>
+<parameter name="v1">
+<parameter_description> an ASCII string
+</parameter_description>
+</parameter>
+<parameter name="v2">
+<parameter_description> another ASCII string
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if they are equal (modulo case)
+</return>
+</function>
+
<function name="gst_sdp_message_set_version">
<description>
Set the version in @msg.
@@ -3587,24 +3798,6 @@
</return>
</function>
-<function name="gst_tuner_get_norms_list">
-<description>
-Retrieve a list of available norms on the currently tuned channel
-from the given tuner object.
-
-
-</description>
-<parameters>
-<parameter name="tuner">
-<parameter_description> the #GstTuner (*a #GstElement) to get the list of norms from.
-</parameter_description>
-</parameter>
-</parameters>
-<return> A list of norms available on the current channel for this
-tuner object.
-</return>
-</function>
-
<function name="gst_rtcp_packet_sdes_add_entry">
<description>
Add a new SDES entry to the current item in @packet.
@@ -4125,15 +4318,15 @@
</description>
<parameters>
<parameter name="caps">
-<parameter_description>
+<parameter_description> pointer to a #GstCaps instance
</parameter_description>
</parameter>
<parameter name="fps_n">
-<parameter_description> pointer to numerator of frame rate (output)
+<parameter_description> pointer to integer to hold numerator of frame rate (output)
</parameter_description>
</parameter>
<parameter name="fps_d">
-<parameter_description> pointer to denominator of frame rate (output)
+<parameter_description> pointer to integer to hold denominator of frame rate (output)
</parameter_description>
</parameter>
</parameters>
@@ -4265,6 +4458,43 @@
</return>
</function>
+<function name="gst_riff_create_video_caps">
+<description>
+
+</description>
+<parameters>
+<parameter name="codec_fcc">
+<parameter_description> fourCC codec for this codec.
+</parameter_description>
+</parameter>
+<parameter name="strh">
+<parameter_description> pointer to the strh stream header structure.
+</parameter_description>
+</parameter>
+<parameter name="strf">
+<parameter_description> pointer to the strf stream header structure, including any
+data that is within the range of strf.size, but excluding any
+additional data withint this chunk but outside strf.size.
+</parameter_description>
+</parameter>
+<parameter name="strf_data">
+<parameter_description> a #GstBuffer containing the additional data in the strf
+chunk outside reach of strf.size. Ususally a palette.
+</parameter_description>
+</parameter>
+<parameter name="strd_data">
+<parameter_description> a #GstBuffer containing the data in the strd stream header
+chunk. Usually codec initialization data.
+</parameter_description>
+</parameter>
+<parameter name="codec_name">
+<parameter_description> if given, will be filled with a human-readable codec name.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
<function name="gst_video_calculate_display_ratio">
<description>
Given the Pixel Aspect Ratio and size of an input video frame, and the
@@ -4642,6 +4872,25 @@
</return>
</function>
+<function name="gst_tuner_list_norms">
+<description>
+Retrieve a GList of available #GstTunerNorm settings for the currently
+tuned channel on the given tuner object.
+
+
+</description>
+<parameters>
+<parameter name="tuner">
+<parameter_description> the #GstTuner (*a #GstElement) to get the list of norms from.
+</parameter_description>
+</parameter>
+</parameters>
+<return> A list of norms available on the current channel for this
+tuner object. The list is owned by the GstTuner and must not
+be freed.
+</return>
+</function>
+
<function name="gst_base_audio_sink_get_provide_clock">
<description>
Queries whether @sink will provide a clock or not. See also
@@ -5118,6 +5367,26 @@
<return></return>
</function>
+<function name="gst_rtsp_transport_parse">
+<description>
+Parse the RTSP transport string @str into @transport.
+
+
+</description>
+<parameters>
+<parameter name="str">
+<parameter_description> a transport string
+</parameter_description>
+</parameter>
+<parameter name="transport">
+<parameter_description> a #GstRTSPTransport
+</parameter_description>
+</parameter>
+</parameters>
+<return> a #GstRTSPResult.
+</return>
+</function>
+
<function name="gst_audio_structure_set_int">
<description>
Do not use anymore.
@@ -5189,6 +5458,34 @@
</return>
</function>
+<function name="gst_video_get_size">
+<description>
+Inspect the caps of the provided pad and retrieve the width and height of
+the video frames it is configured for.
+
+The pad needs to have negotiated caps containing width and height properties.
+
+
+</description>
+<parameters>
+<parameter name="pad">
+<parameter_description> pointer to a #GstPad
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> pointer to integer to hold pixel width of the video frames (output)
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> pointer to integer to hold pixel height of the video frames (output)
+</parameter_description>
+</parameter>
+</parameters>
+<return> TRUE if the width and height could be retrieved.
+
+</return>
+</function>
+
<function name="gst_rtcp_packet_set_rb">
<description>
Set the @nth new report block in @packet with the given values.
@@ -5579,6 +5876,27 @@
</return>
</function>
+<function name="gst_video_frame_rate">
+<description>
+A convenience function to retrieve a GValue holding the framerate
+from the caps on a pad.
+
+The pad needs to have negotiated caps containing a framerate property.
+
+
+</description>
+<parameters>
+<parameter name="pad">
+<parameter_description> pointer to a #GstPad
+</parameter_description>
+</parameter>
+</parameters>
+<return> NULL if the pad has no configured caps or the configured caps
+do not contain a framerate.
+
+</return>
+</function>
+
<function name="gst_rtsp_url_set_port">
<description>
Set the port number in @url to @port.
@@ -5686,11 +6004,33 @@
</parameter_description>
</parameter>
</parameters>
-<return> The type of the GstMixerMessage, or GST_MIXER_MESSAGE_NONE
-if the message is not a GstMixer notification.
-
-Since: 0.10.14
-</return>
+<return> The type of the GstMixerMessage, or GST_MIXER_MESSAGE_NONE
+if the message is not a GstMixer notification.
+
+Since: 0.10.14
+</return>
+</function>
+
+<function name="GstColorBalance">
+<description>
+Fired when the value of the indicated channel has changed.
+
+</description>
+<parameters>
+<parameter name="colorbalance">
+<parameter_description> The GstColorBalance instance
+</parameter_description>
+</parameter>
+<parameter name="channel">
+<parameter_description> The #GstColorBalanceChannel
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> The new value
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
<function name="gst_sdp_message_get_information">
@@ -5750,29 +6090,19 @@
</return>
</function>
-<function name="gst_audio_clock_new">
+<function name="gst_sdp_message_phones_len">
<description>
-Create a new #GstAudioClock instance. Whenever the clock time should be
-calculated it will call @func with @user_data. When @func returns
-#GST_CLOCK_TIME_NONE, the clock will return the last reported time.
+Get the number of phones in @msg.
</description>
<parameters>
-<parameter name="name">
-<parameter_description> the name of the clock
-</parameter_description>
-</parameter>
-<parameter name="func">
-<parameter_description> a function
-</parameter_description>
-</parameter>
-<parameter name="user_data">
-<parameter_description> user data
+<parameter name="msg">
+<parameter_description> a #GstSDPMessage
</parameter_description>
</parameter>
</parameters>
-<return> a new #GstAudioClock casted to a #GstClock.
+<return> the number of phones in @msg.
</return>
</function>
@@ -6218,8 +6548,7 @@
<function name="gst_video_format_has_alpha">
<description>
-Since: 0.10.16
-
+Returns: TRUE if @format has an alpha channel
</description>
<parameters>
@@ -6232,28 +6561,48 @@
</return>
</function>
-<function name="gst_tuner_get_signal_strength">
+<function name="gst_rtsp_connection_clear_auth_params">
<description>
-get the strength of the signal on this channel. Note that this
-requires the current channel to be a "tuning" channel, e.g. a
-channel on which frequency can be set. This can be checked using
-GST_TUNER_CHANNEL_HAS_FLAG (), and the appropriate flag to check
-for is GST_TUNER_CHANNEL_FREQUENCY.
+Clear the list of authentication directives stored in @conn.
+Since: 0.10.20
</description>
<parameters>
-<parameter name="tuner">
-<parameter_description> the #GstTuner (a #GstElement) that owns the given channel.
+<parameter name="conn">
+<parameter_description> a #GstRTSPConnection
</parameter_description>
</parameter>
-<parameter name="channel">
-<parameter_description> the #GstTunerChannel to get the signal strength from.
+</parameters>
+<return></return>
+</function>
+
+<function name="gst_mixer_set_volume">
+<description>
+Sets the volume on each channel in a track. Short note about
+naming: a track is defined as one separate stream owned by
+the mixer/element, such as 'Line-in' or 'Microphone'. A
+channel is said to be a mono-stream inside this track. A
+stereo track thus contains two channels.
+
+</description>
+<parameters>
+<parameter name="mixer">
+<parameter_description> The #GstMixer (a #GstElement) that owns the track.
+</parameter_description>
+</parameter>
+<parameter name="track">
+<parameter_description> The #GstMixerTrack to set the volume on.
+</parameter_description>
+</parameter>
+<parameter name="volumes">
+<parameter_description> an array of integers (of size track-&gt;num_channels)
+that gives the wanted volume for each channel in
+this track.
</parameter_description>
</parameter>
</parameters>
-<return> signal strength, or 0 on error.
-</return>
+<return></return>
</function>
<function name="gst_rtsp_status_as_text">
@@ -6749,7 +7098,7 @@
</description>
<parameters>
<parameter name="caps">
-<parameter_description>
+<parameter_description> pointer to a #GstCaps instance
</parameter_description>
</parameter>
<parameter name="par_n">
@@ -6769,8 +7118,9 @@
<description>
This function is for X11-based applications (such as most Gtk/Qt
applications on linux/unix) only. You can use it to tell the external
-the XID of your main application window, so the installer can make its
-own window transient to your application windonw during the installation.
+installer the XID of your main application window. That way the installer
+can make its own window transient to your application window during the
+installation.
If set, the XID will be passed to the installer via a --transient-for=XID
command line option.
@@ -7342,8 +7692,8 @@
<function name="gst_rtp_buffer_compare_seqnum">
<description>
-Compare two sequence numbers, taking care of wraparounds.
-
+Compare two sequence numbers, taking care of wraparounds. This function
+Returns: a negative value if @seqnum1 is bigger than @seqnum2, 0 if they
</description>
<parameters>
@@ -7356,8 +7706,8 @@
</parameter_description>
</parameter>
</parameters>
-<return> -1 if @seqnum1 is before @seqnum2, 0 if they are equal or 1 if
- seqnum1 is bigger than @segnum2.
+<return> a negative value if @seqnum1 is bigger than @seqnum2, 0 if they
+are equal or a positive value if @seqnum1 is smaller than @segnum2.
Since: 0.10.15
</return>
@@ -7499,6 +7849,27 @@
</return>
</function>
+<function name="gst_audio_clock_reset">
+<description>
+Inform @clock that future calls to #GstAudioClockGetTimeFunc will return values
+starting from @time. The clock will update an internal offset to make sure that
+future calls to internal_time will return an increasing result as required by
+the #GstClock object.
+
+</description>
+<parameters>
+<parameter name="clock">
+<parameter_description> a #GstAudioClock
+</parameter_description>
+</parameter>
+<parameter name="time">
+<parameter_description> a #GstClockTime
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
<function name="gst_fft_next_fast_length">
<description>
Returns: the next fast FFT length.
@@ -7868,24 +8239,23 @@
<return></return>
</function>
-<function name="gst_tuner_get_frequency">
+<function name="gst_sdp_message_get_zone">
<description>
-Retrieve the current frequency from the given channel. The same
-applies as for set_frequency (): check the flag.
+Get time zone information with index @idx from @msg.
</description>
<parameters>
-<parameter name="tuner">
-<parameter_description> the #GstTuner (a #GstElement) that owns the given channel.
+<parameter name="msg">
+<parameter_description> a #GstSDPMessage
</parameter_description>
</parameter>
-<parameter name="channel">
-<parameter_description> the #GstTunerChannel to retrieve the frequency from.
+<parameter name="idx">
+<parameter_description> the zone index
</parameter_description>
</parameter>
</parameters>
-<return> the current frequency, or 0 on error.
+<return> a #GstSDPZone.
</return>
</function>
@@ -8002,29 +8372,29 @@
</return>
</function>
-<function name="gst_fft_f32_new">
+<function name="gst_color_balance_value_changed">
<description>
-This returns a new #GstFFTF32 instance with the given parameters. It makes
-sense to keep one instance for several calls for speed reasons.
-
- len must be even and to get the best performance a product of
-2, 3 and 5. To get the next number with this characteristics use
-gst_fft_next_fast_length().
-
+A helper function called by implementations of the GstColorBalance
+interface. It fires the #GstColorBalance::value-changed signal on the
+instance, and the #GstColorBalanceChannel::value-changed signal on the
+channel object.
</description>
<parameters>
-<parameter name="len">
-<parameter_description> Length of the FFT in the time domain
+<parameter name="balance">
+<parameter_description> A #GstColorBalance instance
</parameter_description>
</parameter>
-<parameter name="inverse">
-<parameter_description> %TRUE if the #GstFFTF32 instance should be used for the inverse FFT
+<parameter name="channel">
+<parameter_description> A #GstColorBalanceChannel whose value has changed
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> The new value of the channel
</parameter_description>
</parameter>
</parameters>
-<return> a new #GstFFTF32 instance.
-</return>
+<return></return>
</function>
<function name="gst_pb_utils_get_sink_description">
@@ -8279,6 +8649,31 @@
</return>
</function>
+<function name="gst_fft_f32_new">
+<description>
+This returns a new #GstFFTF32 instance with the given parameters. It makes
+sense to keep one instance for several calls for speed reasons.
+
+ len must be even and to get the best performance a product of
+2, 3 and 5. To get the next number with this characteristics use
+gst_fft_next_fast_length().
+
+
+</description>
+<parameters>
+<parameter name="len">
+<parameter_description> Length of the FFT in the time domain
+</parameter_description>
+</parameter>
+<parameter name="inverse">
+<parameter_description> %TRUE if the #GstFFTF32 instance should be used for the inverse FFT
+</parameter_description>
+</parameter>
+</parameters>
+<return> a new #GstFFTF32 instance.
+</return>
+</function>
+
<function name="gst_netaddress_set_ip6_address">
<description>
Set @naddr with the IPv6 @address and @port pair.
@@ -8401,6 +8796,24 @@
<return></return>
</function>
+<function name="gst_base_audio_src_get_slave_method">
+<description>
+Get the current slave method used by @src.
+
+
+</description>
+<parameters>
+<parameter name="src">
+<parameter_description> a #GstBaseAudioSrc
+</parameter_description>
+</parameter>
+</parameters>
+<return> The current slave method used by @src.
+
+Since: 0.10.20
+</return>
+</function>
+
<function name="gst_tag_parse_extended_comment">
<description>
Convenience function to parse a GST_TAG_EXTENDED_COMMENT string and
@@ -8513,6 +8926,22 @@
</return>
</function>
+<function name="str_case_hash">
+<description>
+Hashes @key in a case-insensitive manner.
+
+
+</description>
+<parameters>
+<parameter name="key">
+<parameter_description> ASCII string to hash
+</parameter_description>
+</parameter>
+</parameters>
+<return> the hash code.
+</return>
+</function>
+
<function name="gst_is_missing_plugin_message">
<description>
Checks whether @msg is a missing plugins message.
@@ -8633,34 +9062,6 @@
</return>
</function>
-<function name="gst_mixer_set_volume">
-<description>
-Sets the volume on each channel in a track. Short note about
-naming: a track is defined as one separate stream owned by
-the mixer/element, such as 'Line-in' or 'Microphone'. A
-channel is said to be a mono-stream inside this track. A
-stereo track thus contains two channels.
-
-</description>
-<parameters>
-<parameter name="mixer">
-<parameter_description> The #GstMixer (a #GstElement) that owns the track.
-</parameter_description>
-</parameter>
-<parameter name="track">
-<parameter_description> The #GstMixerTrack to set the volume on.
-</parameter_description>
-</parameter>
-<parameter name="volumes">
-<parameter_description> an array of integers (of size track-&gt;num_channels)
-that gives the wanted volume for each channel in
-this track.
-</parameter_description>
-</parameter>
-</parameters>
-<return></return>
-</function>
-
<function name="gst_sdp_media_get_media">
<description>
Get the media description of @media.
@@ -8765,6 +9166,31 @@
</return>
</function>
+<function name="gst_tuner_frequency_changed">
+<description>
+Called by elements implementing the #GstTuner interface when the
+configured frequency changes. Fires the #GstTuner::frequency-changed
+signal on the tuner, and the #GstTunerChannel::frequency-changed signal
+on the channel.
+
+</description>
+<parameters>
+<parameter name="tuner">
+<parameter_description> A #GstTuner instance
+</parameter_description>
+</parameter>
+<parameter name="channel">
+<parameter_description> The current #GstTunerChannel
+</parameter_description>
+</parameter>
+<parameter name="frequency">
+<parameter_description> The new frequency setting
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
<function name="gst_rtcp_packet_bye_add_ssrc">
<description>
Add @ssrc to the BYE @packet.
@@ -8805,6 +9231,22 @@
<return></return>
</function>
+<function name="gst_missing_plugin_message_get_description">
+<description>
+Returns: a newly-allocated description string, or NULL on error. Free
+
+</description>
+<parameters>
+<parameter name="msg">
+<parameter_description> a missing-plugin #GstMessage of type #GST_MESSAGE_ELEMENT
+</parameter_description>
+</parameter>
+</parameters>
+<return> a newly-allocated description string, or NULL on error. Free
+string with g_free() when not needed any longer.
+</return>
+</function>
+
<function name="gst_rtcp_packet_bye_get_reason_len">
<description>
Get the length of the reason string.
@@ -9245,6 +9687,30 @@
</return>
</function>
+<function name="GstTuner">
+<description>
+Reports that the signal strength has changed.
+
+See Also: gst_tuner_signal_strength()
+
+</description>
+<parameters>
+<parameter name="tuner">
+<parameter_description> The element providing the GstTuner interface
+</parameter_description>
+</parameter>
+<parameter name="channel">
+<parameter_description> The current #GstTunerChannel
+</parameter_description>
+</parameter>
+<parameter name="signal">
+<parameter_description> The new signal strength (an integer)
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
<function name="gst_sdp_media_add_format">
<description>
Add the format information to @media.
@@ -9328,6 +9794,26 @@
</return>
</function>
+<function name="gst_base_audio_src_set_slave_method">
+<description>
+Controls how clock slaving will be performed in @src.
+
+Since: 0.10.20
+
+</description>
+<parameters>
+<parameter name="src">
+<parameter_description> a #GstBaseAudioSrc
+</parameter_description>
+</parameter>
+<parameter name="method">
+<parameter_description> the new slave method
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
<function name="gst_ring_buffer_commit_full">
<description>
Commit @in_samples samples pointed to by @data to the ringbuffer @buf.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
