adtf::services::ISessionManager Class Reference

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

#include <session_intf.h>

Inherits adtf::services::joker::ISessionManager.

Public Member Functions
	ADTF_IID (ISessionManager, "session_manager.x.services.adtf.iid")
	definition of interface id
virtual tResult	SetEnvironmentFile (const char *strEnvironmentFile, bool bPluginDiscovery)=0
virtual tResult	SetEnvironmentFile (const char *strEnvironmentFile)=0
Public Member Functions inherited from adtf::services::joker::ISessionManager
	ADTF_IID (ISessionManager, "session_manager.joker.services.adtf.iid")
	definition of interface id
Public Member Functions inherited from adtf::services::ant::ISessionManager
	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::services::joker::ISessionManager
	~ISessionManager ()=default
	not destructable
Protected Member Functions inherited from adtf::services::ant::ISessionManager
	~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

SetEnvironmentFile() [1/2]

virtual tResult adtf::services::joker::ISessionManager::SetEnvironmentFile ( const char * strEnvironmentFile )

virtual

Set the environment file that should be used when creating a session

Parameters

[in]

strEnvironmentFile

The environment file.

Returns

standard result code.

Implements adtf::services::joker::ISessionManager.

SetEnvironmentFile() [2/2]

virtual tResult adtf::services::x::ISessionManager::SetEnvironmentFile ( const char * strEnvironmentFile, bool bPluginDiscovery )

pure virtual

Set the environment file that should be used when creating a session

Parameters

[in]	strEnvironmentFile	The environment file.
[in]	bPluginDiscovery	Whether or not all available plugin descriptions from the environment should be loaded and used for the automatic lookup and loading of required plugins when creating class instances. Will also enable the loading of all available adtf_file plugins during session creation.

Returns

Standard result code.

---

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

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