![]()  | 
  
    AlexaClientSDK
    3.0.0
    
   A cross-platform, modular SDK for interacting with the Alexa Voice Service 
   | 
 
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< InteractionMode > | EXPECTED_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< WindowSize > | SIZES_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< WindowSize > | SIZES_OVERLAY {SIZE_LANDSCAPE_PANEL} | 
| static const std::vector< std::string > | INTERACTION_MODES_OVERLAY {"tv_overlay"} | 
| static const WindowTemplate | TEMPLATE_OVERLAY | 
| static const std::vector< WindowTemplate > | EXPECTED_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::TouchType > | TOUCH_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... | |
| using alexaClientSDK::visualCharacteristics::JSONStream = typedef std::vector<std::shared_ptr<std::istream> > | 
Alias for JSON stream type used in ConfigurationNode initialization. 
      
  | 
  static | 
      
  | 
  static | 
| alexaClientSDK::visualCharacteristics::TEST_F | ( | VCConfigParserTest | , | 
| testParseInteractionModes | |||
| ) | 
Tests parsing logic for Interaction modes.
| alexaClientSDK::visualCharacteristics::TEST_F | ( | VCConfigParserTest | , | 
| testParseWindowTemplates | |||
| ) | 
Tests parsing logic for Window Templates.
| alexaClientSDK::visualCharacteristics::TEST_F | ( | VCConfigParserTest | , | 
| testParseDisplayCharacteristics | |||
| ) | 
Tests parsing logic for display characteristics.
| 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.
| alexaClientSDK::visualCharacteristics::TEST_F | ( | VCConfigParserTest | , | 
| testSerializeInteractionModes | |||
| ) | 
Tests serialize logic for Interaction modes.
| alexaClientSDK::visualCharacteristics::TEST_F | ( | VisualCharacteristicsTest | , | 
| testVerifyGetConfigurations | |||
| ) | 
Verify that other components will be able to fetch the VC configurations.
| alexaClientSDK::visualCharacteristics::TEST_F | ( | VisualCharacteristicsTest | , | 
| testAddWindowInstance | |||
| ) | 
Test if the VisualCharacteristics component is able to add window instance and verify the state context.
| alexaClientSDK::visualCharacteristics::TEST_F | ( | VCConfigParserTest | , | 
| testSerializeWindowTemplates | |||
| ) | 
Tests serialize logic for Window Templates.
| alexaClientSDK::visualCharacteristics::TEST_F | ( | VisualCharacteristicsTest | , | 
| testUpdateWindowInstance | |||
| ) | 
Test if the VisualCharacteristics component is able to update window instance and verify the state context.
| alexaClientSDK::visualCharacteristics::TEST_F | ( | VCConfigParserTest | , | 
| testSerializeDisplayCharacteristics | |||
| ) | 
Tests serialize logic for display characteristics.
| alexaClientSDK::visualCharacteristics::TEST_F | ( | VisualCharacteristicsTest | , | 
| testRemoveWindowInstance | |||
| ) | 
Test if the VisualCharacteristics component is able to remove window instance and verify the state context.
| alexaClientSDK::visualCharacteristics::TEST_F | ( | VisualCharacteristicsTest | , | 
| testValidateConfigurationUnknownInteractionMode | |||
| ) | 
| alexaClientSDK::visualCharacteristics::TEST_F | ( | VisualCharacteristicsTest | , | 
| testClearToken | |||
| ) | 
Test if the VisualCharacteristics component clears the token when an empty state is received
      
  | 
  static | 
Namespace for sending WindowState context from a device.
      
  | 
  static | 
Count of the capability configuration.
      
  | 
  static | 
      
  | 
  static | 
      
  | 
  static | 
      
  | 
  static | 
The endpoint holding this window.
      
  | 
  static | 
      
  | 
  static | 
The VisualCharacteristics context state signature.
      
  | 
  static | 
Expected objects on parsing CONFIG_WINDOW specified above
      
  | 
  static | 
      
  | 
  static | 
Alexa.Display configuration json.
      
  | 
  static | 
Display interface holding a presentation.
      
  | 
  static | 
Empty Presentation token.
      
  | 
  static | 
Empty Visual Context for the window states.
      
  | 
  static | 
      
  | 
  static | 
      
  | 
  static | 
      
  | 
  static | 
Id of an interaction mode used by a window instance instance.
      
  | 
  static | 
Count of the number of interaction modes.
      
  | 
  static | 
Interaction mode configuration json.
      
  | 
  static | 
      
  | 
  static | 
Expected objects on parsing CONFIG_INTERACTIONMODE specified above
      
  | 
  static | 
      
  | 
  static | 
      
  | 
  static | 
      
  | 
  static | 
Alexa.Display.Window configuration json which specifies an invalid interaction mode.
      
  | 
  static | 
Invalid interactionmode configuration for testing VC.
      
  | 
  static | 
      
  | 
  static | 
Expected objects on parsing CONFIG_DISPLAY specified above
      
  | 
  static | 
Dummy configuration for testing VC.
      
  | 
  static | 
Id of a size configuration used by a window instance instance.
      
  | 
  static | 
      
  | 
  static | 
      
  | 
  static | 
      
  | 
  static | 
      
  | 
  static | 
State request #1.
      
  | 
  static | 
State request #2.
      
  | 
  static | 
State request #0.
      
  | 
  static | 
      
  | 
  static | 
      
  | 
  static | 
      
  | 
  static | 
Presentation token of currently served by a presentation.
      
  | 
  static | 
      
  | 
  static | 
Alexa.Display.Window configuration json.
      
  | 
  static | 
Id of a window instance.
      
  | 
  static | 
Visual Context for the window states.
      
  | 
  static | 
Tag for finding the device window state context information sent from the runtime as part of event context.
      
  | 
  static | 
Visual Context for the window states without a token.
      
  | 
  static | 
Count of the number of window template.
      
  | 
  static | 
Id of a window template used by the window instance.
      
  | 
  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