OcaStream

class OcaStream()

A single-channel or multichannel signal flow between a local stream connector (i.e. OcaStreamConnector instance) of an OcaStreamNetwork object in this node and another (“remote”) stream connector. Normally, the remote stream connector is in another node. Each stream is unidirectional. With respect to the OcaStreamNetwork object in question, a stream is either:

• Outbound: A signal flow from an output connector port in the OcaStreamNetwork object to an external destination; or

• Inbound: A signal flow from an external source to an input connector in the OcaStreamNetwork object.

An OcaStream object may represent either a unicast or a multicast stream. Any given OcaStreamConnector object may support multiple outbound flows, but not multiple inbound flows.

OcaStream.ErrorNumber

type: number

Index of most recent error encountered.

OcaStream.IDAdvertised

type: Uint8Array

Public identifier of this stream.

OcaStream.Index

type: number

Index of this stream. Unique within owner OcaNetwork2 object.

OcaStream.Label

type: string

Arbitrary user-settable name for this stream.

OcaStream.LocalConnectorONo

type: number

Object number of OcaStreamConnector object to which this stream is connected. A value of zero means the stream is not connected to any connector in this device.

OcaStream.Priority

type: number

Traffic priority of stream. Values are network implementation dependant.

OcaStream.RemoteConnectorIdentification

type: OcaStreamConnectorIdentification

Full identifier of the connector at the far end of this stream.

OcaStream.Secure

type: boolean

True iff connection is secure.

OcaStream.Status

type: OcaStreamStatus

Current status of the stream.

OcaStream.StreamParameters

type: Uint8Array

Stream parameters (encoding, sampling, etc). Details TBD

OcaStream.StreamType

type: OcaStreamType

Unicast or multicast