adtf::mediadescription::ant Namespace Reference

Namespace for all functionality of the ADTF Mediadescription SDK provided since v3.0. More...

Classes
class	cSampleCodec
class	cSampleCodecFactory
class	cSampleDecoder
class	cStaticSampleCodec
class	cStaticSampleDecoder
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. More...

Functions
tResult	create_adtf_default_stream_type (const char *strStructName, const char *strMediaDescription, ucom::iobject_ptr< adtf::streaming::IStreamType > &pStreamType, adtf_ddl::tDataRepresentation eRep=adtf_ddl::tDataRepresentation::Deserialized)
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)
tResult	create_adtf_default_stream_type_from_service (const char *strStructName, ucom::iobject_ptr< adtf::streaming::IStreamType > &pStreamType, adtf_ddl::tDataRepresentation eRep=adtf_ddl::tDataRepresentation::Deserialized)
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)
tResult	set_stream_type_media_description (adtf::streaming::IStreamType &oStreamType, const char *strStructName, const char *strMediaDescription, adtf_ddl::tDataRepresentation eRep=adtf_ddl::tDataRepresentation::Deserialized)
tResult	set_stream_type_media_description_from_service (adtf::streaming::IStreamType &oStreamType, const char *strStructName, adtf_ddl::tDataRepresentation eRep=adtf_ddl::tDataRepresentation::Deserialized)
tResult	get_codec_factory_from_stream_type (const adtf::streaming::IStreamType &oStreamType, cSampleCodecFactory &oFactory)
tResult	add_stream_meta_type (const adtf::streaming::IStreamMetaType &oStreamTypeDef, adtf_ddl::cDDLDescription &oDescription)
template<typename WRITER>
tResult	make_sample_writer (WRITER &oWriter, const char *strNameOfWriter, const char *strDDLStructType)
template<typename READER>
tResult	make_sample_reader (READER &oReader, const char *strNameOfReader, const char *strDDLStructType)

Detailed Description

Namespace for all functionality of the ADTF Mediadescription SDK 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.

create_adtf_default_stream_type() [1/2]

tResult adtf::mediadescription::ant::create_adtf_default_stream_type	(	const char *	strStructName,
		const char *	strMediaDescription,
		ucom::iobject_ptr< adtf::streaming::IStreamType > &	pStreamType,
		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.
[in]	eRep	Representation of the data (serialized or deserialized)

Returns

Standard result.

Deprecated

Use adtf::ucom::make_object_ptr<stream_type_default<>>(const char*, const char*, adtf_ddl::tDataRepresentation) instead.

create_adtf_default_stream_type() [2/2]

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() [1/2]

tResult adtf::mediadescription::ant::create_adtf_default_stream_type_from_service	(	const char *	strStructName,
		ucom::iobject_ptr< adtf::streaming::IStreamType > &	pStreamType,
		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.
[in]	eRep	Representation of the data (serialized or deserialized)

Returns

Standard result.

Deprecated

Use adtf::ucom::make_object_ptr<stream_type_default<>>(const char*, const char*, adtf_ddl::tDataRepresentation) instead.

create_adtf_default_stream_type_from_service() [2/2]

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()

template<typename 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.

make_sample_writer()

template<typename 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.

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 (deprecated) 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.

Deprecated

The ADTF Media Description Service is deprecated.