adtf::mediadescription::stream_meta_type_default Struct Reference

Use this Stream Meta Type if your sample data are structured and the memory layout can be described via DDL Specification. More...

#include <stream_meta_type_default.h>

Public Member Functions
	stream_meta_type_default ()=default

Static Public Member Functions
static void	SetProperties (const adtf::ucom::iobject_ptr< adtf::base::ant::IProperties > &pProperties)
static tResult	IsCompatible (const adtf::streaming::ant::IStreamType &oTypeToCheck, const adtf::streaming::ant::IStreamType &oTypeExpected)
	Compares the oTypeExpected Stream Type with the oTypeToCheck - see Default Stream Meta Types for a summary of implementations.

Static Public Attributes
static constexpr const tChar *const	MetaTypeName = "adtf/default"
	The name of this meta type.
static constexpr const tChar *const	strMDDefinitionsProperty = "md_definitions"
	The name of the ddl media description definitions property.
static constexpr const tChar *const	strMDStructProperty = "md_struct"
	The name of the ddl media description struct name property, containing the struct type for the whole sample data content.
static constexpr const tChar *const	strMDDataSerialized = "md_data_serialized"
	The name of the property defines wether the sample data are serialized or not serialized.

Detailed Description

Use this Stream Meta Type if your sample data are structured and the memory layout can be described via DDL Specification.

This class is a the "adtf/default" Stream Meta Type for the generator template stream_meta_type_default. Create this ADTF Default Stream Type by using following:

• stream_type_default.

Example code for creating this type with the help of the template description, see Example Demo Code Generation.

Constructor & Destructor Documentation

stream_meta_type_default()

adtf::mediadescription::ant::stream_meta_type_default::stream_meta_type_default ( )

default

CTOR.

Member Function Documentation

IsCompatible()

static tResult adtf::mediadescription::ant::stream_meta_type_default::IsCompatible ( const adtf::streaming::ant::IStreamType & oTypeToCheck, const adtf::streaming::ant::IStreamType & oTypeExpected )

static

Compares the oTypeExpected Stream Type with the oTypeToCheck - see Default Stream Meta Types for a summary of implementations.

Compatible to all other stream types of any stream meta type, where the following conditions are met:

• the property value of the properties strMDDataSerialized are equal in both types (both serialized or both deserialized)
• the property values of strMDStructProperty and strMDDefinitionsProperty must be exactly the same, OR
• if the property values of strMDStructProperty and strMDDefinitionsProperty are not equal then the given in strMDStructProperty complex types must be semantically equal (see ddl::DDCompare::isEqualType with ddl::DDCompare::icf_memory and ddl::DDCompare::icf_subset and ddl::DDCompare::isEqualType with ddl::DDCompare::icf_serialized and ddl::DDCompare::icf_subset)

Parameters

[in]	oTypeToCheck	The incoming type to check.
[in]	oTypeExpected	The expected type which values are more significant.

Return values

ERR_NOERROR

types are compatible

SetProperties()

static void adtf::mediadescription::ant::stream_meta_type_default::SetProperties ( const adtf::ucom::iobject_ptr< adtf::base::ant::IProperties > & pProperties )

static

Adds the default properties of this meta type to pProperties.

Parameters

[in]

pProperties

The properties to the default values to.

Returns

void.

Member Data Documentation

strMDDataSerialized

const tChar* const adtf::mediadescription::ant::stream_meta_type_default::strMDDataSerialized = "md_data_serialized"

staticconstexpr

The name of the property defines wether the sample data are serialized or not serialized.

This property defines wether the sample data are serialized (true) or not serialized (false). By default the value is set to false! This determines that the DDL definitons for deserialized interpretation is used.

strMDDefinitionsProperty

const tChar* const adtf::mediadescription::ant::stream_meta_type_default::strMDDefinitionsProperty = "md_definitions"

staticconstexpr

The name of the ddl media description definitions property.

This property contains a complete self-contained DDL definition which should contain the description of the complex type set in strMDStructProperty. See stream_type_default for creating the type with the help of the template adtf::mediadescription::description. See also Example Demo Code Generation.

strMDStructProperty

const tChar* const adtf::mediadescription::ant::stream_meta_type_default::strMDStructProperty = "md_struct"

staticconstexpr

The name of the ddl media description struct name property, containing the struct type for the whole sample data content.

This property contains a complex type name / struct name out of the complete self-contained DDL definition in strMDDefinitionsProperty. See also Example Demo Code Generation.

---

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

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