#include <codec_sample_streamer.h>

Inherits adtf::streaming::flash::cSampleWriter, and adtf::mediadescription::osborn::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::osborn::cSampleCodecFactory
	cSampleCodecFactory ()

	cSampleCodecFactory (const char strStructName, const char strMediaDescription, ddl::tDataRepresentation eDefaultDataRepresentation=ddl::tDataRepresentation::Deserialized)

	cSampleCodecFactory (const ddl::dd::StructType &oStruct, const ddl::dd::DataDefinition &oParentDD, ddl::tDataRepresentation eDefaultDataRepresentation=ddl::tDataRepresentation::Deserialized)

	cSampleCodecFactory (const std::pair< std::string, std::string > &oMDDescription, ddl::tDataRepresentation eDefaultDataRepresentation=ddl::tDataRepresentation::Deserialized)
	Construct a new c Sample Codec Factory.

	cSampleCodecFactory (const ddl::DDStructure &oTypeDefinition, ddl::tDataRepresentation eDefaultDataRepresentation=ddl::tDataRepresentation::Deserialized)
	Construct a new c Sample Codec Factory.

	cSampleCodecFactory (const streaming::ant::IStreamType &oStreamType)
	Construct a new c Sample Codec Factory.

	cSampleCodecFactory (const ucom::ant::iobject_ptr< const streaming::ant::IStreamType > &pStreamType)
	Construct a new c Sample Codec Factory.

	cSampleCodecFactory (const cSampleCodecFactory &)

	cSampleCodecFactory (cSampleCodecFactory &&)

cSampleCodecFactory &	operator= (const cSampleCodecFactory &)

cSampleCodecFactory &	operator= (cSampleCodecFactory &&)

tResult	IsValid () const

cStaticSampleDecoder	MakeStaticDecoderFor (const adtf::streaming::ISample &oSample, ddl::tDataRepresentation eDataRepresentation) const

cStaticSampleCodec	MakeStaticCodecFor (adtf::streaming::ISample &oSample, ddl::tDataRepresentation eDataRepresentation) const

cSampleDecoder	MakeDecoderFor (const adtf::streaming::ISample &oSample, ddl::tDataRepresentation eDataRepresentation) const

cSampleCodec	MakeCodecFor (adtf::streaming::ISample &oSample, ddl::tDataRepresentation eDataRepresentation) const

tElement	GetElement (const tCodecIndex &oCodecIndex) const

tElement	GetElement (std::string_view strElementFullName) const

tElement	GetChildElement (const tCodecIndex &oCodecIndex, std::string_view strElementPath)

const tElements &	GetElements () const

size_t	GetElementChildCount (const tCodecIndex &oCodecIndex) const

std::string	GetElementFullName (const tCodecIndex &oCodecIndex) const
	Retrieves the full name of the element within its main structure.

std::string	GetElementName (const tCodecIndex &oCodecIndex) const
	Retrieves the name of the element within its structured element.

const std::string &	GetElementBaseName (const tCodecIndex &oCodecIndex) const
	Retrieves the base name of the element within its structured element.

size_t	GetStaticBufferSize (ddl::tDataRepresentation eRep=ddl::tDataRepresentation::Deserialized) const
	Gets the static buffer size in bytes for the structure.

ddl::tDataRepresentation	GetDefaultDataRepresentation () const

cStaticSampleDecoder	MakeStaticDecoderFor (const adtf::ucom::iobject_ptr< const adtf::streaming::ISample > &pSample, ddl::tDataRepresentation eDataRepresentation) const

cSampleDecoder	MakeDecoderFor (const adtf::ucom::iobject_ptr< const adtf::streaming::ISample > &pSample, ddl::tDataRepresentation eDataRepresentation) const

cStaticSampleCodec	MakeStaticCodecFor (const adtf::ucom::iobject_ptr< adtf::streaming::ISample > &pSample, ddl::tDataRepresentation eDataRepresentation) const

cSampleCodec	MakeCodecFor (const adtf::ucom::iobject_ptr< adtf::streaming::ISample > &pSample, 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

void	Resolve (tCodecIndex &oCodecIndex) const

tCodecIndex	Resolve (tCodecLeafIndex nElementLeafIndex) const

Public Member Functions inherited from adtf::mediadescription::osborn::adtf_ddl_access::cCodecFactoryLegacy
tCodecIndex	Resolve (tCodecLeafIndex nElementLeafIndex) const

size_t	GetStaticElementCount () const
	Legacy: Gets the leaf count.

tResult	GetStaticElement (tCodecLeafIndex nElementLeafIndex, const ddl::StructElement *&pElement) const

tCodecLeafIndex	FindIndex (const char *strElementName) const
	Legacy: Retrieves the leaf index of the first element in the given element path.

tCodecLeafIndex	FindArrayIndex (const char *strArrayName) const
	Legacy: Retrieves the leaf index of the first element in the given element path.

tCodecLeafIndex	FindStructIndex (const char *strStructName) const
	Legacy: Retrieves the leaf index of the first element in the given element path.

Additional Inherited Members
Public Types inherited from adtf::mediadescription::osborn::cSampleCodecFactory
typedef ddl::codec::FactoryElement< sample_codec_factory_access< const cSampleCodecFactory > >	tElement

typedef ddl::codec::ChildElements< sample_codec_factory_access< const cSampleCodecFactory > >	tElements

Public Types inherited from adtf::mediadescription::osborn::adtf_ddl_access::cCodecFactoryLegacy
typedef ddl::StructElement	DefinedStructElementType
	type definition for the old access_element API.

Static Public Member Functions inherited from adtf::mediadescription::osborn::adtf_ddl_access::cCodecFactoryLegacy
static const char *	GetStaticStructElementName (const ddl::StructElement *pElement)

Detailed Description

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

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

Template Parameters

WriterImplementation The implementation of the sample writer. (default streaming::flash::cSampleWriter)

See also: adtf::streaming::flash::cSampleWriter

Member Function Documentation

◆ ChangeType()

template<typename WriterImplementation = streaming::flash::cSampleWriter>

tResult adtf::mediadescription::osborn::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] pType The 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::osborn::encoding_sample_writer< WriterImplementation >::MakeSample ( base::flash::tNanoSeconds tmTimeStamp )

inline

Creates a new Sample with an attached Sample Codec.

Parameters

[in] tmTimeStamp The sample timestamp.

Returns: The new sample with an attached Sample Codec.

◆ SetType()

template<typename WriterImplementation = streaming::flash::cSampleWriter>

tResult adtf::mediadescription::osborn::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] pStreamType The stream type

Returns: Standard result.

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

◆ Write()

template<typename WriterImplementation = streaming::flash::cSampleWriter>

tResult adtf::mediadescription::osborn::encoding_sample_writer< WriterImplementation >::Write ( cSampleWithCodec & oSampleWithCodec )

inline

Write a sample to the attached Sample Stream

Parameters

[in] oSampleWithCodec The 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:

src/libraries/mediadescription/include/adtfmediadescription/codec_sample_streamer.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ChangeType()

◆ MakeSample()

◆ SetType()

◆ Write()