ADTF
Loading...
Searching...
No Matches
adtf::streaming::ant::IDynamicDataBinding Class Referenceabstract

#include <data_binding_intf.h>

Inherited by adtf::streaming::ant::ISampleStreamingSink, and adtf::streaming::ant::ISampleStreamingSource.

Public Member Functions

 ADTF_IID (IDynamicDataBinding, "dynamic_data_binding.ant.streaming.adtf.iid")
 defintion of interface id
 
virtual tResult RequestPin (const char *strName, const ucom::ant::iobject_ptr< const IStreamType > &pType, ucom::ant::iobject_ptr< IInPin > &pInPin)=0
 
virtual tResult RequestPin (const char *strName, const ucom::ant::iobject_ptr< const IStreamType > &pType, ucom::ant::iobject_ptr< IOutPin > &pOutPin)=0
 

Protected Member Functions

 ~IDynamicDataBinding ()=default
 not destructable
 

Detailed Description

This interface extends the IDatabinding Interface to provide dynamic pin creation while connection are established within Streaming Graph and Filter Graph.

Member Function Documentation

◆ RequestPin() [1/2]

virtual tResult adtf::streaming::ant::IDynamicDataBinding::RequestPin ( const char * strName,
const ucom::ant::iobject_ptr< const IStreamType > & pType,
ucom::ant::iobject_ptr< IInPin > & pInPin )
pure virtual

Request a in pin which can not be find via IDataBinding::FindPin.

This function will be used to create and retrieve a pin which is requested by an added connection. While connection are established within the filter graph or the streaming graph and the filter or streaming service does not provide the requested pin this call will be used to create the pin.

Parameters
strName[in] pin name requested
pType[in] stream type of the sample stream if already set. Could be nullptr if stream type was not yet sent to the sample stream, so check content! The actually applicable type is guaranteed to be repeated once more as a regular stream item on the pin and can be safely ignored on this interface.
pInPin[in, out] Set to a valid input pin if created one. On Error the caller do not care.
Remarks
This is the ADTF 2 Connection Pin mechanism.
Return values
ERR_NOERRORin pin was created and registered. pInPin must be set to a valid pin reference.
any_errorDepending on the implementation. If any error occures the streaming graph and filter graph will stop initializing.

◆ RequestPin() [2/2]

virtual tResult adtf::streaming::ant::IDynamicDataBinding::RequestPin ( const char * strName,
const ucom::ant::iobject_ptr< const IStreamType > & pType,
ucom::ant::iobject_ptr< IOutPin > & pOutPin )
pure virtual

Request a out pin which can not be find via IDataBinding::FindPin.

This function will be used to create and retrieve a pin which is requested by an added connection. While connection are established within the filter graph or the streaming graph and the filter or streaming service does not provide the requested pin this call will be used to create the pin.

Parameters
strName[in] pin name requested
pType[in] stream previously used on sample stream if already set. Usually nullptr on a fresh sample stream, so check content!
pOutPin[in, out] Set to a valid input pin if created one. On Error the caller do not care.
Return values
ERR_NOERRORout pin was created and registered. pOutPin must be set to a valid pin reference.
any_errorDepending on the implementation. If any error occures the streaming graph and filter graph will stop initializing.

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