ISession

Inheritance diagram for ISession:

Public Types
enum	tPropertyFlags { None = 0x00 }
	The Property Flags.

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
	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 152 of file adtf_remote_session_intf.h.

Member Function Documentation

GetObjectProperties()

virtual const char* 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]	strObject	The name of the session object.
[in]	nFlags	See 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* GetPropertyType ( const char *  strObject, const char *  strPropertyName  ) const

pure virtual

Retrieves the type of a given property.

Parameters

[in]	strObject	The session object that the property belongs to.
[in]	strPropertyName	The name of the property.

Returns

The type.