OcaNetwork

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
LinkType	OcaNetworkLinkType	OcaNetworkLinkType
IDAdvertised	Uint8Array	OcaApplicationNetworkServiceID
ControlProtocol	OcaNetworkControlProtocol	OcaNetworkControlProtocol
MediaProtocol	OcaNetworkMediaProtocol	OcaNetworkMediaProtocol
Status	OcaNetworkStatus	OcaNetworkStatus
SystemInterfaces	OcaNetworkSystemInterfaceID[]	OcaList<OcaNetworkSystemInterfaceID>
MediaPorts	number[]	OcaList<OcaONo>
Statistics	OcaNetworkStatistics	OcaNetworkStatistics

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

class OcaNetwork(objectNumber, device)

DEPRECATED CLASS Replaced by class OcaControlNetwork ** *in version 3 of Connection Management (CM3)* Abstract base class for defining network classes to which this device belongs. This class is to be used for control and monitoring networks only. For media transport networks, and for networks that combine media transport and control, the **OcaStreamNetwork class should be used instead.

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

OcaNetwork.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 network object is known on the network, i.e. the name or GUID that this network object publishes in the network’s directory/discovery system. As of OCA 1.4, this description has been clarified to indicate this property is the registered service name, which may or may not be the same as the device’s host name, if any. For data network types that have host names (e.g. IP networks), the authoritative copy of the host name is in the system interface ID.

OcaNetwork.OnMediaPortsChanged

type: PropertyEvent.<Array.<number>>

This event is emitted when the property MediaPorts changes in the remote object. The property MediaPorts is described in the AES70 standard as follows. Deprecated property. Always is empty. Media transport is now managed by the class <b>OcaStreamNetwork.</b>

OcaNetwork.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. Deprecated property. Always has value NONE. Media transport is managed by the <b>OcaStreamNetwork</b> class.

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

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

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

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

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

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

OcaNetwork.GetMediaPorts()

Deprecated method. Always returns status INVALID_REQUEST. Media transport is now managed by the class OcaStreamNetwork.

Returns

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

OcaNetwork.GetMediaProtocol()

Gets the network’s MediaProtocol property. This is a deprecated method that always returns the value NONE.

Returns

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

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

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

OcaNetwork.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[].

OcaNetwork.ResetStatistics()

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

Returns

Promise.<void> –

OcaNetwork.SetIDAdvertised(Name)

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

Arguments

• Name (Uint8Array) –

Returns

Promise.<void> –

OcaNetwork.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> –

OcaNetwork.Shutdown()

Shut down this network.

Returns

Promise.<void> –

OcaNetwork.Startup()

Start up this network.

Returns

Promise.<void> –