ADTF  3.14.2
adtf::streaming::lucky Namespace Reference

Namespace for all functionality of the ADTF Streaming SDK provided since v3.11. More...

Classes

class  cActiveRunner
 Base class for implementing Active Runner. More...
 
struct  tStreamAudioFormat
 Structure for Audio Format. More...
 
struct  stream_meta_type_image
 Use this Stream Meta Type for describing a video stream with single frames and there format and set the values with set_stream_type_image_format. More...
 

Functions

bool operator== (const tStreamAudioFormat &oLeft, const tStreamAudioFormat &oRight)
 is equal operator to compare tStreamAudioFormat More...
 
bool operator!= (const tStreamAudioFormat &oLeft, const tStreamAudioFormat &oRight)
 is not equal operator to compare tStreamAudioFormat More...
 
tResult set_stream_type_audio_format (IStreamType &oType, const tStreamAudioFormat &sFormat)
 sets the audio format properties within the stream type if meta type "adtf/audio" is set More...
 
tResult get_stream_type_audio_format (tStreamAudioFormat &sFormat, const IStreamType &oType)
 retrievs the audio format from the properties of the stream type if meta type "adtf/audio" is set. More...
 
ucom::ant::object_ptr< ant::IStreamTypecreate_adtf_audio_stream_type ()
 Convinience functionality to create a stream type audio - see Stream Meta Type "adtf/audio". More...
 
ucom::ant::object_ptr< ant::IStreamTypecreate_adtf_audio_stream_type (const tStreamAudioFormat &sFormat)
 Convinience functionality to create a stream type audio with audio description - see Stream Meta Type "adtf/audio". More...
 
ucom::ant::object_ptr< ant::IStreamTypecreate_adtf_image_stream_type ()
 Convenience functionality to create a stream type image - see sec_stream_type_image.
 
ucom::ant::object_ptr< ant::IStreamTypecreate_adtf_image_stream_type (const ant::tStreamImageFormat &oFormat)
 Convenience functionality to create a stream type image with predefined image format - see sec_stream_type_image. More...
 
template<typename T >
ucom::ant::object_ptr< ant::IStreamTypecreate_adtf_plain_stream_type ()
 Convenience functionality to create a stream type plain - see Stream Meta Type "adtf/plaintype". More...
 

Detailed Description

Namespace for all functionality of the ADTF Streaming SDK provided since v3.11.

Function Documentation

◆ create_adtf_audio_stream_type() [1/2]

ucom::ant::object_ptr<ant::IStreamType> adtf::streaming::lucky::create_adtf_audio_stream_type ( )
inline

Convinience functionality to create a stream type audio - see Stream Meta Type "adtf/audio".

Returns
created streamtype

Definition at line 191 of file streammetatypeaudio.h.

Referenced by create_adtf_audio_stream_type().

◆ create_adtf_audio_stream_type() [2/2]

ucom::ant::object_ptr<ant::IStreamType> adtf::streaming::lucky::create_adtf_audio_stream_type ( const tStreamAudioFormat sFormat)
inline

Convinience functionality to create a stream type audio with audio description - see Stream Meta Type "adtf/audio".

Parameters
sFormatThe audio format to immediatelly initialize the properties
Returns
created streamtype

Definition at line 201 of file streammetatypeaudio.h.

References create_adtf_audio_stream_type(), set_stream_type_audio_format(), and THROW_IF_FAILED.

◆ create_adtf_image_stream_type()

ucom::ant::object_ptr<ant::IStreamType> adtf::streaming::lucky::create_adtf_image_stream_type ( const ant::tStreamImageFormat oFormat)
inline

Convenience functionality to create a stream type image with predefined image format - see sec_stream_type_image.

Parameters
oFormatFormat to set
Returns
the created type

Definition at line 150 of file streammetatypeimage.h.

References create_adtf_image_stream_type(), adtf::streaming::ant::set_stream_type_image_format(), and THROW_IF_FAILED.

◆ create_adtf_plain_stream_type()

ucom::ant::object_ptr<ant::IStreamType> adtf::streaming::lucky::create_adtf_plain_stream_type ( )

Convenience functionality to create a stream type plain - see Stream Meta Type "adtf/plaintype".

Template Parameters
Ttype for the stream_type_plain generator template
Returns
created streamtype

Definition at line 203 of file streammetatypeplain.h.

◆ get_stream_type_audio_format()

tResult adtf::streaming::lucky::get_stream_type_audio_format ( tStreamAudioFormat sFormat,
const IStreamType oType 
)
inline

retrievs the audio format from the properties of the stream type if meta type "adtf/audio" is set.

Parameters
sFormatThe Audio format
oTypeThe Stream Type where to retrieve the properties from
Returns
tResult
Return values
ERR_NOERROREverything went fine
ERR_INVALID_TYPEthe given oType is not a instance of stream meta type "adtf/audio"

Definition at line 169 of file streammetatypeaudio.h.

References adtf_string_intf, stream_meta_type_audio::BitsPerSample, stream_meta_type_audio::ChannelCount, stream_meta_type_audio::FormatName, IStreamType::GetMetaTypeName(), tStreamAudioFormat::m_strFormatName, tStreamAudioFormat::m_ui32BitsPerSample, tStreamAudioFormat::m_ui32ChannelCount, tStreamAudioFormat::m_ui32SampleCount, tStreamAudioFormat::m_ui32SampleRateHz, stream_meta_type_audio::MetaTypeName, stream_meta_type_audio::SampleCount, and stream_meta_type_audio::SampleRateHz.

◆ operator!=()

bool adtf::streaming::lucky::operator!= ( const tStreamAudioFormat oLeft,
const tStreamAudioFormat oRight 
)
inline

is not equal operator to compare tStreamAudioFormat

Parameters
oLeft[in] left value
oRight[in] right value
Return values
trueis not equal
falseis equal

Definition at line 128 of file streammetatypeaudio.h.

◆ operator==()

bool adtf::streaming::lucky::operator== ( const tStreamAudioFormat oLeft,
const tStreamAudioFormat oRight 
)
inline

is equal operator to compare tStreamAudioFormat

Parameters
oLeft[in] left value
oRight[in] right value
Return values
trueis equal
falseis not equal

Definition at line 112 of file streammetatypeaudio.h.

References tStreamAudioFormat::m_strFormatName, tStreamAudioFormat::m_ui32BitsPerSample, tStreamAudioFormat::m_ui32ChannelCount, tStreamAudioFormat::m_ui32SampleCount, and tStreamAudioFormat::m_ui32SampleRateHz.

◆ set_stream_type_audio_format()

tResult adtf::streaming::lucky::set_stream_type_audio_format ( IStreamType oType,
const tStreamAudioFormat sFormat 
)
inline

sets the audio format properties within the stream type if meta type "adtf/audio" is set

Parameters
sFormatThe Audio format
oTypeThe Stream Type where to set the properties to
Returns
tResult
Return values
ERR_NOERROREverything went fine
ERR_INVALID_TYPEthe given oType is not a instance of stream meta type "adtf/audio"

Definition at line 142 of file streammetatypeaudio.h.

References adtf_string_intf, stream_meta_type_audio::BitsPerSample, stream_meta_type_audio::ChannelCount, stream_meta_type_audio::FormatName, IStreamType::GetMetaTypeName(), tStreamAudioFormat::m_strFormatName, tStreamAudioFormat::m_ui32BitsPerSample, tStreamAudioFormat::m_ui32ChannelCount, tStreamAudioFormat::m_ui32SampleCount, tStreamAudioFormat::m_ui32SampleRateHz, stream_meta_type_audio::MetaTypeName, stream_meta_type_audio::SampleCount, and stream_meta_type_audio::SampleRateHz.

Referenced by create_adtf_audio_stream_type().


Copyright © Audi Electronics Venture GmbH. All rights reserved. (Generated on Tue May 10 2022 by doxygen 1.9.1)