OcaMediaClock

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

Type

OcaMediaClockType

OcaMediaClockType

DomainID

number

OcaUint16

RatesSupported

OcaMediaClockRate[]

OcaList<OcaMediaClockRate>

CurrentRate

OcaMediaClockRate

OcaMediaClockRate

LockState

OcaMediaClockLockState

OcaMediaClockLockState

Furthermore, it inherits the properties ClassID, ClassVersion, ObjectNumber, Lockable, Role, Label, Owner, Type, DomainID, RatesSupported, CurrentRate and LockState.

class OcaMediaClock(objectNumber, device)

DEPRECATED CLASS Replaced by OcaMediaClock3 A media clock, internal or external.

OcaMediaClock.OnCurrentRateChanged

type: PropertyEvent.<OcaMediaClockRate>

This event is emitted when the property CurrentRate changes in the remote object. The property CurrentRate is described in the AES70 standard as follows. Current clock rate

OcaMediaClock.OnDomainIDChanged

type: PropertyEvent.<number>

This event is emitted when the property DomainID changes in the remote object. The property DomainID is described in the AES70 standard as follows. Clock domain ID. Arbitrary value.

OcaMediaClock.OnLockStateChanged

type: PropertyEvent.<OcaMediaClockLockState>

This event is emitted when the property LockState changes in the remote object. The property LockState is described in the AES70 standard as follows. Lock state of clock.

OcaMediaClock.OnRatesSupportedChanged

type: PropertyEvent.<Array.<OcaMediaClockRate>>

This event is emitted when the property RatesSupported changes in the remote object. The property RatesSupported is described in the AES70 standard as follows. List of supported rates

OcaMediaClock.OnTypeChanged

type: PropertyEvent.<OcaMediaClockType>

This event is emitted when the property Type changes in the remote object. The property Type is described in the AES70 standard as follows. Type of clock.

OcaMediaClock.GetCurrentRate()

Gets the current sampling rate. The return value indicates whether the value was successfully retrieved.

Returns

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

OcaMediaClock.GetDomainID()

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

Returns

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

OcaMediaClock.GetLockState()

Gets the current media clock lock state. The return value indicates whether the value was successfully retrieved.

Returns

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

OcaMediaClock.GetSupportedRates()

Gets the list of supported sampling rates. The return value indicates whether the list was successfully retrieved.

Returns

Promise.<Array.<OcaMediaClockRate>> – A promise which resolves to a single value of type OcaMediaClockRate[].

OcaMediaClock.GetType()

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

Returns

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

OcaMediaClock.SetCurrentRate(rate)

Sets the sampling rate. The return value indicates whether the rate was successfully set.

Arguments
Returns

Promise.<void> –

OcaMediaClock.SetDomainID(ID)

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

Arguments

  • ID (number) –

Returns

Promise.<void> –

OcaMediaClock.SetType(Type)

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

Arguments
Returns

Promise.<void> –