1.1.6 OcaNetworkSignalChannel

Class Hierarchy:

OcaRoot → OcaWorker → OcaNetworkSignalChannel

class OcaNetworkSignalChannel : OcaWorker

DEPRECATED CLASS Replaced by features of the **OcaMediaSinkConnector ** and **OcaMediaSourceConnector ** datatypes in version 3 of Connection Management (CM3) Worker that allows connection of one or more internal signal paths to a network signal channel.

• For stream-oriented media connection management such as used by AVB, this worker will be linked to an OcaStreamConnector object and to the appropriate OcaStreamNetwork object.

• For channel-oriented media connection management, such as the Dante name-based routing mechanism, this worker will be linked only to the OcaStreamNetwork object.

Properties:

static const OcaClassID ClassID = "1.1.6"

ID of this class

This property has id 3.1.

static const OcaClassVersionNumber ClassVersion = 2

Version number of this class

This property has id 3.2.

OcaMap<OcaONo, OcaStreamConnectorPinIndex> ConnectorPins

Map of object numbers of OcaStreamConnector objects to OcaStreamConnectorPinIndex of these connectors. This map identifies which OcaStreamConnector objects contain this network signal channel, and indicates at what pin of the connector this channel is found. If the OcaNetworkSignalChannel object is not part of any OcaStreamConnector this map is empty. Note that OcaNetworkSignalChannel objects of type Sink cannot have more than one entry in the map, else it would implicitly perform mixing. OcaNetworkSignalChannel objects of type Source can have multiple entries in the map.

This property has id 3.3.

OcaNetworkSignalChannelID IDAdvertised

Character name or binary identifier of the port that is advertised on the network to be found by other devices’ discovery processes. Depending on the media transport architecture being used, this ID may be globally unique throughout the network, or only unique within the scope of the specific Network instance to which the port is attached.

This property has id 3.1.

OcaONo Network

Object number of stream network object ( OcaStreamNetwork or one of its subclasses) to which this signal channel belongs.

This property has id 3.2.

OcaNetworkSignalChannelID RemoteChannelID

External ID of ultimate source or destination of signal.

This property has id 3.4.

OcaNetworkMediaSourceOrSink SourceOrSink

Describes whether this signal channel is source (emits signals into the network) or sink (receives signals from the network). Sources are sometimes called “talkers”, and sinks are sometimes called “listeners”.

This property has id 3.5.

OcaNetworkSignalChannelStatus Status

Status of the port

This property has id 3.6.

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 AddToConnector(OcaONo Connector, OcaStreamConnectorPinIndex Index)

Adds the object number of the stream connector object to which this media port belongs, and specifies on what index of the stream connector this channel can be found. Return status indicates success of operation.

This method has id 3.6.

Parameters

• OcaONo Connector – Input parameter.

• OcaStreamConnectorPinIndex Index – Input parameter.

OcaStatus GetConnectorPins(OcaMap<OcaONo, OcaStreamConnectorPinIndex> &ConnectorPins)

Gets the object number of the stream connector object to which this media port belongs, if any. If port does not belong to a stream connector, returns zero. Return status indicates success of operation.

This method has id 3.5.

Parameters

OcaMap<OcaONo, OcaStreamConnectorPinIndex> ConnectorPins – Output parameter.

OcaStatus GetIDAdvertised(OcaNetworkSignalChannelID &IDAdvertised)

Gets the value of the IDAdvertised property. Return status indicates success of operation.

This method has id 3.1.

Parameters

OcaNetworkSignalChannelID IDAdvertised – Output parameter.

OcaStatus GetNetwork(OcaONo &Network)

Gets the object number of the stream network object to which this media port belongs. Return status indicates success of operation.

This method has id 3.3.

Parameters

OcaONo Network – Output parameter.

OcaStatus GetRemoteChannelID(OcaNetworkSignalChannelID &RemoteChannelID)

Gets the remote channel ID to which this channel is connected. Empty if the channel is not connected (at least not directly to another channel). For stream-oriented connection management this functionality is not used (i.e. the remote channel ID will always be empty).

This method has id 3.8.

Parameters

OcaNetworkSignalChannelID RemoteChannelID – Output parameter.

OcaStatus GetSourceOrSink(OcaNetworkMediaSourceOrSink &SourceOrSink)

Gets the value of the SourceOrSink property. Return status indicates success of operation.

This method has id 3.10.

Parameters

OcaNetworkMediaSourceOrSink SourceOrSink – Output parameter.

OcaStatus GetStatus(OcaNetworkSignalChannelStatus &Status)

Gets the value of the Status property. Return status indicates success of operation.

This method has id 3.11.

Parameters

OcaNetworkSignalChannelStatus Status – Output parameter.

OcaStatus RemoveFromConnector(OcaONo Connector)

Removes this channel from the passed stream connector. Return status indicates success of operation.

This method has id 3.7.

Parameters

OcaONo Connector – Input parameter.

OcaStatus SetIDAdvertised(OcaNetworkSignalChannelID IDAdvertised)

Sets the value of the IDAdvertised property. Return status indicates success of operation.

This method has id 3.2.

Parameters

OcaNetworkSignalChannelID IDAdvertised – Input parameter.

OcaStatus SetNetwork(OcaONo Network)

Sets the object number of the stream network object to which this media port belongs. Return status indicates success of operation. Only implemented for reconfigurable devices.

This method has id 3.4.

Parameters

OcaONo Network – Input parameter.

OcaStatus SetRemoteChannelID(OcaNetworkSignalChannelID RemoteChannelID)

Sets the remote channel ID to which this channel must be connected. Only used for channel-oriented connection management. For stream-oriented connection management this method is not used. Clearing the remote channel ID (i.e. tearing down the connection) can be done by passing an empty remote channel ID as parameter.

This method has id 3.9.

Parameters

OcaNetworkSignalChannelID RemoteChannelID – 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()