ADTF: adtf::mediadescription::ant Namespace Reference

Namespace for all functionality provided since v3.0. More...

Classes
class	cStaticSampleDecoder
	Decoder for samples with static data. More...

class	cStaticSampleCodec
	Codec for samples with static data. More...

class	cSampleDecoder
	Decoder for samples with static and/or dynamic data. More...

class	cSampleCodec
	Codec for samples with static and/or dynamic data. More...

class	cSampleCodecFactory
	Factory class for ddl codecs for samples. More...

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

Functions
	ADTF3_DEPRECATED ("Use adtf::ucom::make_object_ptr<stream_type_default<>>(const char, const char, adtf_ddl::tDataRepresentation) " "instead!") tResult create_adtf_default_stream_type(const char *strStructName
	Create an instance of an ADTF default stream type. More...

tResult	create_adtf_default_stream_type (const char strStructName, const char strMediaDescription, ucom::iobject_ptr< adtf::streaming::IStreamType > &pStreamType, cSampleCodecFactory &oFactory, adtf_ddl::tDataRepresentation eRep=adtf_ddl::tDataRepresentation::Deserialized)
	Create an instance of an ADTF default stream type. More...

	ADTF3_DEPRECATED ("Use adtf::ucom::make_object_ptr<stream_type_default<>>(const char, adtf_ddl::tDataRepresentation) " "instead!") tResult create_adtf_default_stream_type_from_service(const char strStructName
	Create an instance of an ADTF default stream type. More...

tResult	create_adtf_default_stream_type_from_service (const char *strStructName, ucom::iobject_ptr< adtf::streaming::IStreamType > &pStreamType, cSampleCodecFactory &oFactory, adtf_ddl::tDataRepresentation eRep=adtf_ddl::tDataRepresentation::Deserialized)
	Create an instance of an ADTF default stream type. More...

tResult	set_stream_type_media_description (adtf::streaming::IStreamType &oStreamType, const char strStructName, const char strMediaDescription, adtf_ddl::tDataRepresentation eRep=adtf_ddl::tDataRepresentation::Deserialized)
	Set the media description properties of a stream type. More...

tResult	set_stream_type_media_description_from_service (adtf::streaming::IStreamType &oStreamType, const char *strStructName, adtf_ddl::tDataRepresentation eRep=adtf_ddl::tDataRepresentation::Deserialized)
	Set the media description properties of a stream type. More...

tResult	get_codec_factory_from_stream_type (const adtf::streaming::IStreamType &oStreamType, cSampleCodecFactory &oFactory)
	Create a sample codec factory from a given stream type. More...

tResult	add_stream_meta_type (const adtf::streaming::IStreamMetaType &oStreamTypeDef, adtf_ddl::cDDLDescription &oDescription)
	Add the stream meta type to an OODDL description. More...

template<typename WRITER >
tResult	make_sample_writer (WRITER &oWriter, const char strNameOfWriter, const char strDDLStructType)
	Creates a new sample writer. More...

template<typename READER >
tResult	make_sample_reader (READER &oReader, const char strNameOfReader, const char strDDLStructType)
	Creates a new sample reader. More...

Variables
const char *	strMediaDescription

const char ucom::iobject_ptr< adtf::streaming::IStreamType > &	pStreamType

const char ucom::iobject_ptr< adtf::streaming::IStreamType > adtf_ddl::tDataRepresentation	eRep = adtf_ddl::tDataRepresentation::Deserialized)

Detailed Description

Namespace for all functionality provided since v3.0.

Function Documentation

◆ add_stream_meta_type()

tResult adtf::mediadescription::ant::add_stream_meta_type	(	const adtf::streaming::IStreamMetaType &	oStreamTypeDef,
		adtf_ddl::cDDLDescription &	oDescription
	)

Add the stream meta type to an OODDL description.

Parameters

[in]	oStreamTypeDef	The stream meta type.
[out]	oDescription	Teh description that the meta type should be added to.

Returns: Standard result.

◆ ADTF3_DEPRECATED() [1/2]

adtf::mediadescription::ant::ADTF3_DEPRECATED ( "Use adtf::ucom::make_object_ptr<stream_type_default<>>(const char*, adtf_ddl::tDataRepresentation) " "instead!" ) const

Create an instance of an ADTF default stream type.

Retrieves the media description from the media description service

Note: This will work only in Init(StageNormal)! Create your pin within the constructor using stream_meta_type_default() and then use ChangeType for your reader/writer.

Parameters

[in]	strStructName	The name of the media description struct.
[out]	pStreamType	The new instance.
[in]	eRep	Representation of the data (serialized or deserialized)

Returns: Standard result.

◆ ADTF3_DEPRECATED() [2/2]

adtf::mediadescription::ant::ADTF3_DEPRECATED ( "Use adtf::ucom::make_object_ptr<stream_type_default<>>(const char*, const char*, adtf_ddl::tDataRepresentation) " "instead!" ) const

Create an instance of an ADTF default stream type.

Parameters

[in]	strStructName	The name of the media description struct.
[in]	strMediaDescription	The media description.
[out]	pStreamType	The new instance.
[in]	eRep	Representation of the data (serialized or deserialized)

Returns: Standard result.

◆ create_adtf_default_stream_type()

tResult adtf::mediadescription::ant::create_adtf_default_stream_type	(	const char *	strStructName,
		const char *	strMediaDescription,
		ucom::iobject_ptr< adtf::streaming::IStreamType > &	pStreamType,
		cSampleCodecFactory &	oFactory,
		adtf_ddl::tDataRepresentation	eRep = `adtf_ddl::tDataRepresentation::Deserialized`
	)

Create an instance of an ADTF default stream type.

Parameters

[in]	strStructName	The name of the media description struct.
[in]	strMediaDescription	The media description.
[out]	pStreamType	The new instance.
[out]	oFactory	An instance of a codec factory for the new type.
[in]	eRep	Representation of the data (serialized or deserialized)

Returns: Standard result.

◆ create_adtf_default_stream_type_from_service()

tResult adtf::mediadescription::ant::create_adtf_default_stream_type_from_service	(	const char *	strStructName,
		ucom::iobject_ptr< adtf::streaming::IStreamType > &	pStreamType,
		cSampleCodecFactory &	oFactory,
		adtf_ddl::tDataRepresentation	eRep = `adtf_ddl::tDataRepresentation::Deserialized`
	)

Create an instance of an ADTF default stream type.

Retrieves the media description from the media description service.

Note: This will work only in Init(StageNormal)! Create your pin within the constructor using stream_meta_type_default() and then use ChangeType for your reader/writer.

Parameters

[in]	strStructName	The name of the media description struct.
[out]	pStreamType	The new instance.
[out]	oFactory	An instance of a codec factory for the new type.
[in]	eRep	Representation of the data (serialized or deserialized)

Returns: Standard result.

◆ get_codec_factory_from_stream_type()

tResult adtf::mediadescription::ant::get_codec_factory_from_stream_type	(	const adtf::streaming::IStreamType &	oStreamType,
		cSampleCodecFactory &	oFactory
	)

Create a sample codec factory from a given stream type.

Parameters

[in]	oStreamType	The stream type.
[out]	oFactory	The new factory.

Returns: Standard result.

◆ make_sample_reader()

tResult adtf::mediadescription::ant::make_sample_reader	(	READER &	oReader,
		const char *	strNameOfReader,
		const char *	strDDLStructType
	)

inline

Creates a new sample reader.

Parameters

[out]	oReader	The new reader.
[in]	strNameOfReader	The name of the new reader.
[in]	strDDLStructType	The media description struct name.

Returns: Standard result.

Definition at line 161 of file media_description_type_legacy.h.

References adtf::ucom::ant::make_object_ptr(), adtf::streaming::ant::make_sample_reader(), and RETURN_IF_THROWS.

◆ make_sample_writer()

tResult adtf::mediadescription::ant::make_sample_writer	(	WRITER &	oWriter,
		const char *	strNameOfWriter,
		const char *	strDDLStructType
	)

inline

Creates a new sample writer.

Parameters

[out]	oWriter	The new writer.
[in]	strNameOfWriter	The name of the new writer.
[in]	strDDLStructType	The media description struct name.

Returns: Standard result.

Definition at line 144 of file media_description_type_legacy.h.

References adtf::ucom::ant::make_object_ptr(), adtf::streaming::ant::make_sample_writer(), and RETURN_IF_THROWS.

◆ set_stream_type_media_description()

tResult adtf::mediadescription::ant::set_stream_type_media_description	(	adtf::streaming::IStreamType &	oStreamType,
		const char *	strStructName,
		const char *	strMediaDescription,
		adtf_ddl::tDataRepresentation	eRep = `adtf_ddl::tDataRepresentation::Deserialized`
	)

Set the media description properties of a stream type.

Parameters

[out]	oStreamType	The stream type.
[in]	strStructName	The name of the media description struct.
[in]	strMediaDescription	The media description.
[in]	eRep	Representation of the data (serialized or deserialized)

Returns: Standard result.

◆ set_stream_type_media_description_from_service()

tResult adtf::mediadescription::ant::set_stream_type_media_description_from_service	(	adtf::streaming::IStreamType &	oStreamType,
		const char *	strStructName,
		adtf_ddl::tDataRepresentation	eRep = `adtf_ddl::tDataRepresentation::Deserialized`
	)

Set the media description properties of a stream type.

Retrieves the media description from the media description service.

Parameters

[out]	oStreamType	The stream type.
[in]	strStructName	The name of the media description struct.
[in]	eRep	Representation of the data (serialized or deserialized)

Returns: Standard result.

Classes

Functions

Variables

Detailed Description

Function Documentation

◆ add_stream_meta_type()

◆ ADTF3_DEPRECATED() [1/2]

◆ ADTF3_DEPRECATED() [2/2]

◆ create_adtf_default_stream_type()

◆ create_adtf_default_stream_type_from_service()

◆ get_codec_factory_from_stream_type()

◆ make_sample_reader()

◆ make_sample_writer()

◆ set_stream_type_media_description()

◆ set_stream_type_media_description_from_service()