alexaClientSDK::visualCharacteristicsInterfaces::WindowTemplate Struct Reference

#include <VisualCharacteristicsInterface.h>

Public Types
enum	WindowType { WindowType::STANDARD, WindowType::OVERLAY }
	Enum defining the window types for the template. More...

Static Public Member Functions
static const std::string	windowTypeToText (const WindowType windowType)

Public Attributes
std::string	id
	Window template id. More...
WindowType	type
	Type of of the window template. More...
std::vector< WindowSize >	sizes
	Sizes supported by this window template. More...
std::vector< std::string >	interactionModes
	Interaction mode supported by this window template. More...

Detailed Description

The window template for Alexa.Display.Window interface. https://developer.amazon.com/en-US/docs/alexa/alexa-voice-service/display-window.html

Member Enumeration Documentation

WindowType

enum alexaClientSDK::visualCharacteristicsInterfaces::WindowTemplate::WindowType

strong

Enum defining the window types for the template.

Enumerator
STANDARD	Permanent, static window.
OVERLAY	Temporary window that might share the screen with other experiences. Overlay windows could be transparent.

Member Function Documentation

windowTypeToText()

static const std::string alexaClientSDK::visualCharacteristicsInterfaces::WindowTemplate::windowTypeToText ( const WindowType  windowType )

inlinestatic

Converts enum to string

Parameters

windowType

WindowType enum value

Returns

Text defining the enum

Member Data Documentation

id

std::string alexaClientSDK::visualCharacteristicsInterfaces::WindowTemplate::id

Window template id.

interactionModes

std::vector<std::string> alexaClientSDK::visualCharacteristicsInterfaces::WindowTemplate::interactionModes

Interaction mode supported by this window template.

sizes

std::vector<WindowSize> alexaClientSDK::visualCharacteristicsInterfaces::WindowTemplate::sizes

Sizes supported by this window template.

type

WindowType alexaClientSDK::visualCharacteristicsInterfaces::WindowTemplate::type

Type of of the window template.

---

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

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