docs: update the controller docs

Add the control bindings to the docs. Add a little more detail.

diff --git a/docs/libs/gstreamer-libs-docs.sgml b/docs/libs/gstreamer-libs-docs.sgml
index f8dfc6b952f59d831f2712d40c2e64ea9b7f64a5..92d25fb08951a3e48ece371026d7781124522277 100644 (file)
--- a/docs/libs/gstreamer-libs-docs.sgml
+++ b/docs/libs/gstreamer-libs-docs.sgml
@@ -56,6 +56,9 @@
         element properties over time.
       </para>
 
+                       <xi:include href="xml/gstargbcontrolbinding.xml" />
+                       <xi:include href="xml/gstdirectcontrolbinding.xml" />
+
       <xi:include href="xml/gsttimedvaluecontrolsource.xml" />
       <xi:include href="xml/gstinterpolationcontrolsource.xml" />
       <xi:include href="xml/gstlfocontrolsource.xml" />

diff --git a/docs/libs/gstreamer-libs-sections.txt b/docs/libs/gstreamer-libs-sections.txt
index 1dd957c12c25be6ff6276f7de8335d163a67cfe5..5c683ac0eba343d9289410987c6e30ad3e9c7f14 100644 (file)
--- a/docs/libs/gstreamer-libs-sections.txt
+++ b/docs/libs/gstreamer-libs-sections.txt
@@ -13,6 +13,44 @@
 # <SUBSECTION Private>
 # </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
 
 <SECTION>

diff --git a/docs/libs/gstreamer-libs.types b/docs/libs/gstreamer-libs.types
index 498019110998b8108b40ba4e5297ab8f52460bc5..8681c4cdd6ecbba184251c757151cad07a4ad70a 100644 (file)
--- a/docs/libs/gstreamer-libs.types
+++ b/docs/libs/gstreamer-libs.types
@@ -18,11 +18,15 @@ gst_push_src_get_type
 
 % controller
 
+#include <gst/controller/gstargbcontrolbinding.h>
+#include <gst/controller/gstdirectcontrolbinding.h>
 #include <gst/controller/gsttimedvaluecontrolsource.h>
 #include <gst/controller/gstinterpolationcontrolsource.h>
 #include <gst/controller/gstlfocontrolsource.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_interpolation_control_source_get_type
 gst_lfo_control_source_get_type

diff --git a/gst/gstcontrolbinding.c b/gst/gstcontrolbinding.c
index 67a7f7d61455e6d6aec0a7344c2fb28c5c7e37aa..3868dc774b5d12e8964f5e78d30282037df4e08d 100644 (file)
--- a/gst/gstcontrolbinding.c
+++ b/gst/gstcontrolbinding.c
@@ -294,7 +294,7 @@ gst_control_binding_get_value (GstControlBinding * binding,
  *
  * 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
- * better suites for bindings.
+ * more suitable for bindings.
  *
  * Returns: %TRUE if the given array could be filled, %FALSE otherwise
  */

diff --git a/libs/gst/controller/gstargbcontrolbinding.c b/libs/gst/controller/gstargbcontrolbinding.c
index 61cf4426117cef14ff7bd70778f6d5771c069dfa..3bb04c170a142914c889a2e038929e4530ea1084 100644 (file)
--- a/libs/gst/controller/gstargbcontrolbinding.c
+++ b/libs/gst/controller/gstargbcontrolbinding.c
@@ -22,10 +22,11 @@
  */
 /**
  * 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
- * 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>

diff --git a/libs/gst/controller/gstdirectcontrolbinding.c b/libs/gst/controller/gstdirectcontrolbinding.c
index ae9fe9741160f2e21148428dd22acbf5a495ea31..7daaed321fd16d5b637c0f35c151585fc509bfab 100644 (file)
--- a/libs/gst/controller/gstdirectcontrolbinding.c
+++ b/libs/gst/controller/gstdirectcontrolbinding.c
@@ -21,9 +21,10 @@
  */
 /**
  * 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. 
  */