1.4.2 OcaMediaTransportNetwork

Class Hirarchy:

OcaRootOcaApplicationNetworkOcaMediaTransportNetwork

class OcaMediaTransportNetwork : OcaApplicationNetwork

Properties:

OcaClassID ClassID

This property is an override of the OcaRoot property.

This property has id 3.1.

OcaClassVersionNumber ClassVersion

This property is an override of the OcaRoot property.

This property has id 3.2.

OcaNetworkMediaProtocol Protocol

Type of media transport protocol used by the network.

This property has id 3.1.

OcaList<OcaPort> Ports

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.

This property has id 3.2.

OcaUint16 MaxSourceConnectors

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

This property has id 3.3.

OcaUint16 MaxSinkConnectors

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

This property has id 3.4.

OcaUint16 MaxPinsPerConnector

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

This property has id 3.5.

OcaUint16 MaxPortsPerPin

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

This property has id 3.6.

OcaDBFS AlignmentLevel

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.

This property has id 3.7.

OcaDB AlignmentGain

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.

This property has id 3.8.

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.

This property has id 3.0.

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.

This property has id 3.0.

Properties inherited from OcaApplicationNetwork:

Properties inherited from OcaRoot:

Methods:

OcaStatus GetMediaProtocol(OcaNetworkMediaProtocol &Protocol)

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

This method has id 3.1.

Parameters

OcaNetworkMediaProtocol Protocol – Output parameter.

OcaStatus GetPorts(OcaList<OcaPort> &OcaPorts)

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.

This method has id 3.2.

Parameters

OcaList<OcaPort> OcaPorts – Output parameter.

OcaStatus GetPortName(OcaPortID PortID, OcaString &Name)

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

This method has id 3.3.

Parameters
  • OcaPortID PortID – Input parameter.

  • OcaString Name – Output parameter.

OcaStatus SetPortName(OcaPortID PortID, OcaString Name)

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

This method has id 3.4.

Parameters
  • OcaPortID PortID – Input parameter.

  • OcaString Name – Input parameter.

OcaStatus GetMaxSourceConnectors(OcaUint16 &MaxSourceConnectors)

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

This method has id 3.5.

Parameters

OcaUint16 MaxSourceConnectors – Output parameter.

OcaStatus GetMaxSinkConnectors(OcaUint16 &MaxSinkConnectors)

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

This method has id 3.6.

Parameters

OcaUint16 MaxSinkConnectors – Output parameter.

OcaStatus GetMaxPinsPerConnector(OcaUint16 &MaxPins)

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

This method has id 3.7.

Parameters

OcaUint16 MaxPins – Output parameter.

OcaStatus GetMaxPortsPerPin(OcaUint16 &MaxPins)

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

This method has id 3.8.

Parameters

OcaUint16 MaxPins – Output parameter.

OcaStatus GetSourceConnectors(OcaList<OcaMediaSourceConnector> &Connectors)

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

This method has id 3.9.

Parameters

OcaList<OcaMediaSourceConnector> Connectors – Output parameter.

OcaStatus GetSourceConnector(OcaMediaConnectorID ID, OcaMediaSourceConnector &Connector)

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

This method has id 3.10.

Parameters
  • OcaMediaConnectorID ID – Input parameter.

  • OcaMediaSourceConnector Connector – Output parameter.

OcaStatus GetSinkConnectors(OcaList<OcaMediaSinkConnector> &Connectors)

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

This method has id 3.11.

Parameters

OcaList<OcaMediaSinkConnector> Connectors – Output parameter.

OcaStatus GetSinkConnector(OcaMediaConnectorID ID, OcaMediaSinkConnector &Connector)

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

This method has id 3.12.

Parameters
  • OcaMediaConnectorID ID – Input parameter.

  • OcaMediaSinkConnector Connector – Output parameter.

OcaStatus GetConnectorsStatuses(OcaList<OcaMediaConnectorStatus> &Statuses)

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

This method has id 3.13.

Parameters

OcaList<OcaMediaConnectorStatus> Statuses – Output parameter.

OcaStatus GetConnectorStatus(OcaMediaConnectorID ConnectorID, OcaMediaConnectorStatus &Status)

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

This method has id 3.14.

Parameters
  • OcaMediaConnectorID ConnectorID – Input parameter.

  • OcaMediaConnectorStatus Status – Output parameter.

OcaStatus AddSourceConnector(OcaMediaSourceConnector Connector, OcaMediaConnectorState InitialStatus, OcaMediaSourceConnector &Connector_)

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.

This method has id 3.15.

Parameters
  • OcaMediaSourceConnector Connector – Input parameter.

  • OcaMediaConnectorState InitialStatus – Input parameter.

  • OcaMediaSourceConnector Connector – Output parameter.

OcaStatus AddSinkConnector(OcaMediaConnectorStatus InitialStatus, OcaMediaSinkConnector Connector, OcaMediaSinkConnector &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.

This method has id 3.16.

Parameters
  • OcaMediaConnectorStatus InitialStatus – Input parameter.

  • OcaMediaSinkConnector Connector – Input parameter.

  • OcaMediaSinkConnector Connector – Output parameter.

OcaStatus ControlConnector(OcaMediaConnectorID ConnectorID, OcaMediaConnectorCommand Command)

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

This method has id 3.17.

Parameters
  • OcaMediaConnectorID ConnectorID – Input parameter.

  • OcaMediaConnectorCommand Command – Input parameter.

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

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

This method has id 3.18.

Parameters
  • OcaMediaConnectorID ConnectorID – Input parameter.

  • OcaMap<OcaUint16, OcaPortID> ChannelPinMap – Input parameter.

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

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

This method has id 3.19.

Parameters
  • OcaMediaConnectorID ConnectorID – Input parameter.

  • OcaMultiMap<OcaUint16, OcaPortID> ChannelPinMap – Input parameter.

OcaStatus SetConnectorConnection(OcaMediaConnectorID ConnectorID, OcaMediaConnection Connection)

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

This method has id 3.20.

Parameters
  • OcaMediaConnectorID ConnectorID – Input parameter.

  • OcaMediaConnection Connection – Input parameter.

OcaStatus SetConnectorCoding(OcaMediaConnectorID ConnectorID, OcaMediaCoding Coding)

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

This method has id 3.21.

Parameters
  • OcaMediaConnectorID ConnectorID – Input parameter.

  • OcaMediaCoding Coding – Input parameter.

OcaStatus SetConnectorAlignmentLevel(OcaMediaConnectorID ConnectorID, OcaDBFS 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.

This method has id 3.22.

Parameters
  • OcaMediaConnectorID ConnectorID – Input parameter.

  • OcaDBFS Level – Input parameter.

OcaStatus SetConnectorAlignmentGain(OcaMediaConnectorID ConnectorID, OcaDB 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.

This method has id 3.23.

Parameters
  • OcaMediaConnectorID ConnectorID – Input parameter.

  • OcaDB Gain – Input parameter.

OcaStatus DeleteConnector(OcaMediaConnectorID ID)

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

This method has id 3.24.

Parameters

OcaMediaConnectorID ID – Input parameter.

OcaStatus GetAlignmentLevel(OcaDBFS &Level, OcaDBFS &MinLevel, OcaDBFS &MaxLevel)

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

This method has id 3.25.

Parameters
  • OcaDBFS Level – Output parameter.

  • OcaDBFS MinLevel – Output parameter.

  • OcaDBFS MaxLevel – Output parameter.

OcaStatus GetAlignmentGain(OcaDB &Gain, OcaDB &minGain, OcaDB &maxGain)

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

This method has id 3.26.

Parameters
  • OcaDB Gain – Output parameter.

  • OcaDB minGain – Output parameter.

  • OcaDB maxGain – Output parameter.

Methods inherited from OcaApplicationNetwork:

Methods inherited from OcaRoot:

Events:

void SourceConnectorChanged(OcaMediaSourceConnectorChangedEventData eventData)

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

void SinkConnectorChanged(OcaMediaSinkConnectorChangedEventData eventData)

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

void ConnectorStatusChanged(OcaMediaConnectorStatusChangedEventData eventData)

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