Interface for sample reads that read from sample streams via input pins. More...
Public Member Functions | |
| virtual tResult | GetNextSample (ucom::ant::iobject_ptr< const ant::ISample > &pSample)=0 |
| Reads the next available sample from the associated sample stream. More... | |
| virtual tResult | GetLastSample (ucom::ant::iobject_ptr< const ant::ISample > &pSample)=0 |
| Reads the latest available sample from the associated sample stream. More... | |
| virtual tResult | GetLastType (ucom::ant::iobject_ptr< const IStreamType > &pType)=0 |
| Returns the last stream type that was read from the sample stream. More... | |
| virtual tResult | SetStreamError (tResult oError)=0 |
| Sets an error on the associated sample stream. More... | |
| virtual tResult | ReadAllAvailableItems ()=0 |
| Reads all available items from the sample stream into internal queues. More... | |
 Public Member Functions inherited from ISampleStreamer | |
| virtual void | SetName (const char *strName)=0 |
| Sets the name of the streamer. More... | |
| virtual tResult | GetName (base::ant::IString &&strName)=0 |
| Retrieves the name of the streamer. More... | |
| virtual tResult | SetType (const ucom::ant::iobject_ptr< const ant::IStreamType > &pStreamType)=0 |
| Sets the initial stream type of a streamer. More... | |
| virtual tResult | GetType (ucom::ant::iobject_ptr< const ant::IStreamType > &pStreamType) const =0 |
| Returns the initial stream type of the streamer. More... | |
| virtual tResult | BeginStreaming (ant::ISampleStream &pStream)=0 |
| Begin streaming on the given sample stream. More... | |
| virtual tResult | EndStreaming ()=0 |
| End streaming. More... | |
| virtual tResult | SetStreamerPin (const ucom::ant::iobject_ptr< flash::IStreamerPin > &pStreamerPin)=0 |
| Sets the pin that the streamer is associated with. More... | |
Detailed Description
Interface for sample reads that read from sample streams via input pins.
Definition at line 187 of file samplestreamer_intf.h.
Member Function Documentation
◆ GetLastSample()
|
pure virtual |
Reads the latest available sample from the associated sample stream.
If more than a single new sample was availablle, all but the last sample will be discarded.
If no new sample was available the last sample previously fetched will be returned again.
- Parameters
-
[out] pSample This will refrerence the sample.
- Return values
-
ERR_EMTPY No sample available
Implemented in cNullReader, and cSampleReader.
◆ GetLastType()
|
pure virtual |
Returns the last stream type that was read from the sample stream.
- Parameters
-
[out] pType This will reference the last stream type
- Returns
Implemented in cNullReader, and cSampleReader.
◆ GetNextSample()
|
pure virtual |
Reads the next available sample from the associated sample stream.
- Parameters
-
[out] pSample This will refrerence the sample.
- Return values
-
ERR_EMTPY No sample available
Implemented in cNullReader, and cSampleReader.
◆ ReadAllAvailableItems()
|
pure virtual |
Reads all available items from the sample stream into internal queues.
- Returns
- Standard result.
Implemented in cNullReader, and cSampleReader.
◆ SetStreamError()
Sets an error on the associated sample stream.
- Parameters
-
[in] oError The error.
- Returns
- Standard result.
Implemented in cNullReader, and cSampleReader.