2000-12-30 16:13:17 +00:00
|
|
|
<!-- ##### SECTION Title ##### -->
|
|
|
|
GstScheduler
|
|
|
|
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
2001-05-27 14:33:30 +00:00
|
|
|
An abstract class for plugable schedulers.
|
2000-12-30 16:13:17 +00:00
|
|
|
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
|
|
<para>
|
2001-10-19 22:49:35 +00:00
|
|
|
This is a base class for custom schedulers.
|
2000-12-30 16:13:17 +00:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
2001-12-28 20:27:59 +00:00
|
|
|
<!-- ##### MACRO GST_SCHEDULER_PARENT ##### -->
|
2001-05-27 14:33:30 +00:00
|
|
|
<para>
|
2001-12-28 20:27:59 +00:00
|
|
|
Get the parent object of this scheduler.
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@sched: the scheduler to get the parent of.
|
|
|
|
|
2001-05-27 14:33:30 +00:00
|
|
|
|
2001-12-28 20:27:59 +00:00
|
|
|
<!-- ##### MACRO GST_SCHEDULER_STATE ##### -->
|
|
|
|
<para>
|
|
|
|
Get the state of the scheduler.
|
2001-05-27 14:33:30 +00:00
|
|
|
</para>
|
|
|
|
|
2001-12-28 20:27:59 +00:00
|
|
|
@sched: the scheduler to get the state of.
|
|
|
|
|
|
|
|
|
2002-01-01 15:59:05 +00:00
|
|
|
<!-- ##### ENUM GstSchedulerState ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@GST_SCHEDULER_STATE_NONE:
|
|
|
|
@GST_SCHEDULER_STATE_RUNNING:
|
|
|
|
@GST_SCHEDULER_STATE_STOPPED:
|
|
|
|
@GST_SCHEDULER_STATE_ERROR:
|
|
|
|
|
|
|
|
<!-- ##### MACRO gst_scheduler_destroy ##### -->
|
|
|
|
<para>
|
|
|
|
Destroy the scheduler
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@sched: The scheduler to destroy.
|
|
|
|
|
|
|
|
|
2001-12-28 20:27:59 +00:00
|
|
|
<!-- ##### FUNCTION gst_scheduler_setup ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@sched:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gst_scheduler_reset ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@sched:
|
2001-05-27 14:33:30 +00:00
|
|
|
|
|
|
|
|
2001-12-09 13:17:13 +00:00
|
|
|
<!-- ##### FUNCTION gst_scheduler_add_element ##### -->
|
2001-05-27 14:33:30 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@sched:
|
2001-12-09 13:17:13 +00:00
|
|
|
@element:
|
2001-05-27 14:33:30 +00:00
|
|
|
|
|
|
|
|
2001-12-09 13:17:13 +00:00
|
|
|
<!-- ##### FUNCTION gst_scheduler_remove_element ##### -->
|
2001-05-27 14:33:30 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
2001-12-09 13:17:13 +00:00
|
|
|
@sched:
|
|
|
|
@element:
|
2001-05-27 14:33:30 +00:00
|
|
|
|
|
|
|
|
2001-12-28 20:27:59 +00:00
|
|
|
<!-- ##### FUNCTION gst_scheduler_state_transition ##### -->
|
2001-05-27 14:33:30 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@sched:
|
|
|
|
@element:
|
2001-12-28 20:27:59 +00:00
|
|
|
@transition:
|
|
|
|
@Returns:
|
2001-05-27 14:33:30 +00:00
|
|
|
|
|
|
|
|
2001-12-28 20:27:59 +00:00
|
|
|
<!-- ##### FUNCTION gst_scheduler_lock_element ##### -->
|
2001-05-27 14:33:30 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@sched:
|
|
|
|
@element:
|
|
|
|
|
|
|
|
|
2001-12-28 20:27:59 +00:00
|
|
|
<!-- ##### FUNCTION gst_scheduler_unlock_element ##### -->
|
2001-05-27 14:33:30 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@sched:
|
2001-12-28 20:27:59 +00:00
|
|
|
@element:
|
2001-05-27 14:33:30 +00:00
|
|
|
|
|
|
|
|
2001-12-28 20:27:59 +00:00
|
|
|
<!-- ##### FUNCTION gst_scheduler_yield ##### -->
|
2001-05-27 14:33:30 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@sched:
|
2001-12-28 20:27:59 +00:00
|
|
|
@element:
|
2001-05-27 14:33:30 +00:00
|
|
|
|
|
|
|
|
2001-12-28 20:27:59 +00:00
|
|
|
<!-- ##### FUNCTION gst_scheduler_interrupt ##### -->
|
2001-05-27 14:33:30 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@sched:
|
2001-12-28 20:27:59 +00:00
|
|
|
@element:
|
2001-12-09 13:17:13 +00:00
|
|
|
@Returns:
|
2001-05-27 14:33:30 +00:00
|
|
|
|
|
|
|
|
2001-12-28 20:27:59 +00:00
|
|
|
<!-- ##### FUNCTION gst_scheduler_error ##### -->
|
2001-05-27 14:33:30 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@sched:
|
2001-12-28 20:27:59 +00:00
|
|
|
@element:
|
2001-05-27 14:33:30 +00:00
|
|
|
|
|
|
|
|
2001-12-28 20:27:59 +00:00
|
|
|
<!-- ##### FUNCTION gst_scheduler_pad_connect ##### -->
|
2001-10-19 22:49:35 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@sched:
|
2001-12-28 20:27:59 +00:00
|
|
|
@srcpad:
|
|
|
|
@sinkpad:
|
2001-10-19 22:49:35 +00:00
|
|
|
|
|
|
|
|
2001-12-28 20:27:59 +00:00
|
|
|
<!-- ##### FUNCTION gst_scheduler_pad_disconnect ##### -->
|
2001-05-27 14:33:30 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@sched:
|
2001-12-28 20:27:59 +00:00
|
|
|
@srcpad:
|
|
|
|
@sinkpad:
|
2001-05-27 14:33:30 +00:00
|
|
|
|
|
|
|
|
2001-12-28 20:27:59 +00:00
|
|
|
<!-- ##### FUNCTION gst_scheduler_pad_select ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@sched:
|
|
|
|
@padlist:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gst_scheduler_iterate ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@sched:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gst_scheduler_show ##### -->
|
2000-12-30 16:13:17 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
2001-05-27 14:33:30 +00:00
|
|
|
@sched:
|
2000-12-30 16:13:17 +00:00
|
|
|
|
|
|
|
|