*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
*/
/**
* @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 to get timestamp-value pairs. A control source essentially is a
+ * function over time, returning float 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"
*
* Gets the value for this #GstControlSource at a given timestamp.
*
- * Returns: FALSE if the value couldn't be returned, TRUE otherwise.
+ * Returns: %FALSE if the value couldn't be returned, %TRUE otherwise.
*/
gboolean
gst_control_source_get_value (GstControlSource * self, GstClockTime timestamp,
* @timestamp: the first timestamp
* @interval: the time steps
* @n_values: the number of values to fetch
- * @value_array: array to put control-values in
+ * @values: array to put control-values in
*
- * Gets an array of values for for this #GstControlSource.
+ * Gets an array of values for for this #GstControlSource. Values that are
+ * undefined contain NANs.
*
* Returns: %TRUE if the given array could be filled, %FALSE otherwise
*/