OcaStreamConnector

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

The class is a subclass of OcaAgent().

This class defines the properties

Name

JavaScript Type

AES70 Type

IDAdvertised

Uint8Array

OcaStreamConnectorID

OwnerNetwork

number

OcaONo

Pins

Map<number, number>

OcaMap<OcaStreamConnectorPinIndex, OcaONo>

SourceOrSink

OcaNetworkMediaSourceOrSink

OcaNetworkMediaSourceOrSink

Status

OcaStreamConnectorStatus

OcaStreamConnectorStatus

Streams

Map<number, OcaStream>

OcaMap<OcaStreamIndex, OcaStream>

Furthermore, it inherits the properties ClassID, ClassVersion, ObjectNumber, Lockable, Role, Label, Owner, IDAdvertised, OwnerNetwork, Pins, SourceOrSink, Status and Streams.

class OcaStreamConnector(objectNumber, device)

DEPRECATED CLASS Replaced by the OcaMediaSinkConnector ** *and* **OcaMediaSourceConnector ** *datatypes in version 3 of Connection Management (CM3)* Agent class for objects (“connectors”) that allow connection of streams to the device. Streams may be single channels or multichannel groups. A connector is either a *source* or a *sink.* Sources are sometimes called “talkers”. Sinks are sometimes called “listeners”. Each connector links to zero or more **OcaStream data objects. Each OcaStream object represents a signal flow to or from a local connector to a remote connector. The remote connector is usually, but not necessarily, in a different node. Each connector collects zero or more signal channels . A signal channel is an instance of OcaNetworkSignalChannel. Each signal channel exposes one media channel of the stream to the interior of the device. A signal channel therefore is a Worker that contains exactly one OcaPort data object. Each OcaStreamConnector object belongs to a particular instance of OcaStreamNetwork or a subclass of OcaStreamNetwork . Each OcaStreamConnector is linked to its network through the Owner property.

  • When a controller creates an OcaStreamConnector object dynamically, the controller must store the Object Number of the corresponding OcaStreamNetwork object in the Owner property.

  • Upon receiving the Owner property change, the OcaStreamConnector object must register itself with the given stream network object via some internal means.

This class may be subclassed to support various network types.

OcaStreamConnector.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 this connector. This ID is advertised on the network to be found by other devices’ discovery processes.

OcaStreamConnector.OnOwnerNetworkChanged

type: PropertyEvent.<number>

This event is emitted when the property OwnerNetwork changes in the remote object. The property OwnerNetwork is described in the AES70 standard as follows. Object number of stream network object (<b>OcaStreamNetwork</b> or one of its subclasses) to which this connector belongs. In reconfigurable devices, a controller that creates an <b>OcaStreamConnector </b>object must store the appropriate stream network object number into this property. It is assumed that, upon receiving a value into its <b>Owner</b> property, the terminus object will by internal means register itself with the identified stream network.

OcaStreamConnector.OnPinsChanged

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

This event is emitted when the property Pins changes in the remote object. The property Pins is described in the AES70 standard as follows. The map of connector pin indexes to <b>OcaNetworkSignalChannel[Source|Sink] </b>objects collected by this connector. The pin indexes are <u>fixed indexes</u> 1 to n, where n is the number of channels the connector accommodates (determined when the connector is created). If a certain pin in the connector is currently not attached the OcaONo of that index is 0.

OcaStreamConnector.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. Specifies whether this connector is for output (source) or input (sink) signal channels.

OcaStreamConnector.OnStatusChanged

type: PropertyEvent.<OcaStreamConnectorStatus>

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 this terminus.

OcaStreamConnector.OnStreamsChanged

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

This event is emitted when the property Streams changes in the remote object. The property Streams is described in the AES70 standard as follows. The list of <b>OcaStream </b>data objects contained in (i.e. connected to) this connector.

OcaStreamConnector.ConnectStream(Stream)

Connects a stream to this connector. Return status indicates success of operation.

Arguments
Returns

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

OcaStreamConnector.DisconnectStream(StreamID)

Disconnects a stream from this connector. Return status indicates success of operation.

Arguments

  • StreamID (number) –

Returns

Promise.<void> –

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

OcaStreamConnector.GetOwnerNetwork()

Gets the object number of the OcaStreamNetwork object to which this connector belongs. Return status indicates success of operation.

Returns

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

OcaStreamConnector.GetPins()

Gets the list of object numbers of OcaNetworkSignalChannel objects connected to this connector. Return status indicates success of operation.

Returns

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

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

OcaStreamConnector.GetStatus()

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

Returns

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

OcaStreamConnector.GetStreams()

Gets the map of OcaStream items connected to this connector. Return status indicates success of operation.

Returns

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

OcaStreamConnector.SetIDAdvertised(IDAdvertised)

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

Arguments

  • IDAdvertised (Uint8Array) –

Returns

Promise.<void> –

OcaStreamConnector.SetOwnerNetwork(Network)

Sets the object number of the OcaStreamNetwork object to which this connector belongs. Return status indicates success of operation. Only implemented for reconfigurable devices.

Arguments

  • Network (number) –

Returns

Promise.<void> –

OcaStreamConnector.SetSourceOrSink(SourceOrSink)

Sets the value of the SourceOrSink property. Return status indicates success of operation. Only implemented for reconfigurable devices. Note that this method can only be called when the SignalChannels property is empty, i.e. does not contain any actual channels.

Arguments
Returns

Promise.<void> –