gstreamer/docs/gst/tmpl/gstclock.sgml

<!-- ##### SECTION Title ##### -->
GstClock

<!-- ##### SECTION Short_Description ##### -->
Abstract class for global clocks

<!-- ##### SECTION Long_Description ##### -->
<para>
GStreamer uses a global clock to synchronise the plugins in a pipeline.
Different clock implementations are possible by implementing this abstract
base class.
</para>
<para>
The clock time is always measured in nanoseconds, with the clock being set
to 0 when the pipeline goes to READY. Usually all renderers sync to the global
clock so that the clock is always a good measure of the time in the pipeline.
</para>

<!-- ##### SECTION See_Also ##### -->
<para>
#GstSystemClock
</para>

<!-- ##### TYPEDEF GstClockTime ##### -->
<para>
A datatype to hold a time, measured in nanoseconds.
</para>


<!-- ##### TYPEDEF GstClockTimeDiff ##### -->
<para>
A datatype to hold a timedifference, measured in nanoseconds.
</para>


<!-- ##### USER_FUNCTION GstClockCallback ##### -->
<para>
The function prototype of the callback.
</para>

@clock: The clock that triggered the callback
@time: The time it was triggered
@id: The id that expired
@user_data: user data passed in the async_wait call


<!-- ##### TYPEDEF GstClockID ##### -->
<para>
A detatype to hold the handle to an outstanding async clock callback
</para>


<!-- ##### ENUM GstClockReturn ##### -->
<para>
The return value of a clock operation.
</para>

@GST_CLOCK_STOPPED: The clock is stopped.
@GST_CLOCK_TIMEOUT: The operation timed out.
@GST_CLOCK_EARLY: The operation was scheduled too late.
@GST_CLOCK_ERROR: An error occured

<!-- ##### MACRO GST_CLOCK_TIME_NONE ##### -->
<para>
Constant to define an undefined clock time
</para>



<!-- ##### MACRO GST_SECOND ##### -->
<para>
Constant that defines one GStreamer second
</para>



<!-- ##### MACRO GST_MSECOND ##### -->
<para>
Constant that defines one GStreamer millisecond
</para>



<!-- ##### MACRO GST_USECOND ##### -->
<para>
Constant that defines one GStreamer microsecond
</para>



<!-- ##### MACRO GST_NSECOND ##### -->
<para>
Constant that defines one GStreamer nanosecond
</para>



<!-- ##### MACRO GST_CLOCK_DIFF ##### -->
<para>
Calculate a difference between to clock times.
</para>

@s: the first time
@e: the second time


<!-- ##### MACRO GST_TIMEVAL_TO_TIME ##### -->
<para>
Convert a GTimeVal to a GstClockTime
</para>

@tv: the timeval to convert


<!-- ##### MACRO GST_TIME_TO_TIMEVAL ##### -->
<para>
Convert a GstClockTime to a GTimeVal
</para>

@t: The GstClockTime to convert
@tv: The target timeval


<!-- ##### STRUCT GstClock ##### -->
<para>
The opaque data structure of the clock.
</para>


<!-- ##### FUNCTION gst_clock_set_speed ##### -->
<para>

</para>

@clock: 
@speed: 


<!-- ##### FUNCTION gst_clock_get_speed ##### -->
<para>

</para>

@clock: 
@Returns: 
<!-- # Unused Parameters # -->
@speed: 


<!-- ##### FUNCTION gst_clock_set_active ##### -->
<para>

</para>

@clock: 
@active: 


<!-- ##### FUNCTION gst_clock_is_active ##### -->
<para>

</para>

@clock: 
@Returns: 


<!-- ##### FUNCTION gst_clock_reset ##### -->
<para>

</para>

@clock: 


<!-- ##### FUNCTION gst_clock_handle_discont ##### -->
<para>

</para>

@clock: 
@time: 
@Returns: 


<!-- ##### FUNCTION gst_clock_async_supported ##### -->
<para>

</para>

@clock: 
@Returns: 


<!-- ##### FUNCTION gst_clock_wait ##### -->
<para>

</para>

@clock: 
@time: 
@jitter: 
@Returns: 


<!-- ##### FUNCTION gst_clock_wait_async ##### -->
<para>

</para>

@clock: 
@time: 
@func: 
@user_data: 
@Returns: 


<!-- ##### FUNCTION gst_clock_cancel_wait_async ##### -->
<para>

</para>

@clock: 
@id: 


<!-- ##### FUNCTION gst_clock_notify_async ##### -->
<para>

</para>

@clock: 
@interval: 
@func: 
@user_data: 
@Returns: 


<!-- ##### FUNCTION gst_clock_remove_notify_async ##### -->
<para>

</para>

@clock: 
@id: 


<!-- ##### FUNCTION gst_clock_wait_id ##### -->
<para>

</para>

@clock: 
@id: 
@jitter: 
@Returns: 


<!-- ##### FUNCTION gst_clock_get_next_id ##### -->
<para>

</para>

@clock: 
@Returns: 


<!-- ##### FUNCTION gst_clock_unlock_id ##### -->
<para>

</para>

@clock: 
@id: 


<!-- ##### FUNCTION gst_clock_get_time ##### -->
<para>

</para>

@clock: 
@Returns: 


<!-- ##### FUNCTION gst_clock_id_get_time ##### -->
<para>

</para>

@id: 
@Returns: 


<!-- ##### FUNCTION gst_clock_get_resolution ##### -->
<para>

</para>

@clock: 
@Returns: 


<!-- ##### FUNCTION gst_clock_set_resolution ##### -->
<para>

</para>

@clock: 
@resolution: