Constructors
new DisplayManager()
new DisplayManager():DisplayManager
Returns
DisplayManager
Methods
addListener()
static addListener(listener): ISubscription
Adds display manager listener object IDisplayManagerListener to receive
callbacks when display manager properties change.
It returns a ISubscription object, which is used to unsubscribe the listener
from receiving events through ().
Parameters
listener
IDisplayManagerListener
IDisplayManagerListener interface
Returns
ISubscription
ISubscription object related to this listener
See
DisplayManagerListenerSubscriptioncommitStates()
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 IDisplayManagerListener.
This API requires the client to have “com.amazon.graphics.privilege.display.manager” application privilege.
Returns
number
commit id which can be used to track the commit status.
enableAutoConfigSwitch()
static enableAutoConfigSwitch(enable): 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.
Returns
void
requestConfigChange()
static requestConfigChange(displayConfig, refreshRateInMillihertz): void
Request the display to switch to a new config.
IDisplayListener.onConfigChange 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
number
Returns
void
setColorDepth()
static setColorDepth(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.
Returns
void
setColorSpace()
static setColorSpace(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.
Returns
void
setHdrMode()
static setHdrMode(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
Returns
void
setLowLatencyModeState()
static setLowLatencyModeState(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
Returns
void
setMultipleRefreshRateState()
static setMultipleRefreshRateState(mrrState): 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
Returns
void
setOverscanBorder()
static setOverscanBorder(leftBorderAsPercentageOfWidth, topBorderAsPercentageOfHeight, rightBorderAsPercentageOfWidth, bottomBorderAsPercentageOfHeight): 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
number
topBorderAsPercentageOfHeight
number
The top border as percentage of
height.
rightBorderAsPercentageOfWidth
number
The right border as percentage of
width.
bottomBorderAsPercentageOfHeight
number
The bottom border as percentage of
height.
Returns
void
