adtf::services::ant::ISessionManager Class Reference

Session Manager interface defines System Core Object. More...

#include <session_intf.h>

Inherits adtf::ucom::ant::IObject.

Inherited by adtf::services::joker::ISessionManager.

Public Member Functions
	ADTF_IID (ISessionManager, "sessionmanager.ant.services.adtf.iid")
	definition of interface id
virtual tResult	CreateSession ()=0
virtual tResult	CreateSession (const char *strSessionFileName)=0
virtual tResult	ReleaseSession ()=0
virtual tResult	GetSessionFile (base::ant::IString &&strSessionFilePath) const =0
virtual tResult	GetCurrentSession (ucom::ant::iobject_ptr< ant::ISession > &pCurrentSession) const =0
Public Member Functions inherited from adtf::ucom::ant::IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")

Protected Member Functions
	~ISessionManager ()=default
	not destructable
Protected Member Functions inherited from adtf::ucom::ant::IObject
	~IObject ()=default
	Protected destructor --> Only the final implementation can be destroyed!

Detailed Description

Session Manager interface defines System Core Object.

The Session Manager is a recommended part of the adtf::system::ant::cADTFSystem and able to read the ADTF Session File to:

• Load Plugins
• Create ADTF Service
• Load and initialize the streaming graph
• Load and initialize the filter graph

Member Function Documentation

CreateSession() [1/2]

virtual tResult adtf::services::ant::ISessionManager::CreateSession ( )

pure virtual

Create a section_session within the Sessionmanager.

Remarks

This function will fail if runlevel is above RL_Shutdown

Returns

Standard Result Code

See also

create_empty_session

CreateSession() [2/2]

virtual tResult adtf::services::ant::ISessionManager::CreateSession ( const char * strSessionFileName )

pure virtual

Create a section_session within the Sessionmanager and will load the given strSessionFileName.

Remarks

This function will fail if runlevel is above RL_Shutdown!

Returns

Standard Result Code

GetCurrentSession()

virtual tResult adtf::services::ant::ISessionManager::GetCurrentSession ( ucom::ant::iobject_ptr< ant::ISession > & pCurrentSession ) const

pure virtual

Gets the current session if created.

Parameters

[in,out]

pCurrentSession

reference object to return the session to Use get_session() to retrieve the latest ISession interface.

Returns

Standard Result Code

See also

CreateSession

adtf::services::get_session

GetSessionFile()

virtual tResult adtf::services::ant::ISessionManager::GetSessionFile ( base::ant::IString && strSessionFilePath ) const

pure virtual

Returns the current session file if set.

Parameters

[in,out]

strSessionFilePath

return value to set the current set path of the ADTF Session File

Returns

Standard Result Code

See also

CreateSession

ReleaseSession()

virtual tResult adtf::services::ant::ISessionManager::ReleaseSession ( )

pure virtual

Release a Session.

Returns

Standard Result Code

---

The documentation for this class was generated from the following file:

• src/libraries/systemsdk/include/adtfsystemsdk/services/session_intf.h