Class to extract DCSM metadata entries from. Objects of this type will be provided by ramses callbacks and should not be created directly. More...

#include <DcsmMetadataUpdate.h>

Inheritance diagram for ramses::DcsmMetadataUpdate:

[legend]

Collaboration diagram for ramses::DcsmMetadataUpdate:

[legend]

Public Member Functions
	~DcsmMetadataUpdate ()
	Destructor. More...

bool	hasPreviewImagePng () const
	Check if object contains PNG preview image metadata entry. More...

std::vector< unsigned char >	getPreviewImagePng () const
	Get preview image metadata entry. The vector contains in memory representation of a PNG file. Will be empty when not hasPreviewImagePng(). More...

bool	hasPreviewDescription () const
	Check if object contains preview description metadata entry. More...

std::u32string	getPreviewDescription () const
	Get preview description metadata entry as utf32 string. Will be empty when not hasPreviewDescription(). More...

bool	hasWidgetOrder () const
	Check if object contains widget order metadata entry. More...

int32_t	getWidgetOrder () const
	Get widget order metadata entry. Value is undefined when not hasWidgetOrder(). More...

bool	hasWidgetBackgroundID () const
	Check if object contains widget background id metadata entry. More...

int32_t	getWidgetBackgroundID () const
	Get widget background id metadata entry. Value is undefined when not hasWidgetBackgroundID(). More...

bool	hasWidgetHUDLineID () const
	Check if object contains widget hud line id metadata entry. More...

int32_t	getWidgetHUDLineID () const
	Get widget hud line id metadata entry. Value is undefined when not hasWidgetHUDLineID(). More...

bool	hasCarModel () const
	Check if object contains car model metadata entry. More...

int32_t	getCarModel () const
	Get car model metadata entry. Value is undefined when not hasCarModel(). More...

bool	hasCarModelView () const
	Check if object contains car model view metadata entry. More...

CarModelViewMetadata	getCarModelView () const
	Get car model view metadata entry. Value is undefined when not hasCarModelView(). More...

bool	hasCarModelViewExtended () const
	Check if object contains car model view extended metadata entry. More...

CarModelViewMetadataExtended	getCarModelViewExtended () const
	Get car model view extended metadata entry. Value is undefined when not hasCarModelViewExtended(). More...

AnimationInformation	getCarModelViewAnimationInfo () const
	Get animation information associated with car model view metadata entry. Value is undefined when not hasCarModelView(). More...

bool	hasCarModelVisibility () const
	Check if object contains car model visibility metadata entry. More...

bool	getCarModelVisibility () const
	Get car model visibility metadata entry. Value is undefined when not hasCarModelVisibility(). More...

bool	hasExclusiveBackground () const
	Check if object contains exclusive background metadata entry. More...

bool	getExclusiveBackground () const
	Get exclusive background metadata entry. Value is undefined when not hasExclusiveBackground(). More...

bool	hasStreamID () const
	Check if object contains streamID metadata entry. More...

int32_t	getStreamID () const
	Get streamID metadata entry. Value is undefined when not hasStreamID(). More...

bool	hasDisplayedDataFlags () const
	Check if object contains displayed data flags metadata entry. More...

uint32_t	getDisplayedDataFlags () const
	Get displayed data flags. Value is undefined when not hasDisplayedDataFlags(). More...

bool	hasContentFlippedVertically () const
	Check if object contains a contentFlippedVertically entry. More...

bool	getContentFlippedVertically () const
	Get contentFlippedVertically metadata entry. Value is undefined when not hasContentFlippedVertically(). More...

bool	hasLayoutAvailability () const
	Check if object contains layoutAvailability metadata entry. More...

uint8_t	getLayoutAvailability () const
	Get layout availability metadata entry. Value is undefined when not hasLayoutAvailability(). More...

bool	hasConfiguratorPriority () const
	Check if object contains configuratorPriority metadata entry. More...

uint8_t	getConfiguratorPriority () const
	Get the widget configurator priority for this dcsm content Value is undefined if not hasConfiguratorPriority(). More...

	DcsmMetadataUpdate ()=delete
	Deleted default constructor. More...

	DcsmMetadataUpdate (DcsmMetadataUpdateImpl &impl_)
	Constructor from impl. More...

	DcsmMetadataUpdate (DcsmMetadataUpdate &&other)=delete
	Deleted move constructor. More...

DcsmMetadataUpdate &	operator= (DcsmMetadataUpdate &&other)=delete
	Deleted move assignment. More...

	DcsmMetadataUpdate (const DcsmMetadataUpdate &other)=delete
	Deleted copy constructor. More...

DcsmMetadataUpdate &	operator= (const DcsmMetadataUpdate &other)=delete
	Deleted copy assignment. More...

Public Member Functions inherited from ramses::StatusObject
status_t	validate () const
	Generates verbose validation of the object. More...

const char *	getValidationReport (EValidationSeverity minSeverity=EValidationSeverity_Info) const
	Provides verbose report in human readable form generated by validate. More...

const char *	getStatusMessage (status_t status) const
	Get the string description for a status provided by a RAMSES API function. More...

	StatusObject (const StatusObject &other)=delete
	Deleted copy constructor. More...

StatusObject &	operator= (const StatusObject &other)=delete
	Deleted copy assignment. More...

Public Attributes
DcsmMetadataUpdateImpl &	impl

Public Attributes inherited from ramses::StatusObject
class StatusObjectImpl &	impl

Additional Inherited Members
Protected Member Functions inherited from ramses::StatusObject
	StatusObject (StatusObjectImpl &pimpl)
	Constructor for StatusObject. More...

virtual	~StatusObject ()
	Destructor of the StatusObject. More...

Detailed Description

Class to extract DCSM metadata entries from. Objects of this type will be provided by ramses callbacks and should not be created directly.

The object can be queried for all available metadata types and when they are available the metadata entries can be extracted. See IDcsmConsumerEventHandler::contentMetadataUpdated() for more details.

Constructor & Destructor Documentation

◆ ~DcsmMetadataUpdate()

ramses::DcsmMetadataUpdate::~DcsmMetadataUpdate ( )

Destructor.

◆ DcsmMetadataUpdate() [1/4]

ramses::DcsmMetadataUpdate::DcsmMetadataUpdate ( )

delete

Deleted default constructor.

◆ DcsmMetadataUpdate() [2/4]

ramses::DcsmMetadataUpdate::DcsmMetadataUpdate ( DcsmMetadataUpdateImpl & impl_ )

explicit

Constructor from impl.

Parameters

impl_ impl

◆ DcsmMetadataUpdate() [3/4]

ramses::DcsmMetadataUpdate::DcsmMetadataUpdate ( DcsmMetadataUpdate && other )

delete

Deleted move constructor.

Parameters

other unused

◆ DcsmMetadataUpdate() [4/4]

ramses::DcsmMetadataUpdate::DcsmMetadataUpdate ( const DcsmMetadataUpdate & other )

delete

Deleted copy constructor.

Parameters

other unused

Member Function Documentation

◆ getCarModel()

int32_t ramses::DcsmMetadataUpdate::getCarModel ( ) const

Get car model metadata entry. Value is undefined when not hasCarModel().

Returns: car model metadata

◆ getCarModelView()

CarModelViewMetadata ramses::DcsmMetadataUpdate::getCarModelView ( ) const

Get car model view metadata entry. Value is undefined when not hasCarModelView().

Returns: car model view metadata

◆ getCarModelViewAnimationInfo()

AnimationInformation ramses::DcsmMetadataUpdate::getCarModelViewAnimationInfo ( ) const

Get animation information associated with car model view metadata entry. Value is undefined when not hasCarModelView().

Returns: animation information for car model view metadata

◆ getCarModelViewExtended()

CarModelViewMetadataExtended ramses::DcsmMetadataUpdate::getCarModelViewExtended ( ) const

Get car model view extended metadata entry. Value is undefined when not hasCarModelViewExtended().

Returns: car model view extended metadata

◆ getCarModelVisibility()

bool ramses::DcsmMetadataUpdate::getCarModelVisibility ( ) const

Get car model visibility metadata entry. Value is undefined when not hasCarModelVisibility().

Returns: car model visibility

◆ getConfiguratorPriority()

uint8_t ramses::DcsmMetadataUpdate::getConfiguratorPriority ( ) const

Get the widget configurator priority for this dcsm content Value is undefined if not hasConfiguratorPriority().

Returns: the widget configurator priority

◆ getContentFlippedVertically()

bool ramses::DcsmMetadataUpdate::getContentFlippedVertically ( ) const

Get contentFlippedVertically metadata entry. Value is undefined when not hasContentFlippedVertically().

When set provider requests to flip content on Y-axis before displaying.

Returns: content flipped vertically state

◆ getDisplayedDataFlags()

uint32_t ramses::DcsmMetadataUpdate::getDisplayedDataFlags ( ) const

Get displayed data flags. Value is undefined when not hasDisplayedDataFlags().

Returns: displayed data flags

◆ getExclusiveBackground()

bool ramses::DcsmMetadataUpdate::getExclusiveBackground ( ) const

Get exclusive background metadata entry. Value is undefined when not hasExclusiveBackground().

Returns: exclusive background state

◆ getLayoutAvailability()

uint8_t ramses::DcsmMetadataUpdate::getLayoutAvailability ( ) const

Get layout availability metadata entry. Value is undefined when not hasLayoutAvailability().

Returns: Bitmask of displaycluster::M_Modes

◆ getPreviewDescription()

std::u32string ramses::DcsmMetadataUpdate::getPreviewDescription ( ) const

Get preview description metadata entry as utf32 string. Will be empty when not hasPreviewDescription().

Returns: utf32 string with preview description

◆ getPreviewImagePng()

std::vector<unsigned char> ramses::DcsmMetadataUpdate::getPreviewImagePng ( ) const

Get preview image metadata entry. The vector contains in memory representation of a PNG file. Will be empty when not hasPreviewImagePng().

Returns: vector with PNG buffer

◆ getStreamID()

int32_t ramses::DcsmMetadataUpdate::getStreamID ( ) const

Get streamID metadata entry. Value is undefined when not hasStreamID().

Returns: streamID

◆ getWidgetBackgroundID()

int32_t ramses::DcsmMetadataUpdate::getWidgetBackgroundID ( ) const

Get widget background id metadata entry. Value is undefined when not hasWidgetBackgroundID().

Returns: widget background id

◆ getWidgetHUDLineID()

int32_t ramses::DcsmMetadataUpdate::getWidgetHUDLineID ( ) const

Get widget hud line id metadata entry. Value is undefined when not hasWidgetHUDLineID().

Returns: widget background id

◆ getWidgetOrder()

int32_t ramses::DcsmMetadataUpdate::getWidgetOrder ( ) const

Get widget order metadata entry. Value is undefined when not hasWidgetOrder().

Returns: widget order

◆ hasCarModel()

bool ramses::DcsmMetadataUpdate::hasCarModel ( ) const

Check if object contains car model metadata entry.

Returns: true when has car model metadata, false when not

◆ hasCarModelView()

bool ramses::DcsmMetadataUpdate::hasCarModelView ( ) const

Check if object contains car model view metadata entry.

Returns: true when has car model view metadata, false when not

◆ hasCarModelViewExtended()

bool ramses::DcsmMetadataUpdate::hasCarModelViewExtended ( ) const

Check if object contains car model view extended metadata entry.

Returns: true when has car model view extended metadata, false when not

◆ hasCarModelVisibility()

bool ramses::DcsmMetadataUpdate::hasCarModelVisibility ( ) const

Check if object contains car model visibility metadata entry.

Returns: true when has car model visibility metadata, false when not

◆ hasConfiguratorPriority()

bool ramses::DcsmMetadataUpdate::hasConfiguratorPriority ( ) const

Check if object contains configuratorPriority metadata entry.

Returns: true if has configuratorPriority metadata, false if not

◆ hasContentFlippedVertically()

bool ramses::DcsmMetadataUpdate::hasContentFlippedVertically ( ) const

Check if object contains a contentFlippedVertically entry.

Returns: true when has content flipped vertically metadata, false when not

◆ hasDisplayedDataFlags()

bool ramses::DcsmMetadataUpdate::hasDisplayedDataFlags ( ) const

Check if object contains displayed data flags metadata entry.

Returns: true when has displayed data flags metadata, false when not

◆ hasExclusiveBackground()

bool ramses::DcsmMetadataUpdate::hasExclusiveBackground ( ) const

Check if object contains exclusive background metadata entry.

Returns: true when has exclusive background metadata, false when not

◆ hasLayoutAvailability()

bool ramses::DcsmMetadataUpdate::hasLayoutAvailability ( ) const

Check if object contains layoutAvailability metadata entry.

Returns: true when has layoutAvailability metadata, false when not

◆ hasPreviewDescription()

bool ramses::DcsmMetadataUpdate::hasPreviewDescription ( ) const

Check if object contains preview description metadata entry.

Returns: true when has preview description metadata, false when not

◆ hasPreviewImagePng()

bool ramses::DcsmMetadataUpdate::hasPreviewImagePng ( ) const

Check if object contains PNG preview image metadata entry.

Returns: true when has preview image metadata, false when not

◆ hasStreamID()

bool ramses::DcsmMetadataUpdate::hasStreamID ( ) const

Check if object contains streamID metadata entry.

Returns: true when has streamID metadata, false when not

◆ hasWidgetBackgroundID()

bool ramses::DcsmMetadataUpdate::hasWidgetBackgroundID ( ) const

Check if object contains widget background id metadata entry.

Returns: true when has widget background id metadata, false when not

◆ hasWidgetHUDLineID()

bool ramses::DcsmMetadataUpdate::hasWidgetHUDLineID ( ) const

Check if object contains widget hud line id metadata entry.

Returns: true when has widget hud line id metadata, false when not

◆ hasWidgetOrder()

bool ramses::DcsmMetadataUpdate::hasWidgetOrder ( ) const

Check if object contains widget order metadata entry.

Returns: true when has widget order metadata, false when not

◆ operator=() [1/2]

DcsmMetadataUpdate& ramses::DcsmMetadataUpdate::operator= ( const DcsmMetadataUpdate & other )

delete

Deleted copy assignment.

Parameters

other unused

Returns: unused

◆ operator=() [2/2]

DcsmMetadataUpdate& ramses::DcsmMetadataUpdate::operator= ( DcsmMetadataUpdate && other )

delete

Deleted move assignment.

Parameters

other unused

Returns: unused

Member Data Documentation

◆ impl

DcsmMetadataUpdateImpl& ramses::DcsmMetadataUpdate::impl

Stores internal data for implementation specifics of DcsmMetadataUpdate

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

/home/runner/work/ramses/ramses/framework/ramses-framework-api/include/ramses-framework-api/DcsmMetadataUpdate.h

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~DcsmMetadataUpdate()

◆ DcsmMetadataUpdate() [1/4]

◆ DcsmMetadataUpdate() [2/4]

◆ DcsmMetadataUpdate() [3/4]

◆ DcsmMetadataUpdate() [4/4]

Member Function Documentation

◆ getCarModel()

◆ getCarModelView()

◆ getCarModelViewAnimationInfo()

◆ getCarModelViewExtended()

◆ getCarModelVisibility()

◆ getConfiguratorPriority()

◆ getContentFlippedVertically()

◆ getDisplayedDataFlags()

◆ getExclusiveBackground()

◆ getLayoutAvailability()

◆ getPreviewDescription()

◆ getPreviewImagePng()

◆ getStreamID()

◆ getWidgetBackgroundID()

◆ getWidgetHUDLineID()

◆ getWidgetOrder()

◆ hasCarModel()

◆ hasCarModelView()

◆ hasCarModelViewExtended()

◆ hasCarModelVisibility()

◆ hasConfiguratorPriority()

◆ hasContentFlippedVertically()

◆ hasDisplayedDataFlags()

◆ hasExclusiveBackground()

◆ hasLayoutAvailability()

◆ hasPreviewDescription()

◆ hasPreviewImagePng()

◆ hasStreamID()

◆ hasWidgetBackgroundID()

◆ hasWidgetHUDLineID()

◆ hasWidgetOrder()

◆ operator=() [1/2]

◆ operator=() [2/2]

Member Data Documentation

◆ impl