1.2.6 OcaMediaClock

Class Hierarchy:

OcaRoot → OcaAgent → OcaMediaClock

class OcaMediaClock : OcaAgent

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

Properties:

static const OcaClassID ClassID = "1.2.6"

This property is an override of the OcaRoot property.

This property has id 3.1.

static const OcaClassVersionNumber ClassVersion = 2

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.

OcaMediaClockType Type

Type of clock.

This property has id 3.1.

OcaUint16 DomainID

Clock domain ID. Arbitrary value.

This property has id 3.2.

OcaList<OcaMediaClockRate> RatesSupported

List of supported rates

This property has id 3.3.

OcaMediaClockRate CurrentRate

Current clock rate

This property has id 3.4.

OcaMediaClockLockState LockState

Lock state of clock.

This property has id 3.5.

Properties inherited from OcaAgent:

• OcaString OcaAgent::Label

• OcaONo OcaAgent::Owner

Properties inherited from OcaRoot:

• OcaONo OcaRoot::ObjectNumber

• OcaBoolean OcaRoot::Lockable

• OcaString OcaRoot::Role

Methods:

OcaStatus GetType(OcaMediaClockType &Type)

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

This method has id 3.1.

Parameters

OcaMediaClockType Type – Output parameter.

OcaStatus SetType(OcaMediaClockType 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.

This method has id 3.2.

Parameters

OcaMediaClockType Type – Input parameter.

OcaStatus GetDomainID(OcaUint16 &ID)

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

This method has id 3.3.

Parameters

OcaUint16 ID – Output parameter.

OcaStatus SetDomainID(OcaUint16 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.

This method has id 3.4.

Parameters

OcaUint16 ID – Input parameter.

OcaStatus GetSupportedRates(OcaList<OcaMediaClockRate> &ID)

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

This method has id 3.5.

Parameters

OcaList<OcaMediaClockRate> ID – Output parameter.

OcaStatus GetCurrentRate(OcaMediaClockRate &rate)

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

This method has id 3.6.

Parameters

OcaMediaClockRate rate – Output parameter.

OcaStatus SetCurrentRate(OcaMediaClockRate rate)

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

This method has id 3.7.

Parameters

OcaMediaClockRate rate – Input parameter.

OcaStatus GetLockState(OcaMediaClockLockState &state)

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

This method has id 3.8.

Parameters

OcaMediaClockLockState state – Output parameter.

Methods inherited from OcaAgent:

• OcaAgent::GetLabel(Label)

• OcaAgent::SetLabel(Label)

• OcaAgent::GetOwner(owner)

• OcaAgent::GetPath(NamePath, ONoPath)

Methods inherited from OcaRoot:

• OcaRoot::GetClassIdentification(ClassIdentification)

• OcaRoot::GetLockable(lockable)

• OcaRoot::LockTotal()

• OcaRoot::Unlock()

• OcaRoot::GetRole(Role)

• OcaRoot::LockReadonly()