2002-01-15 00:41:22 +00:00
|
|
|
<!-- ##### SECTION Title ##### -->
|
|
|
|
GstClock
|
|
|
|
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
2002-03-31 14:00:33 +00:00
|
|
|
Abstract class for global clocks
|
2002-01-15 00:41:22 +00:00
|
|
|
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
|
|
<para>
|
2002-06-12 22:27:18 +00:00
|
|
|
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.
|
2002-01-15 00:41:22 +00:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
|
|
<para>
|
2002-03-31 14:00:33 +00:00
|
|
|
#GstSystemClock
|
2002-01-15 00:41:22 +00:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### TYPEDEF GstClockTime ##### -->
|
|
|
|
<para>
|
2002-06-12 22:27:18 +00:00
|
|
|
A datatype to hold a time, measured in nanoseconds.
|
2002-01-15 00:41:22 +00:00
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### TYPEDEF GstClockTimeDiff ##### -->
|
|
|
|
<para>
|
2002-06-12 22:27:18 +00:00
|
|
|
A datatype to hold a timedifference, measured in nanoseconds.
|
2002-03-31 14:00:33 +00:00
|
|
|
</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>
|
|
|
|
|
2002-01-15 00:41:22 +00:00
|
|
|
|
2002-03-31 14:00:33 +00:00
|
|
|
<!-- ##### ENUM GstClockReturn ##### -->
|
|
|
|
<para>
|
|
|
|
The return value of a clock operation.
|
2002-01-15 00:41:22 +00:00
|
|
|
</para>
|
|
|
|
|
2002-03-31 14:00:33 +00:00
|
|
|
@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
|
2002-01-15 00:41:22 +00:00
|
|
|
|
2002-06-12 22:27:18 +00:00
|
|
|
<!-- ##### 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>
|
|
|
|
|
|
|
|
|
|
|
|
|
2002-01-15 00:41:22 +00:00
|
|
|
<!-- ##### MACRO GST_CLOCK_DIFF ##### -->
|
|
|
|
<para>
|
2002-03-31 14:00:33 +00:00
|
|
|
Calculate a difference between to clock times.
|
2002-01-15 00:41:22 +00:00
|
|
|
</para>
|
|
|
|
|
2002-03-31 14:00:33 +00:00
|
|
|
@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
|
2002-01-15 00:41:22 +00:00
|
|
|
|
|
|
|
|
2002-06-12 22:27:18 +00:00
|
|
|
<!-- ##### MACRO GST_TIME_TO_TIMEVAL ##### -->
|
|
|
|
<para>
|
|
|
|
Convert a GstClockTime to a GTimeVal
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@t: The GstClockTime to convert
|
|
|
|
@tv: The target timeval
|
|
|
|
|
|
|
|
|
2002-01-15 00:41:22 +00:00
|
|
|
<!-- ##### STRUCT GstClock ##### -->
|
|
|
|
<para>
|
2002-03-31 14:00:33 +00:00
|
|
|
The opaque data structure of the clock.
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
2002-06-12 22:27:18 +00:00
|
|
|
<!-- ##### FUNCTION gst_clock_set_speed ##### -->
|
2002-03-31 14:00:33 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@clock:
|
2002-06-12 22:27:18 +00:00
|
|
|
@speed:
|
2002-03-31 14:00:33 +00:00
|
|
|
|
|
|
|
|
2002-06-12 22:27:18 +00:00
|
|
|
<!-- ##### FUNCTION gst_clock_get_speed ##### -->
|
2002-03-31 14:00:33 +00:00
|
|
|
<para>
|
2002-01-15 00:41:22 +00:00
|
|
|
|
|
|
|
</para>
|
|
|
|
|
2002-03-31 14:00:33 +00:00
|
|
|
@clock:
|
|
|
|
@Returns:
|
2002-06-12 22:27:18 +00:00
|
|
|
<!-- # Unused Parameters # -->
|
|
|
|
@speed:
|
2002-03-31 14:00:33 +00:00
|
|
|
|
2002-01-15 00:41:22 +00:00
|
|
|
|
2002-06-12 22:27:18 +00:00
|
|
|
<!-- ##### FUNCTION gst_clock_set_active ##### -->
|
2002-01-15 00:41:22 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
2002-03-31 14:00:33 +00:00
|
|
|
@clock:
|
2002-06-12 22:27:18 +00:00
|
|
|
@active:
|
2002-01-15 00:41:22 +00:00
|
|
|
|
|
|
|
|
2002-06-12 22:27:18 +00:00
|
|
|
<!-- ##### FUNCTION gst_clock_is_active ##### -->
|
2002-01-15 00:41:22 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
2002-03-31 14:00:33 +00:00
|
|
|
@clock:
|
2002-01-15 00:41:22 +00:00
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2002-06-12 22:27:18 +00:00
|
|
|
<!-- ##### FUNCTION gst_clock_reset ##### -->
|
2002-01-15 00:41:22 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@clock:
|
|
|
|
|
|
|
|
|
2002-06-12 22:27:18 +00:00
|
|
|
<!-- ##### FUNCTION gst_clock_handle_discont ##### -->
|
2002-01-15 00:41:22 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@clock:
|
2002-06-12 22:27:18 +00:00
|
|
|
@time:
|
2002-03-31 14:00:33 +00:00
|
|
|
@Returns:
|
2002-01-15 00:41:22 +00:00
|
|
|
|
|
|
|
|
2002-06-12 22:27:18 +00:00
|
|
|
<!-- ##### FUNCTION gst_clock_async_supported ##### -->
|
2002-01-15 00:41:22 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@clock:
|
2002-06-12 22:27:18 +00:00
|
|
|
@Returns:
|
2002-01-15 00:41:22 +00:00
|
|
|
|
|
|
|
|
2002-06-12 22:27:18 +00:00
|
|
|
<!-- ##### FUNCTION gst_clock_wait ##### -->
|
2002-01-15 00:41:22 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@clock:
|
2002-06-12 22:27:18 +00:00
|
|
|
@time:
|
|
|
|
@jitter:
|
|
|
|
@Returns:
|
2002-03-31 14:00:33 +00:00
|
|
|
|
|
|
|
|
2002-06-12 22:27:18 +00:00
|
|
|
<!-- ##### FUNCTION gst_clock_wait_async ##### -->
|
2002-03-31 14:00:33 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@clock:
|
2002-06-12 22:27:18 +00:00
|
|
|
@time:
|
|
|
|
@func:
|
|
|
|
@user_data:
|
2002-03-31 14:00:33 +00:00
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2002-06-12 22:27:18 +00:00
|
|
|
<!-- ##### FUNCTION gst_clock_cancel_wait_async ##### -->
|
2002-03-31 14:00:33 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@clock:
|
2002-06-12 22:27:18 +00:00
|
|
|
@id:
|
2002-03-31 14:00:33 +00:00
|
|
|
|
|
|
|
|
2002-06-12 22:27:18 +00:00
|
|
|
<!-- ##### FUNCTION gst_clock_notify_async ##### -->
|
2002-03-31 14:00:33 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@clock:
|
2002-06-12 22:27:18 +00:00
|
|
|
@interval:
|
|
|
|
@func:
|
|
|
|
@user_data:
|
2002-03-31 14:00:33 +00:00
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2002-06-12 22:27:18 +00:00
|
|
|
<!-- ##### FUNCTION gst_clock_remove_notify_async ##### -->
|
2002-03-31 14:00:33 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
2002-06-12 22:27:18 +00:00
|
|
|
@clock:
|
2002-03-31 14:00:33 +00:00
|
|
|
@id:
|
|
|
|
|
|
|
|
|
2002-06-12 22:27:18 +00:00
|
|
|
<!-- ##### FUNCTION gst_clock_wait_id ##### -->
|
2002-03-31 14:00:33 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@clock:
|
2002-06-12 22:27:18 +00:00
|
|
|
@id:
|
|
|
|
@jitter:
|
2002-03-31 14:00:33 +00:00
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2002-06-12 22:27:18 +00:00
|
|
|
<!-- ##### FUNCTION gst_clock_get_next_id ##### -->
|
2002-03-31 14:00:33 +00:00
|
|
|
<para>
|
2002-01-15 00:41:22 +00:00
|
|
|
|
2002-03-31 14:00:33 +00:00
|
|
|
</para>
|
|
|
|
|
|
|
|
@clock:
|
2002-06-12 22:27:18 +00:00
|
|
|
@Returns:
|
2002-03-31 14:00:33 +00:00
|
|
|
|
|
|
|
|
2002-06-12 22:27:18 +00:00
|
|
|
<!-- ##### FUNCTION gst_clock_unlock_id ##### -->
|
2002-03-31 14:00:33 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@clock:
|
2002-06-12 22:27:18 +00:00
|
|
|
@id:
|
2002-03-31 14:00:33 +00:00
|
|
|
|
|
|
|
|
2002-06-12 22:27:18 +00:00
|
|
|
<!-- ##### FUNCTION gst_clock_get_time ##### -->
|
2002-03-31 14:00:33 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@clock:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2002-06-12 22:27:18 +00:00
|
|
|
<!-- ##### FUNCTION gst_clock_id_get_time ##### -->
|
2002-03-31 14:00:33 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
2002-01-15 00:41:22 +00:00
|
|
|
|
2002-06-12 22:27:18 +00:00
|
|
|
@id:
|
|
|
|
@Returns:
|
2002-03-31 14:00:33 +00:00
|
|
|
|
|
|
|
|
2002-06-12 22:27:18 +00:00
|
|
|
<!-- ##### FUNCTION gst_clock_get_resolution ##### -->
|
2002-01-15 00:41:22 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@clock:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2002-06-12 22:27:18 +00:00
|
|
|
<!-- ##### FUNCTION gst_clock_set_resolution ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@clock:
|
|
|
|
@resolution:
|
|
|
|
|
|
|
|
|