adtf::streaming::stream_meta_type_image Struct Reference

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

#include <streammetatypeimage.h>

Inherits adtf::streaming::ant::stream_meta_type_image.

Static Public Member Functions
static void	SetProperties (const adtf::ucom::iobject_ptr< adtf::base::IProperties > &pProperties)
static tResult	IsCompatible (const adtf::streaming::ant::IStreamType &oTypeToCheck, const adtf::streaming::ant::IStreamType &oTypeExpected)
	Compares the oTypeExpected Stream Type with the oTypeToCheck.
Static Public Member Functions inherited from adtf::streaming::ant::stream_meta_type_image
static void	SetProperties (const adtf::ucom::iobject_ptr< adtf::base::IProperties > &pProperties)

Additional Inherited Members
Static Public Attributes inherited from adtf::streaming::ant::stream_meta_type_image
static constexpr const tChar *const	MetaTypeName = "adtf/image"
	StreamMetaTypeName for imagetype (video stream).
static constexpr const tChar *const	FormatName = "format_name"
	Name for the Property of the format name.
static constexpr const tChar *const	MaxByteSize = "max_byte_size"
	Name for the Property of the max byte size.
static constexpr const tChar *const	PixelWidth = "pixel_width"
	Name for the Property of the pixel width.
static constexpr const tChar *const	PixelHeight = "pixel_height"
	Name for the Property of the pixel height.
static constexpr const tChar *const	DataEndianess = "data_endianess"
	Name for the Property of the data endianess (usually pixel endianess).

Detailed Description

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.

Concept template to create the "adtf/image" Stream Meta Type for the generator template stream_meta_type.

Remarks

Mind that this defines only the absolute minimum of properties for image storage, many formats will require additional properties. This version of meta type defines a specific IsCompatible.

Member Function Documentation

IsCompatible()

static tResult adtf::streaming::lucky::stream_meta_type_image::IsCompatible ( const adtf::streaming::ant::IStreamType & oTypeToCheck, const adtf::streaming::ant::IStreamType & oTypeExpected )

static

Compares the oTypeExpected Stream Type with the oTypeToCheck.

This implementation of IsCompatible will accept all other Meta Types and will return ERR_NOERROR only if:
If a format is set, each property value describing the format must be equal except MaxByteSize which follows thease rules:

• if MaxByteSize is 0 in oTypeExpected - it is dynamic and will be accepted
• if MaxByteSize is greater in oTypeExpected than in oTypeToCheck -> it will fit for any prellocations and will be accepted
• if MaxByteSize in oTypeExpected is lower than in oTypeToCheck -> it is not compatible
• if MaxByteSize is 0 in oTypeToCheck, we need also 0 in oTypeExpected to be compatible

If no format was set, it will return ERR_NOERROR only if the MetaTypeName is equal independently by properties content.

Parameters

[in]	oTypeToCheck	The incoming type to check.
[in]	oTypeExpected	The expected type which values are more significant.

Return values

ERR_NOERROR

types are compatible

SetProperties()

static void adtf::streaming::lucky::stream_meta_type_image::SetProperties ( const adtf::ucom::iobject_ptr< adtf::base::IProperties > & pProperties )

inlinestatic

Sets the default properties to the given pProperties.

Parameters

pProperties

The properties where to set the default properties to

---

The documentation for this struct was generated from the following file:

• src/libraries/streaming3/include/adtfstreaming3/streammetatypeimage.h