AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Types | Static Public Member Functions | Public Attributes | List of all members
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< WindowSizesizes
 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.

Member Enumeration Documentation

◆ WindowType

Enum defining the window types for the template.


Permanent, static window.


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)

Converts enum to string

windowTypeWindowType enum value
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:

AlexaClientSDK 3.0.0 - Copyright 2016-2022, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0