1.2.15 OcaMediaClock3

Class Hirarchy:

OcaRootOcaAgentOcaMediaClock3

class OcaMediaClock3 : OcaAgent

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

Properties:

OcaClassID ClassID

This property is an override of the OcaRoot property.

This property has id 3.1.

OcaClassVersionNumber ClassVersion

Identifies the interface version of the class. Any change to the class definition leads to a higher class version. This property is an override of the OcaRoot property.

This property has id 3.2.

OcaMediaClockAvailability Availability

Availability of media clock.

This property has id 3.1.

OcaONo TimeSourceONo

ONo of time source that drives this media clock.

This property has id 3.2.

OcaTimePTP Offset

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.

This property has id 3.3.

OcaMediaClockRate CurrentRate

Current clock rate

This property has id 3.4.

OcaMap<OcaONo, OcaList> SupportedRates

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.

This property has id 3.5.

Properties inherited from OcaAgent:

Properties inherited from OcaRoot:

Methods:

OcaStatus GetAvailability(OcaMediaClockAvailability &Availability)

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

This method has id 3.1.

Parameters

OcaMediaClockAvailability Availability – Output parameter.

OcaStatus SetAvailability(OcaMediaClockAvailability 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.

This method has id 3.2.

Parameters

OcaMediaClockAvailability Availability – Input parameter.

OcaStatus GetCurrentRate(OcaMediaClockRate &Rate, OcaONo &TimeSourceONo)

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

This method has id 3.3.

Parameters
  • OcaMediaClockRate Rate – Output parameter.

  • OcaONo TimeSourceONo – Output parameter.

OcaStatus SetCurrentRate(OcaMediaClockRate Rate, OcaONo 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.

This method has id 3.4.

Parameters
  • OcaMediaClockRate Rate – Input parameter.

  • OcaONo TimeSourceONo – Input parameter.

OcaStatus GetOffset(OcaTimePTP &Offset)

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.

This method has id 3.5.

Parameters

OcaTimePTP Offset – Output parameter.

OcaStatus SetOffset(OcaTimePTP 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.

This method has id 3.6.

Parameters

OcaTimePTP Offset – Input parameter.

OcaStatus GetSupportedRates(OcaMap<OcaONo, OcaList> &Rates)

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

This method has id 3.7.

Parameters

OcaMap<OcaONo, OcaList> Rates – Output parameter.

Methods inherited from OcaAgent:

Methods inherited from OcaRoot: