DisplayManager

DisplayManager provides APIs to change the display configuration/settings. Clients require the application privilege "com.amazon.graphics.privilege.display.manager" to invoke APIs of this class.

Constructors

new DisplayManager()

new DisplayManager(): DisplayManager

Returns

DisplayManager

Methods

addListener()

static addListener(listener: IDisplayManagerListener): ISubscription

Adds display manager listener object to receive callbacks when display manager properties change. It returns a object, which is used to unsubscribe the listener from receiving events through .

Parameters

listener

IDisplayManagerListener

IDisplayManagerListener interface ISubscription object related to this listener

Returns

ISubscription

---

commitStates()

static commitStates(): number

Request the display manager to commit all pending states. Please note, this function has to be called for any changes to be applied. This API will only update the pending states and it will actually try to apply all the pending states change requests made since last commitStates() call. The benefit of having a single commit call is that fact that clients can apply multiple dependent states together on display hardware. Client can know the result of the commit request through . This API requires the client to have "com.amazon.graphics.privilege.display.manager" application privilege. commit id which can be used to track the commit status.

Returns

number

---

enableAutoConfigSwitch()

static enableAutoConfigSwitch(enable: boolean): void

Request the display to switch to a new config automatically. In this mode, display server selects the most appropriate config dynamically based on various factors. IDisplayListener.onConfigChange will still be called upon a successful config switch. Please note, calling enableAutoConfigSwitch(true) would override previous requestConfigChange() call. The default state is "true". This API requires the client to have "com.amazon.graphics.privilege.display.manager" application privilege.

Parameters

enable

boolean

If true, display subsystem would choose appropriate config automatically.

---

requestConfigChange()

static requestConfigChange(displayConfig: IDisplayConfig, refreshRateInMillihertz: Int32): void

Request the display to switch to a new config. will be called upon successful completion. This API requires the client to have "com.amazon.graphics.privilege.display.manager" application privilege.

Parameters

displayConfig

IDisplayConfig

The new requested display config.

refreshRateInMillihertz

Int32

---

setAisrState()

static setAisrState(aisrState: AisrState): void

Set the system-level AISR state for this display. The change is applied immediately and persisted across reboots. This does NOT require . This API requires the client to have "com.amazon.graphics.privilege.display.manager" application privilege.

Parameters

aisrState

AisrState

---

setColorDepth()

static setColorDepth(colorDepth: ColorDepth): void

Request Display Server to switch to a certain color depth. This API requires the client to have "com.amazon.graphics.privilege.display.manager" application privilege.

Parameters

colorDepth

ColorDepth

Requested new color depth.

---

setColorSpace()

static setColorSpace(colorSpace: ColorSpace): void

Requests Display Server to switch to the supplied color space e.g. RGB or YUV etc. This API requires the client to have "com.amazon.graphics.privilege.display.manager" application privilege.

Parameters

colorSpace

ColorSpace

Requested new color space.

---

setHdrMode()

static setHdrMode(hdrMode: HdrMode): void

Enable or disable HDR mode. This API requires the client to have "com.amazon.graphics.privilege.display.manager" application privilege.

Parameters

hdrMode

HdrMode

---

setLowLatencyModeState()

static setLowLatencyModeState(llmState: LlmState): void

Enable or disable Low latency mode. This API requires the client to have "com.amazon.graphics.privilege.display.manager" application privilege.

Parameters

llmState

LlmState

---

setMultipleRefreshRateState()

static setMultipleRefreshRateState(mrrState: boolean): void

Set the MRR state of the display. MRR is a feature which allows clients to request alternate refresh rate which might be more appropriate for their content. This is a global MRR state for a display and controls if applications can request display server to switch to one of the other supported refresh rates which closely matches original content frame rate. This API requires the client to have "com.amazon.graphics.privilege.display.manager" application privilege.

Parameters

mrrState

boolean

---

setOverscanBorder()

static setOverscanBorder(leftBorderAsPercentageOfWidth: Double, topBorderAsPercentageOfHeight: Double, rightBorderAsPercentageOfWidth: Double, bottomBorderAsPercentageOfHeight: Double): void

Requests display server to adjust the visible area of the display to ensure content is not lost beyond the screen's physical borders. The API takes the widths of the four borders or margins as a percentage of width or height. This API requires the client to have "com.amazon.graphics.privilege.display.manager" application privilege.

Parameters

leftBorderAsPercentageOfWidth

Double

topBorderAsPercentageOfHeight

Double

The top border as percentage of height.

rightBorderAsPercentageOfWidth

Double

The right border as percentage of width.

bottomBorderAsPercentageOfHeight

Double

The bottom border as percentage of height.

---

Last updated: Jul 22, 2026