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::DisplayCharacteristics Struct Reference

#include <VisualCharacteristicsInterface.h>

Collaboration diagram for alexaClientSDK::visualCharacteristicsInterfaces::DisplayCharacteristics:
Collaboration graph
[legend]

Public Types

enum  Type { PIXEL }
 Enum defining the type of the Display. More...
 
enum  TouchType { SINGLE, UNSUPPORTED }
 Enum defining the touch type supported by display. More...
 
enum  Shape { RECTANGLE, ROUND }
 Enum defining the shape of the display. More...
 

Static Public Member Functions

static const std::string typeToText (const Type type)
 
static const std::string touchTypeToText (const TouchType touchType)
 
static const std::string shapeToText (const Shape shape)
 

Public Attributes

Type type
 Type of the display. More...
 
std::vector< TouchTypetouch
 Touch types supported by the display. More...
 
Shape shape
 Shape of the display. More...
 
int pixelDensity
 The pixel density, unit is DPI. More...
 
Dimension resolution
 The display resolution, unit must be PIXEL. More...
 
Dimension densityIndependentResolution
 The density independent resolution, unit must be DP. More...
 
Dimension physicalSize
 The physical size of the display, unit must be CENTIMETERS or INCHES. More...
 

Detailed Description

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

Member Enumeration Documentation

◆ Shape

Enum defining the shape of the display.

Enumerator
RECTANGLE 

Rectangle shape.

ROUND 

Round shape.

◆ TouchType

Enum defining the touch type supported by display.

Enumerator
SINGLE 

Single display type.

UNSUPPORTED 

Unsupported display type.

◆ Type

Enum defining the type of the Display.

Enumerator
PIXEL 

Pixel display type.

Member Function Documentation

◆ shapeToText()

static const std::string alexaClientSDK::visualCharacteristicsInterfaces::DisplayCharacteristics::shapeToText ( const Shape  shape)
inlinestatic

Converts enum to string

Parameters
shapeDisplay shape enum value
Returns
Text defining the enum

◆ touchTypeToText()

static const std::string alexaClientSDK::visualCharacteristicsInterfaces::DisplayCharacteristics::touchTypeToText ( const TouchType  touchType)
inlinestatic

Converts enum to string

Parameters
touchTypeDisplay touch type enum value
Returns
Text defining the enum

◆ typeToText()

static const std::string alexaClientSDK::visualCharacteristicsInterfaces::DisplayCharacteristics::typeToText ( const Type  type)
inlinestatic

Converts enum to string

Parameters
typeDisplay type enum value
Returns
Text defining the enum

Member Data Documentation

◆ densityIndependentResolution

Dimension alexaClientSDK::visualCharacteristicsInterfaces::DisplayCharacteristics::densityIndependentResolution

The density independent resolution, unit must be DP.

◆ physicalSize

Dimension alexaClientSDK::visualCharacteristicsInterfaces::DisplayCharacteristics::physicalSize

The physical size of the display, unit must be CENTIMETERS or INCHES.

◆ pixelDensity

int alexaClientSDK::visualCharacteristicsInterfaces::DisplayCharacteristics::pixelDensity

The pixel density, unit is DPI.

◆ resolution

Dimension alexaClientSDK::visualCharacteristicsInterfaces::DisplayCharacteristics::resolution

The display resolution, unit must be PIXEL.

◆ shape

Shape alexaClientSDK::visualCharacteristicsInterfaces::DisplayCharacteristics::shape

Shape of the display.

◆ touch

std::vector<TouchType> alexaClientSDK::visualCharacteristicsInterfaces::DisplayCharacteristics::touch

Touch types supported by the display.

◆ type

Type alexaClientSDK::visualCharacteristicsInterfaces::DisplayCharacteristics::type

Type of the display.


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

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