libs/gst/controller/gstcontroller.c: Clarify docs: The get_all, get_value_array(s) functions don't modify the GObject...

Original commit message from CVS:
* libs/gst/controller/gstcontroller.c:
Clarify docs: The get_all, get_value_array(s) functions
don't modify the GObject properties.
This commit is contained in:
Sebastian Dröge 2007-06-06 14:20:01 +00:00
parent c478fb4813
commit 7b9fb5505f
2 changed files with 12 additions and 0 deletions

View file

@ -1,3 +1,9 @@
2007-06-06 Sebastian Dröge <slomo@circular-chaos.org>
* libs/gst/controller/gstcontroller.c:
Clarify docs: The get_all, get_value_array(s) functions
don't modify the GObject properties.
2007-06-06 Sebastian Dröge <slomo@circular-chaos.org> 2007-06-06 Sebastian Dröge <slomo@circular-chaos.org>
* libs/gst/controller/gstcontroller.c: * libs/gst/controller/gstcontroller.c:

View file

@ -982,6 +982,8 @@ gst_controller_get (GstController * self, gchar * property_name,
* Returns a read-only copy of the list of GstTimedValue for the given property. * Returns a read-only copy of the list of GstTimedValue for the given property.
* Free the list after done with it. * Free the list after done with it.
* *
* <note><para>This doesn't modify the controlled GObject property!</para></note>
*
* Returns: a copy of the list, or %NULL if the property isn't handled by the controller * Returns: a copy of the list, or %NULL if the property isn't handled by the controller
*/ */
const GList * const GList *
@ -1118,6 +1120,8 @@ gst_controller_sync_values (GstController * self, GstClockTime timestamp)
* *
* The types of the values in the array are the same as the property's type. * The types of the values in the array are the same as the property's type.
* *
* <note><para>This doesn't modify the controlled GObject properties!</para></note>
*
* Returns: %TRUE if the given array(s) could be filled, %FALSE otherwise * Returns: %TRUE if the given array(s) could be filled, %FALSE otherwise
*/ */
gboolean gboolean
@ -1151,6 +1155,8 @@ gst_controller_get_value_arrays (GstController * self,
* of values. * of values.
* *
* The type of the values in the array is the same as the property's type. * The type of the values in the array is the same as the property's type.
*
* <note><para>This doesn't modify the controlled GObject property!</para></note>
* *
* Returns: %TRUE if the given array could be filled, %FALSE otherwise * Returns: %TRUE if the given array could be filled, %FALSE otherwise
*/ */