mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-11-26 03:31:05 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs: improve api docs for controlsource and -binding

Browse source
This commit is contained in:
Stefan Sauer 2013-01-10 11:33:42 +01:00
parent e9497b7bf0
commit 06cf9deafe
2 changed files with 14 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
gst/gstcontrolbinding.c
View file

@ -23,7 +23,10 @@
* SECTION:gstcontrolbinding
* @short_description: attachment for control source sources
*
* A value mapping object that attaches control sources to gobject properties.
* A base class for value mapping objects that attaches control sources to gobject
* properties. Such an object is taking one or more #GstControlSource instances,
* combines them and maps the resulting value to the type and value range of the
* bound property.
*/
/* FIXME(ensonic): should we make gst_object_add_control_binding() internal
* - we create the control_binding for a certain object anyway

22
gst/gstcontrolsource.c
View file

@ -25,20 +25,18 @@
* @short_description: base class for control source sources
*
* The #GstControlSource is a base class for control value sources that could
* be used by #GstController to get timestamp-value pairs.
* be used by #GstController to get timestamp-value pairs. A control source
* essentially is a function over time, returning gloat values between 0.0 and 1.0.
*
* A #GstControlSource is used by first getting an instance, binding it to a
* #GParamSpec (for example by using gst_controller_set_control_source()) and
* then by having it used by the #GstController or calling
* gst_control_source_get_value() or gst_control_source_get_value_array().
*
* For implementing a new #GstControlSource one has to implement a
* #GstControlSourceBind method, which will depending on the #GParamSpec set up
* the control source for use and sets the #GstControlSourceGetValue and
* #GstControlSourceGetValueArray functions. These are then used by
* gst_control_source_get_value() or gst_control_source_get_value_array()
* to get values for specific timestamps.
* A #GstControlSource is used by first getting an instance of a specific
* control-source, creating a binding for the control-source to the target property
* of the element and then adding the binding to the element. The binding will
* convert the data types and value range to fit to the bound property.
*
* For implementing a new #GstControlSource one has to implement
* #GstControlSourceGetValue and #GstControlSourceGetValueArray functions.
* These are then used by gst_control_source_get_value() and
* gst_control_source_get_value_array() to get values for specific timestamps.
*/
#include "gst_private.h"