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

Inheritance diagram for stream_meta_type_image:
[legend]

Static Public Member Functions

static tVoid SetProperties (const adtf::ucom::iobject_ptr< adtf::base::IProperties > &pProperties)
 Sets the default properties to the given pProperties. More...
 

Static Public Attributes

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 - see imageformat_definition and Generic Pixel Format. More...
 
static constexpr const tChar *const MaxByteSize = "max_byte_size"
 Name for the Property of the max byte size. More...
 
static constexpr const tChar *const PixelWidth = "pixel_width"
 Name for the Property of the pixel width. More...
 
static constexpr const tChar *const PixelHeight = "pixel_height"
 Name for the Property of the pixel height. More...
 
static constexpr const tChar *const DataEndianess = "data_endianess"
 Name for the Property of the data endianess (usually pixel endianess). More...
 

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.
See also
Stream Meta Type, set_stream_type_image_format, get_stream_type_image_format

Definition at line 30 of file streammetatypeimage.h.

Member Function Documentation

◆ SetProperties()

static tVoid SetProperties ( const adtf::ucom::iobject_ptr< adtf::base::IProperties > &  pProperties)
inlinestatic

Sets the default properties to the given pProperties.

Parameters
pPropertiesThe properties where to set the default properties to

Definition at line 64 of file streammetatypeimage.h.

References stream_meta_type_image::DataEndianess, stream_meta_type_image::FormatName, stream_meta_type_image::MaxByteSize, stream_meta_type_image::PixelHeight, stream_meta_type_image::PixelWidth, and PLATFORM_BYTEORDER.

Referenced by stream_meta_type_image::SetProperties().

Member Data Documentation

◆ DataEndianess

constexpr const tChar* const DataEndianess = "data_endianess"
static

Name for the Property of the data endianess (usually pixel endianess).

Endianess of the image (usually pixel endianess) - by default this is PLATFORM_BYTEORDER (PLATFORM_BIG_ENDIAN_8 or PLATFORM_LITTLE_ENDIAN_8).

Definition at line 58 of file streammetatypeimage.h.

Referenced by stream_meta_type_image::SetProperties().

◆ FormatName

constexpr const tChar* const FormatName = "format_name"
static

Name for the Property of the format name - see imageformat_definition and Generic Pixel Format.

Formatname of the image - see adtf::streaming::ant::imageformat_definition.

Definition at line 38 of file streammetatypeimage.h.

Referenced by stream_meta_type_image::SetProperties().

◆ MaxByteSize

constexpr const tChar* const MaxByteSize = "max_byte_size"
static

Name for the Property of the max byte size.

Maximal byte size of the image.

Definition at line 43 of file streammetatypeimage.h.

Referenced by stream_meta_type_image::SetProperties().

◆ PixelHeight

constexpr const tChar* const PixelHeight = "pixel_height"
static

Name for the Property of the pixel height.

Pixel height of the image.

Definition at line 53 of file streammetatypeimage.h.

Referenced by stream_meta_type_image::SetProperties().

◆ PixelWidth

constexpr const tChar* const PixelWidth = "pixel_width"
static

Name for the Property of the pixel width.

Pixel width of the image.

Definition at line 48 of file streammetatypeimage.h.

Referenced by stream_meta_type_image::SetProperties().


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