1.2.20 OcaMediaTransportSessionAgent

Class Hierarchy:

OcaRoot : OcaAgent : OcaMediaTransportSessionAgent

class OcaMediaTransportSessionAgent : OcaAgent

Agent to set up, monitor, control, and take down media transport sessions. This shall be the base class for the AES70-CM4 connection management feature. See [AES70-1(Connection Management)]. This is an optional class. Session management functionality is not a mandatory for CM4 implementations.

Properties:

OcaAdaptationData AdaptationData

Session-type-specific data.

This property has id 3.4.

static const OcaClassID ClassID = "1.2.20"

Number that uniquely identifies the class. Note that this differs from the object number, which identifies the instantiated object. This property is an override of the OcaRoot property.

This property has id 1.1.

static const OcaClassVersionNumber ClassVersion = 1

Identifies the interface version of the class. Any change to the class definition leads to a higher class version. This property is an override of the OcaRoot property.

This property has id 1.2.

OcaList<OcaMediaTransportSession> Sessions

Set of transport sessions this Agent contains.

This property has id 3.2.

OcaMap<OcaMediaTransportSessionID, OcaMediaTransportSessionStatus> SessionStatuses

Statuses of transport sessions this Agent contains.

This property has id 3.3.

const OcaString SessionType

Type of session supported by this session agent. Read-only string value. Values beginning with”oca” in any character case are reserved.

This property has id 3.1.

Properties inherited from 1.2 OcaAgent:

Methods:

OcaStatus GetSessionType(OcaString &Type)

Gets type of session supported by this session agent.

This method has id 3.1.

  • Type: Output parameter.

OcaStatus GetSessions(OcaList<OcaMediaTransportSession> &Sessions)

Gets the list of transport sessions held by this Agent.

This method has id 3.2.

OcaStatus GetSession(OcaMediaTransportSessionID ID, OcaMediaTransportSession &Session)

Gets the designated session.

This method has id 3.3.

  • ID: Input parameter.

  • Session: Output parameter.

OcaStatus AddSession()

Adds a new session. Returns given OcaMediaTransportSession parameter with session ID filled in.

This method has id 3.4.

OcaStatus ConfigureSession(OcaMediaTransportSessionID IDinternal, OcaBlob IDexternal, OcaString UserLabel, OcaBlob AdaptationData)

Configures a session.

This method has id 3.5.

OcaStatus DeleteSession(OcaMediaTransportSessionID ID)

Deletes the designated session. Closes all connections the session contains.

This method has id 3.6.

  • ID: Input parameter.

OcaStatus ResetSession(OcaMediaTransportSessionID ID)

Resets the designated session. Returns the session to the state it has following a device reset.

This method has id 3.7.

  • ID: Input parameter.

OcaStatus SetStreamingEnabled(OcaMediaTransportSessionID ID, OcaBoolean Active)

Sets the streaming enabled switch.

This method has id 3.8.

  • ID: Input parameter.

  • Active: Input parameter.

OcaStatus StartStreaming(OcaMediaTransportSessionID ID)

if StreamingEnabled is TRUE, changes state from ConnectedNotStreaming to ConnectedStreaming.

This method has id 3.9.

  • ID: Input parameter.

OcaStatus StopStreaming(OcaMediaTransportSessionID ID)

if state is ConnectedStreaming, changes state to ConnectedNotStreaming.

This method has id 3.10.

  • ID: Input parameter.

OcaStatus GetSessionStatuses(OcaMap<OcaMediaTransportSessionID, OcaMediaTransportSessionStatus> &Sessions)

Gets the map of statuses of transport sessions held by this Agent.

This method has id 3.11.

OcaStatus GetSessionStatus(OcaMediaTransportSessionID ID, OcaMediaTransportSessionStatus &Session)

Gets status of the designated transport session.

This method has id 3.12.

  • ID: Input parameter.

  • Session: Output parameter.

OcaStatus AddConnection(OcaMediaTransportSessionID SessionID)

Adds a new connection to an existing transport session. Returns given OcaMediaTransportSessionConnection parameter with connection ID filled in.

This method has id 3.13.

OcaStatus ConfigureConnection(OcaMediaTransportSessionID SessionID, OcaMediaTransportSessionConnectionID ConnectionID, OcaMediaStreamEndpointID LocalEndpointID, OcaBlob RemoteEndpointID)

Configures a connection.

This method has id 3.14.

OcaStatus DeleteConnection(OcaMediaTransportSessionID SessionID, OcaMediaTransportSessionConnectionID ConnectionID)

Deletes a connection from a transport session.

This method has id 3.15.

OcaStatus DeleteConnections(OcaMediaTransportSessionID SessionID)

Deletes all connections from a transport session.

This method has id 3.16.

OcaStatus GetAdaptationData(OcaAdaptationData &Data)

Gets value of property AdaptationData

This method has id 3.17.

  • Data: Output parameter.

OcaStatus SetAdaptationData(OcaAdaptationData Data)

Sets value of property AdaptationData

This method has id 3.18.

  • Data: Input parameter.

Methods inherited from 1.2 OcaAgent: