OcaMediaClock3

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

OcaMediaClockAvailability

OcaMediaClockAvailability

TimeSourceONo

number

OcaONo

Offset

OcaTimePTP

OcaTimePTP

CurrentRate

OcaMediaClockRate

OcaMediaClockRate

SupportedRates

Map<number, OcaMediaClockRate[]>

OcaMap<OcaONo, OcaList<OcaMediaClockRate>>

Furthermore, it inherits the properties ClassID, ClassVersion, ObjectNumber, Lockable, Role, Label, Owner, Availability, TimeSourceONo, Offset, CurrentRate and SupportedRates.

class OcaMediaClock3(objectNumber, device)

A media clock, internal or external. OCA Connection Management 3 (OCA-CM3) version.

OcaMediaClock3.OnAvailabilityChanged

type: PropertyEvent.<OcaMediaClockAvailability>

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 media clock.

OcaMediaClock3.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

OcaMediaClock3.OnOffsetChanged

type: PropertyEvent.<OcaTimePTP>

This event is emitted when the property Offset changes in the remote object. The property Offset is described in the AES70 standard as follows. Offset of media clock time from reference time. Note: For RTP-based media transport networks, this value is NOT the RTP time offset. RTP time offset is an implementation detail that is out of AES70’s scope.

OcaMediaClock3.OnSupportedRatesChanged

type: PropertyEvent.<Map.<number, Array.<OcaMediaClockRate>>>

This event is emitted when the property SupportedRates changes in the remote object. The property SupportedRates is described in the AES70 standard as follows. Map of supported rates for each supported time source. Key of map is ONo of supported time source; value is list of supported clock rates for the given time source. Private parameter, does not generate property-change events.

OcaMediaClock3.OnTimeSourceONoChanged

type: PropertyEvent.<number>

This event is emitted when the property TimeSourceONo changes in the remote object. The property TimeSourceONo is described in the AES70 standard as follows. ONo of time source that drives this media clock.

OcaMediaClock3.GetAvailability()

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

Returns

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

OcaMediaClock3.GetCurrentRate()

Gets the current clock rate and the ONo of the associated OcaTimeSource object. The return value indicates whether the value was successfully retrieved. The return values of this method are

Returns

Promise.<Arguments.<OcaMediaClockRate, number>> –

OcaMediaClock3.GetOffset()

Gets the offset of this media clock’s time from that of the associated OcaTimeSource object. The return value indicates whether the value was successfully retrieved.

Returns

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

OcaMediaClock3.GetSupportedRates()

Gets the list of supported media clock rates for the given time source. The return value indicates whether the list was successfully retrieved.

Returns

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

OcaMediaClock3.SetAvailability(Availability)

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

Arguments
Returns

Promise.<void> –

OcaMediaClock3.SetCurrentRate(Rate, TimeSourceONo)

Sets the clock rate and the ONo of the associated OcaTimeSource object. The return value indicates whether the value was successfully set. Optional method, may not be supported in all implementations.

Arguments
Returns

Promise.<void> –

OcaMediaClock3.SetOffset(Offset)

Sets the offset of this media clock’s time from that of the associated OcaTimeSource object. The return value indicates whether the value was successfully set. Optional method, may not be supported in all implementations.

Arguments
Returns

Promise.<void> –