mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2025-03-30 20:59:44 +00:00
ptpclock: Fix documentation a bit
This commit is contained in:
parent
0c80c41ade
commit
bf62a96549
1 changed files with 5 additions and 13 deletions
|
@ -37,10 +37,8 @@
|
||||||
* gst_ptp_clock_new() then allows to create a GstClock that provides the PTP
|
* gst_ptp_clock_new() then allows to create a GstClock that provides the PTP
|
||||||
* time from a master clock inside a specific PTP domain. This clock will only
|
* time from a master clock inside a specific PTP domain. This clock will only
|
||||||
* return valid timestamps once the timestamps in the PTP domain are known. To
|
* return valid timestamps once the timestamps in the PTP domain are known. To
|
||||||
* check this, the GstPtpClock::internal-clock property and the related
|
* check this, you can use gst_clock_wait_for_sync(), the GstClock::synced
|
||||||
* notify::clock signal can be used. Once the internal clock is not NULL, the
|
* signal and gst_clock_is_synced().
|
||||||
* PTP domain's time is known. Alternatively you can wait for this with
|
|
||||||
* gst_ptp_clock_wait_ready().
|
|
||||||
*
|
*
|
||||||
*
|
*
|
||||||
* To gather statistics about the PTP clock synchronization,
|
* To gather statistics about the PTP clock synchronization,
|
||||||
|
@ -2421,9 +2419,9 @@ gst_ptp_clock_get_internal_time (GstClock * clock)
|
||||||
*
|
*
|
||||||
* This clock only returns valid timestamps after it received the first
|
* This clock only returns valid timestamps after it received the first
|
||||||
* times from the PTP master clock on the network. Once this happens the
|
* times from the PTP master clock on the network. Once this happens the
|
||||||
* GstPtpClock::internal-clock property will become non-NULL. You can connect
|
* GstPtpClock::internal-clock property will become non-NULL. You can
|
||||||
* to the notify::internal-clock signal to get notified about this, or
|
* check this with gst_clock_wait_for_sync(), the GstClock::synced signal and
|
||||||
* alternatively use gst_ptp_clock_wait_ready() to wait for this to happen.
|
* gst_clock_is_synced().
|
||||||
*
|
*
|
||||||
* Since: 1.6
|
* Since: 1.6
|
||||||
*/
|
*/
|
||||||
|
@ -2562,12 +2560,6 @@ gst_ptp_clock_new (const gchar * name, guint domain)
|
||||||
return NULL;
|
return NULL;
|
||||||
}
|
}
|
||||||
|
|
||||||
gboolean
|
|
||||||
gst_ptp_clock_wait_ready (GstPtpClock * self, GstClockTime timeout)
|
|
||||||
{
|
|
||||||
return FALSE;
|
|
||||||
}
|
|
||||||
|
|
||||||
gulong
|
gulong
|
||||||
gst_ptp_statistics_callback_add (GstPtpStatisticsCallback callback,
|
gst_ptp_statistics_callback_add (GstPtpStatisticsCallback callback,
|
||||||
gpointer user_data, GDestroyNotify destroy_data)
|
gpointer user_data, GDestroyNotify destroy_data)
|
||||||
|
|
Loading…
Reference in a new issue