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

struct	tStreamAudioFormat
	Structure for Audio Format. More...

Functions
bool	operator== (const tStreamAudioFormat &oLeft, const tStreamAudioFormat &oRight)
	is equal operator to compare tStreamAudioFormat

bool	operator!= (const tStreamAudioFormat &oLeft, const tStreamAudioFormat &oRight)
	is not equal operator to compare tStreamAudioFormat

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

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.

ucom::ant::object_ptr< ant::IStreamType >	create_adtf_audio_stream_type ()
	Convinience functionality to create a stream type audio - see Stream Meta Type "adtf/audio".

ucom::ant::object_ptr< ant::IStreamType >	create_adtf_audio_stream_type (const tStreamAudioFormat &sFormat)
	Convinience functionality to create a stream type audio with audio description - see Stream Meta Type "adtf/audio".

ucom::ant::object_ptr< ant::IStreamType >	create_adtf_image_stream_type ()
	Convenience functionality to create a stream type image - see sec_stream_type_image.

ucom::ant::object_ptr< ant::IStreamType >	create_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.

template<typename T>
ucom::ant::object_ptr< ant::IStreamType >	create_adtf_plain_stream_type ()
	Convenience functionality to create a stream type plain - see Stream Meta Type "adtf/plaintype".

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

inline

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

Returns: created streamtype

See also: stream_type_audio

Definition at line 195 of file streammetatypeaudio.h.

References create_adtf_audio_stream_type(), and adtf::ucom::ant::make_object_ptr().

Referenced by create_adtf_audio_stream_type(), and create_adtf_audio_stream_type().

◆ create_adtf_audio_stream_type() [2/2]

ucom::ant::object_ptr< ant::IStreamType > 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

sFormat The audio format to immediatelly initialize the properties

Returns: created streamtype

See also: stream_type_audio

Definition at line 207 of file streammetatypeaudio.h.

References create_adtf_audio_stream_type(), adtf::ucom::ant::make_object_ptr(), set_stream_type_audio_format(), and THROW_IF_FAILED.

◆ create_adtf_image_stream_type() [1/2]

ucom::ant::object_ptr< ant::IStreamType > create_adtf_image_stream_type ( )

inline

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

Returns: the created type

See also: stream_type_image

Definition at line 145 of file streammetatypeimage.h.

References create_adtf_image_stream_type(), and adtf::ucom::ant::make_object_ptr().

Referenced by create_adtf_image_stream_type(), and create_adtf_image_stream_type().

◆ create_adtf_image_stream_type() [2/2]

ucom::ant::object_ptr< ant::IStreamType > 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

oFormat Format to set

Returns: the created type

See also: stream_type_image

Definition at line 157 of file streammetatypeimage.h.

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

◆ create_adtf_plain_stream_type()

template<typename T>

ucom::ant::object_ptr< ant::IStreamType > create_adtf_plain_stream_type ( )

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

Template Parameters

T	type for the stream_type_plain generator template

Returns: created streamtype

See also: adtf::streaming::penguin::stream_type_plain

Definition at line 212 of file streammetatypeplain.h.

References create_adtf_plain_stream_type(), and adtf::ucom::ant::make_object_ptr().

Referenced by create_adtf_plain_stream_type().

◆ get_stream_type_audio_format()

tResult 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

sFormat	The Audio format
oType	The Stream Type where to retrieve the properties from

Returns: tResult

Return values

ERR_NOERROR	Everything went fine
ERR_INVALID_TYPE	the given oType is not a instance of stream meta type "adtf/audio"

Definition at line 171 of file streammetatypeaudio.h.

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

◆ operator!=()

bool 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

true	is not equal
false	is equal

Definition at line 130 of file streammetatypeaudio.h.

◆ operator==()

bool 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

true	is equal
false	is not equal

Definition at line 114 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 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

sFormat	The Audio format
oType	The Stream Type where to set the properties to

Returns: tResult

Return values

ERR_NOERROR	Everything went fine
ERR_INVALID_TYPE	the given oType is not a instance of stream meta type "adtf/audio"

Definition at line 144 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, RETURN_ERROR, RETURN_NOERROR, stream_meta_type_audio::SampleCount, stream_meta_type_audio::SampleRateHz, and adtf::streaming::set_property().

Referenced by create_adtf_audio_stream_type().

Classes

Functions

Detailed Description

Function Documentation

◆ create_adtf_audio_stream_type() [1/2]

◆ create_adtf_audio_stream_type() [2/2]

◆ create_adtf_image_stream_type() [1/2]

◆ create_adtf_image_stream_type() [2/2]

◆ create_adtf_plain_stream_type()

◆ get_stream_type_audio_format()

◆ operator!=()

◆ operator==()

◆ set_stream_type_audio_format()