controlsource: fix GetValue and GetValueArray documentation
authorAurélien Zanelli <aurelien.zanelli@parrot.com>
Wed, 25 Nov 2015 16:36:25 +0000 (17:36 +0100)
committerTim-Philipp Müller <tim@centricular.com>
Fri, 8 Jan 2016 18:24:06 +0000 (18:24 +0000)
GstControlSourceGetValue() value paramater is a gdouble, not a GValue
and GstControlSourceGetValueArray doesn't return a GstValueArray but
an array of double.

https://bugzilla.gnome.org/show_bug.cgi?id=758668

gst/gstcontrolsource.h

index b1b5b1b..4bd9f5c 100644 (file)
@@ -66,7 +66,7 @@ struct _GstTimedValue
  * GstControlSourceGetValue:
  * @self: the #GstControlSource instance
  * @timestamp: timestamp for which a value should be calculated
- * @value: a #GValue which will be set to the result. It must be initialized to the correct type.
+ * @value: a value which will be set to the result.
  *
  * Function for returning a value for a given timestamp.
  *
@@ -95,7 +95,7 @@ typedef gboolean (* GstControlSourceGetValueArray) (GstControlSource *self,
 /**
  * GstControlSource:
  * @get_value: Function for returning a value for a given timestamp
- * @get_value_array: Function for returning a #GstValueArray for a given timestamp
+ * @get_value_array: Function for returning a values array for a given timestamp
  *
  * The instance structure of #GstControlSource.
  */