adtf::mediadescription::osborn::adtf_ddl_access::cCodecFactoryLegacy Class Reference

Legacy CodecFactory API. More...

#include <sample_codec_access_legacy.h>

Inherited by adtf::mediadescription::osborn::cSampleCodecFactory.

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

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

Static Public Member Functions
static const char *	GetStaticStructElementName (const ddl::StructElement *pElement)

Protected Member Functions
virtual const ddl::codec::CodecFactory *	getFactory () const =0
	For internal use only.

Detailed Description

Legacy CodecFactory API.

Member Function Documentation

FindArrayIndex()

tCodecLeafIndex adtf::mediadescription::osborn::adtf_ddl_access::cCodecFactoryLegacy::FindArrayIndex

(

const char *

strArrayName

)

const

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

Parameters

strArrayName

The array element name

Returns

tCodecLeafIndex

FindIndex()

tCodecLeafIndex adtf::mediadescription::osborn::adtf_ddl_access::cCodecFactoryLegacy::FindIndex

(

const char *

strElementName

)

const

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

Parameters

strElementName

The element name

Returns

tCodecLeafIndex

FindStructIndex()

tCodecLeafIndex adtf::mediadescription::osborn::adtf_ddl_access::cCodecFactoryLegacy::FindStructIndex

(

const char *

strStructName

)

const

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

Parameters

strStructName

The struct element name

Returns

tCodecLeafIndex

GetStaticElement()

tResult adtf::mediadescription::osborn::adtf_ddl_access::cCodecFactoryLegacy::GetStaticElement	(	tCodecLeafIndex	nElementLeafIndex,
		const ddl::StructElement *&	pElement ) const

Legacy: Access information about an element.

Parameters

[in]	nElementLeafIndex	The leaf index of the element.
[out]	pElement	Pointer that will be updated to point to the element information.

Return values

ERR_INVALID_INDEX

Invalid index.

Deprecated

This is only provided for legacy reason. Use adtf::mediadescription::cSampleDecoder::GetElement instead

GetStaticElementCount()

size_t adtf::mediadescription::osborn::adtf_ddl_access::cCodecFactoryLegacy::GetStaticElementCount

(

)

const

Legacy: Gets the leaf count.

Returns

The amount of static elements contained in the handled structure.

Deprecated

This is only provided for legacy reason. Use adtf::mediadescription::cSampleDecoder::GetElement instead

GetStaticStructElementName()

static const char * adtf::mediadescription::osborn::adtf_ddl_access::cCodecFactoryLegacy::GetStaticStructElementName ( const ddl::StructElement * pElement )

static

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

Parameters

[in]

pElement

the elemnent struct to retriev the name from.

Returns

char pointer to the pElement value!

Resolve()

tCodecIndex adtf::mediadescription::osborn::adtf_ddl_access::cCodecFactoryLegacy::Resolve

(

tCodecLeafIndex

nElementLeafIndex

)

const

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

Parameters

nElementLeafIndex

The leaf index (between 0 and GetElementCount())

Returns

The codec index for this element.

Exceptions

throws

tResult if not found.

Deprecated

This is only provided for legacy reason. Use adtf::mediadescription::cSampleDecoder::GetElement instead

---

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

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