Deprecated Time Datatypes

OcaTimeReferenceType

enum OcaTimeReferenceType : uint8_t

Types of time references. This datatype is deprecated as of AES70-2023.

enumerator Undefined = 0

Time reference is undefined.

enumerator Local = 1

Time reference is internal to device.

enumerator Private = 2

Time reference is private to the application.

enumerator TAI = 3

Time reference is International Atomic Time

enumerator ExpansionBase = 128

Proprietary time references start here.

OcaTimeProtocol

enum OcaTimeProtocol : uint8_t

Types of time sources. See RFC7273 particularly sections 4.4-4.8 .

enumerator Undefined = 0

Time protocol is undefined.

enumerator None = 1

Time reference is inside device, so no network time protocol is used.

enumerator Private = 2

Time protocol is not a public standard.

enumerator NTP = 3

Time protocol is Network Time Protocol.

enumerator SNTP = 4

Time protocol is Simple Network Time Protocol.

enumerator IEEE1588_2002 = 5

Time protocol is PTP (IEEE 1588), older version.

enumerator IEEE1588_2008 = 6

Time protocol is PTP (IEEE 1588), newer version.

enumerator IEEE_802_1AS = 7

Time protocol is IEEE 802.1as.

enumerator StreamEndpoint = 8

Time protocol is derived from a stream endpoint.

enumerator AES11 = 9

Time protocol is AES11 - see [AES11].

enumerator Genlock = 10

Time protocol is Genlock

enumerator ExpansionBase = 128

Proprietary additions start here.

OcaMediaClockLockState

enum OcaMediaClockLockState : uint8_t

Lock states of media clocks.

enumerator Undefined = 0

Lock state is undefined.

enumerator Locked = 1

Media clock is locked.

enumerator Synchronizing = 2

Media clock is attempting to lock.

enumerator FreeRun = 3

Media clock is free-running.

enumerator Stopped = 4

Media clock is stopped.

OcaMediaClockType

enum OcaMediaClockType : uint8_t

Types of media clocks.

enumerator None = 0

No network

enumerator Internal = 1

Internal media clock

enumerator Network = 2

Network media clock

enumerator External = 3

External media clock input on this device

OcaTimeNTP

using OcaTimeNTP = OcaUint64

Time of day in NTP format

OcaTimeOfDay

using OcaTimeOfDay = OcaUint64

The original NTP-format time datatype used in AES70-2015. In AES70-2018

  • NTP time has been replaced by the new datatype OcaTime.

  • For compatibility, certain parameters with NTP time values have been retained, but deprecated; for clarity, the datatype of these values has been changed to **OcaTimeNTP. **

  • OcaTimeNTP is the renamed version of OcaTimeOfDay, and is a deprecated datatype.

  • This datatype, OcaTimeOfDay, is listed in the deprecated list for descriptive purposes only.