1.7.1 OcaMediaTransportApplication

Class Hierarchy:

OcaRoot : OcaNetworkApplication : OcaMediaTransportApplication

class OcaMediaTransportApplication : OcaNetworkApplication 

Connection Management 4 (CM4) class. Specifies the device’s control interface to media transport functions. This is the anchoring class for CM4 data structures. Abstract class that shall be subclassed for each media transport Adaptation.

Properties:

OcaInterval<OcaDBFS> AlignmentLevelLimits

Alignment level limits for newly-created OcaMediaStreamEndpoint instances. The min and max values of this property define respectively the lowest and highest alignment level values that may be specified when adding stream endpoints to this media transport application.

This property has id 3.9.

static const OcaClassID ClassID = "1.7.1"

This property is an override of the OcaRoot property.

This property has id 1.1.

static const OcaClassVersionNumber ClassVersion = 1

This property is an override of the OcaRoot property.

This property has id 1.2.

OcaList<OcaMediaStreamEndpoint> Endpoints

The list of stream endpoints this media transport application has.

This property has id 3.10.

OcaMap<OcaMediaStreamEndpointID, OcaMediaStreamEndpointStatus> EndpointStatuses

Map of states of this media transport application’s endpoints. Map key is endpoint ID.

This property has id 3.11.

OcaUint16 MaxChannelsPerEndpoint

The maximum number of channels in a stream endpoint that this media transport application will support.

This property has id 3.6.

OcaUint16 MaxInputEndpoints

The maximum number of input stream endpoints this media transport network application can have (read-only property).

This property has id 3.3.

OcaUint16 MaxOutputEndpoints

The maximum number of output stream endpoints this media transport application can have (read-only property).

This property has id 3.4.

OcaUint16 MaxPortsPerChannel

The maximum number of ports per stream endpoint channel that this media transport application will support. Value of zero indicates there is no specific limit.

This property has id 3.5.

OcaList<OcaMediaStreamModeCapability> MediaStreamModeCapabilities

List of media stream mode capability descriptors that apply to this media transport application.

This property has id 3.7.

OcaMap<OcaPortID, OcaPortClockMapEntry> PortClockMap

Map that connects OcaMediaClock3 object numbers to this network’s input and output OcaPorts and specifies sampling rate converters, if any. OcaPortID = {mode,index}, where mode = Input or Output. Optional property.

This property has id 3.2.

OcaList<OcaPort> Ports

The list of OcaPorts this network offers on its inward face.

This property has id 3.1.

OcaList<OcaONo> TransportSessionControlAgentONos

Object number(s) of media transport session control agent(s) associated with this media transport application.

This property has id 3.13.

OcaMediaTransportTimingParameters TransportTimingParameters

Timing parameters for media transport through this media transport application.

This property has id 3.8.

Properties inherited from 1.7 OcaNetworkApplication:

Methods:

OcaStatus AddPort(OcaString Name, OcaIODirection Mode, OcaPortID &ID)

Adds an input or output port..

This method has id 3.1.

Name: Input parameter.
Mode: Input parameter.
ID: Output parameter.

OcaStatus DeletePort(OcaPortID ID)

Deletes an input or output port..

This method has id 3.2.

ID: Input parameter.

OcaStatus GetPorts(OcaList<OcaPort> &OcaPorts)

Gets the list of ports owned by this object.

This method has id 3.3.

OcaPorts: Output parameter.

OcaStatus GetPortName(OcaPortID PortID, OcaString &Name)

Gets the name of the designated port.

This method has id 3.4.

PortID: Input parameter.
Name: Output parameter.

OcaStatus SetPortName(OcaPortID PortID, OcaString Name)

Sets the name of the designated port.

This method has id 3.5.

PortID: Input parameter.
Name: Input parameter.

OcaStatus GetPortClockMap(OcaMap<OcaPortID, OcaPortClockMapEntry> &Map)

Gets the value of the PortClockMap property.

This method has id 3.6.

Map: Output parameter.

OcaStatus SetPortClockMap(OcaMap<OcaPortID, OcaPortClockMapEntry> Map)

Sets the value of the PortClockMap property.

This method has id 3.7.

Map: Input parameter.

OcaStatus SetPortClockMapEntry(OcaPortID ID, OcaPortClockMapEntry Entry)

Adds or replaces an entry in the PortClockMap property.

This method has id 3.8.

ID: Input parameter.
Entry: Input parameter.

OcaStatus DeletePortClockMapEntry(OcaPortID ID)

Deletes the PortClockMap entry identified by the given ID.

This method has id 3.9.

ID: Input parameter.

OcaStatus GetPortClockMapEntry(OcaPortID ID, OcaPortClockMapEntry &Entry)

Retrieves the value of the PortClockMap entry identified by the given port ID.

This method has id 3.10.

ID: Input parameter.
Entry: Output parameter.

OcaStatus GetMaxEndpointCounts(OcaUint16 &MaxOutputCount, OcaUint16 &MaxInputCount)

Gets the maximum number of input and output stream endpoints this media transport application supports.

This method has id 3.11.

MaxOutputCount: Output parameter.
MaxInputCount: Output parameter.

OcaStatus GetMaxPortsPerChannel(OcaUint16 &Value)

Gets the maximum number of ports per stream endpoint channel this media transport application supports.

This method has id 3.12.

Value: Output parameter.

OcaStatus GetMaxChannelsPerEndpoint(OcaUint16 &Value)

Gets the maximum number of channels per stream endpoint this media transport application supports.

This method has id 3.13.

Value: Output parameter.

OcaStatus SetAlignmentLevelLimits(OcaInterval<OcaDBFS> Limits)

Sets the alignment level limits for stream endpoints attached to this media transport application.

This method has id 3.14.

Limits: Input parameter.

OcaStatus GetMediaStreamModeCapabilities(OcaList<OcaMediaStreamModeCapability> &Capabilities)

Gets this media transport application’s media stream mode capability descriptors.

This method has id 3.15.

Capabilities: Output parameter.

OcaStatus SetMediaStreamModeCapabilities(OcaList<OcaMediaStreamModeCapability> Capabilities)

Sets this media transport application’s media stream mode capability descriptors. May only be called when there are no media stream endpoints defined. If this condition is not met, the call will return status value InvalidRequest.

This method has id 3.16.

Capabilities: Input parameter.

OcaStatus GetMediaStreamModeCapability(OcaID16 CapabilityID, OcaMediaStreamModeCapability &Capability)

Gets a specific media stream mode capability descriptor.

This method has id 3.17.

CapabilityID: Input parameter.
Capability: Output parameter.

OcaStatus GetTransportTimingParameters(OcaMediaTransportTimingParameters &Parameters)

Gets this media transport application’s media transport timing parameters.

This method has id 3.18.

Parameters: Output parameter.

OcaStatus SetTransportTimingParameters(OcaMediaTransportTimingParameters Parameters)

Sets this media transport application’s media transport timing parameters. Optional method.

This method has id 3.19.

Parameters: Input parameter.

OcaStatus GetAlignmentLevelLimits(OcaInterval<OcaDBFS> &Limits)

Gets the min and max alignment levels for stream endpoints attached to this media transport application.

This method has id 3.20.

Limits: Output parameter.

OcaStatus GetEndpoints(OcaList<OcaMediaStreamEndpoint> &Endpoints)

Gets the descriptors of all the stream endpoints owned by this media transport application object.

This method has id 3.21.

Endpoints: Output parameter.

OcaStatus GetEndpoint(OcaMediaStreamEndpointID ID, OcaMediaStreamEndpoint &Endpoint)

Retrieves the descriptor of a given stream endpoint.

This method has id 3.22.

ID: Input parameter.
Endpoint: Output parameter.

OcaStatus GetEndpointStatuses(OcaMap<OcaMediaStreamEndpointID, OcaMediaStreamEndpointStatus> &Statuses)

Gets the status of all the stream endpoints collected by this media transport application. Key of returned map is endpoint ID.

This method has id 3.23.

Statuses: Output parameter.

OcaStatus GetEndpointStatus(OcaMediaStreamEndpointID ID, OcaMediaStreamEndpointStatus &Status)

Gets the status of a single stream endpoint.

This method has id 3.24.

ID: Input parameter.
Status: Output parameter.

OcaStatus AddEndpoint(OcaMediaStreamEndpointState InitialStatus)

Adds an Endpoint to this media transport application object. Parameters of the new Endpoint shall be given in the Endpoint parameter; Device shall return the same parameter with the new Endpoint ID filled in. The new Endpoint’s AlignmentLevel value shall be within the bounds set by the property AlignmentLevelLimits.

This method has id 3.25.

InitialStatus: Input parameter.

OcaStatus DeleteEndpoint(OcaMediaStreamEndpointID ID)

Deletes a stream endpoint from this media transport application object.

This method has id 3.26.

ID: Input parameter.

OcaStatus ApplyEndpointCommand(OcaMediaStreamEndpointID EndpointID, OcaMediaStreamEndpointCommand Command)

Changes the state of a given Endpoint.

This method has id 3.27.

EndpointID: Input parameter.
Command: Input parameter.

OcaStatus SetEndpointUserLabel(OcaMediaStreamEndpointID EndpointID, OcaString Label)

Sets the UserLabel field of the of the referenced Endpoint.

This method has id 3.28.

EndpointID: Input parameter.
Label: Input parameter.

OcaStatus SetEndpointMediaStreamMode(OcaMediaStreamEndpointID EndpointID, OcaMediaStreamMode StreamMode)

Sets the CurrentStreamMode field of the of the designated stream endpoint.

This method has id 3.29.

EndpointID: Input parameter.
StreamMode: Input parameter.

OcaStatus SetEndpointChannelMap(OcaMediaStreamEndpointID EndpointID, OcaMultiMap<OcaID16, OcaPortID> ChannelMap)

Sets an Endpoint’s ChannelMap field. Mapping rules:

Input Endpoint maps shall specify only OCA Output Ports.

Output Endpoint maps shall specify only OCA Input Ports.

Input Endpoint maps may specify any number of OCA Output Ports per stream channel.

Output Endpoint maps may specify at most one OCA Input Port per stream channel.

This method has id 3.30.

EndpointID: Input parameter.
ChannelMap: Input parameter.

OcaStatus SetEndpointAlignmentLevel(OcaMediaStreamEndpointID EndpointID, OcaDBFS Level)

Sets OcaEndpoint.AlignmentLevel for the identified endpoint.

This method has id 3.31.

EndpointID: Input parameter.
Level: Input parameter.

OcaStatus GetEndpointTimeSource(OcaMediaStreamEndpointID ID, OcaTimeReferenceType &ReferenceType, OcaString &ReferenceID)

Gets type and ID of this Endpoint’s time source.

This method has id 3.32.

ID: Input parameter.
ReferenceType: Output parameter.
ReferenceID: Output parameter.

OcaStatus SetEndpointAdaptationData(OcaMediaStreamEndpointID EndpointID, OcaAdaptationData Data)

Sets the AdaptationData field of the given Endpoint.

This method has id 3.33.

EndpointID: Input parameter.
Data: Input parameter.

OcaStatus GetEndpointCounterSets(OcaMap<OcaMediaStreamEndpointID, OcaCounterSet> &Sets)

Retrieves map of counter sets of all Endpoints.

This method has id 3.34.

Sets: Output parameter.

OcaStatus GetEndpointCounterSet(OcaMediaStreamEndpointID EndpointID, OcaCounterSet &CounterSet)

Gets the Counterset of a designated Endpoint.

This method has id 3.35.

EndpointID: Input parameter.
CounterSet: Output parameter.

OcaStatus GetEndpointCounter(OcaMediaStreamEndpointID EndpointID, OcaID16 CounterID, OcaCounter &Counter)

Retrieves a Counter of a designated Endpoint

This method has id 3.36.

EndpointID: Input parameter.
CounterID: Input parameter.
Counter: Output parameter.

OcaStatus AttachEndpointCounterNotifier(OcaMediaStreamEndpointID EndpointID, OcaID16 CounterID, OcaONo NotifierONo)

Adds a Notifier to the designated Counter.

This method has id 3.37.

EndpointID: Input parameter.
CounterID: Input parameter.
NotifierONo: Input parameter.

OcaStatus DetachEndpointCounterNotifier(OcaMediaStreamEndpointID EndpointID, OcaID16 CounterID, OcaONo NotifierONo)

Removes a Notifier from the designated Counter.

This method has id 3.38.

EndpointID: Input parameter.
CounterID: Input parameter.
NotifierONo: Input parameter.

OcaStatus ResetEndpointCounterSet(OcaMediaStreamEndpointID EndpointID, OcaID16 CounterID)

Resets Counter(s) of one or all of this media transport application object’s Endpoints.

If given Counter ID is zero, resets entire Counterset; otherwise, resets designated Counter only.

If given Endpoint ID is zero, resets the designated Counter(s) in all this media transport application object’s Endpoints; otherwise, resets the designated Counter(s) in the designated Endpoint only.

Resetting a Counter causes its value to be set to its initial value, as defined in its OcaCounter instance.

This method has id 3.39.

EndpointID: Input parameter.
CounterID: Input parameter.

OcaStatus GetTransportSessionControlAgentONos(OcaList<OcaONo> &ONos)

Gets list of ONos of Media Transport Session Agents associated with this media transport application object, or empty list if there aren’t any.

This method has id 3.40.

ONos: Output parameter.

OcaStatus SetTransportSessionControlAgentONos(OcaList<OcaONo> ONos)

Sets list of ONos of Media Transport Session Agents associated with this media transport application object. Optional method, mainly useful for dynamic devices.

This method has id 3.41.

ONos: Input parameter.

Methods inherited from 1.7 OcaNetworkApplication: