Index

Class OcaMediaClock

ClassID: 1.2.6

extends OcaAgent

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

Properties

static readonly OcaClassID ClassID = 1.2.6

Level: 1 Index: 1

This property is an override of the OcaRoot property.

static readonly OcaClassVersionNumber ClassVersion = 2

Level: 1 Index: 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.

OcaMediaClockType Type

Level: 3 Index: 1

Type of clock.

OcaUint16 DomainID

Level: 3 Index: 2

Clock domain ID. Arbitrary value.

OcaList<OcaMediaClockRate > RatesSupported

Level: 3 Index: 3

List of supported rates

OcaMediaClockRate CurrentRate

Level: 3 Index: 4

Current clock rate

OcaMediaClockLockState LockState

Level: 3 Index: 5

Lock state of clock.

Properties inherited from OcaAgent

OcaString Label

OcaONo Owner

Properties inherited from OcaRoot

readonly OcaONo ObjectNumber

readonly OcaBoolean Lockable

readonly OcaString Role

Methods

OcaMediaClock::GetType ( ) → ( OcaMediaClockType Type)

Level: 3 Index: 1

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

OcaMediaClock::SetType ( OcaMediaClockType Type )

Level: 3 Index: 2

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.

OcaMediaClock::GetDomainID ( ) → ( OcaUint16 ID)

Level: 3 Index: 3

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

OcaMediaClock::SetDomainID ( OcaUint16 ID )

Level: 3 Index: 4

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.

OcaMediaClock::GetSupportedRates ( ) → ( OcaList<OcaMediaClockRate > ID)

Level: 3 Index: 5

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

OcaMediaClock::GetRate ( ) → ( OcaMediaClockRate rate)

Level: 3 Index: 6

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

OcaMediaClock::SetRate ( OcaMediaClockRate rate )

Level: 3 Index: 7

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

OcaMediaClock::GetLockState ( ) → ( OcaMediaClockLockState state)

Level: 3 Index: 8

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

Methods inherited from OcaAgent

OcaAgent::GetLabel ( ) → ( OcaString Label)

OcaAgent::SetLabel ( OcaString Label )

OcaAgent::GetOwner ( ) → ( OcaONo owner)

OcaAgent::GetPath ( ) → ( OcaNamePath NamePath, OcaONoPath ONoPath)

Methods inherited from OcaRoot

OcaRoot::GetClassIdentification ( ) → ( OcaClassIdentification ClassIdentification)

OcaRoot::GetLockable ( ) → ( OcaBoolean lockable)

OcaRoot::LockTotal ( )

OcaRoot::Unlock ( )

OcaRoot::GetRole ( ) → ( OcaString Role)

OcaRoot::LockReadonly ( )