ISampleStreamer

Base interface for sample readers and writers. More...

Inheritance diagram for ISampleStreamer:

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

Base interface for sample readers and writers.

Definition at line 129 of file samplestreamer_intf.h.

Member Function Documentation

BeginStreaming()

virtual tResult BeginStreaming ( ant::ISampleStream &  pStream )

pure virtual

Begin streaming on the given sample stream.

Parameters

[in]

pStream

the sample stream.

Returns

Standard result.

Implemented in writer_with_request_broker< BaseWriter >, writer_with_request_broker< adtf::streaming::cSampleWriter >, cSampleWriter, cSampleReader, and cNullReader.

EndStreaming()

virtual tResult EndStreaming ( )

pure virtual

End streaming.

Returns

Standard result.

Implemented in cSampleWriter, cNullReader, cSampleReader, requestable_writer< BaseWriter >, writer_with_request_broker< BaseWriter >, and writer_with_request_broker< adtf::streaming::cSampleWriter >.

GetName()

virtual tResult 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 cSampleWriter, cNullReader, and cSampleReader.

GetType()

virtual tResult 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 cSampleWriter, cNullReader, and cSampleReader.

SetName()

virtual void 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 cSampleWriter, cNullReader, and cSampleReader.

SetStreamerPin()

virtual tResult 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 cSampleWriter, cSampleReader, and cNullReader.

SetType()

virtual tResult 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 encoding_sample_writer< WriterImplementation >, decoding_sample_reader< ReaderImplementation >, encoding_sample_writer< WriterImplementation >, decoding_sample_reader< ReaderImplementation >, requestable_writer< BaseWriter >, cSampleWriter, cNullReader, and cSampleReader.