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

Namespaces
namespace	detail
	Namespace for all internally used functionality implemented.

Classes
struct	arithmetic_type

class	cDDLPrinter

class	cDumper

class	cEnumerationType

class	cSampleCodecFactory

class	cSampleWithCodec

class	cStructureType

class	cType

class	decoding_sample_reader

struct	description

class	encoding_sample_writer

class	enumeration

class	enumeration< UnderlyingType, typename std::enable_if< std::is_arithmetic< UnderlyingType >::value >::type >

struct	indices

class	md_array

class	md_sample_data

class	md_sample_data_factory

class	md_struct_array

class	structure

class	structure< void >

Functions
std::ostream &	operator<< (std::ostream &oStream, const cDDLPrinter &oPrinter)

std::ostream &	operator<< (std::ostream &oStream, const cDumper &cDumper)

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)

ucom::ant::object_ptr< streaming::ant::IStreamType >	create_adtf_default_stream_type (const cStructureType &type_definition)
	Create a stream type containing the media description of a given structure type definition.

ucom::ant::object_ptr< streaming::ant::IStreamType >	create_adtf_default_stream_type (const char strStructName, const char strMediaDescription)
	Create a stream type continaing the given media description.

template<typename Struct>
ucom::ant::object_ptr< streaming::ant::IStreamType >	create_adtf_default_stream_type ()
	Create a stream type from a generated media description.

tResult	set_media_description_properties (base::ant::IProperties &oProperties, const char strStructName, const char strMediaDescription, adtf_ddl::tDataRepresentation eRep=adtf_ddl::tDataRepresentation::Deserialized)

tResult	set_media_description_properties (base::ant::IProperties &oProperties, const cStructureType &type_definition, adtf_ddl::tDataRepresentation eRep=adtf_ddl::tDataRepresentation::Deserialized)

void	set_stream_type_media_description (streaming::ant::IStreamType &oStreamType, const cStructureType &type_definition)

Detailed Description

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

Function Documentation

◆ create_adtf_default_stream_type() [1/3]

template<typename Struct>

ucom::ant::object_ptr< streaming::ant::IStreamType > adtf::mediadescription::flash::create_adtf_default_stream_type ( )

Create a stream type from a generated media description.

Template Parameters

Struct The struct that has been generated via media description code generation.

Returns: A stream type containing a generated media description.

Deprecated: Use adtf::ucom::make_object_ptr<stream_type_default<T>>() instead.

◆ create_adtf_default_stream_type() [2/3]

ucom::ant::object_ptr< streaming::ant::IStreamType > adtf::mediadescription::flash::create_adtf_default_stream_type	(	const char *	strStructName,
		const char *	strMediaDescription )

Create a stream type continaing the given media description.

Parameters

[in]	strStructName	The name of the struct.
[in]	strMediaDescription	The description containing the struct definition.

Returns: A stream type containing the given media description.

Exceptions

tResult in case of error.

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

◆ create_adtf_default_stream_type() [3/3]

ucom::ant::object_ptr< streaming::ant::IStreamType > adtf::mediadescription::flash::create_adtf_default_stream_type ( const cStructureType & type_definition )

Create a stream type containing the media description of a given structure type definition.

Parameters

[in] type_definition A structure type definition.

Returns: A stream type containing the media description of the given type definition.

Exceptions

tResult in case of error.

◆ make_sample_reader()

template<typename READER>

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

inline

Helper template to setup a sample reader with a stream type set from the (deprecated) media description service.

Parameters

[in,out]	oReader	The reader that should be setup.
[in]	strNameOfReader	The name of the reader, which will be used to create an input pin.
[in]	strDDLStructType	The name of the struct that the description should be retrieved from the (deprecated) media description service.

Returns: Standard result.

Deprecated: The ADTF Media Description Service is deprecated.

◆ make_sample_writer()

template<typename WRITER>

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

inline

Helper template to setup a sample writer with a stream type set from the (deprecated) media description service.

Parameters

[in,out]	oWriter	The writer that should be setup.
[in]	strNameOfWriter	The name of the writer, which will be used to create an output pin.
[in]	strDDLStructType	The name of the struct that the description should be retrieved from the (deprecated) media description service.

Returns: Standard result.

Deprecated: The ADTF Media Description Service is deprecated.

◆ operator<<() [1/2]

std::ostream & adtf::mediadescription::flash::operator<<	(	std::ostream &	oStream,
		const cDDLPrinter &	oPrinter )

Stream operator for cDDLPrinter. Prints the DDL description to the given stream.

Parameters

[in]	oStream	The stream.
[in]	oPrinter	The printer.

Returns: The stream.

◆ operator<<() [2/2]

std::ostream & adtf::mediadescription::flash::operator<<	(	std::ostream &	oStream,
		const cDumper &	cDumper )

Stream output operator for cDumper.

Parameters

[in]	oStream	The stream.
[in]	oDumper	The dumper.

Returns: The stream.

◆ set_media_description_properties() [1/2]

tResult adtf::mediadescription::flash::set_media_description_properties	(	base::ant::IProperties &	oProperties,
		const char *	strStructName,
		const char *	strMediaDescription,
		adtf_ddl::tDataRepresentation	eRep = adtf_ddl::tDataRepresentation::Deserialized )

Adds the media description properties to a properties object.

Parameters

[out]	oProperties	The properties object where the properties should be added/set to.
[in]	strStructName	The name of the struct.
[in]	strMediaDescription	The media description containing the struct definition.
[in]	eRep	The data representation of the struct that samples contain.

Returns: Standard result.

◆ set_media_description_properties() [2/2]

tResult adtf::mediadescription::flash::set_media_description_properties	(	base::ant::IProperties &	oProperties,
		const cStructureType &	type_definition,
		adtf_ddl::tDataRepresentation	eRep = adtf_ddl::tDataRepresentation::Deserialized )

Adds the media description properties to a properties object.

Parameters

[out]	oProperties	The properties object where the properties should be added/set to.
[in]	type_definition	A structure type definition.
[in]	eRep	The data representation of the struct that samples contain.

Returns: Standard result.

◆ set_stream_type_media_description()

void adtf::mediadescription::flash::set_stream_type_media_description	(	streaming::ant::IStreamType &	oStreamType,
		const cStructureType &	type_definition )

Adds the media description properties to a stream type.

Parameters

[out]	oStreamType	The stream type where the properties should be added/set to.
[in]	type_definition	A structure type definition.

Exceptions

tResult in case of error.

Namespaces

Classes

Functions

Detailed Description

Function Documentation

◆ create_adtf_default_stream_type() [1/3]

◆ create_adtf_default_stream_type() [2/3]

◆ create_adtf_default_stream_type() [3/3]

◆ make_sample_reader()

◆ make_sample_writer()

◆ operator<<() [1/2]

◆ operator<<() [2/2]

◆ set_media_description_properties() [1/2]

◆ set_media_description_properties() [2/2]

◆ set_stream_type_media_description()