ADTF
Loading...
Searching...
No Matches
adtf::streaming::flash::IStreamerPin Class Referenceabstract

#include <pin_intf.h>

Inherits adtf::ucom::ant::IObject.

Public Member Functions

 ADTF_IID (IStreamerPin, "streamer_pin.flash.streaming.adtf.iid")
 defintion of interface id
 
virtual tResult RegisterStreamer (ISampleStreamer &oStreamer)=0
 
virtual tResult UnregisterStreamer (ISampleStreamer &oStreamer)=0
 
- Public Member Functions inherited from adtf::ucom::ant::IObject
 ADTF_IID (IObject, "object.ant.ucom.adtf.iid")
 

Additional Inherited Members

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

Detailed Description

Enhance Pin Interface for the inner data binding of the streamer.

Member Function Documentation

◆ RegisterStreamer()

virtual tResult adtf::streaming::flash::IStreamerPin::RegisterStreamer ( ISampleStreamer & oStreamer)
pure virtual

Registers a streamer (sample writer or sample reader) to the Pin.

Parameters
[in]oStreamerThe streamer to register.
Returns
Standard Result Code.
Return values
ERR_INVALID_STATEThe pin is already activated (running state already reached)

◆ UnregisterStreamer()

virtual tResult adtf::streaming::flash::IStreamerPin::UnregisterStreamer ( ISampleStreamer & oStreamer)
pure virtual

Unregisters a streamer (sample writer or sample reader) from the Pin.

Parameters
[in]oStreamerThe streamer to unregister.
Returns
Standard Result Code.
Return values
ERR_NOT_FOUNDThe streamer was not registered to the pin.

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