adtf::streaming::lucky Namespace Reference

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

Classes
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

Functions
bool	operator== (const tStreamAudioFormat &oLeft, const tStreamAudioFormat &oRight)
bool	operator!= (const tStreamAudioFormat &oLeft, const tStreamAudioFormat &oRight)
tResult	set_stream_type_audio_format (IStreamType &oType, const tStreamAudioFormat &sFormat)
tResult	get_stream_type_audio_format (tStreamAudioFormat &sFormat, const IStreamType &oType)
ucom::ant::object_ptr< ant::IStreamType >	create_adtf_audio_stream_type ()
ucom::ant::object_ptr< ant::IStreamType >	create_adtf_audio_stream_type (const tStreamAudioFormat &sFormat)
ucom::ant::object_ptr< ant::IStreamType >	create_adtf_image_stream_type ()
ucom::ant::object_ptr< ant::IStreamType >	create_adtf_image_stream_type (const ant::tStreamImageFormat &oFormat)
template<typename T>
ucom::ant::object_ptr< ant::IStreamType >	create_adtf_plain_stream_type ()

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.

Returns

created streamtype

See also

adtf::streaming::penguin::stream_type_audio

Deprecated

Use adtf::ucom::make_object_ptr<stream_type_audio<>>() instead.

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.

Parameters

sFormat

The audio format to immediatelly initialize the properties

Returns

created streamtype

See also

adtf::streaming::penguin::stream_type_audio

Deprecated

adtf::ucom::make_object_ptr<stream_type_audio<>>(const tStreamAudioFormat&) instead.

create_adtf_image_stream_type() [1/2]

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

inline

Convenience functionality to create a stream type image.

Returns

the created type

See also

adtf::streaming::penguin::stream_type_image

Deprecated

Use adtf::ucom::make_object_ptr<stream_type_image<>>() instead.

create_adtf_image_stream_type() [2/2]

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.

Parameters

oFormat

Format to set

Returns

the created type

See also

adtf::streaming::penguin::stream_type_image

Deprecated

Use adtf::ucom::make_object_ptr<stream_type_image<>>(const ant::tStreamImageFormat&) instead.

create_adtf_plain_stream_type()

template<typename T>

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

(

)

Convenience functionality to create a stream type plain.

Template Parameters

T	type for the stream_type_plain generator template

Returns

created streamtype

See also

adtf::streaming::penguin::stream_type_plain

Deprecated

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

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

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"

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

true	is not equal
false	is equal

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

true	is equal
false	is not equal

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

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"