AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Classes | Typedefs | Functions | Variables
alexaClientSDK::visualCharacteristics Namespace Reference

Classes

class  MockPresentationOrchestratorStateObserver
 Mocked PresentationOrchestratorStateObserverInterface. More...
 
class  VCConfigParserTest
 Test harness for VisualCharacteristics class. More...
 
class  VisualCharacteristicsFactory
 
class  VisualCharacteristicsSerializerFactory
 
class  VisualCharacteristicsTest
 Test harness for VisualCharacteristics class. More...
 

Typedefs

using JSONStream = std::vector< std::shared_ptr< std::istream > >
 Alias for JSON stream type used in ConfigurationNode initialization. More...
 

Functions

static ConfigurationNode getConfigurationNode (const std::string &jsonConfig)
 
 TEST_F (VCConfigParserTest, testParseInteractionModes)
 
 TEST_F (VCConfigParserTest, testParseWindowTemplates)
 
 TEST_F (VCConfigParserTest, testParseDisplayCharacteristics)
 
 TEST_F (VCConfigParserTest, testSerializeInteractionModes)
 
 TEST_F (VCConfigParserTest, testSerializeWindowTemplates)
 
 TEST_F (VCConfigParserTest, testSerializeDisplayCharacteristics)
 
static void setConfig ()
 
 TEST_F (VisualCharacteristicsTest, testGetCapabilityConfigurations)
 
 TEST_F (VisualCharacteristicsTest, testVerifyGetConfigurations)
 
 TEST_F (VisualCharacteristicsTest, testAddWindowInstance)
 
 TEST_F (VisualCharacteristicsTest, testUpdateWindowInstance)
 
 TEST_F (VisualCharacteristicsTest, testRemoveWindowInstance)
 
 TEST_F (VisualCharacteristicsTest, testValidateConfigurationUnknownInteractionMode)
 
 TEST_F (VisualCharacteristicsTest, testClearToken)
 

Variables

static const std::string INTERACTION_MODES = "interactionModes"
 
static const std::string TEMPLATES = "templates"
 
static const std::string CONFIG_INTERACTIONMODE
 
static const InteractionMode INTERACTION_MODE_STANDARD
 
static const InteractionMode INTERACTION_MODE_OVERLAY
 
static const std::vector< InteractionModeEXPECTED_INTERACTION_MODES
 
static const std::string CONFIG_WINDOW
 
static const Dimension DIMENSION_FULL_SCREEN = {Dimension::Unit::PIXEL, 1920, 1080}
 
static const WindowSize SIZE_FULL_SCREEN
 
static const std::vector< WindowSizeSIZES_FULL_SCREEN {SIZE_FULL_SCREEN}
 
static const std::vector< std::string > INTERACTION_MODES_FULL_SCREEN {"tv"}
 
static const WindowTemplate TEMPLATE_FULL_SCREEN
 
static const Dimension DIMENSION_OVERLAY = {Dimension::Unit::PIXEL, 1920, 400}
 
static const WindowSize SIZE_LANDSCAPE_PANEL
 
static const std::vector< WindowSizeSIZES_OVERLAY {SIZE_LANDSCAPE_PANEL}
 
static const std::vector< std::string > INTERACTION_MODES_OVERLAY {"tv_overlay"}
 
static const WindowTemplate TEMPLATE_OVERLAY
 
static const std::vector< WindowTemplateEXPECTED_TEMPLATES {TEMPLATE_FULL_SCREEN, TEMPLATE_OVERLAY}
 
static const std::string CONFIG_DISPLAY
 
static const Dimension RESOLUTION = {Dimension::Unit::PIXEL, 1920, 1080}
 
static const Dimension PHYSICAL_SIZE = {Dimension::Unit::INCHES, 56.7, 31.9}
 
static const Dimension DENSITY_INDEPENDENT_RESOLUTION = {Dimension::Unit::DP, 960, 540}
 
static const std::vector< DisplayCharacteristics::TouchTypeTOUCH_TYPES
 
static const DisplayCharacteristics EXPECTED_DISPLAY_CHARACTERISTICS
 
static const std::string INTERACTION_MODE_CONFIG
 Interaction mode configuration json. More...
 
static const std::string WINDOW_CONFIG
 Alexa.Display.Window configuration json. More...
 
static const std::string INVALID_INTERACTION_MODE_WINDOW_CONFIG
 Alexa.Display.Window configuration json which specifies an invalid interaction mode. More...
 
static const std::string DISPLAY_CONFIG
 Alexa.Display configuration json. More...
 
static const std::string SETTINGS_CONFIG
 Dummy configuration for testing VC. More...
 
static const std::string INVALID_WINDOW_INTERACTIONMODE_SETTINGS_CONFIG
 Invalid interactionmode configuration for testing VC. More...
 
static const std::string WINDOW_STATE
 Visual Context for the window states. More...
 
static const std::string WINDOW_STATE_NO_TOKEN
 Visual Context for the window states without a token. More...
 
static const std::string EMPTY_WINDOW_STATE = R"({"defaultWindowId":"tvFullscreen","instances":[]})"
 Empty Visual Context for the window states. More...
 
static const std::string ALEXA_DISPLAY_WINDOW_NAMESPACE {"Alexa.Display.Window"}
 Namespace for sending WindowState context from a device. More...
 
static const std::string WINDOW_STATE_NAME {"WindowState"}
 Tag for finding the device window state context information sent from the runtime as part of event context. More...
 
static const std::string WINDOW_ID {"tvFullscreen"}
 Id of a window instance. More...
 
static const std::string WINDOW_TEMPLATE_ID {"tvFullscreen"}
 Id of a window template used by the window instance. More...
 
static const std::string WINDOW_TEMPLATE_ID_OVERLAY {"tvOverlayLandscape"}
 Id of a window template used by the window instance. More...
 
static const std::string INTERACTION_MODE {"tv"}
 Id of an interaction mode used by a window instance instance. More...
 
static const std::string SIZE_CONFIG_ID {"fullscreen"}
 Id of a size configuration used by a window instance instance. More...
 
static const std::string TOKEN {"token1"}
 Presentation token of currently served by a presentation. More...
 
static const std::string EMPTY_TOKEN {""}
 Empty Presentation token. More...
 
static const std::string DISPLAY_INTERFACE {"Alexa.Presentation.APL"}
 Display interface holding a presentation. More...
 
static const std::string DEFAULT_ENDPOINT {""}
 The endpoint holding this window. More...
 
static const int CAPABILITY_CFG_COUNT = 3
 Count of the capability configuration. More...
 
static const int INTERACTION_MODE_CFG_COUNT = 2
 Count of the number of interaction modes. More...
 
static const int WINDOW_TEMPLATE_CFG_COUNT = 2
 Count of the number of window template. More...
 
static const int STATE_REQUEST_ZERO = 0
 State request #0. More...
 
static const int STATE_REQUEST_ONE = 1
 State request #1. More...
 
static const int STATE_REQUEST_TWO = 2
 State request #2. More...
 
static const avsCommon::avs::NamespaceAndName DEVICE_WINDOW_STATE {ALEXA_DISPLAY_WINDOW_NAMESPACE, WINDOW_STATE_NAME}
 The VisualCharacteristics context state signature. More...
 

Typedef Documentation

◆ JSONStream

using alexaClientSDK::visualCharacteristics::JSONStream = typedef std::vector<std::shared_ptr<std::istream> >

Alias for JSON stream type used in ConfigurationNode initialization.

Function Documentation

◆ getConfigurationNode()

static ConfigurationNode alexaClientSDK::visualCharacteristics::getConfigurationNode ( const std::string &  jsonConfig)
static

◆ setConfig()

static void alexaClientSDK::visualCharacteristics::setConfig ( )
static

◆ TEST_F() [1/13]

alexaClientSDK::visualCharacteristics::TEST_F ( VCConfigParserTest  ,
testParseInteractionModes   
)

Tests parsing logic for Interaction modes.

◆ TEST_F() [2/13]

alexaClientSDK::visualCharacteristics::TEST_F ( VCConfigParserTest  ,
testParseWindowTemplates   
)

Tests parsing logic for Window Templates.

◆ TEST_F() [3/13]

alexaClientSDK::visualCharacteristics::TEST_F ( VCConfigParserTest  ,
testParseDisplayCharacteristics   
)

Tests parsing logic for display characteristics.

◆ TEST_F() [4/13]

alexaClientSDK::visualCharacteristics::TEST_F ( VisualCharacteristicsTest  ,
testGetCapabilityConfigurations   
)

Tests that the VisualCharacteristics capability agent can successfully publish the four APIs in the config file. Verify that other components are able to fetch the configurations.

◆ TEST_F() [5/13]

alexaClientSDK::visualCharacteristics::TEST_F ( VCConfigParserTest  ,
testSerializeInteractionModes   
)

Tests serialize logic for Interaction modes.

◆ TEST_F() [6/13]

alexaClientSDK::visualCharacteristics::TEST_F ( VisualCharacteristicsTest  ,
testVerifyGetConfigurations   
)

Verify that other components will be able to fetch the VC configurations.

◆ TEST_F() [7/13]

alexaClientSDK::visualCharacteristics::TEST_F ( VisualCharacteristicsTest  ,
testAddWindowInstance   
)

Test if the VisualCharacteristics component is able to add window instance and verify the state context.

◆ TEST_F() [8/13]

alexaClientSDK::visualCharacteristics::TEST_F ( VCConfigParserTest  ,
testSerializeWindowTemplates   
)

Tests serialize logic for Window Templates.

◆ TEST_F() [9/13]

alexaClientSDK::visualCharacteristics::TEST_F ( VisualCharacteristicsTest  ,
testUpdateWindowInstance   
)

Test if the VisualCharacteristics component is able to update window instance and verify the state context.

◆ TEST_F() [10/13]

alexaClientSDK::visualCharacteristics::TEST_F ( VCConfigParserTest  ,
testSerializeDisplayCharacteristics   
)

Tests serialize logic for display characteristics.

◆ TEST_F() [11/13]

alexaClientSDK::visualCharacteristics::TEST_F ( VisualCharacteristicsTest  ,
testRemoveWindowInstance   
)

Test if the VisualCharacteristics component is able to remove window instance and verify the state context.

◆ TEST_F() [12/13]

alexaClientSDK::visualCharacteristics::TEST_F ( VisualCharacteristicsTest  ,
testValidateConfigurationUnknownInteractionMode   
)

◆ TEST_F() [13/13]

alexaClientSDK::visualCharacteristics::TEST_F ( VisualCharacteristicsTest  ,
testClearToken   
)

Test if the VisualCharacteristics component clears the token when an empty state is received

Variable Documentation

◆ ALEXA_DISPLAY_WINDOW_NAMESPACE

const std::string alexaClientSDK::visualCharacteristics::ALEXA_DISPLAY_WINDOW_NAMESPACE {"Alexa.Display.Window"}
static

Namespace for sending WindowState context from a device.

◆ CAPABILITY_CFG_COUNT

const int alexaClientSDK::visualCharacteristics::CAPABILITY_CFG_COUNT = 3
static

Count of the capability configuration.

◆ CONFIG_DISPLAY

const std::string alexaClientSDK::visualCharacteristics::CONFIG_DISPLAY
static

◆ CONFIG_INTERACTIONMODE

const std::string alexaClientSDK::visualCharacteristics::CONFIG_INTERACTIONMODE
static
Initial value:
= R"({
"interactionModes": [
{
"id": "tv",
"uiMode": "TV",
"interactionDistance": {
"unit": "INCHES",
"value": 130
},
"touch": "UNSUPPORTED",
"keyboard": "SUPPORTED",
"video": "SUPPORTED",
"dialog": "SUPPORTED"
},
{
"id": "tv_overlay",
"uiMode": "TV",
"interactionDistance": {
"unit": "INCHES",
"value": 130
},
"touch": "UNSUPPORTED",
"keyboard": "SUPPORTED",
"video": "UNSUPPORTED",
"dialog": "SUPPORTED"
}
]
})"

◆ CONFIG_WINDOW

const std::string alexaClientSDK::visualCharacteristics::CONFIG_WINDOW
static

◆ DEFAULT_ENDPOINT

const std::string alexaClientSDK::visualCharacteristics::DEFAULT_ENDPOINT {""}
static

The endpoint holding this window.

◆ DENSITY_INDEPENDENT_RESOLUTION

const Dimension alexaClientSDK::visualCharacteristics::DENSITY_INDEPENDENT_RESOLUTION = {Dimension::Unit::DP, 960, 540}
static

◆ DEVICE_WINDOW_STATE

const avsCommon::avs::NamespaceAndName alexaClientSDK::visualCharacteristics::DEVICE_WINDOW_STATE {ALEXA_DISPLAY_WINDOW_NAMESPACE, WINDOW_STATE_NAME}
static

The VisualCharacteristics context state signature.

◆ DIMENSION_FULL_SCREEN

const Dimension alexaClientSDK::visualCharacteristics::DIMENSION_FULL_SCREEN = {Dimension::Unit::PIXEL, 1920, 1080}
static

Expected objects on parsing CONFIG_WINDOW specified above

◆ DIMENSION_OVERLAY

const Dimension alexaClientSDK::visualCharacteristics::DIMENSION_OVERLAY = {Dimension::Unit::PIXEL, 1920, 400}
static

◆ DISPLAY_CONFIG

const std::string alexaClientSDK::visualCharacteristics::DISPLAY_CONFIG
static
Initial value:
= R"({
"type": "AlexaInterface",
"interface": "Alexa.Display",
"version": "1.0",
"configurations": {
"display": {
"type": "PIXEL",
"touch": ["UNSUPPORTED"],
"shape": "RECTANGLE",
"dimensions": {
"resolution": {
"unit": "PIXEL",
"value": { "width": 1920, "height": 1080 }
},
"physicalSize": {
"unit": "INCHES",
"value": { "width": 56.7, "height": 31.9 }
},
"pixelDensity": { "unit": "DPI", "value": 320 },
"densityIndependentResolution": {
"unit": "DP",
"value": { "width": 960, "height": 540 }
}
}
}
}
})"

Alexa.Display configuration json.

◆ DISPLAY_INTERFACE

const std::string alexaClientSDK::visualCharacteristics::DISPLAY_INTERFACE {"Alexa.Presentation.APL"}
static

Display interface holding a presentation.

◆ EMPTY_TOKEN

const std::string alexaClientSDK::visualCharacteristics::EMPTY_TOKEN {""}
static

Empty Presentation token.

◆ EMPTY_WINDOW_STATE

const std::string alexaClientSDK::visualCharacteristics::EMPTY_WINDOW_STATE = R"({"defaultWindowId":"tvFullscreen","instances":[]})"
static

Empty Visual Context for the window states.

◆ EXPECTED_DISPLAY_CHARACTERISTICS

const DisplayCharacteristics alexaClientSDK::visualCharacteristics::EXPECTED_DISPLAY_CHARACTERISTICS
static
Initial value:
= {DisplayCharacteristics::Type::PIXEL,
DisplayCharacteristics::Shape::RECTANGLE,
320,
static const Dimension PHYSICAL_SIZE
Definition: VCConfigParserTest.cpp:195
static const Dimension DENSITY_INDEPENDENT_RESOLUTION
Definition: VCConfigParserTest.cpp:196
static const std::vector< DisplayCharacteristics::TouchType > TOUCH_TYPES
Definition: VCConfigParserTest.cpp:197
static const Dimension RESOLUTION
Definition: VCConfigParserTest.cpp:194

◆ EXPECTED_INTERACTION_MODES

const std::vector<InteractionMode> alexaClientSDK::visualCharacteristics::EXPECTED_INTERACTION_MODES
static
Initial value:
static const InteractionMode INTERACTION_MODE_OVERLAY
Definition: VCConfigParserTest.cpp:71
static const InteractionMode INTERACTION_MODE_STANDARD
Definition: VCConfigParserTest.cpp:69

◆ EXPECTED_TEMPLATES

const std::vector<WindowTemplate> alexaClientSDK::visualCharacteristics::EXPECTED_TEMPLATES {TEMPLATE_FULL_SCREEN, TEMPLATE_OVERLAY}
static

◆ INTERACTION_MODE

const std::string alexaClientSDK::visualCharacteristics::INTERACTION_MODE {"tv"}
static

Id of an interaction mode used by a window instance instance.

◆ INTERACTION_MODE_CFG_COUNT

const int alexaClientSDK::visualCharacteristics::INTERACTION_MODE_CFG_COUNT = 2
static

Count of the number of interaction modes.

◆ INTERACTION_MODE_CONFIG

const std::string alexaClientSDK::visualCharacteristics::INTERACTION_MODE_CONFIG
static
Initial value:
= R"({
"type": "AlexaInterface",
"interface": "Alexa.InteractionMode",
"version": "1.1",
"configurations": {
"interactionModes": [
{
"id": "tv",
"uiMode": "TV",
"interactionDistance": { "unit": "INCHES", "value": 130 },
"touch": "UNSUPPORTED",
"keyboard": "SUPPORTED",
"video": "SUPPORTED",
"dialog": "SUPPORTED"
},
{
"id": "tv_overlay",
"uiMode": "TV",
"interactionDistance": { "unit": "INCHES", "value": 130 },
"touch": "UNSUPPORTED",
"keyboard": "SUPPORTED",
"video": "UNSUPPORTED",
"dialog": "SUPPORTED"
}
]
}
})"

Interaction mode configuration json.

◆ INTERACTION_MODE_OVERLAY

const InteractionMode alexaClientSDK::visualCharacteristics::INTERACTION_MODE_OVERLAY
static
Initial value:
=
{InteractionMode::UIMode::TV, "tv_overlay", InteractionMode::Unit::INCHES, 130, false, true, false, true}

◆ INTERACTION_MODE_STANDARD

const InteractionMode alexaClientSDK::visualCharacteristics::INTERACTION_MODE_STANDARD
static
Initial value:
=
{InteractionMode::UIMode::TV, "tv", InteractionMode::Unit::INCHES, 130, false, true, true, true}

Expected objects on parsing CONFIG_INTERACTIONMODE specified above

◆ INTERACTION_MODES

const std::string alexaClientSDK::visualCharacteristics::INTERACTION_MODES = "interactionModes"
static

◆ INTERACTION_MODES_FULL_SCREEN

const std::vector<std::string> alexaClientSDK::visualCharacteristics::INTERACTION_MODES_FULL_SCREEN {"tv"}
static

◆ INTERACTION_MODES_OVERLAY

const std::vector<std::string> alexaClientSDK::visualCharacteristics::INTERACTION_MODES_OVERLAY {"tv_overlay"}
static

◆ INVALID_INTERACTION_MODE_WINDOW_CONFIG

const std::string alexaClientSDK::visualCharacteristics::INVALID_INTERACTION_MODE_WINDOW_CONFIG
static
Initial value:
= R"({
"type": "AlexaInterface",
"interface": "Alexa.Display.Window",
"version": "1.0",
"configurations": {
"templates": [
{
"id": "tvFullscreen",
"type": "STANDARD",
"configuration": {
"sizes": [
{
"type": "DISCRETE",
"id": "fullscreen",
"value": {
"unit": "PIXEL",
"value": { "width": 1920, "height": 1080 }
}
}
],
"interactionModes": ["potato", "tv"]
}
}
]
}
})"

Alexa.Display.Window configuration json which specifies an invalid interaction mode.

◆ INVALID_WINDOW_INTERACTIONMODE_SETTINGS_CONFIG

const std::string alexaClientSDK::visualCharacteristics::INVALID_WINDOW_INTERACTIONMODE_SETTINGS_CONFIG
static
Initial value:
= R"({
"visualCharacteristics": [)" + INTERACTION_MODE_CONFIG + "," + INVALID_INTERACTION_MODE_WINDOW_CONFIG +
"," + DISPLAY_CONFIG + R"(]
})"
static const std::string DISPLAY_CONFIG
Alexa.Display configuration json.
Definition: VisualCharacteristicsTest.cpp:149
static const std::string INTERACTION_MODE_CONFIG
Interaction mode configuration json.
Definition: VisualCharacteristicsTest.cpp:47
static const std::string INVALID_INTERACTION_MODE_WINDOW_CONFIG
Alexa.Display.Window configuration json which specifies an invalid interaction mode.
Definition: VisualCharacteristicsTest.cpp:121

Invalid interactionmode configuration for testing VC.

◆ PHYSICAL_SIZE

const Dimension alexaClientSDK::visualCharacteristics::PHYSICAL_SIZE = {Dimension::Unit::INCHES, 56.7, 31.9}
static

◆ RESOLUTION

const Dimension alexaClientSDK::visualCharacteristics::RESOLUTION = {Dimension::Unit::PIXEL, 1920, 1080}
static

Expected objects on parsing CONFIG_DISPLAY specified above

◆ SETTINGS_CONFIG

const std::string alexaClientSDK::visualCharacteristics::SETTINGS_CONFIG
static
Initial value:
= R"({
"visualCharacteristics": [)" + INTERACTION_MODE_CONFIG +
"," + WINDOW_CONFIG + "," + DISPLAY_CONFIG + R"(]
})"
static const std::string DISPLAY_CONFIG
Alexa.Display configuration json.
Definition: VisualCharacteristicsTest.cpp:149
static const std::string INTERACTION_MODE_CONFIG
Interaction mode configuration json.
Definition: VisualCharacteristicsTest.cpp:47
static const std::string WINDOW_CONFIG
Alexa.Display.Window configuration json.
Definition: VisualCharacteristicsTest.cpp:76

Dummy configuration for testing VC.

◆ SIZE_CONFIG_ID

const std::string alexaClientSDK::visualCharacteristics::SIZE_CONFIG_ID {"fullscreen"}
static

Id of a size configuration used by a window instance instance.

◆ SIZE_FULL_SCREEN

const WindowSize alexaClientSDK::visualCharacteristics::SIZE_FULL_SCREEN
static
Initial value:
= {"fullscreen",
WindowSize::WindowSizeType::DISCRETE,
DIMENSION_FULL_SCREEN}
static const Dimension DIMENSION_FULL_SCREEN
Definition: VCConfigParserTest.cpp:128

◆ SIZE_LANDSCAPE_PANEL

const WindowSize alexaClientSDK::visualCharacteristics::SIZE_LANDSCAPE_PANEL
static
Initial value:
= {"landscapePanel",
WindowSize::WindowSizeType::DISCRETE,
DIMENSION_OVERLAY}
static const Dimension DIMENSION_OVERLAY
Definition: VCConfigParserTest.cpp:140

◆ SIZES_FULL_SCREEN

const std::vector<WindowSize> alexaClientSDK::visualCharacteristics::SIZES_FULL_SCREEN {SIZE_FULL_SCREEN}
static

◆ SIZES_OVERLAY

const std::vector<WindowSize> alexaClientSDK::visualCharacteristics::SIZES_OVERLAY {SIZE_LANDSCAPE_PANEL}
static

◆ STATE_REQUEST_ONE

const int alexaClientSDK::visualCharacteristics::STATE_REQUEST_ONE = 1
static

State request #1.

◆ STATE_REQUEST_TWO

const int alexaClientSDK::visualCharacteristics::STATE_REQUEST_TWO = 2
static

State request #2.

◆ STATE_REQUEST_ZERO

const int alexaClientSDK::visualCharacteristics::STATE_REQUEST_ZERO = 0
static

State request #0.

◆ TEMPLATE_FULL_SCREEN

const WindowTemplate alexaClientSDK::visualCharacteristics::TEMPLATE_FULL_SCREEN
static
Initial value:
= {"tvFullscreen",
WindowTemplate::WindowType::STANDARD,
static const std::vector< std::string > INTERACTION_MODES_FULL_SCREEN
Definition: VCConfigParserTest.cpp:134
static const std::vector< WindowSize > SIZES_FULL_SCREEN
Definition: VCConfigParserTest.cpp:133

◆ TEMPLATE_OVERLAY

const WindowTemplate alexaClientSDK::visualCharacteristics::TEMPLATE_OVERLAY
static
Initial value:
= {"tvOverlayLandscape",
WindowTemplate::WindowType::OVERLAY,
static const std::vector< std::string > INTERACTION_MODES_OVERLAY
Definition: VCConfigParserTest.cpp:146
static const std::vector< WindowSize > SIZES_OVERLAY
Definition: VCConfigParserTest.cpp:145

◆ TEMPLATES

const std::string alexaClientSDK::visualCharacteristics::TEMPLATES = "templates"
static

◆ TOKEN

const std::string alexaClientSDK::visualCharacteristics::TOKEN {"token1"}
static

Presentation token of currently served by a presentation.

◆ TOUCH_TYPES

const std::vector<DisplayCharacteristics::TouchType> alexaClientSDK::visualCharacteristics::TOUCH_TYPES
static
Initial value:
{DisplayCharacteristics::TouchType::SINGLE,
DisplayCharacteristics::TouchType::UNSUPPORTED}

◆ WINDOW_CONFIG

const std::string alexaClientSDK::visualCharacteristics::WINDOW_CONFIG
static

Alexa.Display.Window configuration json.

◆ WINDOW_ID

const std::string alexaClientSDK::visualCharacteristics::WINDOW_ID {"tvFullscreen"}
static

Id of a window instance.

◆ WINDOW_STATE

const std::string alexaClientSDK::visualCharacteristics::WINDOW_STATE
static
Initial value:
=
R"({"defaultWindowId":"tvFullscreen","instances":[{"id":"tvFullscreen","templateId":"tvFullscreen","token":"token1","configuration":{"interactionMode":"tv","sizeConfigurationId":"fullscreen"}}]})"

Visual Context for the window states.

◆ WINDOW_STATE_NAME

const std::string alexaClientSDK::visualCharacteristics::WINDOW_STATE_NAME {"WindowState"}
static

Tag for finding the device window state context information sent from the runtime as part of event context.

◆ WINDOW_STATE_NO_TOKEN

const std::string alexaClientSDK::visualCharacteristics::WINDOW_STATE_NO_TOKEN
static
Initial value:
=
R"({"defaultWindowId":"tvFullscreen","instances":[{"id":"tvFullscreen","templateId":"tvFullscreen","token":"","configuration":{"interactionMode":"tv","sizeConfigurationId":"fullscreen"}}]})"

Visual Context for the window states without a token.

◆ WINDOW_TEMPLATE_CFG_COUNT

const int alexaClientSDK::visualCharacteristics::WINDOW_TEMPLATE_CFG_COUNT = 2
static

Count of the number of window template.

◆ WINDOW_TEMPLATE_ID

const std::string alexaClientSDK::visualCharacteristics::WINDOW_TEMPLATE_ID {"tvFullscreen"}
static

Id of a window template used by the window instance.

◆ WINDOW_TEMPLATE_ID_OVERLAY

const std::string alexaClientSDK::visualCharacteristics::WINDOW_TEMPLATE_ID_OVERLAY {"tvOverlayLandscape"}
static

Id of a window template used by the window instance.

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