#include <VisualCharacteristicsInterface.h>

Public Types
enum	UIMode { UIMode::AUTO, UIMode::HUB, UIMode::TV, UIMode::MOBILE, UIMode::PC, UIMode::HEADLESS }
	Enum defining the UI modes of interaction mode. More...

enum	Unit { Unit::CENTIMETERS, Unit::INCHES }
	Enum class defining the unit for the interaction mode. More...

Static Public Member Functions
static const std::string	uiModeToText (const UIMode uiMode)

static const std::string	unitToText (const Unit unit)

Public Attributes
UIMode	uiMode
	UI mode for this interaction mode. More...

std::string	id
	ID of this interaction mode. More...

Unit	interactionDistanceUnit
	Unit of the interaction distance for this interaction mode. More...

int	interactionDistanceValue
	Value of the interaction distance for this interaction mode. More...

bool	touchSupported
	Touch support. More...

bool	keyboardSupported
	Keyboard support. More...

bool	videoSupported
	Video support. More...

bool	dialogSupported
	Dialog support. More...

Detailed Description

The interaction mode for Alexa.InteractionMode interface. https://developer.amazon.com/en-US/docs/alexa/alexa-voice-service/interaction-mode.html

Member Enumeration Documentation

◆ UIMode

enum alexaClientSDK::visualCharacteristicsInterfaces::InteractionMode::UIMode

strong

Enum defining the UI modes of interaction mode.

Enumerator
AUTO	Auto UI mode.
HUB	Hub UI mode.
TV	Tv UI mode.
MOBILE	Mobile UI mode.
PC	Pc UI mode.
HEADLESS	Headless UI mode.

◆ Unit

enum alexaClientSDK::visualCharacteristicsInterfaces::InteractionMode::Unit

strong

Enum class defining the unit for the interaction mode.

Enumerator
CENTIMETERS	Unit is centimeters.
INCHES	Unit is inches.

Member Function Documentation

◆ uiModeToText()

static const std::string alexaClientSDK::visualCharacteristicsInterfaces::InteractionMode::uiModeToText ( const UIMode uiMode )

inlinestatic

Converts enum to string

Parameters

uiMode UIMode enum value

Returns: Text defining the enum

◆ unitToText()

static const std::string alexaClientSDK::visualCharacteristicsInterfaces::InteractionMode::unitToText ( const Unit unit )

inlinestatic

Converts enum to string

Parameters

unit	Unit enum value

Returns: Text defining the enum

Member Data Documentation

◆ dialogSupported

bool alexaClientSDK::visualCharacteristicsInterfaces::InteractionMode::dialogSupported

Dialog support.

◆ id

std::string alexaClientSDK::visualCharacteristicsInterfaces::InteractionMode::id

ID of this interaction mode.

◆ interactionDistanceUnit

Unit alexaClientSDK::visualCharacteristicsInterfaces::InteractionMode::interactionDistanceUnit

Unit of the interaction distance for this interaction mode.

◆ interactionDistanceValue

int alexaClientSDK::visualCharacteristicsInterfaces::InteractionMode::interactionDistanceValue

Value of the interaction distance for this interaction mode.

◆ keyboardSupported

bool alexaClientSDK::visualCharacteristicsInterfaces::InteractionMode::keyboardSupported

Keyboard support.

◆ touchSupported

bool alexaClientSDK::visualCharacteristicsInterfaces::InteractionMode::touchSupported

Touch support.

◆ uiMode

UIMode alexaClientSDK::visualCharacteristicsInterfaces::InteractionMode::uiMode

UI mode for this interaction mode.

◆ videoSupported

bool alexaClientSDK::visualCharacteristicsInterfaces::InteractionMode::videoSupported

Video support.

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

/workplace/avs-device-sdk/capabilities/VisualCharacteristics/VisualCharacteristicsInterfaces/include/acsdk/VisualCharacteristicsInterfaces/VisualCharacteristicsInterface.h

Public Types

Static Public Member Functions

Public Attributes