adtf::remote::ISession Class Reference

Inherits adtf::remote::quiet::ISession.

Classes
struct	tGraphObjectState

Public Types
enum class	tGraphObjectStateValue : uint8_t { Other = 0 , Stopped = 1 , Started = 2 }
Public Types inherited from adtf::remote::quiet::ISession
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.ultron.remote.adtf")
	RPC interface ID of the ADTF Session RPC object server.
virtual tGraphObjectState	GetGraphObjectState (const char *strObjectName) const=0
virtual tResult	SetGraphObjectState (const char *strObjectName, tGraphObjectStateValue eState)=0
Public Member Functions inherited from adtf::remote::quiet::ISession
	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, tGraphObjectInfo >	GetGraphObjectsInfo () 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 Function Documentation

GetGraphObjectState()

virtual tGraphObjectState adtf::remote::ultron::ISession::GetGraphObjectState ( const char * strObjectName ) const

pure virtual

Retrieve GraphObject state for the graph object. see tGraphObjectInfo::strObjectType which types are possible and there content.

Parameters

[in]

strObject

The graph object name to retrieve info for.

Returns

tGraphObjectState

SetGraphObjectState()

virtual tResult adtf::remote::ultron::ISession::SetGraphObjectState ( const char * strObjectName, tGraphObjectStateValue eState )

pure virtual

Retrieve GraphObject state for the graph object. see tGraphObjectInfo::strObjectType which types are possible and there content.

Parameters

[in]	strObject	The graph object name to retrieve info for.
[in]	nState	State to set

Returns

Error code if call was successful

Remarks

We cannot guarantee that stopping any component will have an effect or not lead to queue overflows or whatever.
This might affect data triggered filter except they explicitly implement to discard samples/triggers. in stopped state.

---

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

• src/libraries/adtfremotesdk/include/adtfremotesdk/adtf_remote_session_intf.h