summaryrefslogtreecommitdiff
path: root/gst/gstscheduler.c
diff options
context:
space:
mode:
authorWim Taymans <wim.taymans@gmail.com>2001-12-09 13:17:54 +0000
committerWim Taymans <wim.taymans@gmail.com>2001-12-09 13:17:54 +0000
commitf4c17c3ba15d87bdc02e6d9abc89a603631572c4 (patch)
tree31a19cabf5b414cb80b46b555db72f5df00389fc /gst/gstscheduler.c
parent3e5a0a6d725209e28b0f4f427b6d844712b5e772 (diff)
downloadgstreamer-f4c17c3ba15d87bdc02e6d9abc89a603631572c4.tar.gz
Added some more docs
Original commit message from CVS: Added some more docs
Diffstat (limited to 'gst/gstscheduler.c')
-rw-r--r--gst/gstscheduler.c20
1 files changed, 18 insertions, 2 deletions
diff --git a/gst/gstscheduler.c b/gst/gstscheduler.c
index d11c93410c..7166646003 100644
--- a/gst/gstscheduler.c
+++ b/gst/gstscheduler.c
@@ -169,6 +169,13 @@ gst_scheduler_remove_element (GstScheduler *sched, GstElement *element)
CLASS (sched)->remove_element (sched, element);
}
+/**
+ * gst_scheduler_lock_element:
+ * @sched: the schedulerr
+ * @element: the element to lock
+ *
+ * Acquire a lock on the given element in the given scheduler.
+ */
void
gst_scheduler_lock_element (GstScheduler *sched, GstElement *element)
{
@@ -176,6 +183,13 @@ gst_scheduler_lock_element (GstScheduler *sched, GstElement *element)
CLASS (sched)->lock_element (sched, element);
}
+/**
+ * gst_scheduler_unlock_element:
+ * @sched: the schedulerr
+ * @element: the element to unlock
+ *
+ * Release the lock on the given element in the given scheduler.
+ */
void
gst_scheduler_unlock_element (GstScheduler *sched, GstElement *element)
{
@@ -373,9 +387,10 @@ gst_schedulerfactory_get_list (void)
/**
* gst_schedulerfactory_create:
* @factory: the factory used to create the instance
+ * @parent: the parent element of this scheduler
*
* Create a new #GstScheduler instance from the
- * given schedulerfactory.
+ * given schedulerfactory with the given parent.
*
* Returns: A new #GstScheduler instance.
*/
@@ -399,9 +414,10 @@ gst_schedulerfactory_create (GstSchedulerFactory *factory, GstElement *parent)
/**
* gst_schedulerfactory_make:
* @name: the name of the factory used to create the instance
+ * @parent: the parent element of this scheduler
*
* Create a new #GstScheduler instance from the
- * schedulerfactory with the given name.
+ * schedulerfactory with the given name and parent.
*
* Returns: A new #GstScheduler instance.
*/