gstreamer/docs/gst/tmpl/gstscheduler.sgml
Wim Taymans d30487f9d0 Documentation updates
Original commit message from CVS:
Documentation updates
2002-03-31 14:00:33 +00:00

261 lines
3.1 KiB
Text

<!-- ##### SECTION Title ##### -->
GstScheduler
<!-- ##### SECTION Short_Description ##### -->
An abstract class for plugable schedulers.
<!-- ##### SECTION Long_Description ##### -->
<para>
This is a base class for custom schedulers.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### MACRO GST_SCHEDULER_PARENT ##### -->
<para>
Get the parent object of this scheduler.
</para>
@sched: the scheduler to get the parent of.
<!-- ##### MACRO GST_SCHEDULER_STATE ##### -->
<para>
Get the state of the scheduler.
</para>
@sched: the scheduler to get the state of.
<!-- ##### ENUM GstSchedulerState ##### -->
<para>
</para>
@GST_SCHEDULER_STATE_NONE:
@GST_SCHEDULER_STATE_RUNNING:
@GST_SCHEDULER_STATE_STOPPED:
@GST_SCHEDULER_STATE_ERROR:
<!-- ##### ENUM GstSchedulerFlags ##### -->
<para>
</para>
@GST_SCHEDULER_FLAG_FIXED_CLOCK:
@GST_SCHEDULER_FLAG_LAST:
<!-- ##### MACRO gst_scheduler_destroy ##### -->
<para>
Destroy the scheduler
</para>
@sched: The scheduler to destroy.
<!-- ##### FUNCTION gst_scheduler_setup ##### -->
<para>
</para>
@sched:
<!-- ##### FUNCTION gst_scheduler_reset ##### -->
<para>
</para>
@sched:
<!-- ##### FUNCTION gst_scheduler_add_element ##### -->
<para>
</para>
@sched:
@element:
<!-- ##### FUNCTION gst_scheduler_remove_element ##### -->
<para>
</para>
@sched:
@element:
<!-- ##### FUNCTION gst_scheduler_state_transition ##### -->
<para>
</para>
@sched:
@element:
@transition:
@Returns:
<!-- ##### FUNCTION gst_scheduler_lock_element ##### -->
<para>
</para>
@sched:
@element:
<!-- ##### FUNCTION gst_scheduler_unlock_element ##### -->
<para>
</para>
@sched:
@element:
<!-- ##### FUNCTION gst_scheduler_yield ##### -->
<para>
</para>
@sched:
@element:
<!-- ##### FUNCTION gst_scheduler_interrupt ##### -->
<para>
</para>
@sched:
@element:
@Returns:
<!-- ##### FUNCTION gst_scheduler_error ##### -->
<para>
</para>
@sched:
@element:
<!-- ##### FUNCTION gst_scheduler_pad_connect ##### -->
<para>
</para>
@sched:
@srcpad:
@sinkpad:
<!-- ##### FUNCTION gst_scheduler_pad_disconnect ##### -->
<para>
</para>
@sched:
@srcpad:
@sinkpad:
<!-- ##### FUNCTION gst_scheduler_pad_select ##### -->
<para>
</para>
@sched:
@padlist:
@Returns:
<!-- ##### FUNCTION gst_scheduler_add_scheduler ##### -->
<para>
</para>
@sched:
@sched2:
<!-- ##### FUNCTION gst_scheduler_remove_scheduler ##### -->
<para>
</para>
@sched:
@sched2:
<!-- ##### FUNCTION gst_scheduler_auto_clock ##### -->
<para>
</para>
@sched:
<!-- ##### FUNCTION gst_scheduler_get_clock ##### -->
<para>
</para>
@sched:
@Returns:
<!-- ##### FUNCTION gst_scheduler_set_clock ##### -->
<para>
</para>
@sched:
@clock:
<!-- ##### FUNCTION gst_scheduler_use_clock ##### -->
<para>
</para>
@sched:
@clock:
<!-- ##### FUNCTION gst_scheduler_clock_wait ##### -->
<para>
</para>
@sched:
@element:
@clock:
@time:
@Returns:
<!-- ##### FUNCTION gst_scheduler_iterate ##### -->
<para>
</para>
@sched:
@Returns:
<!-- ##### FUNCTION gst_scheduler_show ##### -->
<para>
</para>
@sched: