IFilterGraphConnection

Interface to describe a connection within the IFilterGraph. More...

Inheritance diagram for IFilterGraphConnection:

Public Types
enum	eCategory : uint32_t {   immediate = 0 , static_out = 1 , static_server = 1 , static_in = 2 ,   static_client = 2 , static_runner = 2 , dynamic_in = 3 , dynamic_client = 3 ,   dynamic_out = 4 , dynamic_server = 4 , dynamic_runner = 5 }
	simple category to classify connection establishing order More...

Public Member Functions
	ADTF_IID (IFilterGraphConnection, "filtergraphconnection.ant.streaming.adtf.iid")
	defintion of interface id
virtual bool	IsSync () const =0
	Returns the Sync state of the connection. More...
virtual eCategory	GetCategory () const =0
	Returns the order category of the conenction. More...
virtual tResult	Request () const =0
	Request a Connection. More...
Public Member Functions inherited from IGraphConnection
	ADTF_IID (IGraphConnection, "graphconnection.ant.streaming.adtf.iid")
	defintion of interface id
virtual tResult	GetSource (ucom::ant::iobject_ptr< INamedGraphObject > &pSource) const =0
	Gets the source object. More...
virtual tResult	GetSourceName (base::ant::IString &&strName) const =0
	Gets the source object name. More...
virtual tResult	GetSourceConnectorName (base::ant::IString &&strName) const =0
	Gets the source object name. More...
virtual tResult	GetDestination (ucom::ant::iobject_ptr< INamedGraphObject > &pDestination) const =0
	Gets the destination object. More...
virtual tResult	GetDestinationName (base::ant::IString &&strName) const =0
	Gets the destination object name. More...
virtual tResult	GetDestinationConnectorName (base::ant::IString &&strName) const =0
	Gets the destination object name. More...
virtual tResult	Connect ()=0
	Establishes the conenction between the source and the destination. More...
virtual tResult	Disconnect ()=0
	Disconnects the connection between the source and the destination. More...
virtual bool	IsConnected () const =0
	Return if either the connection is established or not. More...
Public Member Functions inherited from INamedGraphObject
	ADTF_IID (INamedGraphObject, "namedgraphobject.ant.streaming.adtf.iid")
	defintion of interface id
virtual tResult	GetName (base::ant::IString &&strName) const =0
	Gets the Name of the object to the IString rvalue reference strName. More...
virtual tResult	SetName (const char *strName)=0
	Sets the Name of the object. More...
virtual tResult	SetParent (const ucom::ant::IObject *oParentObject)=0
	Sets the Parent of the object. More...
virtual tResult	GetParent (const ucom::ant::IObject *&poParentObject) const =0
	Retrieves the Parent of the object. More...
Public Member Functions inherited from IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")
	Marks the IObject to be castable with the ucom_cast() More...

Protected Member Functions
	~IFilterGraphConnection ()=default
	not destrucable
Protected Member Functions inherited from IGraphConnection
	~IGraphConnection ()=default
	not destrucable
Protected Member Functions inherited from INamedGraphObject
	~INamedGraphObject ()=default
	not destructable
Protected Member Functions inherited from IObject
	~IObject ()=default
	Protected destructor --> Use implemented Destroy() instead of delete!

Detailed Description

Interface to describe a connection within the IFilterGraph.

The object is created with the help of IFilterGraph::AddConnection.

See also

sec_filter_graph which connections are possible by default.

Definition at line 22 of file filtergraphconnection_intf.h.

Member Enumeration Documentation

eCategory

enum eCategory : uint32_t

simple category to classify connection establishing order

Enumerator
immediate	immediate connections will be established while AddConnection call
static_out	Static connection (outpin to sample stream)
static_server	Static connection (server to binding proxy)
static_in	Static connection (samplestream to inpin)
static_client	Static connection (binding proxy to client object)
static_runner	Static connection (runner to sample stream, samplestream to runner, pin to runner, runner to pin)
dynamic_in	dynamic connection (inpin will be requested)
dynamic_client	dynamic connection (client will be requested)
dynamic_out	dynamic connection (outpin will be requested)
dynamic_server	dynamic connection (server will be requested)
dynamic_runner	dynamic connection (runner connection for dynamic runners (which are created on requests))

Definition at line 34 of file filtergraphconnection_intf.h.

Member Function Documentation

GetCategory()

virtual eCategory GetCategory ( ) const

pure virtual

Returns the order category of the conenction.

Returns

see eCategory.

IsSync()

virtual bool IsSync ( ) const

pure virtual

Returns the Sync state of the connection.

Returns

The sync state

Return values

true	- The connecton is synchronous
false	- The connecton is a-synchronous

Request()

virtual tResult Request ( ) const

pure virtual

Request a Connection.

Will try to establish the connection also with the help of IDynamicDataBInding and IDynamicInterfaceBinding.

Return values

ERR_NOERROR	Connection is requested and established.
ERR_NOT_FOUND	Connection can not be established due to a missing connector.

Returns

Several Error Code are possible, it will also return the Error codes of IDynamicDataBinding::RequestPin or IDynamicInterfaceBinding::RequestBindingObject Consider tResult::GetDescription for more information.