ADTF  3.18.3
ISessionabstract
Inheritance diagram for ISession:
[legend]

Classes

struct  tGraphConnectableObjectInfo
 Info for a connectable object This might be a pin, samplestream or port. More...
 
struct  tGraphObjectInfo
 Info for a graph object. More...
 

Public Types

enum class  tGraphObjectConnectableType : uint8_t { in = 0 , out = 1 }
 
enum class  tGraphObjectInfoType : uint8_t {
  unknown = 0 , filter , samplestreamingsource , samplestreamingsink ,
  inpin , outpin , samplestream , subgraph ,
  inport , outport
}
 type of the object
 
- Public Types inherited from ISession
enum  tPropertyFlags { None = 0x00 }
 The Property Flags.
 

Public Member Functions

 ADTF_IID (ISession, "session.quiet.remote.adtf")
 RPC interface ID of the ADTF Session RPC object server.
 
virtual const char * GetGraphObjects () const =0
 Get all available graph objects. More...
 
virtual tGraphObjectInfo GetGraphObjectInfo (const char *strObject) const =0
 Retrieve GraphObject Info and there input and output objects. More...
 
virtual std::unordered_map< std::string, tGraphObjectInfoGetGraphObjectsInfo () const =0
 Retrieve a list of all Graph Object Info and there input and output objects. More...
 
- Public Member Functions inherited from ISession
 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
 Retrieve the properties a given session object. More...
 
virtual const char * GetPropertyType (const char *strObject, const char *strPropertyName) const =0
 Retrieves the type of a given property. More...
 
- Public Member Functions inherited from ISession
 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 205 of file adtf_remote_session_intf.h.

Member Function Documentation

◆ GetGraphObjectInfo()

virtual tGraphObjectInfo GetGraphObjectInfo ( const char *  strObject) const
pure virtual

Retrieve GraphObject Info and there input and output objects.

see tGraphObjectInfo::strObjectType which types are possible and there content.

Parameters
[in]strObjectThe graph object name to retrieve info for.
Returns
tGraphObjectInfoState

◆ GetGraphObjects()

virtual const char* GetGraphObjects ( ) const
pure virtual

Get all available graph objects.

Returns
A '
' seperated list of graph objects.

◆ GetGraphObjectsInfo()

virtual std::unordered_map<std::string, tGraphObjectInfo> GetGraphObjectsInfo ( ) const
pure virtual

Retrieve a list of all Graph Object Info and there input and output objects.

see tGraphObjectInfo::strObjectType which types are possible and there content.

Returns
tGraphObjectInfoState