OcaTimeSource

A online version of the AES70 specification of this class can be found at http://docs.deuso.de.

The class is a subclass of OcaAgent().

This class defines the properties

Name

JavaScript Type

AES70 Type

Availability

OcaTimeSourceAvailability

OcaTimeSourceAvailability

Protocol

OcaTimeProtocol

OcaTimeProtocol

Parameters

string

OcaSDPString

ReferenceType

OcaTimeReferenceType

OcaTimeReferenceType

ReferenceID

string

OcaString

SyncStatus

OcaTimeSourceSyncStatus

OcaTimeSourceSyncStatus

Furthermore, it inherits the properties ClassID, ClassVersion, ObjectNumber, Lockable, Role, Label, Owner, Availability, Protocol, Parameters, ReferenceType, ReferenceID and SyncStatus.

class OcaTimeSource(objectNumber, device)

A time source, internal or external. See RFC 7273 for a detailed discussion of time sources.

OcaTimeSource.OnAvailabilityChanged

type: PropertyEvent.<OcaTimeSourceAvailability>

This event is emitted when the property Availability changes in the remote object. The property Availability is described in the AES70 standard as follows. Availability of this time source.

OcaTimeSource.OnParametersChanged

type: PropertyEvent.<string>

This event is emitted when the property Parameters changes in the remote object. The property Parameters is described in the AES70 standard as follows. Parameters (identifiers, modifiers, etc.) for this time source . Content is an SDP timestamp reference specification as defined in RFC7273, section 4.8.

OcaTimeSource.OnProtocolChanged

type: PropertyEvent.<OcaTimeProtocol>

This event is emitted when the property Protocol changes in the remote object. The property Protocol is described in the AES70 standard as follows. Time transport protocol used by this time source

OcaTimeSource.OnReferenceIDChanged

type: PropertyEvent.<string>

This event is emitted when the property ReferenceID changes in the remote object. The property ReferenceID is described in the AES70 standard as follows. Identifier of reference to which this time source is synced, if any. Not needed for all reference types.

OcaTimeSource.OnReferenceTypeChanged

type: PropertyEvent.<OcaTimeReferenceType>

This event is emitted when the property ReferenceType changes in the remote object. The property ReferenceType is described in the AES70 standard as follows. Type of time reference to which this time source is synced, if any.

OcaTimeSource.OnSyncStatusChanged

type: PropertyEvent.<OcaTimeSourceSyncStatus>

This event is emitted when the property SyncStatus changes in the remote object. The property SyncStatus is described in the AES70 standard as follows. Synchronization status of this time source.

OcaTimeSource.GetAvailability()

Gets the value of the Availability property. The return value indicates whether the value was successfully retrieved.

Returns

Promise.<OcaTimeSourceAvailability> – A promise which resolves to a single value of type OcaTimeSourceAvailability().

OcaTimeSource.GetParameters()

Gets the value of the Parameters property. The return value indicates whether the value was successfully retrieved.

Returns

Promise.<string> – A promise which resolves to a single value of type string.

OcaTimeSource.GetProtocol()

Gets the value of the Protocol property. The return value indicates whether the value was successfully retrieved.

Returns

Promise.<OcaTimeProtocol> – A promise which resolves to a single value of type OcaTimeProtocol().

OcaTimeSource.GetReferenceID()

Gets the timing source ID. The return value indicates whether the value was successfully retrieved. Optional method, not required for all time reference types.

Returns

Promise.<string> – A promise which resolves to a single value of type string.

OcaTimeSource.GetReferenceType()

Gets the time reference type. The return value indicates whether the value was successfully retrieved.

Returns

Promise.<OcaTimeReferenceType> – A promise which resolves to a single value of type OcaTimeReferenceType().

OcaTimeSource.GetSyncStatus()

Gets the synchronization status of this time source. The return value indicates whether the value was successfully retrieved.

Returns

Promise.<OcaTimeSourceSyncStatus> – A promise which resolves to a single value of type OcaTimeSourceSyncStatus().

OcaTimeSource.Reset()

Resets this time source. Initiates a new synchronization sequence. The return value indicates whether the reset was successful.

Returns

Promise.<void> –

OcaTimeSource.SetParameters(Parameters)

Sets the value of the Parameters property. The return value indicates whether the value was successfully set. Optional method, may not be supported in all implementations.

Arguments

  • Parameters (string) –

Returns

Promise.<void> –

OcaTimeSource.SetProtocol(Protocol)

Sets the value of the Protocol property. The return value indicates whether the value was successfully set.

Arguments
Returns

Promise.<void> –

OcaTimeSource.SetReferenceID(ID)

Sets the time reference ID. The return value indicates whether the ID was successfully set. Optional method, not required for all time reference types.

Arguments

  • ID (string) –

Returns

Promise.<void> –

OcaTimeSource.SetReferenceType(ReferenceType)

Sets the time reference type. The return value indicates whether the value was successfully set. Optional method, may not be supported in all implementations.

Arguments
Returns

Promise.<void> –