ADTF  3.15.3
ISessionabstract

Main interface for a Session. More...

Inheritance diagram for ISession:
[legend]

Public Member Functions

 ADTF_IID (ISession, "session.ant.services.adtf.iid")
 definition of interface id
 
virtual tResult SetSessionName (const char *strSessionFileName)=0
 Sets the session name. More...
 
virtual tResult GetSessionName (base::ant::IString &&strSessionName)=0
 Retrieves the session name. More...
 
virtual tResult SetSystemFile (const char *strSystemFileName, const char *strSystemPropertiesFileName)=0
 Sets and loads a system file. More...
 
virtual tResult GetSystemFile (base::ant::IString &&strSystemFile) const =0
 Retrieves the filepath of the set ADTF System File. More...
 
virtual tResult GetSystemPropertiesFile (base::ant::IString &&strProperties) const =0
 Retrieves the filepath of the set ADTF System File Properties. More...
 
virtual tResult SetGraphFile (const char *strGraphFileName, const char *strPropertiesFileName)=0
 Sets and loads the current adtfgraph file. More...
 
virtual tResult GetGraphFile (base::ant::IString &&strGraph) const =0
 Retrieves the filepath of the set ADTF Graph File. More...
 
virtual tResult GetGraphPropertiesFile (base::ant::IString &&strProperties) const =0
 Retrieves the filepath of the set ADTF Graph File Properties. More...
 
virtual tResult GetCurrentFilterGraph (ucom::ant::iobject_ptr< streaming::ant::IFilterGraph > &pGraph) const =0
 Returns a reference to the current instantiated FilterGraph. More...
 
virtual tResult GetCurrentStreamingGraph (ucom::ant::iobject_ptr< streaming::ant::IStreamingGraph > &pStreamingGraph) const =0
 Returns a reference to the current instantiated FilterGraph. More...
 
virtual tResult SetActiveFilterGraph (const char *strActiveFilterGraph)=0
 Sets the active filter graph name. More...
 
virtual tResult GetActiveFilterGraph (base::ant::IString &&strActiveFilterGraph) const =0
 Returns the name of current active filter graph set. More...
 
virtual tResult SetActiveStreamingGraph (const char *strActiveStreamingGraph)=0
 Sets the active streaming graph name. More...
 
virtual tResult GetActiveStreamingGraph (base::ant::IString &&strActiveStreamingGraph) const =0
 Returns the name of current active streaming graph set. More...
 
- Public Member Functions inherited from IObject
 ADTF_IID (IObject, "object.ant.ucom.adtf.iid")
 Marks the IObject to be castable with the ucom_cast() More...
 

Protected Member Functions

 ~ISession ()=default
 not destructable
 
- Protected Member Functions inherited from IObject
 ~IObject ()=default
 Protected destructor --> Use implemented Destroy() instead of delete!
 

Detailed Description

Main interface for a Session.

The Session is responsible for loading, initializing configuraing a particular Filter Graph. The default implementation can be reached via Session Manager. See section_system_core_objects.

Definition at line 29 of file session_intf.h.

Member Function Documentation

◆ GetActiveFilterGraph()

virtual tResult GetActiveFilterGraph ( base::ant::IString &&  strActiveFilterGraph) const
pure virtual

Returns the name of current active filter graph set.

Parameters
[out]strActiveFilterGraphname of filter graph.
Returns
Standard Result Code
See also
sec_filter_graph, Session, ADTF Session XML Schema file

◆ GetActiveStreamingGraph()

virtual tResult GetActiveStreamingGraph ( base::ant::IString &&  strActiveStreamingGraph) const
pure virtual

Returns the name of current active streaming graph set.

Parameters
[out]strActiveStreamingGraphname of streaming graph.
Returns
Standard Result Code
See also
page_streaming_graph, Session, ADTF Session XML Schema file

◆ GetCurrentFilterGraph()

virtual tResult GetCurrentFilterGraph ( ucom::ant::iobject_ptr< streaming::ant::IFilterGraph > &  pGraph) const
pure virtual

Returns a reference to the current instantiated FilterGraph.

Remarks
A FilterGraph is only available while adtf::ucom::IRuntime::RL_Application and higher!
This is the only possibility to get references to all filters. In contrast to ADTF2 the Filters were not registered within the adtf::ucom::ant::IRuntime.
Parameters
[out]pGraphReference object to return the FilterGraph to.
Returns
Standard Result Code
See also
sec_filter_graph

◆ GetCurrentStreamingGraph()

virtual tResult GetCurrentStreamingGraph ( ucom::ant::iobject_ptr< streaming::ant::IStreamingGraph > &  pStreamingGraph) const
pure virtual

Returns a reference to the current instantiated FilterGraph.

Remarks
A FilterGraph is only available while adtf::ucom::IRuntime::RL_Application and higher!
This is the only possibility to get references to all filters. In contrast to ADTF2 the Filters were not registered within the adtf::ucom::ant::IRuntime.
Parameters
[out]pStreamingGraphReference object to return the StreamingGraph to.
Returns
Standard Result Code
See also
page_streaming_graph

◆ GetGraphFile()

virtual tResult GetGraphFile ( base::ant::IString &&  strGraph) const
pure virtual

Retrieves the filepath of the set ADTF Graph File.

Parameters
[out]strGraphThe IString where to return the filepath to.
Return values
ERR_NOERRORThe filpath was set.
Returns
Usually it returns the return value of adtf::base::IString::Set
See also
SetGraphFile

◆ GetGraphPropertiesFile()

virtual tResult GetGraphPropertiesFile ( base::ant::IString &&  strProperties) const
pure virtual

Retrieves the filepath of the set ADTF Graph File Properties.

Parameters
[out]strPropertiesThe IString where to return the filepath to.
Return values
ERR_NOERRORThe filpath was set.
Returns
Usually it returns the return value of adtf::base::IString::Set
See also
SetGraphFile

◆ GetSessionName()

virtual tResult GetSessionName ( base::ant::IString &&  strSessionName)
pure virtual

Retrieves the session name.

Parameters
[out]strSessionNameThe IString where to return the name to.
Return values
ERR_NOERRORThe name was set.
Returns
Usually it returns the return value of adtf::base::IString::Set

◆ GetSystemFile()

virtual tResult GetSystemFile ( base::ant::IString &&  strSystemFile) const
pure virtual

Retrieves the filepath of the set ADTF System File.

Parameters
[out]strSystemFileThe IString where to return the filepath to.
Return values
ERR_NOERRORThe filpath was set.
Returns
Usually it returns the return value of adtf::base::IString::Set
See also
SetSystemFile

◆ GetSystemPropertiesFile()

virtual tResult GetSystemPropertiesFile ( base::ant::IString &&  strProperties) const
pure virtual

Retrieves the filepath of the set ADTF System File Properties.

Parameters
[out]strPropertiesThe IString where to return the filepath to.
Return values
ERR_NOERRORThe filpath was set.
Returns
Usually it returns the return value of adtf::base::ant::IString::Set
See also
SetSystemFile

◆ SetActiveFilterGraph()

virtual tResult SetActiveFilterGraph ( const char *  strActiveFilterGraph)
pure virtual

Sets the active filter graph name.

This name must be part of the ADTF Graph File.

Remarks
A ADTF Graph File must be set ! (see SetGraphFile)
Parameters
[in]strActiveFilterGraphname of filter graph to set.
Returns
Standard Result Code
See also
sec_filter_graph, Session, ADTF Session XML Schema file

◆ SetActiveStreamingGraph()

virtual tResult SetActiveStreamingGraph ( const char *  strActiveStreamingGraph)
pure virtual

Sets the active streaming graph name.

This name must be part of the ADTF Graph File.

Remarks
A ADTF Graph File must be set ! (see SetGraphFile)
Parameters
[in]strActiveStreamingGraphname of streaming graph to set.
Returns
Standard Result Code
See also
page_streaming_graph, Session, ADTF Session XML Schema file

◆ SetGraphFile()

virtual tResult SetGraphFile ( const char *  strGraphFileName,
const char *  strPropertiesFileName 
)
pure virtual

Sets and loads the current adtfgraph file.

Parameters
[in]strGraphFileNamePath to the Graph File to set.
[in]strPropertiesFileNamePath to the Property File to set.
Returns
Standard Result Code
See also
page_adtfxsd_graph

◆ SetSessionName()

virtual tResult SetSessionName ( const char *  strSessionFileName)
pure virtual

Sets the session name.

Parameters
[in]strSessionFileNameThe name to set.
Return values
ERR_NOERRORThe name was set.
See also
GetSessionName

◆ SetSystemFile()

virtual tResult SetSystemFile ( const char *  strSystemFileName,
const char *  strSystemPropertiesFileName 
)
pure virtual

Sets and loads a system file.

Parameters
[in]strSystemFileNamePath to the System File to set.
[in]strSystemPropertiesFileNamePath to the System Properties File to set.
Returns
Standard Result Code
See also
ADTF Graph XML Schema file
GetSystemFile, GetSystemPropertiesFile
Remarks
This function may only succeed if called while RL_Shutdown