gstreamer/docs/gst/tmpl/gstscheduler.sgml
Stefan Kost 8178973c41 enabled gobject hierarchy in the gtk-doc enabled the GstQueue class in the gtk-doc added a few missing symbols so tha...
Original commit message from CVS:
enabled gobject hierarchy in the gtk-doc
enabled the GstQueue class in the gtk-doc
added a few missing symbols so that the hierachy works
2004-05-14 14:00:04 +00:00

444 lines
5.3 KiB
Text

<!-- ##### SECTION Title ##### -->
GstScheduler
<!-- ##### SECTION Short_Description ##### -->
Abstract class for objects that manage the scheduling of groups of elements
<!-- ##### SECTION Long_Description ##### -->
<para>
This is a base class for custom schedulers.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GstScheduler ##### -->
<para>
</para>
<!-- ##### STRUCT GstSchedulerClass ##### -->
<para>
</para>
@parent_class:
@setup:
@reset:
@add_element:
@remove_element:
@add_scheduler:
@remove_scheduler:
@state_transition:
@scheduling_change:
@lock_element:
@unlock_element:
@yield:
@interrupt:
@error:
@pad_link:
@pad_unlink:
@pad_select:
@clock_wait:
@iterate:
@show:
@object_sync:
@_gst_reserved:
<!-- ##### ENUM GstSchedulerFlags ##### -->
<para>
Flags for the scheduler
</para>
@GST_SCHEDULER_FLAG_FIXED_CLOCK: The scheduler has a fixed clock
@GST_SCHEDULER_FLAG_NEW_API:
@GST_SCHEDULER_FLAG_LAST: subclasses can start numbering their flags starting
from here.
<!-- ##### 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
<!-- ##### 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_add_scheduler ##### -->
<para>
</para>
@sched:
@sched2:
<!-- ##### FUNCTION gst_scheduler_remove_scheduler ##### -->
<para>
</para>
@sched:
@sched2:
<!-- ##### 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_clock_wait ##### -->
<para>
</para>
@sched:
@element:
@id:
@jitter:
@Returns:
<!-- # Unused Parameters # -->
@clock:
@time:
<!-- ##### FUNCTION gst_scheduler_iterate ##### -->
<para>
</para>
@sched:
@Returns:
<!-- ##### FUNCTION gst_scheduler_use_clock ##### -->
<para>
</para>
@sched:
@clock:
<!-- ##### FUNCTION gst_scheduler_set_clock ##### -->
<para>
</para>
@sched:
@clock:
<!-- ##### FUNCTION gst_scheduler_get_clock ##### -->
<para>
</para>
@sched:
@Returns:
<!-- ##### FUNCTION gst_scheduler_auto_clock ##### -->
<para>
</para>
@sched:
<!-- ##### FUNCTION gst_scheduler_show ##### -->
<para>
</para>
@sched:
<!-- ##### MACRO GST_TYPE_SCHEDULER_FACTORY ##### -->
<para>
</para>
<!-- ##### MACRO GST_SCHEDULER_FACTORY ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO GST_IS_SCHEDULER_FACTORY ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO GST_SCHEDULER_FACTORY_CLASS ##### -->
<para>
</para>
@klass:
<!-- ##### MACRO GST_IS_SCHEDULER_FACTORY_CLASS ##### -->
<para>
</para>
@klass:
<!-- # Unused Parameters # -->
@obj:
<!-- ##### MACRO GST_SCHEDULER_FACTORY_GET_CLASS ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO GST_SCHEDULER_DEFAULT_NAME ##### -->
<para>
</para>
<!-- ##### STRUCT GstSchedulerFactory ##### -->
<para>
</para>
<!-- ##### STRUCT GstSchedulerFactoryClass ##### -->
<para>
</para>
@parent:
@_gst_reserved:
<!-- ##### FUNCTION gst_scheduler_factory_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_scheduler_factory_new ##### -->
<para>
</para>
@name:
@longdesc:
@type:
@Returns:
<!-- ##### FUNCTION gst_scheduler_factory_destroy ##### -->
<para>
</para>
@factory:
<!-- ##### FUNCTION gst_scheduler_factory_find ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### FUNCTION gst_scheduler_factory_create ##### -->
<para>
</para>
@factory:
@parent:
@Returns:
<!-- ##### FUNCTION gst_scheduler_factory_make ##### -->
<para>
</para>
@name:
@parent:
@Returns:
<!-- ##### FUNCTION gst_scheduler_factory_set_default_name ##### -->
<para>
</para>
@name:
<!-- ##### FUNCTION gst_scheduler_factory_get_default_name ##### -->
<para>
</para>
@Returns: