adtf::streaming::flash::ISampleStreamer Class Reference

#include <samplestreamer_intf.h>

Inherited by adtf::streaming::flash::ISampleReader, and adtf::streaming::flash::ISampleWriter.

Public Member Functions
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

Base interface for sample readers and writers.

Member Function Documentation

BeginStreaming()

virtual tResult adtf::streaming::flash::ISampleStreamer::BeginStreaming ( ant::ISampleStream & pStream )

pure virtual

Begin streaming on the given sample stream.

Parameters

[in]

pStream

the sample stream.

Returns

Standard result.

Implemented in adtf::streaming::cNullReader, adtf::streaming::cRequestForwardingWriter, adtf::streaming::cSampleReader, adtf::streaming::cSampleWriter, adtf::streaming::flash::cSampleReader, adtf::streaming::flash::cSampleWriter, adtf::streaming::hollow::writer_with_request_broker< BaseWriter >, adtf::streaming::hollow::writer_with_request_broker< adtf::streaming::cSampleWriter >, adtf::streaming::kiwi::cNullReader, adtf::streaming::request_forwarding_reader< BaseReader >, adtf::streaming::vision::cRequestForwardingWriter, and adtf::streaming::vision::request_forwarding_reader< BaseReader >.

EndStreaming()

virtual tResult adtf::streaming::flash::ISampleStreamer::EndStreaming ( )

pure virtual

End streaming

Returns

Standard result.

Implemented in adtf::streaming::cNullReader, adtf::streaming::cRequestForwardingWriter, adtf::streaming::cSampleReader, adtf::streaming::cSampleWriter, adtf::streaming::flash::cSampleReader, adtf::streaming::flash::cSampleWriter, adtf::streaming::hollow::requestable_writer< BaseWriter >, adtf::streaming::hollow::writer_with_request_broker< BaseWriter >, adtf::streaming::hollow::writer_with_request_broker< adtf::streaming::cSampleWriter >, adtf::streaming::kiwi::cNullReader, adtf::streaming::requestable_writer< BaseWriter >, and adtf::streaming::vision::cRequestForwardingWriter.

GetName()

virtual tResult adtf::streaming::flash::ISampleStreamer::GetName ( base::ant::IString && strName )

pure virtual

Retrieves the name of the streamer

Parameters

[out]

strName

This will be updated with the name.

Returns

Standard result.

Implemented in adtf::streaming::cNullReader, adtf::streaming::cSampleReader, adtf::streaming::cSampleWriter, adtf::streaming::flash::cSampleReader, adtf::streaming::flash::cSampleWriter, and adtf::streaming::kiwi::cNullReader.

GetType()

virtual tResult adtf::streaming::flash::ISampleStreamer::GetType ( ucom::ant::iobject_ptr< const ant::IStreamType > & pStreamType ) const

pure virtual

Returns the initial stream type of the streamer.

Parameters

[out]

pStreamType

This will reference the initial stream type.

Returns

Standard result.

Implemented in adtf::streaming::cNullReader, adtf::streaming::cSampleReader, adtf::streaming::cSampleWriter, adtf::streaming::flash::cSampleReader, adtf::streaming::flash::cSampleWriter, and adtf::streaming::kiwi::cNullReader.

SetName()

virtual void adtf::streaming::flash::ISampleStreamer::SetName ( const char * strName )

pure virtual

Sets the name of the streamer. This will be used when creating pins.

Parameters

[in]

strName

The name

Implemented in adtf::streaming::cNullReader, adtf::streaming::cSampleReader, adtf::streaming::cSampleWriter, adtf::streaming::flash::cSampleReader, adtf::streaming::flash::cSampleWriter, and adtf::streaming::kiwi::cNullReader.

SetStreamerPin()

virtual tResult adtf::streaming::flash::ISampleStreamer::SetStreamerPin ( const ucom::ant::iobject_ptr< flash::IStreamerPin > & pStreamerPin )

pure virtual

Sets the pin that the streamer is associated with.

Parameters

[in]

pStreamerPin

The pin.

Returns

Standard result.

Implemented in adtf::streaming::cNullReader, adtf::streaming::flash::cSampleReader, adtf::streaming::flash::cSampleWriter, and adtf::streaming::kiwi::cNullReader.

SetType()

virtual tResult adtf::streaming::flash::ISampleStreamer::SetType ( const ucom::ant::iobject_ptr< const ant::IStreamType > & pStreamType )

pure virtual

Sets the initial stream type of a streamer.

Parameters

[in]

pStreamType

The stream type

Returns

Standard result.

Implemented in adtf::mediadescription::decoding_sample_reader< ReaderImplementation >, adtf::mediadescription::encoding_sample_writer< WriterImplementation >, adtf::mediadescription::flash::decoding_sample_reader< ReaderImplementation >, adtf::mediadescription::flash::encoding_sample_writer< WriterImplementation >, adtf::mediadescription::osborn::decoding_sample_reader< ReaderImplementation >, adtf::mediadescription::osborn::encoding_sample_writer< WriterImplementation >, adtf::streaming::cNullReader, adtf::streaming::cSampleReader, adtf::streaming::cSampleWriter, adtf::streaming::flash::cSampleReader, adtf::streaming::flash::cSampleWriter, adtf::streaming::hollow::requestable_writer< BaseWriter >, adtf::streaming::kiwi::cNullReader, and adtf::streaming::requestable_writer< BaseWriter >.

---

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

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