OcaMediaTransportNetwork

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

The class is a subclass of OcaApplicationNetwork().

This class defines the properties

Name

JavaScript Type

AES70 Type

Protocol

OcaNetworkMediaProtocol

OcaNetworkMediaProtocol

Ports

OcaPort[]

OcaList<OcaPort>

MaxSourceConnectors

number

OcaUint16

MaxSinkConnectors

number

OcaUint16

MaxPinsPerConnector

number

OcaUint16

MaxPortsPerPin

number

OcaUint16

AlignmentLevel

number

OcaDBFS

AlignmentGain

number

OcaDB

Furthermore, it inherits the properties ClassID, ClassVersion, ObjectNumber, Lockable, Role, Label, Owner, ServiceID, SystemInterfaces, State, ErrorCode, Protocol, Ports, MaxSourceConnectors, MaxSinkConnectors, MaxPinsPerConnector, MaxPortsPerPin, AlignmentLevel, AlignmentGain, SinkConnectors and SourceConnectors.

class OcaMediaTransportNetwork(objectNumber, device)

This was not documented in the OCA standard.

OcaMediaTransportNetwork.OnAlignmentGainChanged

type: PropertyEvent.<number>

This event is emitted when the property AlignmentGain changes in the remote object. The property AlignmentGain is described in the AES70 standard as follows. Default value of AlignmentGain for newly-created OcaMediaSinkConnectors attached to this network. The min and max values of this property define respectively the lowest and highest alignment level values that may be specified when adding sink connectors to this network.

OcaMediaTransportNetwork.OnAlignmentLevelChanged

type: PropertyEvent.<number>

This event is emitted when the property AlignmentLevel changes in the remote object. The property AlignmentLevel is described in the AES70 standard as follows. Default alignment level value for newly-created <b>OcaMedia{Source|Sink}Connector </b>elements. The min and max values of this property define respectively the lowest and highest alignment level values that may be specified when adding connectors to this network.

OcaMediaTransportNetwork.OnConnectorStatusChanged

type: Event

Event indicating that the status of a source or sink connector has changed.

OcaMediaTransportNetwork.OnMaxPinsPerConnectorChanged

type: PropertyEvent.<number>

This event is emitted when the property MaxPinsPerConnector changes in the remote object. The property MaxPinsPerConnector is described in the AES70 standard as follows. The maximum number of pins (channels) in a connector that this network will support.

OcaMediaTransportNetwork.OnMaxPortsPerPinChanged

type: PropertyEvent.<number>

This event is emitted when the property MaxPortsPerPin changes in the remote object. The property MaxPortsPerPin is described in the AES70 standard as follows. The maximum number of ports per pin that this network will support. Value of zero indicates there is no specific limit.

OcaMediaTransportNetwork.OnMaxSinkConnectorsChanged

type: PropertyEvent.<number>

This event is emitted when the property MaxSinkConnectors changes in the remote object. The property MaxSinkConnectors is described in the AES70 standard as follows. The maximum number of sink connectors this media transport network can have (read-only property).

OcaMediaTransportNetwork.OnMaxSourceConnectorsChanged

type: PropertyEvent.<number>

This event is emitted when the property MaxSourceConnectors changes in the remote object. The property MaxSourceConnectors is described in the AES70 standard as follows. The maximum number of source connectors this media transport network can have (read-only property).

OcaMediaTransportNetwork.OnPortsChanged

type: PropertyEvent.<Array.<OcaPort>>

This event is emitted when the property Ports changes in the remote object. The property Ports is described in the AES70 standard as follows. The list of ports this network has. Note that these represent network channels of the media transport network. Each input port represents a source (transmit) network channel, each output port represents a sink (receive) network channel. Such network channels are directly linked to the ports, so the first input port represents the first source network channel, etc.

OcaMediaTransportNetwork.OnProtocolChanged

type: PropertyEvent.<OcaNetworkMediaProtocol>

This event is emitted when the property Protocol changes in the remote object. The property Protocol is described in the AES70 standard as follows. Type of media transport protocol used by the network.

OcaMediaTransportNetwork.OnSinkConnectorChanged

type: Event

Event indicating that a media sink connector has changed. The change type indicates if the connector was added, deleted or changed.

OcaMediaTransportNetwork.OnSourceConnectorChanged

type: Event

Event indicating that a media source connector has changed. The change type indicates if the connector was added, deleted or changed.

OcaMediaTransportNetwork.AddSinkConnector(InitialStatus, Connector)

Adds a sinkconnector to this network. Parameters of the new connector are given in the Connector parameter; device returns the same parameter with the new connector ID filled in. If the new connector’s AlignmentLevel property value is given as NaN, the value of this network’s AlignmentLevel property will be used. If the new connector’s AlignmentGain property value is given as NaN, the value of this network’s AlignmentGain property will be used. Return status indicates the success of the operation.

Arguments
Returns

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

OcaMediaTransportNetwork.AddSourceConnector(Connector, InitialStatus)

Adds a source connector to this network. Parameters of the new connector are given in the Connector parameter; device returns the same parameter with the new connector ID filled in. If the new connector’s AlignmentLevel property value is given as NaN, the value of this network’s AlignmentLevel property will be used. Return status indicates the success of the operation.

Arguments
Returns

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

OcaMediaTransportNetwork.ControlConnector(ConnectorID, Command)

Change the state of a given connector. Return status indicates the success of the operation.

Arguments
Returns

Promise.<void> –

OcaMediaTransportNetwork.DeleteConnector(ID)

Deletes a connector from this network. Return status indicates the success of the operation.

Arguments

  • ID (number) –

Returns

Promise.<void> –

OcaMediaTransportNetwork.GetAlignmentGain()

Gets the default, min, and max alignment gains for OcaMediaSinkConnectors attached to this network. Return status indicates success of the operation. The return values of this method are

  • Gain of type number

  • minGain of type number

  • maxGain of type number

Returns

Promise.<Arguments.<number, number, number>> –

OcaMediaTransportNetwork.GetAlignmentLevel()

Gets the default, min, and max alignment levels for OcaMedia{Source|Sink}Connectors attached to this network. Return status indicates success of the operation. The return values of this method are

  • Level of type number

  • MinLevel of type number

  • MaxLevel of type number

Returns

Promise.<Arguments.<number, number, number>> –

OcaMediaTransportNetwork.GetConnectorStatus(ConnectorID)

Gets the status of a single connector. Return status indicates success of the operation.

Arguments

  • ConnectorID (number) –

Returns

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

OcaMediaTransportNetwork.GetConnectorsStatuses()

Gets the status of all the source and sink connectors collected by this network object. Return status indicates success of the operation.

Returns

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

OcaMediaTransportNetwork.GetMaxPinsPerConnector()

Gets the maximum number of ports per pin this media transport network supports.

Returns

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

OcaMediaTransportNetwork.GetMaxPortsPerPin()

Gets the maximum number of pins (channels) per connector this media transport network supports.

Returns

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

OcaMediaTransportNetwork.GetMaxSinkConnectors()

Gets the maximum number of source connectors this media transport network supports.

Returns

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

OcaMediaTransportNetwork.GetMaxSourceConnectors()

Gets the maximum number of source connectors this media transport network supports.

Returns

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

OcaMediaTransportNetwork.GetMediaProtocol()

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

Returns

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

OcaMediaTransportNetwork.GetPortName(PortID)

Gets the name of the designated port. The return value indicates whether the name was successfully retrieved.

Arguments
Returns

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

OcaMediaTransportNetwork.GetPorts()

Gets the list of ports owned by the MediaTransportNetwork object (representing the source and sink network channels). The return value indicates whether the list was successfully retrieved.

Returns

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

OcaMediaTransportNetwork.GetSinkConnector(ID)

Retrieves the descriptor of a given sink connector. Return status indicates the success of the operation.

Arguments

  • ID (number) –

Returns

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

OcaMediaTransportNetwork.GetSinkConnectors()

Gets the descriptors of all the sink (output) connectors collected by this network object. Return status indicates success of the operation.

Returns

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

OcaMediaTransportNetwork.GetSourceConnector(ID)

Retrieves the descriptor of a given source connector. Return status indicates the success of the operation.

Arguments

  • ID (number) –

Returns

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

OcaMediaTransportNetwork.GetSourceConnectors()

Gets the descriptors of all the source (output) connectors collected by this network object. Return status indicates success of the operation.

Returns

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

OcaMediaTransportNetwork.SetConnectorAlignmentGain(ConnectorID, Gain)

For OcaMediaSinkConnectors only (not source). Sets the Alignment Gain field of the connection descriptor of the referenced connector. Value must be between the min and max values of the AlignmentGain property of this network. A value of NaN will cause the current value of the network’s AlignmentGain property to be used. Return status indicates the success of the operation.

Arguments

  • ConnectorID (number) –

  • Gain (number) –

Returns

Promise.<void> –

OcaMediaTransportNetwork.SetConnectorAlignmentLevel(ConnectorID, Level)

Sets the Alignment Level field of a connector. Value must be between the min and max values of the AlignmentLevel property of this network. A value of NaN will cause the current value of this network’s AlignmentLevel property to be used. Return status indicates the success of the operation.

Arguments

  • ConnectorID (number) –

  • Level (number) –

Returns

Promise.<void> –

OcaMediaTransportNetwork.SetConnectorCoding(ConnectorID, Coding)

Sets the Coding field of the connection descriptor of the referenced connector. Return status indicates the success of the operation.

Arguments
Returns

Promise.<void> –

OcaMediaTransportNetwork.SetConnectorConnection(ConnectorID, Connection)

Sets a connector’s Connection property. Return status indicates the success of the operation.

Arguments
Returns

Promise.<void> –

OcaMediaTransportNetwork.SetPortName(PortID, Name)

Sets the name of the designated port. The return value indicates whether the name was successfully set.

Arguments
Returns

Promise.<void> –

OcaMediaTransportNetwork.SetSinkConnectorPinMap(ConnectorID, ChannelPinMap)

Sets a sink connector’s channel pin map. Return status indicates the success of the operation.

Arguments

  • ConnectorID (number) –

  • Array.<OcaPortID>> ChannelPinMap (Map.<number,) –

Returns

Promise.<void> –

OcaMediaTransportNetwork.SetSourceConnectorPinMap(ConnectorID, ChannelPinMap)

Sets a source connector’s channel pin map. Return status indicates the success of the operation.

Arguments

  • ConnectorID (number) –

  • OcaPortID> ChannelPinMap (Map.<number,) –

Returns

Promise.<void> –