adtf::streaming::IFilterGraphDataPort Class Reference

brings latest ant::IFilterGraphDataPort to the users scope More...

#include <filtergraphport_intf.h>

Inherits adtf::streaming::ant::IFilterGraphPort.

Inherited by adtf::streaming::ant::IFilterGraphDataInPort, and adtf::streaming::ant::IFilterGraphDataOutPort.

Public Member Functions
	ADTF_IID (IFilterGraphDataPort, "filtergraphdataport.ant.streaming.adtf.iid")
	Definition of interface id.
virtual tResult	InnerConnect (const ucom::ant::iobject_ptr< ISampleStream > &pSampleStream)=0
virtual tResult	InnerDisconnect ()=0
virtual tResult	SetTriggerForwardingFromParent (bool bForwarded)=0
virtual tResult	SetTriggerForwardingToChild (const ucom::ant::iobject_ptr< ISampleStream > &pSampleStream, bool bForwarded)=0
Public Member Functions inherited from adtf::streaming::ant::IFilterGraphPort
	ADTF_IID (IFilterGraphPort, "filtergraphport.ant.streaming.adtf.iid")
	Definition of interface id.
Public Member Functions inherited from adtf::ucom::ant::IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")

Protected Member Functions
	~IFilterGraphDataPort ()=default
	not destructable
Protected Member Functions inherited from adtf::streaming::ant::IFilterGraphPort
	~IFilterGraphPort ()=default
	not destructable
Protected Member Functions inherited from adtf::ucom::ant::IObject
	~IObject ()=default
	Protected destructor --> Only the final implementation can be destroyed!

Detailed Description

brings latest ant::IFilterGraphDataPort to the users scope

Common interface for a FilterGraph Port that allows to connect to a IFilterGraph with SampleStreams.

Warning

: This interface is only used internally by the filtergraph implementation!

Member Function Documentation

InnerConnect()

virtual tResult adtf::streaming::ant::IFilterGraphDataPort::InnerConnect ( const ucom::ant::iobject_ptr< ISampleStream > & pSampleStream )

pure virtual

Inner Connect the ISampleStream which will be provided for the outside.

Parameters

[in]

pSampleStream

SampleStream to forward

Returns

Standard Result Code.

InnerDisconnect()

virtual tResult adtf::streaming::ant::IFilterGraphDataPort::InnerDisconnect ( )

pure virtual

Inner Disconnect the ISampleStream if connected.

Returns

Standard Result Code.

SetTriggerForwardingFromParent()

virtual tResult adtf::streaming::ant::IFilterGraphDataPort::SetTriggerForwardingFromParent ( bool bForwarded )

pure virtual

Enable forwarding of triggers from the parent trigger pipe. Default state of a port is to not forward them. A trigger reaches a child only if both forwarding from the parent and forwarding to the specific child is enabled.

See also

SetTriggerForwardingToChild.

Parameters

[in]

bForwarded

Whether triggers are forwarded or not.

Returns

Standard Result Code.

SetTriggerForwardingToChild()

virtual tResult adtf::streaming::ant::IFilterGraphDataPort::SetTriggerForwardingToChild ( const ucom::ant::iobject_ptr< ISampleStream > & pSampleStream, bool bForwarded )

pure virtual

Enable forwarding of triggers to the given child sample stream and its trigger pipe. Default state of a port is to not forward them. A trigger reaches a child only if both forwarding from the parent and forwarding to the specific child is enabled.

See also

SetTriggerForwardingFromParent.

Parameters

[in]	pSampleStream	The stream the connection leads to.
[in]	bForwarded	Whether triggers are forwarded or not.

Returns

Standard Result Code.

Return values

ERR_NOT_FOUND

The port does not route to pSampleStream.

---

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

• src/libraries/streaming3/include/adtfstreaming3/filtergraphport_intf.h