struct GstScheduler

struct GstScheduler;

enum GstSchedulerFlags

typedef enum {
  /* this scheduler works with a fixed clock */
  GST_SCHEDULER_FLAG_FIXED_CLOCK	= GST_OBJECT_FLAG_LAST,
  /* this scheduler supports select and lock calls */
  GST_SCHEDULER_FLAG_NEW_API,

  /* padding */
  GST_SCHEDULER_FLAG_LAST 		= GST_OBJECT_FLAG_LAST + 4
} GstSchedulerFlags;

Flags for the scheduler

GST_SCHEDULER_PARENT()

#define GST_SCHEDULER_PARENT(sched)		((sched)->parent)

Get the parent object of this scheduler.

GST_SCHEDULER_STATE()

#define GST_SCHEDULER_STATE(sched)		((sched)->state)

Get the state of the scheduler.

enum GstSchedulerState

typedef enum {
  GST_SCHEDULER_STATE_NONE,
  GST_SCHEDULER_STATE_RUNNING,
  GST_SCHEDULER_STATE_STOPPED,
  GST_SCHEDULER_STATE_ERROR
} GstSchedulerState;

The state of the scheduler

gst_scheduler_setup ()

void        gst_scheduler_setup             (GstScheduler *sched);

Prepare the scheduler.

gst_scheduler_reset ()

void        gst_scheduler_reset             (GstScheduler *sched);

Reset the schedulers.

gst_scheduler_add_element ()

void        gst_scheduler_add_element       (GstScheduler *sched,
                                             GstElement *element);

Add an element to the scheduler.

gst_scheduler_remove_element ()

void        gst_scheduler_remove_element    (GstScheduler *sched,
                                             GstElement *element);

Remove an element from the scheduler.

gst_scheduler_add_scheduler ()

void        gst_scheduler_add_scheduler     (GstScheduler *sched,
                                             GstScheduler *sched2);

Notifies the scheduler that it has to monitor this scheduler.

gst_scheduler_remove_scheduler ()

void        gst_scheduler_remove_scheduler  (GstScheduler *sched,
                                             GstScheduler *sched2);

a Notifies the scheduler that it can stop monitoring this scheduler.

gst_scheduler_state_transition ()

GstElementStateReturn gst_scheduler_state_transition
                                            (GstScheduler *sched,
                                             GstElement *element,
                                             gint transition);

Tell the scheduler that an element changed its state.

gst_scheduler_scheduling_change ()

void        gst_scheduler_scheduling_change (GstScheduler *sched,
                                             GstElement *element);

Tell the scheduler that an element changed its scheduling strategy. An element could, for example, change its loop function or changes from a loop based element to a chain based element.

gst_scheduler_lock_element ()

void        gst_scheduler_lock_element      (GstScheduler *sched,
                                             GstElement *element);

Acquire a lock on the given element in the given scheduler.

gst_scheduler_unlock_element ()

void        gst_scheduler_unlock_element    (GstScheduler *sched,
                                             GstElement *element);

Release the lock on the given element in the given scheduler.

gst_scheduler_yield ()

gboolean    gst_scheduler_yield             (GstScheduler *sched,
                                             GstElement *element);

Tell the scheduler to schedule another element.

gst_scheduler_interrupt ()

gboolean    gst_scheduler_interrupt         (GstScheduler *sched,
                                             GstElement *element);

Tell the scheduler to interrupt execution of this element.

gst_scheduler_error ()

void        gst_scheduler_error             (GstScheduler *sched,
                                             GstElement *element);

Tell the scheduler an element was in error

gst_scheduler_pad_link ()

void        gst_scheduler_pad_link          (GstScheduler *sched,
                                             GstPad *srcpad,
                                             GstPad *sinkpad);

Links the srcpad to the given sinkpad.

gst_scheduler_pad_unlink ()

void        gst_scheduler_pad_unlink        (GstScheduler *sched,
                                             GstPad *srcpad,
                                             GstPad *sinkpad);

Unlinks the srcpad from the given sinkpad.

gst_scheduler_pad_select ()

GstPad*     gst_scheduler_pad_select        (GstScheduler *sched,
                                             GList *padlist);

register the given padlist for a select operation.

gst_scheduler_clock_wait ()

GstClockReturn gst_scheduler_clock_wait     (GstScheduler *sched,
                                             GstElement *element,
                                             GstClockID id,
                                             GstClockTimeDiff *jitter);

Wait till the clock reaches a specific time. The ClockID can be obtained from gst_clock_new_single_shot_id.

gst_scheduler_iterate ()

gboolean    gst_scheduler_iterate           (GstScheduler *sched);

Perform one iteration on the scheduler.

gst_scheduler_use_clock ()

void        gst_scheduler_use_clock         (GstScheduler *sched,
                                             GstClock *clock);

Force the scheduler to use the given clock. The scheduler will always use the given clock even if new clock providers are added to this scheduler.

gst_scheduler_set_clock ()

void        gst_scheduler_set_clock         (GstScheduler *sched,
                                             GstClock *clock);

Set the clock for the scheduler. The clock will be distributed to all the elements managed by the scheduler.

gst_scheduler_get_clock ()

GstClock*   gst_scheduler_get_clock         (GstScheduler *sched);

Gets the current clock used by the scheduler.

gst_scheduler_auto_clock ()

void        gst_scheduler_auto_clock        (GstScheduler *sched);

Let the scheduler select a clock automatically.

gst_scheduler_show ()

void        gst_scheduler_show              (GstScheduler *sched);

Dump the state of the scheduler

GST_SCHEDULER_DEFAULT_NAME

#define GST_SCHEDULER_DEFAULT_NAME	"opt"