ADTF  3.13.2
adtf::mediadescription::ant Namespace Reference

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

Classes

class  cSampleCodec
 Codec for samples with static and/or dynamic data. More...
 
class  cSampleCodecFactory
 Factory class for ddl codecs for samples. More...
 
class  cSampleDecoder
 Decoder for samples with static and/or dynamic data. More...
 
class  cStaticSampleCodec
 Codec for samples with static data. More...
 
class  cStaticSampleDecoder
 Decoder for samples with static data. 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 - see also Usage of Stream Meta Type "adtf/default". More...
 

Functions

tResult create_adtf_default_stream_type (const tChar *strStructName, const tChar *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. More...
 
tResult create_adtf_default_stream_type (const tChar *strStructName, const tChar *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...
 
tResult create_adtf_default_stream_type_from_service (const tChar *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. More...
 
tResult create_adtf_default_stream_type_from_service (const tChar *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 tChar *strStructName, const tChar *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 tChar *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 tChar *strNameOfWriter, const tChar *strDDLStructType)
 Creates a new sample writer. More...
 
template<typename READER >
tResult make_sample_reader (READER &oReader, const tChar *strNameOfReader, const tChar *strDDLStructType)
 Creates a new sample reader. More...
 

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]oStreamTypeDefThe stream meta type.
[out]oDescriptionTeh 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 tChar strStructName,
const tChar 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]strStructNameThe name of the media description struct.
[in]strMediaDescriptionThe media description.
[out]pStreamTypeThe new instance.
[in]eRepRepresentation of the data (serialized or deserialized)
Returns
Standard result.

◆ create_adtf_default_stream_type() [2/2]

tResult adtf::mediadescription::ant::create_adtf_default_stream_type ( const tChar strStructName,
const tChar 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]strStructNameThe name of the media description struct.
[in]strMediaDescriptionThe media description.
[out]pStreamTypeThe new instance.
[out]oFactoryAn instance of a codec factory for the new type.
[in]eRepRepresentation 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 tChar 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

Parameters
[in]strStructNameThe name of the media description struct.
[out]pStreamTypeThe new instance.
[in]eRepRepresentation of the data (serialized or deserialized)
Returns
Standard result.

Referenced by make_sample_reader(), adtf::mediadescription::flash::make_sample_reader(), make_sample_writer(), and adtf::mediadescription::flash::make_sample_writer().

◆ create_adtf_default_stream_type_from_service() [2/2]

tResult adtf::mediadescription::ant::create_adtf_default_stream_type_from_service ( const tChar 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.

Parameters
[in]strStructNameThe name of the media description struct.
[out]pStreamTypeThe new instance.
[out]oFactoryAn instance of a codec factory for the new type.
[in]eRepRepresentation 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]oStreamTypeThe stream type.
[out]oFactoryThe new factory.
Returns
Standard result.

Referenced by decoding_sample_reader< ReaderImplementation >::decoding_sample_reader().

◆ make_sample_reader()

tResult adtf::mediadescription::ant::make_sample_reader ( READER &  oReader,
const tChar strNameOfReader,
const tChar strDDLStructType 
)
inline

Creates a new sample reader.

Parameters
[out]oReaderThe new reader.
[in]strNameOfReaderThe name of the new reader.
[in]strDDLStructTypeThe media description struct name.
Returns
Standard result.

Definition at line 149 of file media_description_type.h.

References create_adtf_default_stream_type_from_service(), adtf::streaming::ant::make_sample_reader(), and RETURN_IF_FAILED.

◆ make_sample_writer()

tResult adtf::mediadescription::ant::make_sample_writer ( WRITER &  oWriter,
const tChar strNameOfWriter,
const tChar strDDLStructType 
)
inline

Creates a new sample writer.

Parameters
[out]oWriterThe new writer.
[in]strNameOfWriterThe name of the new writer.
[in]strDDLStructTypeThe media description struct name.
Returns
Standard result.

Definition at line 132 of file media_description_type.h.

References create_adtf_default_stream_type_from_service(), adtf::streaming::ant::make_sample_writer(), and RETURN_IF_FAILED.

◆ set_stream_type_media_description()

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

Set the media description properties of a stream type.

Parameters
[out]oStreamTypeThe stream type.
[in]strStructNameThe name of the media description struct.
[in]strMediaDescriptionThe media description.
[in]eRepRepresentation 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 tChar 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]oStreamTypeThe stream type.
[in]strStructNameThe name of the media description struct.
[in]eRepRepresentation of the data (serialized or deserialized)
Returns
Standard result.

Copyright © Audi Electronics Venture GmbH. All rights reserved. (Generated on Tue Nov 16 2021 by doxygen 1.8.14)