docs: update the controller docs

Add the control bindings to the docs. Add a little more detail.
This commit is contained in:
Stefan Sauer 2013-02-01 21:59:41 +01:00
parent bbf77402f0
commit fba696eb05
6 changed files with 52 additions and 5 deletions

View file

@ -56,6 +56,9 @@
element properties over time. element properties over time.
</para> </para>
<xi:include href="xml/gstargbcontrolbinding.xml" />
<xi:include href="xml/gstdirectcontrolbinding.xml" />
<xi:include href="xml/gsttimedvaluecontrolsource.xml" /> <xi:include href="xml/gsttimedvaluecontrolsource.xml" />
<xi:include href="xml/gstinterpolationcontrolsource.xml" /> <xi:include href="xml/gstinterpolationcontrolsource.xml" />
<xi:include href="xml/gstlfocontrolsource.xml" /> <xi:include href="xml/gstlfocontrolsource.xml" />

View file

@ -13,6 +13,44 @@
# <SUBSECTION Private> # <SUBSECTION Private>
# </SECTION> # </SECTION>
# control binding classes
<SECTION>
<FILE>gstargbcontrolbinding</FILE>
<TITLE>GstARGBControlBinding</TITLE>
<INCLUDE>libs/controller/gstargbcontrolbinding.h</INCLUDE>
gst_argb_control_binding_new
<SUBSECTION Standard>
GstARGBControlBinding
GstARGBControlBindingClass
GST_ARGB_CONTROL_BINDING
GST_ARGB_CONTROL_BINDING_CLASS
GST_ARGB_CONTROL_BINDING_GET_CLASS
GST_IS_ARGB_CONTROL_BINDING
GST_IS_ARGB_CONTROL_BINDING_CLASS
GST_TYPE_ARGB_CONTROL_BINDING
gst_argb_control_binding_get_type
</SECTION>
<SECTION>
<FILE>gstdirectcontrolbinding</FILE>
<TITLE>GstDirectControlBinding</TITLE>
<INCLUDE>libs/controller/gstdirectcontrolbinding.h</INCLUDE>
gst_direct_control_binding_new
<SUBSECTION Standard>
GstDirectControlBindingConvertValue
GstDirectControlBindingConvertGValue
GstDirectControlBinding
GstDirectControlBindingClass
GST_DIRECT_CONTROL_BINDING
GST_DIRECT_CONTROL_BINDING_CLASS
GST_DIRECT_CONTROL_BINDING_GET_CLASS
GST_IS_DIRECT_CONTROL_BINDING
GST_IS_DIRECT_CONTROL_BINDING_CLASS
GST_TYPE_DIRECT_CONTROL_BINDING
gst_direct_control_binding_get_type
</SECTION>
# control source classes # control source classes
<SECTION> <SECTION>

View file

@ -18,11 +18,15 @@ gst_push_src_get_type
% controller % controller
#include <gst/controller/gstargbcontrolbinding.h>
#include <gst/controller/gstdirectcontrolbinding.h>
#include <gst/controller/gsttimedvaluecontrolsource.h> #include <gst/controller/gsttimedvaluecontrolsource.h>
#include <gst/controller/gstinterpolationcontrolsource.h> #include <gst/controller/gstinterpolationcontrolsource.h>
#include <gst/controller/gstlfocontrolsource.h> #include <gst/controller/gstlfocontrolsource.h>
#include <gst/controller/gsttriggercontrolsource.h> #include <gst/controller/gsttriggercontrolsource.h>
gst_argb_control_binding_get_type
gst_direct_control_binding_get_type
gst_timed_value_control_source_get_type gst_timed_value_control_source_get_type
gst_interpolation_control_source_get_type gst_interpolation_control_source_get_type
gst_lfo_control_source_get_type gst_lfo_control_source_get_type

View file

@ -294,7 +294,7 @@ gst_control_binding_get_value (GstControlBinding * binding,
* *
* The values are unboxed and ready to be used. The similar function * The values are unboxed and ready to be used. The similar function
* gst_control_binding_get_g_value_array() returns the array as #GValues and is * gst_control_binding_get_g_value_array() returns the array as #GValues and is
* better suites for bindings. * more suitable for bindings.
* *
* Returns: %TRUE if the given array could be filled, %FALSE otherwise * Returns: %TRUE if the given array could be filled, %FALSE otherwise
*/ */

View file

@ -22,10 +22,11 @@
*/ */
/** /**
* SECTION:gstargbcontrolbinding * SECTION:gstargbcontrolbinding
* @short_description: attachment for control source sources to argb properties * @short_description: attachment for control sources to argb properties
* *
* A value mapping object that attaches multiple control sources to a guint * A value mapping object that attaches multiple control sources to a guint
* gobject properties representing a color. * gobject properties representing a color. A control value of 0.0 will turn the
* color component off and a value of 1.0 will be the color level.
*/ */
#include <glib-object.h> #include <glib-object.h>

View file

@ -21,9 +21,10 @@
*/ */
/** /**
* SECTION:gstdirectcontrolbinding * SECTION:gstdirectcontrolbinding
* @short_description: direct attachment for control source sources * @short_description: direct attachment for control sources
* *
* A value mapping object that attaches control sources to gobject properties. * A value mapping object that attaches control sources to gobject properties. It
* will map the control values [0.0 ... 1.0] to the target property range.
*/ */