NetClientClock#

class NetClientClock(**properties: Any)#

Superclasses: SystemClock, Clock, Object, InitiallyUnowned, Object

Subclasses: NtpClock

NetClientClock implements a custom Clock that synchronizes its time to a remote time provider such as NetTimeProvider. GstNtpClock implements a Clock that synchronizes its time to a remote NTPv4 server.

A new clock is created with new() or new(), which takes the address and port of the remote time provider along with a name and an initial time.

This clock will poll the time provider and will update its calibration parameters based on the local and remote observations.

The “round-trip” property limits the maximum round trip packets can take.

Various parameters of the clock can be configured with the parent Clock “timeout”, “window-size” and “window-threshold” object properties.

A NetClientClock and GstNtpClock is typically set on a Pipeline with use_clock().

If you set a Bus on the clock via the “bus” object property, it will send GST_MESSAGE_ELEMENT messages with an attached Structure containing statistics about clock accuracy and network traffic.

Constructors#

class NetClientClock
classmethod new(name: str | None, remote_address: str, remote_port: int, base_time: int) → Clock#

Create a new NetClientClock that will report the time provided by the NetTimeProvider on remote_address and remote_port.

Parameters:

  • name – a name for the clock

  • remote_address – the address or hostname of the remote clock provider

  • remote_port – the port of the remote clock provider

  • base_time – initial time of the clock

Properties#

class NetClientClock
props.address: str#

The type of the None singleton.

props.base_time: int#

The type of the None singleton.

props.bus: Bus#

The type of the None singleton.

props.internal_clock: Clock#

The type of the None singleton.

props.minimum_update_interval: int#

The type of the None singleton.

props.port: int#

The type of the None singleton.

props.qos_dscp: int#

The type of the None singleton.

props.round_trip_limit: int#

The type of the None singleton.

Fields#

class NetClientClock
clock#
priv#