1.1.1.6 OcaPanBalance

Class Hierarchy:

OcaRoot → OcaWorker → OcaActuator → OcaPanBalance

class OcaPanBalance : OcaActuator

Pan or Balance control.

Properties:

static const OcaClassID ClassID = "1.1.1.6"

Number that uniquely identifies the class. Note that this differs from the object number, which identifies the instantiated object. This property is an override of the OcaRoot property.

This property has id 4.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 4.2.

OcaFloat32 Position

Pan position. Range = -1.0 to +1.0. -1.0 is 100% left, +1.0 is 100% right.

This property has id 4.1.

OcaDB MidpointGain

Midpoint gain. Normally, max=0dB, min=-6dB. May be readonly for pan/balance objects with fixed midpoint gains.

This property has id 4.2.

Properties inherited from OcaWorker:

• OcaBoolean OcaWorker::Enabled

• OcaList<OcaPort> OcaWorker::Ports

• OcaString OcaWorker::Label

• OcaONo OcaWorker::Owner

• OcaTimeInterval OcaWorker::Latency

Properties inherited from OcaRoot:

• OcaONo OcaRoot::ObjectNumber

• OcaBoolean OcaRoot::Lockable

• OcaString OcaRoot::Role

Methods:

OcaStatus GetPosition(OcaFloat32 &Position, OcaFloat32 &minPosition, OcaFloat32 &maxPosition)

Gets the value and limits of the Position property. The return value indicates whether the data was successfully retrieved.

This method has id 4.1.

Parameters

• OcaFloat32 Position – Output parameter.

• OcaFloat32 minPosition – Output parameter.

• OcaFloat32 maxPosition – Output parameter.

OcaStatus SetPosition(OcaFloat32 Position)

Sets the value of the Position property. The return value indicates whether the property was successfully set.

This method has id 4.2.

Parameters

OcaFloat32 Position – Input parameter.

OcaStatus GetMidpointGain(OcaDB &Gain, OcaDB &minGain, OcaDB &maxGain)

Gets the value and limits of the MidpointGain property. The return value indicates whether the data was successfully retrieved.

This method has id 4.3.

Parameters

• OcaDB Gain – Output parameter.

• OcaDB minGain – Output parameter.

• OcaDB maxGain – Output parameter.

OcaStatus SetMidpointGain(OcaDB Gain)

Sets the value of the MidpointGain property. The return value indicates whether the property was successfully set.

This method has id 4.4.

Parameters

OcaDB Gain – Input parameter.

Methods inherited from OcaWorker:

• OcaWorker::GetEnabled(enabled)

• OcaWorker::SetEnabled(enabled)

• OcaWorker::AddPort(Label, Mode, ID)

• OcaWorker::DeletePort(ID)

• OcaWorker::GetPorts(OcaPorts)

• OcaWorker::GetPortName(PortID, Name)

• OcaWorker::SetPortName(PortID, Name)

• OcaWorker::GetLabel(label)

• OcaWorker::SetLabel(label)

• OcaWorker::GetOwner(owner)

• OcaWorker::GetLatency(latency)

• OcaWorker::SetLatency(latency)

• OcaWorker::GetPath(NamePath, ONoPath)

Methods inherited from OcaRoot:

• OcaRoot::GetClassIdentification(ClassIdentification)

• OcaRoot::GetLockable(lockable)

• OcaRoot::LockTotal()

• OcaRoot::Unlock()

• OcaRoot::GetRole(Role)

• OcaRoot::LockReadonly()