Amazon Developer

as

Settings
Sign out
Notifications
Alexa
Amazon Appstore
Ring
AWS
Documentation
Support
Contact Us
My Cases
Get Started
Design and Develop
Publish
Reference
Support
Native
Skip to main content

Interface IDisplayController

interface IDisplayController
Extends com.amazon.apmf.IStandard This represents the display subsystem. Each client needs only one of this object. This is the top level object that clients should create first before calling any other display APIs.

Methods

getDisplayList()

IDisplay*[] getDisplayList()
Returns a list of displays that the display controller is managing. Client should usually call this after display initialization and inside the listener implementation of IDisplayControllerListener. All displays in this list may not be accessible for this client. getPrimaryDisplay() should be called to retrieve the display which will most likely be used for this client.

Returns

IDisplay*[] Returns a list of displays

Throws

  • DeviceError — if the display subsystem is not in active state
  • OutOfMemoryError — if device doesn’t have enough memory to complete the operation [IDisplayControllerListener#onAddDisplay] [IDisplayControllerListener#onRemoveDisplay]

getPrimaryDisplay()

IDisplay* getPrimaryDisplay()
Returns the display where client windows will most likely be placed on. This is different than getDisplayList() which returns all displays managed by a IDisplayController instance. Primary display depends on the IComponentInfo object passed while creating IDisplayController.

Returns

IDisplay* Return a display

Throws

  • DeviceError — if the display subsystem is not in active state
  • OutOfMemoryError — if device doesn’t have enough memory to complete the operation

getCanvasConfig()

ICanvasConfig* getCanvasConfig()
Returns the canvas config being used by the display subsystem

Returns

ICanvasConfig* Return ICanvasConfig

Throws

  • DeviceError — if the display subsystem is not in active state
  • OutOfMemoryError — if device doesn’t have enough memory to complete the operation [ICanvasConfig]

Last modified on October 29, 2026