Index

Class OcaMediaTransportNetwork

ClassID: 1.4.2

extends OcaApplicationNetwork

Properties

static readonly OcaClassID ClassID = 1.4.2

Level: 1 Index: 1

This property is an override of the OcaRoot property.

static readonly OcaClassVersionNumber ClassVersion = 1

Level: 1 Index: 2

This property is an override of the OcaRoot property.

OcaNetworkMediaProtocol Protocol

Level: 3 Index: 1

Type of media transport protocol used by the network.

OcaList<OcaPort> Ports

Level: 3 Index: 2

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.

OcaUint16 MaxSourceConnectors

Level: 3 Index: 3

The maximum number of source connectors this media transport network can have (read-only property).

OcaUint16 MaxSinkConnectors

Level: 3 Index: 4

The maximum number of sink connectors this media transport network can have (read-only property).

OcaUint16 MaxPinsPerConnector

Level: 3 Index: 5

The maximum number of pins (channels) in a connector that this network will support.

OcaUint16 MaxPortsPerPin

Level: 3 Index: 6

The maximum number of ports per pin that this network will support. Value of zero indicates there is no specific limit.

OcaDBFS AlignmentLevel

Level: 3 Index: 7

Default alignment level value for newly-created OcaMedia{Source|Sink}Connector 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.

OcaDB AlignmentGain

Level: 3 Index: 8

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.

OcaList<OcaMediaSinkConnector> SinkConnectors

The list of sink connectors this network has. This is a private property, so it does not generate property-change events. It may be accessed by the relevant methods.

OcaList<OcaMediaSourceConnector> SourceConnectors

The list of source connectors this network has. This is a private property, so it does not generate property-change events. It may be accessed by the relevant methods.

Properties inherited from OcaApplicationNetwork

static OcaString Label

static OcaONo Owner

OcaApplicationNetworkServiceID ServiceID

OcaList<OcaNetworkSystemInterfaceDescriptor> SystemInterfaces

OcaApplicationNetworkState State

OcaUint16 ErrorCode

Properties inherited from OcaRoot

readonly OcaONo ObjectNumber

readonly OcaBoolean Lockable

readonly OcaString Role

Methods

OcaMediaTransportNetwork::GetMediaProtocol ( ) → ( OcaNetworkMediaProtocol Protocol)

Level: 3 Index: 1

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

OcaMediaTransportNetwork::GetPorts ( ) → ( OcaList<OcaPort> OcaPorts)

Level: 3 Index: 2

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.

OcaMediaTransportNetwork::GetPortName ( OcaPortID PortID ) → ( OcaString Name)

Level: 3 Index: 3

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

OcaMediaTransportNetwork::SetPortName ( OcaPortID PortID, OcaString Name )

Level: 3 Index: 4

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

OcaMediaTransportNetwork::GetMaxSourceConnectors ( ) → ( OcaUint16 MaxSourceConnectors)

Level: 3 Index: 5

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

OcaMediaTransportNetwork::GetMaxSinkConnectors ( ) → ( OcaUint16 MaxSinkConnectors)

Level: 3 Index: 6

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

OcaMediaTransportNetwork::GetMaxPinsPerConnector ( ) → ( OcaUint16 MaxPins)

Level: 3 Index: 7

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

OcaMediaTransportNetwork::GetMaxPortsPerPin ( ) → ( OcaUint16 MaxPins)

Level: 3 Index: 8

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

OcaMediaTransportNetwork::GetSourceConnectors ( ) → ( OcaList<OcaMediaSourceConnector> Connectors)

Level: 3 Index: 9

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

OcaMediaTransportNetwork::GetSourceConnector ( OcaMediaConnectorID ID ) → ( OcaMediaSourceConnector Connector)

Level: 3 Index: 10

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

OcaMediaTransportNetwork::GetSinkConnectors ( ) → ( OcaList<OcaMediaSinkConnector> Connectors)

Level: 3 Index: 11

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

OcaMediaTransportNetwork::GetSinkConnector ( OcaMediaConnectorID ID ) → ( OcaMediaSinkConnector Connector)

Level: 3 Index: 12

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

OcaMediaTransportNetwork::GetConnectorsStatuses ( ) → ( OcaList<OcaMediaConnectorStatus> Statuses)

Level: 3 Index: 13

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

OcaMediaTransportNetwork::GetConnectorStatus ( OcaMediaConnectorID ConnectorID ) → ( OcaMediaConnectorStatus Status)

Level: 3 Index: 14

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

OcaMediaTransportNetwork::AddSourceConnector ( OcaMediaSourceConnector Connector, OcaMediaConnectorState InitialStatus ) → ( OcaMediaSourceConnector Connector_)

Level: 3 Index: 15

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.

OcaMediaTransportNetwork::AddSinkConnector ( OcaMediaConnectorStatus InitialStatus, OcaMediaSinkConnector Connector ) → ( OcaMediaSinkConnector Connector_)

Level: 3 Index: 16

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.

OcaMediaTransportNetwork::ControlConnector ( OcaMediaConnectorID ConnectorID, OcaMediaConnectorCommand Command )

Level: 3 Index: 17

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

OcaMediaTransportNetwork::SetSourceConnectorPinMap ( OcaMediaConnectorID ConnectorID, OcaMap<OcaUint16,OcaPortID> ChannelPinMap )

Level: 3 Index: 18

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

OcaMediaTransportNetwork::SetSinkConnectorPinMap ( OcaMediaConnectorID ConnectorID, OcaMultiMap<OcaUint16,OcaPortID> ChannelPinMap )

Level: 3 Index: 19

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

OcaMediaTransportNetwork::SetConnectorConnection ( OcaMediaConnectorID ConnectorID, OcaMediaConnection Connection )

Level: 3 Index: 20

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

OcaMediaTransportNetwork::SetConnectorCoding ( OcaMediaConnectorID ConnectorID, OcaMediaCoding Coding )

Level: 3 Index: 21

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

OcaMediaTransportNetwork::SetConnectorAlignmentLevel ( OcaMediaConnectorID ConnectorID, OcaDBFS Level )

Level: 3 Index: 22

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.

OcaMediaTransportNetwork::SetConnectorAlignmentGain ( OcaMediaConnectorID ConnectorID, OcaDB Gain )

Level: 3 Index: 23

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.

OcaMediaTransportNetwork::DeleteConnector ( OcaMediaConnectorID ID )

Level: 3 Index: 24

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

OcaMediaTransportNetwork::GetAlignmentLevel ( ) → ( OcaDBFS Level, OcaDBFS MinLevel, OcaDBFS MaxLevel)

Level: 3 Index: 25

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

OcaMediaTransportNetwork::GetAlignmentGain ( ) → ( OcaDB Gain, OcaDB minGain, OcaDB maxGain)

Level: 3 Index: 26

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

Methods inherited from OcaApplicationNetwork

OcaApplicationNetwork::GetLabel ( ) → ( OcaString Label)

OcaApplicationNetwork::SetLabel ( OcaString Label )

OcaApplicationNetwork::GetOwner ( ) → ( OcaONo Owner)

OcaApplicationNetwork::GetServiceID ( ) → ( OcaApplicationNetworkServiceID Name)

OcaApplicationNetwork::SetServiceID ( OcaApplicationNetworkServiceID Name )

OcaApplicationNetwork::GetSystemInterfaces ( ) → ( OcaList<OcaNetworkSystemInterfaceDescriptor> SystemInterfaces)

OcaApplicationNetwork::SetSystemInterfaces ( OcaList<OcaNetworkSystemInterfaceDescriptor> Descriptors )

OcaApplicationNetwork::GetState ( ) → ( OcaApplicationNetworkState State)

OcaApplicationNetwork::GetErrorCode ( ) → ( OcaUint16 ErrorCode)

OcaApplicationNetwork::Control ( OcaApplicationNetworkCommand Command )

OcaApplicationNetwork::GetPath ( ) → ( OcaNamePath NamePath, OcaONoPath ONoPath)

Methods inherited from OcaRoot

OcaRoot::GetClassIdentification ( ) → ( OcaClassIdentification ClassIdentification)

OcaRoot::GetLockable ( ) → ( OcaBoolean lockable)

OcaRoot::LockTotal ( )

OcaRoot::Unlock ( )

OcaRoot::GetRole ( ) → ( OcaString Role)

OcaRoot::LockReadonly ( )

Events

Event SourceConnectorChanged

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

Event SinkConnectorChanged

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

Event ConnectorStatusChanged

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