adtf::mediadescription::osborn::cSampleWithCodec Class Reference

#include <codec_sample_streamer.h>

Inherits adtf::mediadescription::osborn::cSampleCodec.

Public Member Functions
	cSampleWithCodec ()=default
	cSampleWithCodec (cSampleCodec &&oCodec, const ucom::ant::iobject_ptr< const streaming::ant::ISample > &pSample)
	cSampleWithCodec (cSampleWithCodec &&)=default
cSampleWithCodec &	operator= (cSampleWithCodec &&)=default
virtual	~cSampleWithCodec ()
ucom::ant::object_ptr< const streaming::ant::ISample >	Release ()
Public Member Functions inherited from adtf::mediadescription::osborn::cSampleCodec
	cSampleCodec ()
	cSampleCodec (cSampleCodec &&)
cSampleCodec &	operator= (cSampleCodec &&)
template<typename T>
void	SetElementValue (const tCodecIndex &oCodecIndex, const T &oValue)
	Sets the elements value from the given oValue. If this element is a enum type the enum types element name can be used in oValue if T = std::string. Otherwise the string value is automatically converted to the elments data type.
template<typename T>
void	SetElementValue (const tLeafCodecIndex &oLeafCodecIndex, const T &oValue)
	Sets the elements value from the given oValue. If this element is a enum type the enum types element name can be used in oValue if T = std::string. Otherwise the string value is automatically converted to the elments data type. You may use a valid codec index retrieved by the cSampleCodecFactory, but no other! This is to prepare for codec processing in advance:
void	SetElementVariantValue (const tCodecIndex &oCodecIndex, const a_util::variant::Variant &oValue)
void	SetElementStringValue (const tCodecIndex &oCodecIndex, const std::string &strValue)
void	SetElementRawValue (const tCodecIndex &oCodecIndex, const void *pValue, size_t szValueSize)
	Sets the elements value by copy the memory from pValue. You may use a valid codec index retrieved by the cSampleCodecFactory, but no other! This is to prepare for codec processing in advance:
void *	GetElementAddress (const tCodecIndex &oCodecIndex)
	Gets the elements value memory pointer into the given data for writig access.
tElement	GetElement (const tCodecIndex &oCodecIndex)
tElement	GetElement (std::string_view strElementFullName)
tElements &	GetElements ()
void *	GetElementAddress (std::string_view strElementFullName)
	Gets the elements value memory pointer into the given data for writing access.
size_t	GetBufferSize () const
	Gets the buffer size in bytes for the main structure.
size_t	GetBufferSize (ddl::tDataRepresentation eRep) const
	Gets the buffer size in bytes for the main structure.
const void *	GetData () const
	Get the current data pointer.
void *	GetData ()
	Get the current data pointer for writing access.
size_t	GetDataSize () const
	Get the current data size.
tElement	GetElement (const tCodecIndex &oCodecIndex) const
tElement	GetElement (std::string_view strElementFullName) const
tResult	GetElement (tCodecLeafIndex nElementLeafIndex, const ddl::StructElement *&pElement) const
	Get the Element StructElement information.
const tElements &	GetElements () const
const void *	GetElementAddress (const tCodecIndex &oCodecIndex) const
	Gets the elements value memory pointer into the given data.
const void *	GetElementAddress (tCodecLeafIndex nElementLeafIndex) const
	Legacy: Get the Element StructElement information.
Public Member Functions inherited from adtf::mediadescription::osborn::cSampleDecoderBase
	cSampleDecoderBase ()
	cSampleDecoderBase (cSampleDecoderBase &&)
cSampleDecoderBase &	operator= (cSampleDecoderBase &&)
tResult	IsValid () const
tElement	GetElement (const tCodecIndex &oCodecIndex) const
tElement	GetElement (std::string_view strElementFullName) const
tElement	GetChildElement (const tCodecIndex &oCodecIndex, std::string_view strElementPath) const
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 () const
	Gets the static buffer size in bytes for the main structure.
size_t	GetStaticBufferSize (ddl::tDataRepresentation eRep) const
	Gets the static buffer size in bytes for the main structure.
ddl::tDataRepresentation	GetRepresentation () const
template<typename T>
T	GetElementValue (const tCodecIndex &oCodecIndex) const
	Gets the elements value as value of type T. You may use a valid codec index retrieved by the cSampleCodecFactory, but no other! This is to prepare for decoding in advance:
template<typename T>
T	GetElementValue (const penguin::tLeafCodecIndex &oLeafCodecIndex) const
	Gets the elements value as value of type T. You may use a valid codec index retrieved by the cSampleCodecFactory, but no other! This is to prepare for decoding in advance:
a_util::variant::Variant	GetElementVariantValue (const tCodecIndex &oCodecIndex) const
void	GetElementVariantValue (const tCodecIndex &oCodecIndex, a_util::variant::Variant &oValue) const
std::string	GetElementStringValue (const tCodecIndex &oCodecIndex) const
void	GetElementRawValue (const tCodecIndex &oCodecIndex, void *pValue, size_t szValueSize) const
	Copies the elements value to the given memory pointer in pValue.
const void *	GetElementAddress (const tCodecIndex &oCodecIndex) const
	Gets the elements value memory pointer into the given data.
void	Resolve (tCodecIndex &oCodecIndex) const
tResult	GetElement (tCodecLeafIndex nElementLeafIndex, const ddl::StructElement *&pElement) const
	Get the Element StructElement information.
adtf_util::cVariant	GetElementValue (tCodecLeafIndex nElementLeafIndex) const
	Legacy: Get the Element Value.
tResult	GetElementValue (tCodecLeafIndex nElementLeafIndex, adtf_util::cVariant &oValue) const
	Legacy: Get the Element Value.
tResult	GetElementValue (const char *strElementName, adtf_util::cVariant &oValue) const
	Legacy: Get the Element Value.
tResult	GetElementValue (tCodecLeafIndex nElementLeafIndex, void *pValue) const
	Legacy: Copies the Element Value memory into the memory pointer. Keep in MIND this function is UNSAFE in case of value memory is biger than the given one.
tResult	GetElementValue (const char *strElementName, void *pValue) const
	Legacy: Get the Element Value pointer.
const void *	GetElementAddress (tCodecLeafIndex nElementLeafIndex) const
	Legacy: Get the Element StructElement information.
tCodecIndex	Resolve (tCodecLeafIndex nElementLeafIndex) const
Public Member Functions inherited from adtf::mediadescription::osborn::adtf_ddl_access::cDecoderLegacy
tCodecIndex	Resolve (tCodecLeafIndex nElementLeafIndex) const
adtf_util::cVariant	GetElementValue (tCodecLeafIndex nElementLeafIndex) const
	Legacy: Get the Element Value.
tResult	GetElementValue (tCodecLeafIndex nElementLeafIndex, adtf_util::cVariant &oValue) const
	Legacy: Get the Element Value.
tResult	GetElementValue (const char *strElementName, adtf_util::cVariant &oValue) const
	Legacy: Get the Element Value.
tResult	GetElementValue (tCodecLeafIndex nElementLeafIndex, void *pValue) const
	Legacy: Copies the Element Value memory into the memory pointer. Keep in MIND this function is UNSAFE in case of value memory is biger than the given one.
tResult	GetElementValue (const char *strElementName, void *pValue) const
	Legacy: Get the Element Value pointer.
adtf_util::cString	GetElementValueString (tCodecLeafIndex nElementLeafIndex) const
	Legacy: Get the Element Value as string (resolved to the enum element name if is enum type)
tResult	GetElement (tCodecLeafIndex nElementLeafIndex, const ddl::StructElement *&pElement) const
	Get the Element StructElement information.
const void *	GetElementAddress (tCodecLeafIndex nElementLeafIndex) const
	Legacy: Get the Element StructElement information.
size_t	GetElementCount () const
	Legacy: Get the Element Leaf count.
Public Member Functions inherited from adtf::mediadescription::osborn::adtf_ddl_access::cCodecLegacy< ddl::codec::Codec >
tResult	SetElementValue (tCodecLeafIndex nElementLeafIndex, const adtf_util::cVariant &oValue)
	Legacy: Set the Element Value.
tResult	SetElementValue (const char *strElementName, const adtf_util::cVariant &oValue)
	Legacy: Set the Element Value.
void *	GetElementAddress (tCodecLeafIndex nElementLeafIndex)
	Legacy:Get the Element Address object.

Additional Inherited Members
Public Types inherited from adtf::mediadescription::osborn::cSampleCodec
typedef ddl::codec::CodecElement< sample_codec_access< cSampleCodec > >	tElement
typedef ddl::codec::ChildElements< sample_codec_access< cSampleCodec > >	tElements
Public Types inherited from adtf::mediadescription::osborn::cSampleDecoderBase
typedef ddl::codec::DecoderElement< sample_decoder_access< const cSampleDecoderBase > >	tElement
typedef ddl::codec::ChildElements< sample_decoder_access< const cSampleDecoderBase > >	tElements
Public Types inherited from adtf::mediadescription::osborn::adtf_ddl_access::cDecoderLegacy
typedef ddl::StructElement	DefinedStructElementType
	type definition for the old access_element API.
Static Public Member Functions inherited from adtf::mediadescription::osborn::adtf_ddl_access::cDecoderLegacy
static const char *	GetStructElementName (const ddl::StructElement *pElement)
	Legacy: Get the Struct Element Name for access_element legacy support.
Protected Member Functions inherited from adtf::mediadescription::osborn::cSampleDecoderBase
void	ResetFirst ()

Detailed Description

Helper class that combines a Sample Codec with a Sample instance.

Constructor & Destructor Documentation

cSampleWithCodec() [1/3]

adtf::mediadescription::osborn::cSampleWithCodec::cSampleWithCodec ( )

default

Default Constructor -> invalid object.

cSampleWithCodec() [2/3]

adtf::mediadescription::osborn::cSampleWithCodec::cSampleWithCodec	(	cSampleCodec &&	oCodec,
		const ucom::ant::iobject_ptr< const streaming::ant::ISample > &	pSample )

Constructor that initializes a valid object.

Parameters

[in]	oCodec	The codec the encodes values into the sample.
[in]	pSample	The sample.

cSampleWithCodec() [3/3]

adtf::mediadescription::osborn::cSampleWithCodec::cSampleWithCodec ( cSampleWithCodec && )

default

Move constructor.

~cSampleWithCodec()

virtual adtf::mediadescription::osborn::cSampleWithCodec::~cSampleWithCodec ( )

virtual

Destructor

Member Function Documentation

operator=()

cSampleWithCodec & adtf::mediadescription::osborn::cSampleWithCodec::operator= ( cSampleWithCodec && )

default

Move assignment operator.

Release()

ucom::ant::object_ptr< const streaming::ant::ISample > adtf::mediadescription::osborn::cSampleWithCodec::Release

(

)

Retrieve the sample instance.

Call this when you're done updating the sample data in order to write it via streaming::flash::ISampleWriter::Write.

Do not call any other methods of the object after you have called this method.

Returns

A Pointer to the sample.

---

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

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