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

Inherits adtf::remote::hollow::ISession.

Inherited by adtf::remote::ultron::ISession.

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 , activerunner
}
 
- Public Types inherited from adtf::remote::hollow::ISession
enum  tPropertyFlags { None = 0x00 }
 

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
 
virtual tGraphObjectInfo GetGraphObjectInfo (const char *strObject) const =0
 
virtual std::unordered_map< std::string, tGraphObjectInfoGetGraphObjectsInfo () const =0
 
- Public Member Functions inherited from adtf::remote::hollow::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
 
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

◆ tGraphObjectInfoType

type of the object

Member Function Documentation

◆ GetGraphObjectInfo()

virtual tGraphObjectInfo adtf::remote::quiet::ISession::GetGraphObjectInfo ( const char * strObject) const
pure virtual

Retrieve GraphObject Info and there input and output objects. see tGraphObjectInfo which types are possible and there content.

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

◆ GetGraphObjects()

virtual const char * adtf::remote::quiet::ISession::GetGraphObjects ( ) const
pure virtual

Get all available graph objects.

Returns
A '
' seperated list of graph objects.

◆ GetGraphObjectsInfo()

virtual std::unordered_map< std::string, tGraphObjectInfo > adtf::remote::quiet::ISession::GetGraphObjectsInfo ( ) const
pure virtual

Retrieve a list of all Graph Object Info and there input and output objects. see tGraphObjectInfo which types are possible and there content.

Returns
map of tGraphObjectInfo

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