cSampleReader

The default Sample Reader will read the incomung Stream of a IInPin. More...

Inheritance diagram for cSampleReader:

Public Member Functions
	cSampleReader (ant::ISampleReaderQueue &oQueue, ant::ISampleStreamAccess::tMode eAccessMode, bool bStoreLastSample)
void	SetName (const char *strName) override
	Sets the name of the streamer. More...
tResult	GetName (base::ant::IString &&strName) override
	Retrieves the name of the streamer. More...
tResult	SetType (const ucom::ant::iobject_ptr< const ant::IStreamType > &pStreamType) override
	Sets the initial stream type of a streamer. More...
tResult	GetType (ucom::ant::iobject_ptr< const ant::IStreamType > &pStreamType) const override
	Returns the initial stream type of the streamer. More...
tResult	BeginStreaming (ISampleStream &oSampleStream) override
	Begin streaming on the given sample stream. More...
tResult	EndStreaming () override
	End streaming. More...
tResult	SetStreamerPin (const ucom::ant::iobject_ptr< IStreamerPin > &pStreamerPin) override
	Sets the pin that the streamer is associated with. More...
void	SetAcceptTypeCallback (const std::function< tResult(const ucom::ant::iobject_ptr< const ant::IStreamType > &pStreamType)> &fnAcceptTypeCallback)
	Sets a callback function which is called while a Stream Type is received - see also AcceptType and IsCompatible implementations. More...
void	SetStreamErrorCallback (const std::function< tResult(tResult oStreamError)> &fnStreamErrorCallback)
	A callback function to react on stream errors. More...
tResult	SetStreamError (tResult oError) override
	Sets an error on the associated sample stream. More...
tResult	GetLastType (ucom::ant::iobject_ptr< const ant::IStreamType > &pType) override
	Returns the last stream type that was read from the sample stream. More...
tResult	GetNextSample (ucom::ant::iobject_ptr< const ant::ISample > &pSample) override
	Reads the next available sample from the associated sample stream. More...
tResult	GetLastSample (ucom::ant::iobject_ptr< const ant::ISample > &pSample) override
	Reads the latest available sample from the associated sample stream. More...
void	Reset ()
tResult	ReadAllAvailableItems () override
	Reads all available items from the sample stream into internal queues. More...
tResult	RequestSamples (ucom::ant::iobject_ptr< hollow::IStreamingRequest > &pRequest, uint32_t nSubStreamId, const base::ant::IProperties *pRequestProperties=nullptr)
	RequestSamples of the given Substream to be generated and/or transmitted. More...
void	SetSynchronousTypeUpdateCallback (const std::function< tResult(const ucom::ant::iobject_ptr< const ant::IStreamType > &pStreamType)> &fnRequestTypeUpdateCallback)

Protected Attributes
std::unique_ptr< cImplementation >	m_pImplementation

Detailed Description

The default Sample Reader will read the incomung Stream of a IInPin.

Definition at line 948 of file samplereader.h.

Member Function Documentation

BeginStreaming()

tResult BeginStreaming ( ISampleStream &  pStream )

overridevirtual

Begin streaming on the given sample stream.

Parameters

[in]

pStream

the sample stream.

Returns

Standard result.

Implements ISampleStreamer.

EndStreaming()

tResult EndStreaming ( )

overridevirtual

End streaming.

Returns

Standard result.

Implements ISampleStreamer.

GetLastSample()

tResult GetLastSample ( ucom::ant::iobject_ptr< const ant::ISample > &  pSample )

overridevirtual

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

Implements ISampleReader.

GetLastType()

tResult GetLastType ( ucom::ant::iobject_ptr< const ant::IStreamType > &  pType )

overridevirtual

Returns the last stream type that was read from the sample stream.

Parameters

[out]

pType

This will reference the last stream type

Returns

Implements ISampleReader.

GetName()

tResult GetName ( base::ant::IString &&  strName )

overridevirtual

Retrieves the name of the streamer.

Parameters

[out]

strName

This will be updated with the name.

Returns

Standard result.

Implements ISampleStreamer.

GetNextSample()

tResult GetNextSample ( ucom::ant::iobject_ptr< const ant::ISample > &  pSample )

overridevirtual

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

Implements ISampleReader.

GetType()

tResult GetType ( ucom::ant::iobject_ptr< const ant::IStreamType > &  pStreamType ) const

overridevirtual

Returns the initial stream type of the streamer.

Parameters

[out]

pStreamType

This will reference the initial stream type.

Returns

Standard result.

Implements ISampleStreamer.

ReadAllAvailableItems()

tResult ReadAllAvailableItems ( )

overridevirtual

Reads all available items from the sample stream into internal queues.

Returns

Standard result.

Implements ISampleReader.

RequestSamples()

tResult RequestSamples	(	ucom::ant::iobject_ptr< hollow::IStreamingRequest > &	pRequest,
		uint32_t	nSubStreamId,
		const base::ant::IProperties *	pRequestProperties = nullptr
	)

RequestSamples of the given Substream to be generated and/or transmitted.

Parameters

[out]	pRequest	Keep this as long as you request samples to be transmitted.
[in]	nSubStreamId	The id of the Substream.
[in]	pRequestProperties	The request properties. If nullptr, then defaults will be used.

Returns

Standard Result.

SetAcceptTypeCallback()

void SetAcceptTypeCallback

(

const std::function< tResult(const ucom::ant::iobject_ptr< const ant::IStreamType > &pStreamType)> &

fnAcceptTypeCallback

)

Sets a callback function which is called while a Stream Type is received - see also AcceptType and IsCompatible implementations.

Parameters

[in]

fnAcceptTypeCallback

The callback function is called while AcceptType is executed. It must return ERR_NOERROR to accept the type or any error to reject the new type.

SetName()

void SetName ( const char *  strName )

overridevirtual

Sets the name of the streamer.

This will be used when creating pins.

Parameters

[in]

strName

The name

Implements ISampleStreamer.

SetStreamerPin()

tResult SetStreamerPin ( const ucom::ant::iobject_ptr< IStreamerPin > &  pStreamerPin )

overridevirtual

Sets the pin that the streamer is associated with.

Parameters

[in]

pStreamerPin

The pin.

Returns

Standard result.

Implements ISampleStreamer.

SetStreamError()

tResult SetStreamError ( tResult  oError )

overridevirtual

Sets an error on the associated sample stream.

Parameters

[in]

oError

The error.

Returns

Standard result.

Implements ISampleReader.

SetStreamErrorCallback()

void SetStreamErrorCallback

(

const std::function< tResult(tResult oStreamError)> &

fnStreamErrorCallback

)

A callback function to react on stream errors.

Parameters

[in]

fnStreamErrorCallback

The callback function which will be called on stream errors

SetType()

tResult SetType ( const ucom::ant::iobject_ptr< const ant::IStreamType > &  pStreamType )

overridevirtual

Sets the initial stream type of a streamer.

Parameters

[in]

pStreamType

The stream type

Returns

Standard result.

Implements ISampleStreamer.

Reimplemented in decoding_sample_reader< ReaderImplementation >, and decoding_sample_reader< ReaderImplementation >.