mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-11-23 18:21:04 +00:00
1211e26e59
Original commit message from CVS: docs fixes: comment macros in templates, not in headers (stupid gtk-doc)
267 lines
3.3 KiB
Text
267 lines
3.3 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>
|
|
The state of the scheduler
|
|
</para>
|
|
|
|
@GST_SCHEDULER_STATE_NONE: no state
|
|
@GST_SCHEDULER_STATE_RUNNING: the scheduler is running
|
|
@GST_SCHEDULER_STATE_STOPPED: the scheduler is stopped
|
|
@GST_SCHEDULER_STATE_ERROR: the scheduler is in error
|
|
|
|
<!-- ##### ENUM GstSchedulerFlags ##### -->
|
|
<para>
|
|
Flags for the scheduler
|
|
</para>
|
|
|
|
@GST_SCHEDULER_FLAG_FIXED_CLOCK: The scheduler has a fixed clock
|
|
@GST_SCHEDULER_FLAG_LAST: subclasses can start numbering their flags starting
|
|
from here.
|
|
|
|
<!-- ##### 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_scheduling_change ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@sched:
|
|
@element:
|
|
|
|
|
|
<!-- ##### 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:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_scheduler_interrupt ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@sched:
|
|
@element:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_scheduler_error ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@sched:
|
|
@element:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_scheduler_pad_link ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@sched:
|
|
@srcpad:
|
|
@sinkpad:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_scheduler_pad_unlink ##### -->
|
|
<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:
|
|
@id:
|
|
@jitter:
|
|
@Returns:
|
|
<!-- # Unused Parameters # -->
|
|
@clock:
|
|
@time:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_scheduler_iterate ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@sched:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_scheduler_show ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@sched:
|
|
|
|
|