static
readonly
OcaClassID ClassID
= 1.1.6
Level: 1 Index: 1
ID of this class
Level: 1 Index: 2
Version number of this class
OcaMap<OcaONo,OcaStreamConnectorPinIndex
> ConnectorPins
Level: 3 Index: 3
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.
OcaNetworkSignalChannelID
IDAdvertised
Level: 3 Index: 1
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.
Level: 3 Index: 2
Object number of stream network object (OcaStreamNetwork or one of its subclasses) to which this signal channel belongs.
OcaNetworkSignalChannelID
RemoteChannelID
Level: 3 Index: 4
External ID of ultimate source or destination of signal.
OcaNetworkMediaSourceOrSink
SourceOrSink
Level: 3 Index: 5
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".
OcaNetworkSignalChannelStatus
Status
Level: 3 Index: 6
Status of the port
Properties inherited from OcaWorker
Properties inherited from OcaRoot
OcaNetworkSignalChannel::AddToConnector (
OcaONo Connector, OcaStreamConnectorPinIndex
Index )
Level: 3 Index: 6
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.
OcaNetworkSignalChannel::GetConnectorPins (
)
→ (
OcaMap<OcaONo,OcaStreamConnectorPinIndex
> ConnectorPins)
Level: 3 Index: 5
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.
OcaNetworkSignalChannel::GetIDAdvertised (
)
→ (
OcaNetworkSignalChannelID
IDAdvertised)
Level: 3 Index: 1
Gets the value of the IDAdvertised property. Return status indicates success of operation.
OcaNetworkSignalChannel::GetNetwork (
)
→ (
OcaONo Network)
Level: 3 Index: 3
Gets the object number of the stream network object to which this media port belongs. Return status indicates success of operation.
OcaNetworkSignalChannel::GetRemoteChannelID (
)
→ (
OcaNetworkSignalChannelID
RemoteChannelID)
Level: 3 Index: 8
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).
OcaNetworkSignalChannel::GetSourceOrSink (
)
→ (
OcaNetworkMediaSourceOrSink
SourceOrSink)
Level: 3 Index: 10
Gets the value of the SourceOrSink property. Return status indicates success of operation.
OcaNetworkSignalChannel::GetStatus (
)
→ (
OcaNetworkSignalChannelStatus
Status)
Level: 3 Index: 11
Gets the value of the Status property. Return status indicates success of operation.
OcaNetworkSignalChannel::RemoveFromConnector (
OcaONo Connector )
Level: 3 Index: 7
Removes this channel from the passed stream connector. Return status indicates success of operation.
OcaNetworkSignalChannel::SetIDAdvertised (
OcaNetworkSignalChannelID
IDAdvertised )
Level: 3 Index: 2
Sets the value of the IDAdvertised property. Return status indicates success of operation.
OcaNetworkSignalChannel::SetNetwork (
OcaONo Network )
Level: 3 Index: 4
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.
OcaNetworkSignalChannel::SetRemoteChannelID (
OcaNetworkSignalChannelID
RemoteChannelID )
Level: 3 Index: 9
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.