adtf::streaming::flash::ISampleWriter Class Reference

#include <samplestreamer_intf.h>

Inherits adtf::streaming::flash::ISampleStreamer.

Inherited by adtf::streaming::flash::cSampleWriter.

Public Member Functions
virtual tResult	Write (const ucom::ant::iobject_ptr< const ant::ISample > &pSample)=0
virtual tResult	ChangeType (const ucom::ant::iobject_ptr< const ant::IStreamType > &pType)=0
virtual tResult	Flush ()=0
virtual tResult	SetStreamError (tResult oError)=0
virtual tResult	ManualTrigger (base::flash::tNanoSeconds tmActivationTime=base::flash::tNanoSeconds{-1})=0
Public Member Functions inherited from adtf::streaming::flash::ISampleStreamer
virtual void	SetName (const char *strName)=0
virtual tResult	GetName (base::ant::IString &&strName)=0
virtual tResult	SetType (const ucom::ant::iobject_ptr< const ant::IStreamType > &pStreamType)=0
virtual tResult	GetType (ucom::ant::iobject_ptr< const ant::IStreamType > &pStreamType) const =0
virtual tResult	BeginStreaming (ant::ISampleStream &pStream)=0
virtual tResult	EndStreaming ()=0
virtual tResult	SetStreamerPin (const ucom::ant::iobject_ptr< flash::IStreamerPin > &pStreamerPin)=0

Detailed Description

Interface for sample writers that write to sample streams via output pins.

Member Function Documentation

ChangeType()

virtual tResult adtf::streaming::flash::ISampleWriter::ChangeType ( const ucom::ant::iobject_ptr< const ant::IStreamType > & pType )

pure virtual

Communicates a type change for all following samples.

Parameters

[in]

pType

The new stream type

Returns

Standard result. Errors will be reported via the associated sample stream.

Implemented in adtf::mediadescription::encoding_sample_writer< WriterImplementation >, adtf::mediadescription::flash::encoding_sample_writer< WriterImplementation >, adtf::mediadescription::osborn::encoding_sample_writer< WriterImplementation >, adtf::streaming::cSampleWriter, adtf::streaming::flash::cSampleWriter, adtf::streaming::hollow::requestable_writer< BaseWriter >, and adtf::streaming::requestable_writer< BaseWriter >.

Flush()

virtual tResult adtf::streaming::flash::ISampleWriter::Flush ( )

pure virtual

Flushes the writer.

Returns

Standard result.

Implemented in adtf::streaming::cSampleWriter, and adtf::streaming::flash::cSampleWriter.

ManualTrigger()

virtual tResult adtf::streaming::flash::ISampleWriter::ManualTrigger ( base::flash::tNanoSeconds tmActivationTime = base::flash::tNanoSeconds{-1} )

pure virtual

Calls all connected runners synchronously in this call.

Parameters

[in]

tmActivationTime

The timestamp passed to all runners. If equals -1, the current stream time is retrieved from the reference clock.

Returns

Standard result. Errors will be reported via the associated sample stream.

Implemented in adtf::streaming::cSampleWriter, and adtf::streaming::flash::cSampleWriter.

SetStreamError()

virtual tResult adtf::streaming::flash::ISampleWriter::SetStreamError ( tResult oError )

pure virtual

Reports and handles an error via the sample stream. Mind that you still need to cope with the error in the best possible manner.

Parameters

[in]

oError

The error code.

Returns

Standard result.

Implemented in adtf::streaming::cSampleWriter, and adtf::streaming::flash::cSampleWriter.

Write()

virtual tResult adtf::streaming::flash::ISampleWriter::Write ( const ucom::ant::iobject_ptr< const ant::ISample > & pSample )

pure virtual

Writes a sample to the connected sample stream.

Parameters

[in]

pSample

The sample to write

Returns

Standard result. Errors will be reported via the associated sample stream.

Implemented in adtf::streaming::cSampleWriter, and adtf::streaming::flash::cSampleWriter.

---

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

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