PtpClock

GstPtpClock implements a PTP (IEEE1588:2008) ordinary clock in slave-only mode, that allows a GStreamer pipeline to synchronize to a PTP network clock in some specific domain.

The PTP subsystem can be initialized with gstnet.global.ptpInit, which then starts a helper process to do the actual communication via the PTP ports. This is required as PTP listens on ports < 1024 and thus requires special privileges. Once this helper process is started, the main process will synchronize to all PTP domains that are detected on the selected interfaces.

gstnet.ptp_clock.PtpClock.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 return valid timestamps once the timestamps in the PTP domain are known. To check this, you can use gst.clock.Clock.waitForSync, the GstClock::synced signal and gst.clock.Clock.isSynced.

To gather statistics about the PTP clock synchronization, gstnet.global.ptpStatisticsCallbackAdd can be used. This gives the application the possibility to collect all kinds of statistics from the clock synchronization.

Constructors

this
this(string name, uint domain)

Creates a new PTP clock instance that exports the PTP time of the master clock in domain. This clock can be slaved to other clocks as needed.

Inherited Members

From SystemClock

obtain
gst.clock.Clock obtain()

Get a handle to the default system clock. The refcount of the clock will be increased so you need to unref the clock after usage.

setDefault
void setDefault(gst.clock.Clock newClock)

Sets the default system clock that can be obtained with gst.system_clock.SystemClock.obtain.