gstreamer/docs/gst/tmpl/gstscheduler.sgml
David Schleef 1e4ad29e52 docs/gst/gstreamer-docs.sgml: I got tired of the reference manual being such complete crap, that I decided to do majo...
Original commit message from CVS:
* docs/gst/gstreamer-docs.sgml:  I got tired of the reference
manual being such complete crap, that I decided to do major
hacking of it.  This checkin replaces any fine tuning that
may have been done previously, with the benefit of actually
being complete for much of the API that was changed since
0.6.  Further fine tuning will occur shortly.  (bug #134721)
* docs/gst/gstreamer-sections.txt:
* docs/gst/tmpl/GstBin.sgml:
* docs/gst/tmpl/GstBuffer.sgml:
* docs/gst/tmpl/GstCaps.sgml:
* docs/gst/tmpl/GstClock.sgml:
* docs/gst/tmpl/GstCompat.sgml:
* docs/gst/tmpl/GstData.sgml:
* docs/gst/tmpl/GstElement.sgml:
* docs/gst/tmpl/GstEvent.sgml:
* docs/gst/tmpl/GstIndex.sgml:
* docs/gst/tmpl/GstStructure.sgml:
* docs/gst/tmpl/GstTag.sgml:
* docs/gst/tmpl/cothreads.sgml:
* docs/gst/tmpl/cothreads_compat.sgml:
* docs/gst/tmpl/gettext.sgml:
* docs/gst/tmpl/grammar.tab.sgml:
* docs/gst/tmpl/gst-i18n-app.sgml:
* docs/gst/tmpl/gst-i18n-lib.sgml:
* docs/gst/tmpl/gst.sgml:
* docs/gst/tmpl/gst_private.sgml:
* docs/gst/tmpl/gstaggregator.sgml:
* docs/gst/tmpl/gstarch.sgml:
* docs/gst/tmpl/gstatomic.sgml:
* docs/gst/tmpl/gstatomic_impl.sgml:
* docs/gst/tmpl/gstbin.sgml:
* docs/gst/tmpl/gstbuffer.sgml:
* docs/gst/tmpl/gstbufferstore.sgml:
* docs/gst/tmpl/gstcaps.sgml:
* docs/gst/tmpl/gstclock.sgml:
* docs/gst/tmpl/gstcompat.sgml:
* docs/gst/tmpl/gstconfig.sgml:
* docs/gst/tmpl/gstcpu.sgml:
* docs/gst/tmpl/gstdata.sgml:
* docs/gst/tmpl/gstdata_private.sgml:
* docs/gst/tmpl/gstelement.sgml:
* docs/gst/tmpl/gstenumtypes.sgml:
* docs/gst/tmpl/gsterror.sgml:
* docs/gst/tmpl/gstevent.sgml:
* docs/gst/tmpl/gstfakesink.sgml:
* docs/gst/tmpl/gstfakesrc.sgml:
* docs/gst/tmpl/gstfilesink.sgml:
* docs/gst/tmpl/gstfilter.sgml:
* docs/gst/tmpl/gstindex.sgml:
* docs/gst/tmpl/gstinfo.sgml:
* docs/gst/tmpl/gstinterface.sgml:
* docs/gst/tmpl/gstlog.sgml:
* docs/gst/tmpl/gstmacros.sgml:
* docs/gst/tmpl/gstmarshal.sgml:
* docs/gst/tmpl/gstmd5sink.sgml:
* docs/gst/tmpl/gstmultifilesrc.sgml:
* docs/gst/tmpl/gstobject.sgml:
* docs/gst/tmpl/gstpad.sgml:
* docs/gst/tmpl/gstparse.sgml:
* docs/gst/tmpl/gstpipeline.sgml:
* docs/gst/tmpl/gstplugin.sgml:
* docs/gst/tmpl/gstpluginfeature.sgml:
* docs/gst/tmpl/gstqueue.sgml:
* docs/gst/tmpl/gstreamer-unused.sgml:
* docs/gst/tmpl/gstregistry.sgml:
* docs/gst/tmpl/gstregistrypool.sgml:
* docs/gst/tmpl/gstscheduler.sgml:
* docs/gst/tmpl/gstsearchfuncs.sgml:
* docs/gst/tmpl/gstshaper.sgml:
* docs/gst/tmpl/gstspider.sgml:
* docs/gst/tmpl/gstspideridentity.sgml:
* docs/gst/tmpl/gststructure.sgml:
* docs/gst/tmpl/gstsystemclock.sgml:
* docs/gst/tmpl/gsttag.sgml:
* docs/gst/tmpl/gsttaginterface.sgml:
* docs/gst/tmpl/gsttee.sgml:
* docs/gst/tmpl/gstthread.sgml:
* docs/gst/tmpl/gsttrace.sgml:
* docs/gst/tmpl/gsttrashstack.sgml:
* docs/gst/tmpl/gsttypefind.sgml:
* docs/gst/tmpl/gsttypes.sgml:
* docs/gst/tmpl/gsturi.sgml:
* docs/gst/tmpl/gsturitype.sgml:
* docs/gst/tmpl/gstutils.sgml:
* docs/gst/tmpl/gstvalue.sgml:
* docs/gst/tmpl/gstversion.sgml:
* docs/gst/tmpl/gstxml.sgml:
* docs/gst/tmpl/gstxmlregistry.sgml:
* docs/gst/tmpl/gthread-cothreads.sgml:
* docs/gst/tmpl/types.sgml:
2004-03-25 04:20:33 +00:00

395 lines
4.7 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>
<!-- ##### 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.
<!-- ##### 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>
<!-- ##### 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: