unreal.LiveLinkOpenTrackIOSynchronization

class unreal.LiveLinkOpenTrackIOSynchronization(locked: bool = False, source: str = '', frequency: LiveLinkOpenTrackIOFrameRate = Ellipsis, offsets: LiveLinkOpenTrackIOSynchronizationOffsets = Ellipsis, present: bool = False, ptp: LiveLinkOpenTrackIO_PTP = Ellipsis)

Bases: StructBase

Object describing how the tracking device is synchronized for this sample.

frequency:

The frequency of a synchronization signal.This may differ from the sample frame rate for example in a genlocked tracking device. This is not required if the synchronization source is PTP or NTP.

locked: Is the tracking device locked to the synchronization source

offsets: Offsets in seconds between sync and sample. Critical for e.g.

frame remapping, or when using different data sources for position/rotation and lens encoding

present: Is the synchronization source present (a synchronization source can be present but not locked if frame rates differ)

ptp: If the synchronization source is a PTP leader, then this object

contains:

  • “profile”: Specifies the PTP profile in use. This defines the operational rules and parameters for synchronization. For example “SMPTE

ST2059-2:2021” for SMPTE 2110 based systems, or “IEEE Std 1588-2019” or “IEEE Std 802.1AS-2020” for industrial applications

  • “domain”: Identifies the PTP domain the device belongs to. Devices in the same domain can synchronize with each other

  • “leaderIdentity”: The unique identifier (usually MAC address) of the current PTP leader

  • “leaderPriorities”: The priority values of the leader used in the Best Clock Algorithm (BMCA). Lower values indicate higher priority

  • “priority1”: Static priority set by the administrator

  • “priority2”: Dynamic priority based on the leader’s role or clock quality

  • “leaderAccuracy”: The timing offset in seconds from the sample timestamp to the PTP timestamp

  • “meanPathDelay”: The average round-trip delay between the device and the PTP leader, measured in seconds

source: The source of synchronization must be defined as one of the

following:

  • “vlan”: Integer representing the VLAN ID for PTP traffic (e.g., 100 for

VLAN 100)

  • “leaderTimeSource”: Indicates the leader’s source of time, such as GNSS, atomic clock, or NTP

  • “genlock”: The tracking device has an external black/burst or tri-level analog sync signal that is triggering the capture of tracking samples

  • “videoIn”: The tracking device has an external video signal that is triggering the capture of tracking samples

  • “ptp”: The tracking device is locked to a PTP leader

  • “ntp”: The tracking device is locked to an NTP server

C++ Source:

  • Plugin: LiveLinkOpenTrackIO

  • Module: LiveLinkOpenTrackIO

  • File: LiveLinkOpenTrackIOTypes.h

Editor Properties: (see get_editor_property/set_editor_property)

  • frequency (LiveLinkOpenTrackIOFrameRate): [Read-Write] Synchonization rate.

  • locked (bool): [Read-Write]

  • offsets (LiveLinkOpenTrackIOSynchronizationOffsets): [Read-Write]

  • present (bool): [Read-Write]

  • ptp (LiveLinkOpenTrackIO_PTP): [Read-Write]

  • source (str): [Read-Write] Enum as string value can be “genlock”, “videoIn”, “ptp”, …

property frequency: LiveLinkOpenTrackIOFrameRate

[Read-Write] Synchonization rate.

Type:

(LiveLinkOpenTrackIOFrameRate)

property locked: bool

[Read-Write]

Type:

(bool)

property offsets: LiveLinkOpenTrackIOSynchronizationOffsets

[Read-Write]

Type:

(LiveLinkOpenTrackIOSynchronizationOffsets)

property present: bool

[Read-Write]

Type:

(bool)

property ptp: LiveLinkOpenTrackIO_PTP

[Read-Write]

Type:

(LiveLinkOpenTrackIO_PTP)

property source: str

[Read-Write] Enum as string value can be “genlock”, “videoIn”, “ptp”, …

Type:

(str)