ADTF  3.18.2
ISessionabstract
Inheritance diagram for ISession:
[legend]

Public Member Functions

 ADTF_IID (ISession, "session.catwo.remote.adtf")
 RPC interface ID of the ADTF Session RPC object server.
 
virtual const char * GetObjects () const =0
 Get all available session objects. More...
 
virtual const char * GetProperties (const char *strObject) const =0
 Retrieve the properties and their values of a given session object. More...
 
virtual const char * GetProperty (const char *strObject, const char *strPropertyName) const =0
 Gets the value of a given property. More...
 
virtual tResult SetProperty (const char *strObject, const char *strPropertyName, const char *strPropertyValue)=0
 Sets the value of a given property. More...
 
- Public Member Functions inherited from ISession
 ADTF_IID (ISession, "session.ant.remote.adtf")
 RPC interface ID of the ADTF Session RPC object server.
 
virtual const char * GetSessionUrl () const =0
 
virtual const char * GetSystemUrl () const =0
 
virtual const char * GetSystemPropertiesUrl () const =0
 
virtual const char * GetGraphUrl () const =0
 
virtual const char * GetGraphPropertiesUrl () const =0
 
virtual const char * GetSessionName () const =0
 
virtual tResult LoadGraphFromUrl (const char *strGraphFile)=0
 Loads a new graph file. More...
 
virtual tResult LoadGraphPropertiesFromUrl (const char *strPropertiesFile)=0
 Loads a new graph properties file. More...
 
virtual const char * GetActiveFilterGraph () const =0
 
virtual tResult SetActiveFilterGraph (const char *strFilterGraphName)=0
 Selects the active filter graph. More...
 
virtual const char * GetActiveStreamingGraph () const =0
 
virtual tResult SetActiveStreamingGraph (const char *strStreamingGraphName)=0
 Selects the active streaming graph. More...
 

Additional Inherited Members

- Static Public Attributes inherited from ISession
static constexpr const tChar *const DEFAULT_NAME = "session"
 Default RPC object server name of the ADTF Session RPC object server.
 

Detailed Description

Definition at line 105 of file adtf_remote_session_intf.h.

Member Function Documentation

◆ GetObjects()

virtual const char* GetObjects ( ) const
pure virtual

Get all available session objects.

Returns
A '
' seperated list of session objects.

◆ GetProperties()

virtual const char* GetProperties ( const char *  strObject) const
pure virtual

Retrieve the properties and their values of a given session object.

Parameters
[in]strObjectThe name of the session object.
Returns
A '
' seperated list of [name]=[value] pairs.

◆ GetProperty()

virtual const char* GetProperty ( const char *  strObject,
const char *  strPropertyName 
) const
pure virtual

Gets the value of a given property.

Parameters
[in]strObjectThe session object that the property belongs to.
[in]strPropertyNameThe name of the property.
Returns
The property value.

◆ SetProperty()

virtual tResult SetProperty ( const char *  strObject,
const char *  strPropertyName,
const char *  strPropertyValue 
)
pure virtual

Sets the value of a given property.

Parameters
[in]strObjectThe session object that the property belongs to.
[in]strPropertyNameThe name of the property.
[in]strPropertyValueThe new value of the property.
Returns
Standard result.