Alexa.Display 1.0

The Alexa.Display interface is one of the APIs available for the Alexa Presentation Language (APL). Alexa.Display represents the physical properties of two-dimensional video display devices, such as LCD and LED displays.

Publish your Alexa.Display characteristics to the Alexa cloud upon device startup. The visual characteristics specified by the interface describe the static hardware specifications and physical dimensions of the device, which do not change.

To learn more about APL, its interfaces, and how to use those interfaces together, see Alexa Presentation Language (APL) Overview.

Capability assertion

Alexa.Display 1.0 may be implemented by the device on its own behalf, but not on behalf of any connected endpoints.

New AVS integrations must assert support through Alexa.Discovery, but Alexa will continue to support existing integrations using the Capabilities API.

Sample Declaration

    "type": "AlexaInterface",
    "interface": "Alexa.Display",
    "version": "1.0"

Object syntax

The following code snippet shows the parameters, valid values, and types for the Alexa.Display interface:

    "type": "AlexaInterface",
    "interface": "Alexa.Display",
    "version": "1.0",
    "configurations" : {
        "display" : {
                "type" : "PIXEL",
                "touch" : [ "SINGLE", "UNSUPPORTED" ],
                "shape": [ "RECTANGLE", "ROUND" ],
                "dimensions" : {
                    "resolution": {
                        "unit" : "PIXEL",
                        "value" : {
                            "width": {{INTEGER}},
                            "height": {{INTEGER}},
                    "pixelDensity" : {
                        "unit" : "DPI",
                        "value" : {{INTEGER}}
                    "densityIndependentResolution" : {
                        "unit" : "DP",
                        "value" : {
                            "width" : {{INTEGER}},
                            "height": {{INTEGER}}
                    "physicalSize" : {
                        "unit" : [ "CENTIMETERS" | "INCHES" ],
                        "value" : {
                            "width" : {{DECIMAL}},
                            "height": {{DECIMAL}}

Configuration parameters

The following table lists the parameters, valid values, and types for the Alexa.Display interface. Because these properties are applicable to the physical device display, they only change when the physical display itself is changed, such as connecting a new display. These properties do not change with screen rotation or other dynamic adjustments.

Field Type Required Description
type String Yes Type of display. Valid value is "PIXEL". Represents pixel-based displays, such as televisions, monitors, etc.
touch Array of strings Yes Collection of supported levels for touch input. Valid value is "SINGLE": Touch input through one point of contact. An empty array indicates no touch support for a device.
shape String Yes Shape of the device. Valid values are "RECTANGLE" and "ROUND". For a ROUND device, the dimensions represent the rectangle containing the round shape.
dimensions Object Yes Applicable dimensions of the device.
dimensions.resolution Object For PIXEL type. Resolution of the display.
dimensions.resolution.unit String For PIXEL type. Resolution unit of the display. Valid value is "PIXEL".
dimensions.resolution.value Object For PIXEL type. Resolution value of the display.
dimensions.resolution.value.width Integer For PIXEL type. Width of the display in pixels.
dimensions.resolution.value.height Integer For PIXEL type Height of the display in pixels.
densityIndependentResolution Object For PIXEL type. Screen width and height of the device in DP units as reported by the display.
String For PIXEL type. DP unit of the display. Accepted value is "DP".
Object For PIXEL type. DP size of the display.
Integer For PIXEL type. Width of the display in pixels.
Integer For PIXEL type Height of the display in pixels.
pixelDensity Object For PIXEL type. The dots-per inch (DPI) as reported by the display. DPI should be one of the following values: 120, 160, 213, 240, 320, 480, 640. If the device does not directly map to one of these values, choose the closest value to the reported value.
pixelDensity.unit String For PIXEL type. Pixel density unit for the device. Accepted value is "DPI".
pixelDensity.value Integer For PIXEL type. DPI value of the display.
physicalSize Object Yes Physical size of the display.
physicalSize.unit String Yes Unit of measurement for the resolution of the display. Accepted values are "CENTIMETERS" and "INCHES".
physicalSize.value Object Yes Physical size value of the display.
physicalSize.value.width Float Yes Width of the display defined in expressed units.
physicalSize.value.height Float Yes Height of the display defined in expressed units.

Was this page helpful?

Last updated: Nov 27, 2023