OcaStreamNetwork

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

ControlProtocol

OcaNetworkControlProtocol

OcaNetworkControlProtocol

IDAdvertised

Uint8Array

OcaNetworkNodeID

LinkType

OcaNetworkLinkType

OcaNetworkLinkType

MediaProtocol

OcaNetworkMediaProtocol

OcaNetworkMediaProtocol

SignalChannelsSink

number[]

OcaList<OcaONo>

SignalChannelsSource

number[]

OcaList<OcaONo>

Statistics

OcaNetworkStatistics

OcaNetworkStatistics

Status

OcaNetworkStatus

OcaNetworkStatus

StreamConnectorsSink

number[]

OcaList<OcaONo>

StreamConnectorsSource

number[]

OcaList<OcaONo>

SystemInterfaces

OcaNetworkSystemInterfaceID[]

OcaList<OcaNetworkSystemInterfaceID>

Furthermore, it inherits the properties ClassID, ClassVersion, ObjectNumber, Lockable, Role, Label, Owner, ControlProtocol, IDAdvertised, LinkType, MediaProtocol, SignalChannelsSink, SignalChannelsSource, Statistics, Status, StreamConnectorsSink, StreamConnectorsSource and SystemInterfaces.

class OcaStreamNetwork(objectNumber, device)

DEPRECATED CLASS Replaced by class **OcaMediaTransportNetwork ** in version 3 of Connection Management (CM3) Abstract base class for defining network classes to which this device belongs. May be a media transport network, a control and monitoring network, or a network that does both. There shall be one OcaStreamNetwork instance for each network to which the device belongs. This class may be subclassed to support networks of various types.

OcaStreamNetwork.OnControlProtocolChanged

type: PropertyEvent.<OcaNetworkControlProtocol>

This event is emitted when the property ControlProtocol changes in the remote object. The property ControlProtocol is described in the AES70 standard as follows. Type of control protocol used by the network (OCAnn) or NONE if this network is not used for control.

OcaStreamNetwork.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. ID by which this device is known on the network, i.e. the host name or GUID that this device publishes in the network’s directory/discovery system.

OcaStreamNetwork.OnMediaProtocolChanged

type: PropertyEvent.<OcaNetworkMediaProtocol>

This event is emitted when the property MediaProtocol changes in the remote object. The property MediaProtocol is described in the AES70 standard as follows. Type of media transport protocol used by the network, or NONE if this network is not used for media transport.

OcaStreamNetwork.OnSignalChannelsSinkChanged

type: PropertyEvent.<Array.<number>>

This event is emitted when the property SignalChannelsSink changes in the remote object. The property SignalChannelsSink is described in the AES70 standard as follows. List of object numbers of <u>sink </u><b>OcaNetworkSignalChannel </b>objects collected by this network.

OcaStreamNetwork.OnSignalChannelsSourceChanged

type: PropertyEvent.<Array.<number>>

This event is emitted when the property SignalChannelsSource changes in the remote object. The property SignalChannelsSource is described in the AES70 standard as follows. List of object numbers of <u>source </u><b>OcaNetworkSignalChannel </b>objects collected by this network.

OcaStreamNetwork.OnStatisticsChanged

type: PropertyEvent.<OcaNetworkStatistics>

This event is emitted when the property Statistics changes in the remote object. The property Statistics is described in the AES70 standard as follows. Error statistics for this network

OcaStreamNetwork.OnStatusChanged

type: PropertyEvent.<OcaNetworkStatus>

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

OcaStreamNetwork.OnStreamConnectorsSinkChanged

type: PropertyEvent.<Array.<number>>

This event is emitted when the property StreamConnectorsSink changes in the remote object. The property StreamConnectorsSink is described in the AES70 standard as follows. List of object numbers of <u>sink </u><b>OcaStreamConnector </b>objects collected by this network.

OcaStreamNetwork.OnStreamConnectorsSourceChanged

type: PropertyEvent.<Array.<number>>

This event is emitted when the property StreamConnectorsSource changes in the remote object. The property StreamConnectorsSource is described in the AES70 standard as follows. List of object numbers of <u>source </u><b>OcaStreamConnector </b>objects collected by this network.

OcaStreamNetwork.OnSystemInterfacesChanged

type: PropertyEvent.<Array.<OcaNetworkSystemInterfaceID>>

This event is emitted when the property SystemInterfaces changes in the remote object. The property SystemInterfaces is described in the AES70 standard as follows. Collection of identifiers of system interface(s) used by the network. A “system interface” is the system service through which network traffic passes into and out of the device – e.g. a socket. The identifier format is system and network dependent; for OCA purposes, it is maintained as a variable-length blob which the protocol does not inspect.

OcaStreamNetwork.GetControlProtocol()

Gets the network’s ControlProtocol property. Return status indicates whether the operation was successful.

Returns

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

OcaStreamNetwork.GetIDAdvertised()

Gets the network’s IDAdvertised. Return status indicates whether the operation was successful.

Returns

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

OcaStreamNetwork.GetLinkType()

Gets the network’s link type (wired Ethernet, USB, etc.). Return status indicates whether the operation was successful.

Returns

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

OcaStreamNetwork.GetMediaProtocol()

Gets the network’s MediaProtocol property. Return status indicates whether the operation was successful.

Returns

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

OcaStreamNetwork.GetSignalChannelsSink()

Gets the list of object numbers of Sink OcaNetworkSignalChannel objects owned by this network. Return status indicates success of the operation. If the value of the network’s MediaProtocol property is NONE, this method will return the status value InvalidRequest. Members are added to and deleted from this list when OcaNetworkSignalChannel objects’ Owner properties are updated, or when OcaNetworkSignalChannel objects are deleted. For reconfigurable devices, such changes may be initiated by controllers during device operation.

Returns

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

OcaStreamNetwork.GetSignalChannelsSource()

Gets the list of object numbers of Source OcaNetworkSignalChannel objects owned by this network. Return status indicates success of the operation. If the value of the network’s MediaProtocol property is NONE, this method will return the status value InvalidRequest. Members are added to and deleted from this list when OcaNetworkSignalChannel objects’ Owner properties are updated, or when OcaNetworkSignalChannel objects are deleted. For reconfigurable devices, such changes may be initiated by controllers during device operation.

Returns

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

OcaStreamNetwork.GetStatistics()

Retrieves network error statistics counter values. Return status indicates whether the values were successfully retrieved.

Returns

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

OcaStreamNetwork.GetStatus()

Retrieves the network’s status. Return status indicates whether the status was successfully retrieved.

Returns

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

OcaStreamNetwork.GetStreamConnectorsSink()

Gets the list of object numbers of Sink OcaStreamConnector objects owned by this network. Return status indicates success of the operation. If the value of the network’s MediaProtocol property is NONE, this method will return the status value InvalidRequest. Members are added to and deleted from this list when OcaStreamConnector objects’ Owner properties are updated, or when OcaStreamConnector objects are deleted. For reconfigurable devices, such changes may be initiated by controllers during device operation.

Returns

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

OcaStreamNetwork.GetStreamConnectorsSource()

Gets the list of object numbers of Source OcaStreamConnector objects owned by this network. Return status indicates success of the operation. If the value of the network’s MediaProtocol property is NONE, this method will return the status value InvalidRequest. Members are added to and deleted from this list when OcaStreamConnector objects’ Owner properties are updated, or when OcaStreamConnector objects are deleted. For reconfigurable devices, such changes may be initiated by controllers during device operation.

Returns

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

OcaStreamNetwork.GetSystemInterfaces()

Gets the list of system interface IDs that this network is using. Return status indicates success of the operation.

Returns

Promise.<Array.<OcaNetworkSystemInterfaceID>> – A promise which resolves to a single value of type OcaNetworkSystemInterfaceID[].

OcaStreamNetwork.ResetStatistics()

Resets network error statistics counters. Return status indicates whether the counters were successfully reset.

Returns

Promise.<void> –

OcaStreamNetwork.SetIDAdvertised(Name)

Sets the network’s IDAdvertised. Return status indicates whether the operation was successful.

Arguments

  • Name (Uint8Array) –

Returns

Promise.<void> –

OcaStreamNetwork.SetSignalChannelsSink(SignalChannels)

Sets the list of object numbers of Sink OcaNetworkSignalChannel objects owned by this network. Return status indicates success of the operation. If the value of the network’s MediaProtocol property is NONE, this method will return the status value InvalidRequest. Members are added to and deleted from this list when OcaNetworkSignalChannel objects’ Owner properties are updated, or when OcaNetworkSignalChannel objects are deleted. For reconfigurable devices, such changes may be initiated by controllers during device operation.

Arguments

  • SignalChannels (Array.<number>) –

Returns

Promise.<void> –

OcaStreamNetwork.SetSignalChannelsSource(SignalChannels)

Sets the list of object numbers of Source OcaNetworkSignalChannel objects owned by this network. Return status indicates success of the operation. If the value of the network’s MediaProtocol property is NONE, this method will return the status value InvalidRequest. Members are added to and deleted from this list when OcaNetworkSignalChannel objects’ Owner properties are updated, or when OcaNetworkSignalChannel objects are deleted. For reconfigurable devices, such changes may be initiated by controllers during device operation.

Arguments

  • SignalChannels (Array.<number>) –

Returns

Promise.<void> –

OcaStreamNetwork.SetStreamConnectorsSink(StreamConnectors)

Sets the list of object numbers of Sink OcaStreamConnector objects owned by this network. Return status indicates success of the operation. If the value of the network’s MediaProtocol property is NONE, this method will return the status value InvalidRequest. Members are added to and deleted from this list when OcaStreamConnector objects’ Owner properties are updated, or when OcaStreamConnector objects are deleted. For reconfigurable devices, such changes may be initiated by controllers during device operation.

Arguments

  • StreamConnectors (Array.<number>) –

Returns

Promise.<void> –

OcaStreamNetwork.SetStreamConnectorsSource(StreamConnectors)

Sets the list of object numbers of Source OcaStreamConnector objects owned by this network. Return status indicates success of the operation. If the value of the network’s MediaProtocol property is NONE, this method will return the status value InvalidRequest. Members are added to and deleted from this list when OcaStreamConnector objects’ Owner properties are updated, or when OcaStreamConnector objects are deleted. For reconfigurable devices, such changes may be initiated by controllers during device operation.

Arguments

  • StreamConnectors (Array.<number>) –

Returns

Promise.<void> –

OcaStreamNetwork.SetSystemInterfaces(Interfaces)

Sets the list of system interface IDs that this network will use. Return status indicates success of the operation. This method is not implemented by all network implementations.

Arguments

  • Interfaces (Array.<OcaNetworkSystemInterfaceID>) –

Returns

Promise.<void> –

OcaStreamNetwork.Shutdown()

Shut down this network.

Returns

Promise.<void> –

OcaStreamNetwork.Startup()

Start up this network.

Returns

Promise.<void> –