adtf::streaming::IStreamMetaType Class Reference

Defines access methods for a Stream Meta Type. More...

#include <streamtype_intf.h>

Inherits adtf::ucom::ant::IObject.

Public Member Functions
	ADTF_IID (IStreamMetaType, "streamtypedef.ant.streaming.adtf.iid")
	Interface ID for the Stream Typedef interface.
virtual tResult	GetMetaTypeName (base::ant::IString &&strTypeName) const=0
	Gets the unique meta type name.
virtual adtf::util::tVersion	GetVersion () const=0
	Get version of a Stream Type.
virtual tResult	GetDefaultConfig (ucom::ant::iobject_ptr< const base::ant::IProperties > &pProperties) const=0
	Get the default configuration values for a Stream Type.
virtual tResult	GetParent (ucom::ant::iobject_ptr< const IStreamMetaType > &pParent) const=0
	This GetParent function is deprecated.
virtual tResult	IsCompatible (const IStreamType &oTypeToCheck, const IStreamType &oExpectedType) const=0
	Compares the Stream Type oTypeToCheck based on this meta type. It alway depends on the concete implementation what to check.
Public Member Functions inherited from adtf::ucom::ant::IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")

Protected Member Functions
	~IStreamMetaType ()=default
	not destructable
Protected Member Functions inherited from adtf::ucom::ant::IObject
	~IObject ()=default
	Protected destructor --> Only the final implementation can be destroyed!

Detailed Description

Defines access methods for a Stream Meta Type.

The Stream Meta Type provides the user with all necessary information of a Stream Type. These information cover:

• The meta type name (IStreamMetaType::GetMetaTypeName()) which is a string identifier distributing information about how to interpret the actual property data (e.g. audio, video, default, etc.)
• The current version of a Stream Type (IStreamMetaType::GetVersion())
• The default configuration values (IStreamMetaType::GetDefaultConfig())
• The parent StreamMetaType a StreamMetaType is derived from (IStreamMetaType::GetParent())

Member Function Documentation

GetDefaultConfig()

virtual tResult adtf::streaming::ant::IStreamMetaType::GetDefaultConfig ( ucom::ant::iobject_ptr< const base::ant::IProperties > & pProperties ) const

pure virtual

Get the default configuration values for a Stream Type.

Parameters

[out]

pProperties

All properties of the default configuration

Returns

Standard error code

Return values

ERR_NOERROR

Everything went fine

GetMetaTypeName()

virtual tResult adtf::streaming::ant::IStreamMetaType::GetMetaTypeName ( base::ant::IString && strTypeName ) const

pure virtual

Gets the unique meta type name.

Returns

Standard error code

Parameters

[out]

strTypeName

The meta type name as string

Return values

ERR_NOERROR

Everything went fine

GetParent()

virtual tResult adtf::streaming::ant::IStreamMetaType::GetParent ( ucom::ant::iobject_ptr< const IStreamMetaType > & pParent ) const

pure virtual

This GetParent function is deprecated.

Deprecated

This IStreamMetaType::GetParent function is not supported anymore!

Parameters

[out]

pParent

The parent Stream Type definition

Returns

Standard error code

Return values

ERR_NOERROR	Everything went fine
ERR_NOT_SUPPORTED	Is not supported anymore

GetVersion()

virtual adtf::util::tVersion adtf::streaming::ant::IStreamMetaType::GetVersion ( ) const

pure virtual

Get version of a Stream Type.

Returns

Version of the Stream Type.

See also

adtf_util::tVersion

IsCompatible()

virtual tResult adtf::streaming::ant::IStreamMetaType::IsCompatible ( const IStreamType & oTypeToCheck, const IStreamType & oExpectedType ) const

pure virtual

Compares the Stream Type oTypeToCheck based on this meta type. It alway depends on the concete implementation what to check.

Parameters

[in]	oTypeToCheck	The incoming type to check.
[in]	oExpectedType	The base type which

Return values

ERR_NOERROR

types are compatible

---

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

• src/libraries/streaming3/include/adtfstreaming3/streamtype_intf.h