ADTF
Loading...
Searching...
No Matches
Public Member Functions | List of all members
adtf::remote::catwo::ISession Class Referenceabstract

Inherits adtf::remote::ant::ISession.

Inherited by adtf::remote::hollow::ISession.

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
 
virtual const char * GetProperties (const char *strObject) const =0
 
virtual const char * GetProperty (const char *strObject, const char *strPropertyName) const =0
 
virtual tResult SetProperty (const char *strObject, const char *strPropertyName, const char *strPropertyValue)=0
 
- Public Member Functions inherited from adtf::remote::ant::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
 
virtual tResult LoadGraphPropertiesFromUrl (const char *strPropertiesFile)=0
 
virtual const char * GetActiveFilterGraph () const =0
 
virtual tResult SetActiveFilterGraph (const char *strFilterGraphName)=0
 
virtual const char * GetActiveStreamingGraph () const =0
 
virtual tResult SetActiveStreamingGraph (const char *strStreamingGraphName)=0
 

Additional Inherited Members

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

Member Function Documentation

◆ GetObjects()

virtual const char * adtf::remote::catwo::ISession::GetObjects ( ) const
pure virtual

Get all available session objects.

Returns
A '
' seperated list of session objects.

◆ GetProperties()

virtual const char * adtf::remote::catwo::ISession::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 * adtf::remote::catwo::ISession::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 adtf::remote::catwo::ISession::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.
The documentation for this class was generated from the following file: