ADTF  3.18.2
cCodecFactoryLegacyabstract

Legacy CodecFactory API. More...

Inheritance diagram for cCodecFactoryLegacy:
[legend]

Public Types

typedef ddl::StructElement DefinedStructElementType
 type definition for the old access_element API.
 

Public Member Functions

tCodecIndex Resolve (tCodecLeafIndex nElementIndex) const
 Legacy: Retrieves a codec index with element information for the given leaf index. More...
 
size_t GetStaticElementCount () const
 Legacy: Gets the leaf count. More...
 
tResult GetStaticElement (tCodecLeafIndex nElementLeafIndex, const ddl::StructElement *&pElement) const
 Legacy: Access information about an element. More...
 
tCodecLeafIndex FindIndex (const char *strElementName) const
 Legacy: Retrieves the leaf index of the first element in the given element path. More...
 
tCodecLeafIndex FindArrayIndex (const char *strArrayName) const
 Legacy: Retrieves the leaf index of the first element in the given element path. More...
 
tCodecLeafIndex FindStructIndex (const char *strStructName) const
 Legacy: Retrieves the leaf index of the first element in the given element path. More...
 

Static Public Member Functions

static const char * GetStaticStructElementName (const ddl::StructElement *pElement)
 Legacy helper funtion to support old adtf_ddl::element_access::find_* functions. More...
 

Protected Member Functions

virtual const ddl::codec::CodecFactorygetFactory () const =0
 For internal use only.
 

Detailed Description

Legacy CodecFactory API.

See also
The Codec Leaf Index.

Definition at line 254 of file sample_codec_access_legacy.h.

Member Function Documentation

◆ FindArrayIndex()

tCodecLeafIndex FindArrayIndex ( const char *  strArrayName) const

Legacy: Retrieves the leaf index of the first element in the given element path.

Parameters
strArrayNameThe array element name
Returns
tCodecLeafIndex

◆ FindIndex()

tCodecLeafIndex FindIndex ( const char *  strElementName) const

Legacy: Retrieves the leaf index of the first element in the given element path.

Parameters
strElementNameThe element name
Returns
tCodecLeafIndex

◆ FindStructIndex()

tCodecLeafIndex FindStructIndex ( const char *  strStructName) const

Legacy: Retrieves the leaf index of the first element in the given element path.

Parameters
strStructNameThe struct element name
Returns
tCodecLeafIndex

◆ GetStaticElement()

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

Legacy: Access information about an element.

Parameters
[in]nElementLeafIndexThe leaf index of the element.
[out]pElementPointer that will be updated to point to the element information.
Return values
ERR_INVALID_INDEXInvalid index.

◆ GetStaticElementCount()

size_t GetStaticElementCount ( ) const

Legacy: Gets the leaf count.

Returns
The amount of static elements contained in the handled structure.

◆ GetStaticStructElementName()

static const char* GetStaticStructElementName ( const ddl::StructElement pElement)
static

Legacy helper funtion to support old adtf_ddl::element_access::find_* functions.

Parameters
[in]pElementthe elemnent struct to retriev the name from.
Returns
char pointer to the pElement value!

◆ Resolve()

tCodecIndex Resolve ( tCodecLeafIndex  nElementIndex) const

Legacy: Retrieves a codec index with element information for the given leaf index.

Parameters
nElementLeafIndexThe leaf index (between 0 and GetElementCount())
Returns
The codec index for this element.
Exceptions
throwstResult if not found.
Deprecated:
This is only provided for legacy reason. Use adtf::mediadescription::cSampleDecoder::GetElement!