ADTF
Loading...
Searching...
No Matches
adtf::mediadescription::flash::encoding_sample_writer< WriterImplementation > Class Template Reference

#include <codec_sample_streamer_legacy.h>

Inherits adtf::streaming::flash::cSampleWriter, and adtf::mediadescription::flash::cSampleCodecFactory.

Public Member Functions

cSampleWithCodec MakeSample (base::flash::tNanoSeconds tmTimeStamp)
 
tResult SetType (const ucom::ant::iobject_ptr< const streaming::ant::IStreamType > &pStreamType) override
 
tResult ChangeType (const ucom::ant::iobject_ptr< const streaming::ant::IStreamType > &pStreamType) override
 
tResult Write (cSampleWithCodec &oSampleWithCodec)
 
- Public Member Functions inherited from adtf::streaming::flash::cSampleWriter
void SetName (const char *strName) override
 
tResult GetName (base::ant::IString &&strName) override
 
tResult GetType (ucom::ant::iobject_ptr< const ant::IStreamType > &pStreamType) const override
 
tResult BeginStreaming (ISampleStream &oSampleStream) override
 
tResult EndStreaming () override
 
tResult SetStreamerPin (const ucom::ant::iobject_ptr< IStreamerPin > &pStreamerPin) override
 
tResult GetStreamerPin (ucom::ant::iobject_ptr< IStreamerPin > &pStreamerPin) const
 
tResult Write (const ucom::ant::iobject_ptr< const ant::ISample > &pSample) override
 
virtual tResult Transmit (const ucom::ant::iobject_ptr< const ant::ISample > &pSample)
 
tResult Flush () override
 
tResult SetStreamError (tResult oError) override
 
tResult ManualTrigger (base::flash::tNanoSeconds tmActivationTime=base::flash::tNanoSeconds{-1}) override
 
- Public Member Functions inherited from adtf::mediadescription::flash::cSampleCodecFactory
 cSampleCodecFactory (const cStructureType &oTypeDefinition)
 
 cSampleCodecFactory (const streaming::ant::IStreamType &oStreamType)
 
 cSampleCodecFactory (const ucom::ant::iobject_ptr< const streaming::ant::IStreamType > &pStreamType)
 
size_t FindIndex (const char *strElementName) const
 
size_t FindArrayIndex (const char *strArrayName) const
 
size_t FindStructIndex (const char *strStructName) const
 
const adtf_ddl::tStructElement & GetStaticElement (size_t nElementIndex) const
 
 cSampleCodecFactory (const char *strStructName, const char *strMediaDescription, adtf_ddl::tDataRepresentation eDefaultDataRepresentation=adtf_ddl::tDataRepresentation::Deserialized)
 
 cSampleCodecFactory (const adtf_ddl::cDDLComplex *pStruct, adtf_ddl::tDataRepresentation eDefaultDataRepresentation=adtf_ddl::tDataRepresentation::Deserialized)
 
 cSampleCodecFactory (cSampleCodecFactory &)=default
 
 cSampleCodecFactory (const cSampleCodecFactory &)=default
 
 cSampleCodecFactory (cSampleCodecFactory &&)=default
 
tResult GetStaticElement (size_t nIndex, const adtf_ddl::tStructElement *&pElement) const
 
- Public Member Functions inherited from adtf::mediadescription::ant::cSampleCodecFactory
 cSampleCodecFactory ()=default
 
 cSampleCodecFactory (const char *strStructName, const char *strMediaDescription, adtf_ddl::tDataRepresentation eDefaultDataRepresentation=adtf_ddl::tDataRepresentation::Deserialized)
 
 cSampleCodecFactory (const adtf_ddl::cDDLComplex *pStruct, adtf_ddl::tDataRepresentation eDefaultDataRepresentation=adtf_ddl::tDataRepresentation::Deserialized)
 
 cSampleCodecFactory (cSampleCodecFactory &)=default
 
 cSampleCodecFactory (const cSampleCodecFactory &)=default
 
 cSampleCodecFactory (cSampleCodecFactory &&)=default
 
cSampleCodecFactoryoperator= (cSampleCodecFactory &)=default
 
cSampleCodecFactoryoperator= (cSampleCodecFactory &&)=default
 
tResult IsValid () const
 
cStaticSampleDecoder MakeStaticDecoderFor (const adtf::streaming::ISample &oSample, adtf_ddl::tDataRepresentation eDataRepresentation) const
 
cStaticSampleCodec MakeStaticCodecFor (adtf::streaming::ISample &oSample, adtf_ddl::tDataRepresentation eDataRepresentation) const
 
cSampleDecoder MakeDecoderFor (const adtf::streaming::ISample &oSample, adtf_ddl::tDataRepresentation eDataRepresentation) const
 
cSampleCodec MakeCodecFor (adtf::streaming::ISample &oSample, adtf_ddl::tDataRepresentation eDataRepresentation) const
 
size_t GetStaticElementCount () const
 
tResult GetStaticElement (size_t nIndex, const adtf_ddl::tStructElement *&pElement) const
 
size_t GetStaticBufferSize (adtf_ddl::tDataRepresentation eRep=adtf_ddl::tDataRepresentation::Deserialized) const
 
adtf_ddl::tDataRepresentation GetDefaultDataRepresentation () const
 
cStaticSampleDecoder MakeStaticDecoderFor (const adtf::ucom::iobject_ptr< const adtf::streaming::ISample > &pSample, adtf_ddl::tDataRepresentation eDataRepresentation) const
 
cSampleDecoder MakeDecoderFor (const adtf::ucom::iobject_ptr< const adtf::streaming::ISample > &pSample, adtf_ddl::tDataRepresentation eDataRepresentation) const
 
cStaticSampleCodec MakeStaticCodecFor (const adtf::ucom::iobject_ptr< adtf::streaming::ISample > &pSample, adtf_ddl::tDataRepresentation eDataRepresentation) const
 
cSampleCodec MakeCodecFor (const adtf::ucom::iobject_ptr< adtf::streaming::ISample > &pSample, adtf_ddl::tDataRepresentation eDataRepresentation) const
 
cStaticSampleDecoder MakeStaticDecoderFor (const adtf::ucom::iobject_ptr< const adtf::streaming::ISample > &pSample) const
 
cSampleDecoder MakeDecoderFor (const adtf::ucom::iobject_ptr< const adtf::streaming::ISample > &pSample) const
 
cStaticSampleCodec MakeStaticCodecFor (const adtf::ucom::iobject_ptr< adtf::streaming::ISample > &pSample) const
 
cSampleCodec MakeCodecFor (const adtf::ucom::iobject_ptr< adtf::streaming::ISample > &pSample) const
 
cStaticSampleDecoder MakeStaticDecoderFor (const adtf::streaming::ISample &oSample) const
 
cSampleDecoder MakeDecoderFor (const adtf::streaming::ISample &oSample) const
 
cStaticSampleCodec MakeStaticCodecFor (adtf::streaming::ISample &oSample) const
 
cSampleCodec MakeCodecFor (adtf::streaming::ISample &oSample) const
 

Additional Inherited Members

- Public Types inherited from adtf::mediadescription::flash::cSampleCodecFactory
typedef adtf_ddl::tStructElement DefinedStructElementType
 
- Static Public Member Functions inherited from adtf::mediadescription::flash::cSampleCodecFactory
static const char * GetStaticStructElementName (const adtf_ddl::tStructElement *pElement)
 add for legacy reason
 

Detailed Description

template<typename WriterImplementation = streaming::flash::cSampleWriter>
class adtf::mediadescription::flash::encoding_sample_writer< WriterImplementation >

Sample Writer that provides samples that can be updated via a Codec.

See Example Media Description Data Generator for an example usage.

Member Function Documentation

◆ ChangeType()

template<typename WriterImplementation = streaming::flash::cSampleWriter>
tResult adtf::mediadescription::flash::encoding_sample_writer< WriterImplementation >::ChangeType ( const ucom::ant::iobject_ptr< const streaming::ant::IStreamType > & pType)
inlineoverridevirtual

Communicates a type change for all following samples.

Parameters
[in]pTypeThe new stream type
Returns
Standard result. Errors will be reported via the associated sample stream.

Reimplemented from adtf::streaming::flash::cSampleWriter.

◆ MakeSample()

template<typename WriterImplementation = streaming::flash::cSampleWriter>
cSampleWithCodec adtf::mediadescription::flash::encoding_sample_writer< WriterImplementation >::MakeSample ( base::flash::tNanoSeconds tmTimeStamp)
inline

Creates a new Sample with an attached Sample Codec.

Parameters
[in]tmTimeStampThe sample timestamp.
Returns
The new sample with an attached Sample Codec.

◆ SetType()

template<typename WriterImplementation = streaming::flash::cSampleWriter>
tResult adtf::mediadescription::flash::encoding_sample_writer< WriterImplementation >::SetType ( const ucom::ant::iobject_ptr< const streaming::ant::IStreamType > & pStreamType)
inlineoverridevirtual

Sets the initial stream type of a streamer.

Parameters
[in]pStreamTypeThe stream type
Returns
Standard result.

Reimplemented from adtf::streaming::flash::cSampleWriter.

◆ Write()

template<typename WriterImplementation = streaming::flash::cSampleWriter>
tResult adtf::mediadescription::flash::encoding_sample_writer< WriterImplementation >::Write ( cSampleWithCodec & oSampleWithCodec)
inline

Write a sample to the attached Sample Stream

Parameters
[in]oSampleWithCodecThe sample that you created with MakeSample(). This calls cSampleWithCodec::Release(), so do not call any further methods of the sample afterwards.
Returns
Standard result.

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