gstreamer/docs/gst/tmpl/gstscheduler.sgml

222 lines
3.3 KiB
Text
Raw Normal View History

<!-- ##### 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_SCHED_PARENT ##### -->
<para>
Get the parent #GstElement of this scheduler.
</para>
@sched: the scheduler to query.
<!-- ##### STRUCT GstScheduleChain ##### -->
<para>
</para>
@sched:
@disabled:
@elements:
@num_elements:
@entry:
@cothreaded_elements:
@schedule:
<!-- ##### MACRO GST_SCHEDULE_SAFETY ##### -->
<para>
Handy macro to check for a non NULL scheduler. The next block of statements
will only be axecuted if the scheduler is not NULL.
</para>
@sched: the scheduler to query.
<!-- ##### MACRO GST_SCHEDULE_ADD_ELEMENT ##### -->
<para>
Fast macro to add an element to the scheduler.
</para>
@sched: The scheduler to add the element to.
@element: The element to add to the scheduler.
<!-- ##### MACRO GST_SCHEDULE_REMOVE_ELEMENT ##### -->
<para>
Fast macro to remove an element from the scheduler.
</para>
@sched: The scheduler to remove the element from.
@element: The element to remove from the scheduler.
<!-- ##### MACRO GST_SCHEDULE_ENABLE_ELEMENT ##### -->
<para>
Fast macro to enable the element in the scheduler.
</para>
@sched: The scheduler.
@element: The element to activate.
<!-- ##### MACRO GST_SCHEDULE_DISABLE_ELEMENT ##### -->
<para>
Fast macro to disable the element.
</para>
@sched: The scheduler.
@element: The element to disable.
<!-- ##### MACRO GST_SCHEDULE_LOCK_ELEMENT ##### -->
<para>
Fast macro to lock a given element.
</para>
@sched: The scheduler.
@element: The element to lock.
<!-- ##### MACRO GST_SCHEDULE_UNLOCK_ELEMENT ##### -->
<para>
Fast macro to unlock a given element.
</para>
@sched: The scheduler.
@element: The element to unlock.
<!-- ##### MACRO GST_SCHEDULE_PAD_CONNECT ##### -->
<para>
Fast macro to connect two pads.
</para>
@sched: The scheduler.
@srcpad: The source pad.
@sinkpad: The sink pad.
<!-- ##### MACRO GST_SCHEDULE_PAD_DISCONNECT ##### -->
<para>
Fast macro to disconnect two pads.
</para>
@sched: The scheduler.
@srcpad: The source pad.
@sinkpad: The sink pad.
<!-- ##### MACRO GST_SCHEDULE_ITERATE ##### -->
<para>
Fast macro to perform one iteration of the scheduler.
</para>
@sched: The scheduler to iterate.
<!-- ##### FUNCTION gst_schedule_new ##### -->
<para>
</para>
@parent:
@Returns:
<!-- ##### FUNCTION gst_schedule_add_element ##### -->
<para>
</para>
@sched:
@element:
<!-- ##### FUNCTION gst_schedule_remove_element ##### -->
<para>
</para>
@sched:
@element:
<!-- ##### FUNCTION gst_schedule_enable_element ##### -->
<para>
</para>
@sched:
@element:
<!-- ##### FUNCTION gst_schedule_disable_element ##### -->
<para>
</para>
@sched:
@element:
<!-- ##### FUNCTION gst_schedule_pad_connect ##### -->
<para>
</para>
@sched:
@srcpad:
@sinkpad:
<!-- ##### FUNCTION gst_schedule_pad_disconnect ##### -->
<para>
</para>
@sched:
@srcpad:
@sinkpad:
<!-- ##### FUNCTION gst_schedule_pad_select ##### -->
<para>
</para>
@sched:
@padlist:
@Returns:
<!-- ##### FUNCTION gst_schedule_iterate ##### -->
<para>
</para>
@sched:
@Returns:
<!-- ##### FUNCTION gst_schedule_show ##### -->
<para>
</para>
@sched: