Media Transport Session Datatypes

OcaMediaTransportSessionID

using OcaMediaTransportSessionID = OcaUint32 : Internal ID of a Media Transport Session

OcaMediaTransportSessionConnectionID

using OcaMediaTransportSessionConnectionID = OcaUint32 : Internal ID of a connection that belongs to a Media Transport Session

OcaMediaTransportSession

struct OcaMediaTransportSession

Container of all the Media Transport Sessions belonging to a Media Transport Session control Agent.

OcaMediaTransportSessionID IDInternal: Internal ID, unique within OcaTransportSessionControlAgent instance.

OcaBlob IDExternal: External ID, i.e. the ID that is published to the network. Format is Adaptation-specific.

OcaString UserLabel: Arbitrary text label - not programmatically significant.

OcaBoolean StreamingEnabled: TRUE if and only if media streaming is allowed. If set to FALSE, does not cause disconnection.

OcaAdaptationData AdaptationData: Adaptation-specific data.

OcaList<OcaMediaTransportSessionConnection> Connections: This session’s stream connections.

OcaMap<OcaMediaTransportSessionConnectionID, OcaMediaTransportSessionConnectionState> ConnectionStates: State(s) of session’s connection(s). Map key is connection ID.

OcaMediaTransportSessionConnection

struct OcaMediaTransportSessionConnection

A Media Stream connection belonging to an OcaMediaTransportSession instance.

OcaMediaTransportSessionConnectionID ID: Local ID of this connection, unique within OcaMediaTransportSession instance.

OcaMediaStreamEndpointID LocalEndpointID: Value of the IDInternal property of the OcaMediaStreamEndpoint descriptor that applies to the local endpoint of the connection.

OcaBlob RemoteEndpointID: External ID of the remote endpoint of the connection. Typically, this will be the value of the IDexternal property of the applicable OcaMediaStreamEndpoint descriptor in the remote device.

OcaMediaTransportSessionConnectionState

struct OcaMediaTransportSessionConnectionState

State of a stream connection belonging to an OcaMediaTransportSession instance. The state of a stream connection is the union of the states of its two endpoints.

OcaMediaStreamEndpointState LocalEndpointState: State of local endpoint of a connection.

OcaMediaStreamEndpointState RemoteEndpointState: State of remote endpoint of a connection.

OcaMediaTransportSessionStatus

struct OcaMediaTransportSessionStatus

Status of a media transport session. Two parts: a generic part, and an application-specific part.

OcaMediaTransportSessionState State: Generic state of session

OcaBlob AdaptationData: Adaptation-dependent state data

OcaMediaTransportSessionState

enum OcaMediaTransportSessionState : uint8_t

State of a session

enumerator Unconfigured = 1: Session has no connection information

enumerator Configured = 2: Session has connection information but not all of its connections are actually connected.

enumerator ConnectedNotStreaming = 3: All Media Stream connections are connected but no data is flowing.

enumerator ConnectedStreaming = 4: All Media Stream connections are connected and data is flowing.

enumerator Error = 5: An error has occurred. Condition of Media Stream data flow is application- and circumstance-dependent.