ClockID

Object Hierarchy:

Description:

public class ClockID

A datatype to hold the handle to an outstanding sync or async clock callback.

Namespace: Gst

Package: gstreamer-0.10

Content:

Static methods:

public static int compare_func (void* id1, void* id2)
Compares the two ClockID instances. This function can be used as a GCompareFunc when sorting ids. MT safe.

Creation methods:

public ClockID.periodic (Clock clock, ClockTime start_time, ClockTime interval)
Get an ID from clock to trigger a periodic notification. The periodic notifications will start at time start_time and will then be fired with the given interval. id should be unreffed after usage. time notification. MT safe.
public ClockID.single_shot (Clock clock, ClockTime time)
Get a ClockID from clock to trigger a single shot notification at the requested time. The single shot id should be unreffed after usage. time notification. MT safe.

Methods:

public ClockTime get_time ()
Get the time of the clock ID MT safe.
public void unschedule ()
Cancel an outstanding request with id. This can either be an outstanding async notification or a pending sync notification. After this call, id cannot be used anymore to receive sync or async notifications, you need to create a new ClockID. MT safe.
public ClockReturn wait (out ClockTimeDiff jitter)
Perform a blocking wait on id. or ClockID.periodic and should not have been unscheduled with a call to unschedule. If the jitter argument is not null and this function returns OK or EARLY, it will contain the difference against the clock and the time of id when this method was called. Positive values indicate how late id was relative to the clock (in which case this function will return EARLY). Negative values indicate how much time was spent waiting on the clock before this function returned. if the current clock time is past the time of id, OK if unscheduled with unschedule. MT safe.
public ClockReturn wait_async (ClockCallback func)
Register a callback on the given ClockID id with the given function and user_data. When passing a ClockID with an invalid time to this function, the callback will be called immediately with a time set to GST_CLOCK_TIME_NONE. The callback will be called when the time of id has been reached. The callback func can be invoked from any thread, either provided by the core or from a streaming thread. The application should be prepared for this. MT safe.
public ClockReturn wait_async_full (ClockCallback func, DestroyNotify destroy_data)
Register a callback on the given ClockID id with the given function and user_data. When passing a ClockID with an invalid time to this function, the callback will be called immediately with a time set to GST_CLOCK_TIME_NONE. The callback will be called when the time of id has been reached. The callback func can be invoked from any thread, either provided by the core or from a streaming thread. The application should be prepared for this. MT safe.