ADTF
Loading...
Searching...
No Matches
adtf::remote::hollow::ISession Class Referenceabstract

Inherits adtf::remote::catwo::ISession.

Inherited by adtf::remote::quiet::ISession.

Public Types

enum  tPropertyFlags { None = 0x00 }
 

Public Member Functions

 ADTF_IID (ISession, "session.hollow.remote.adtf")
 RPC interface ID of the ADTF Session RPC object server.
 
virtual const char * GetObjectProperties (const char *strObject, uint32_t nFlags=tPropertyFlags::None) const =0
 
virtual const char * GetPropertyType (const char *strObject, const char *strPropertyName) const =0
 
- Public Member Functions inherited from adtf::remote::catwo::ISession
 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 Enumeration Documentation

◆ tPropertyFlags

Member Function Documentation

◆ GetObjectProperties()

virtual const char * adtf::remote::hollow::ISession::GetObjectProperties ( const char * strObject,
uint32_t nFlags = tPropertyFlags::None ) const
pure virtual

Retrieve the properties a given session object.

Remarks
This supersedes adtf::remote::catwo::ISession::GetProperties.
Parameters
[in]strObjectThe name of the session object.
[in]nFlagsSee tPropertyFlags.
Returns
And XML string that contains a list of properties, their types and values in the following form:
<properties>
<property>
<name>name</name>
<type>type</type>
<value>value</value>
</property>
...
</properties>

◆ GetPropertyType()

virtual const char * adtf::remote::hollow::ISession::GetPropertyType ( const char * strObject,
const char * strPropertyName ) const
pure virtual

Retrieves the type of a given property.

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

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