OcaNetworkSignalChannel¶

A online version of the AES70 specification of this class can be found at http://docs.deuso.de.

The class is a subclass of OcaWorker().

This class defines the properties

Name	JavaScript Type	AES70 Type
ConnectorPins	Map<number, number>	OcaMap<OcaONo, OcaStreamConnectorPinIndex>
IDAdvertised	Uint8Array	OcaNetworkSignalChannelID
Network	number	OcaONo
RemoteChannelID	Uint8Array	OcaNetworkSignalChannelID
SourceOrSink	OcaNetworkMediaSourceOrSink	OcaNetworkMediaSourceOrSink
Status	OcaNetworkSignalChannelStatus	OcaNetworkSignalChannelStatus

Furthermore, it inherits the properties ClassID, ClassVersion, ObjectNumber, Lockable, Role, Enabled, Ports, Label, Owner, Latency, ConnectorPins, IDAdvertised, Network, RemoteChannelID, SourceOrSink and Status.

class OcaNetworkSignalChannel(objectNumber, device)¶

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.

OcaNetworkSignalChannel.OnConnectorPinsChanged¶

type: PropertyEvent.<Map.<number, number>>

This event is emitted when the property ConnectorPins changes in the remote object. The property ConnectorPins is described in the AES70 standard as follows. 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.

OcaNetworkSignalChannel.OnIDAdvertisedChanged¶

type: PropertyEvent.<Uint8Array>

This event is emitted when the property IDAdvertised changes in the remote object. The property IDAdvertised is described in the AES70 standard as follows. 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.

OcaNetworkSignalChannel.OnNetworkChanged¶

type: PropertyEvent.<number>

This event is emitted when the property Network changes in the remote object. The property Network is described in the AES70 standard as follows. Object number of stream network object (OcaStreamNetwork or one of its subclasses) to which this signal channel belongs.

OcaNetworkSignalChannel.OnRemoteChannelIDChanged¶

type: PropertyEvent.<Uint8Array>

This event is emitted when the property RemoteChannelID changes in the remote object. The property RemoteChannelID is described in the AES70 standard as follows. External ID of ultimate source or destination of signal.

OcaNetworkSignalChannel.OnSourceOrSinkChanged¶

type: PropertyEvent.<OcaNetworkMediaSourceOrSink>

This event is emitted when the property SourceOrSink changes in the remote object. The property SourceOrSink is described in the AES70 standard as follows. 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”.

OcaNetworkSignalChannel.OnStatusChanged¶

type: PropertyEvent.<OcaNetworkSignalChannelStatus>

This event is emitted when the property Status changes in the remote object. The property Status is described in the AES70 standard as follows. Status of the port

OcaNetworkSignalChannel.AddToConnector(Connector, 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.

Arguments

Connector (number) –
Index (number) –

Returns

Promise.<void> –

OcaNetworkSignalChannel.GetConnectorPins()¶

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.

Returns: Promise.<Map.<number, number>> – A promise which resolves to a single value of type Map<number, number>.

OcaNetworkSignalChannel.GetIDAdvertised()¶

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

Returns: Promise.<Uint8Array> – A promise which resolves to a single value of type Uint8Array.

OcaNetworkSignalChannel.GetNetwork()¶

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

Returns: Promise.<number> – A promise which resolves to a single value of type number.

OcaNetworkSignalChannel.GetRemoteChannelID()¶

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).

Returns: Promise.<Uint8Array> – A promise which resolves to a single value of type Uint8Array.

OcaNetworkSignalChannel.GetSourceOrSink()¶

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

Returns: Promise.<OcaNetworkMediaSourceOrSink> – A promise which resolves to a single value of type OcaNetworkMediaSourceOrSink().

OcaNetworkSignalChannel.GetStatus()¶

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

Returns: Promise.<OcaNetworkSignalChannelStatus> – A promise which resolves to a single value of type OcaNetworkSignalChannelStatus().

OcaNetworkSignalChannel.RemoveFromConnector(Connector)¶

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

Arguments

Connector (number) –

Returns

Promise.<void> –

OcaNetworkSignalChannel.SetIDAdvertised(IDAdvertised)¶

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

Arguments

IDAdvertised (Uint8Array) –

Returns

Promise.<void> –

OcaNetworkSignalChannel.SetNetwork(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.

Arguments

Network (number) –

Returns

Promise.<void> –

OcaNetworkSignalChannel.SetRemoteChannelID(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.

Arguments

RemoteChannelID (Uint8Array) –

Returns

Promise.<void> –