ADTF  3.18.2
stream_meta_type_default

Use this Stream Meta Type if your sample data are structured and the memory layout can be described via DDL - see also Usage of Stream Meta Type "adtf/default". More...

Public Member Functions

 stream_meta_type_default ()=default
 CTOR.
 

Static Public Member Functions

static void SetProperties (const adtf::ucom::iobject_ptr< adtf::base::ant::IProperties > &pProperties)
 Adds the default properties of this meta type to pProperties. More...
 
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 in ADTF for a summary of implementations. More...
 

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. More...
 
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. More...
 
static constexpr const tChar *const strMDDataSerialized = "md_data_serialized"
 The name of the property defines wether the sample data are serialized or not serialized. More...
 

Detailed Description

Use this Stream Meta Type if your sample data are structured and the memory layout can be described via DDL - see also Usage of Stream Meta Type "adtf/default".

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:

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

See also
Stream Meta Type, Demo Media Description Code Generation Filters Plugin.

Definition at line 33 of file stream_meta_type_default.h.

Member Function Documentation

◆ IsCompatible()

static tResult 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 in ADTF for a summary of implementations.

Compatible to all other stream types of any Stream Meta Type, where the following conditions are met:

Remarks
: For a complete definition of the delivered default types and the information of which Stream Type is compatible to another one then see Default Stream Meta Types in ADTF.
Parameters
[in]oTypeToCheckThe incoming type to check.
[in]oTypeExpectedThe expected type which values are more significant.
Return values
ERR_NOERRORtypes are compatible
See also
Default Stream Meta Types in ADTF, AcceptType and IsCompatible implementations, ddl::DDCompare::isEqualType.

◆ SetProperties()

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

Adds the default properties of this meta type to pProperties.

Parameters
[in]pPropertiesThe properties to the default values to.
Returns
void.

Member Data Documentation

◆ strMDDataSerialized

constexpr const tChar* const 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. For more information on serialized/deserialized see page_ddl_specification and Serialization of "adtf/default" Samples.

Definition at line 64 of file stream_meta_type_default.h.

◆ strMDDefinitionsProperty

constexpr const tChar* const 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 Demo Media Description Code Generation Filters Plugin.

Definition at line 49 of file stream_meta_type_default.h.

◆ strMDStructProperty

constexpr const tChar* const 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 Demo Media Description Code Generation Filters Plugin.

Definition at line 56 of file stream_meta_type_default.h.