diff --git a/gst/gstbin.c b/gst/gstbin.c index 1bac78474e..4d53bc6223 100644 --- a/gst/gstbin.c +++ b/gst/gstbin.c @@ -362,8 +362,18 @@ gst_bin_remove (GstBin * bin, GstElement * element) } } +/** + * gst_bin_child_state_change: + * @bin: #GstBin with the child + * @oldstate: The old child state + * @newstate: The new child state + * @child: #GstElement that signaled an changed state + * + * An internal function to inform the parent bin about a state change + * of a child. + */ void -gst_bin_child_state_change (GstBin *bin, GstElementState old, GstElementState new, +gst_bin_child_state_change (GstBin *bin, GstElementState oldstate, GstElementState newstate, GstElement *child) { gint old_idx = 0, new_idx = 0, i; @@ -394,6 +404,13 @@ gst_bin_child_state_change (GstBin *bin, GstElementState old, GstElementState ne GST_UNLOCK (bin); } +/** + * gst_bin_child_error: + * @bin: #GstBin with the child + * @child: #GstElement that signaled an error + * + * An internal function to inform the parent bin about a failed child. + */ void gst_bin_child_error (GstBin *bin, GstElement *child) { diff --git a/gst/gstelement.c b/gst/gstelement.c index 25001d392f..a92fcd9ccb 100644 --- a/gst/gstelement.c +++ b/gst/gstelement.c @@ -825,6 +825,7 @@ gst_element_error (GstElement *element, const gchar *error, ...) * gst_element_info: * @element: Element with the info * @info: String describing the info + * @...: arguments for the string. * * This function is used internally by elements to signal an info * condition. It results in the "info" signal. @@ -1281,6 +1282,13 @@ gst_element_restore_thyself (xmlNodePtr self, GstObject *parent) } #endif /* GST_DISABLE_LOADSAVE */ +/** + * gst_element_yield: + * @element: Element to yield + * + * Request a yield operation for the child. The scheduler will typically + * give control to another element. + */ void gst_element_yield (GstElement *element) { @@ -1289,6 +1297,16 @@ gst_element_yield (GstElement *element) } } +/** + * gst_element_interrupt: + * @element: Element to interrupt + * + * Request the scheduler of this element to interrupt the execution of + * this element and scheduler another one. + * + * Returns: a boolean indicating that the child should exit its chain/loop/get + * function ASAP, depending on the scheduler implementation. + */ gboolean gst_element_interrupt (GstElement *element) { @@ -1512,6 +1530,7 @@ gst_element_populate_std_props (GObjectClass * klass, * @klass: the class to add the properties to * @first_name: the first in a NULL terminated * 'name', 'id', 'flags' triplet list. + * @...: the triplet list * * Add a list of standardized properties with types to the @klass. * the id is for the property switch in your get_prop method, and diff --git a/gst/gstevent.c b/gst/gstevent.c index 7a4284ff6d..0a88c6abdd 100644 --- a/gst/gstevent.c +++ b/gst/gstevent.c @@ -134,7 +134,8 @@ gst_event_new_seek (GstSeekType type, guint64 offset, gboolean flush) /** * gst_event_new_info: - * @props: The GstProps for this info event + * @firstname: the first property name + * @...: properties * * Allocate a new info event with the given props. * diff --git a/gst/gstscheduler.c b/gst/gstscheduler.c index 66ec27fca5..8bba009c53 100644 --- a/gst/gstscheduler.c +++ b/gst/gstscheduler.c @@ -547,6 +547,12 @@ gst_schedulerfactory_make (const gchar *name, GstElement *parent) return gst_schedulerfactory_create (factory, parent); } +/** + * gst_schedulerfactory_set_default_name: + * @name: the name of the factory used as a default + * + * Set the default schedulerfactory name. + */ void gst_schedulerfactory_set_default_name (const gchar* name) { @@ -556,6 +562,13 @@ gst_schedulerfactory_set_default_name (const gchar* name) _default_name = g_strdup (name); } +/** + * gst_schedulerfactory_get_default_name: + * + * Get the default schedulerfactory name. + * + * Returns: the name of the default scheduler. + */ const gchar* gst_schedulerfactory_get_default_name (void) { diff --git a/gst/gstutils.c b/gst/gstutils.c index 8db8aa2305..14dd8f5b29 100644 --- a/gst/gstutils.c +++ b/gst/gstutils.c @@ -94,11 +94,11 @@ gst_util_get_long_arg (GObject * object, const gchar * argname) } /** - * gst_util_get_long_arg: + * gst_util_get_int64_arg: * @object: the object to query * @argname: the name of the argument * - * Retrieves a property of an object as a long. + * Retrieves a property of an object as an int64. * * Returns: the property of the object */