Display

Class that retrieves properties of the primary display. Note only primary display is supported by this turbomodule.

​

Constructors

​

new Display()

new Display(): Display

​

Returns

Display

​

Methods

​

addDisplayListener()

static addDisplayListener(listener): ISubscription Adds display listener object IDisplayListener to receive callbacks when display properties change. It returns a ISubscription object, which is used to unsubscribe the listener from receiving events through ().

​

Parameters

listener

IDisplayListener IDisplayListener interface

​

Returns

ISubscription ISubscription object related to this listener

​

See

DisplayListenerSubscription

---

​

addDisplayListener2()

static addDisplayListener2(listener): ISubscription Adds display listener object IDisplayListener to receive callbacks when display properties change. It returns a ISubscription object, which is used to unsubscribe the listener from receiving events through ().

​

Parameters

listener

IDisplayListener IDisplayListener interface

​

Returns

ISubscription ISubscription object related to this listener

​

See

DisplayListenerSubscription

---

​

getAllowedColorDepths()

static getAllowedColorDepths(colorSpace): ColorDepth[] Query for allowed color depths for given color space, which are obtained based on the connected display/TV capabilities and the device capabilities. If the resolution, the refresh rate or the HDR setting changes then clients are expected to query this API again to get updated allowed color depth.

​

Parameters

colorSpace

ColorSpace the color space for which allowed color depths are queried.

​

Returns

ColorDepth[] An array of ColorDepth values available for the specified color space DisplayManager.setColorDepth()

---

​

getAllowedColorSpaces()

static getAllowedColorSpaces(): ColorSpace[] Query for allowed color spaces which are obtained based on the connected display/TV capabilities and the device capabilities. If the resolution, the refresh rate or the HDR setting changes then clients are expected to query this API again to get updated allowed color spaces.

​

Returns

ColorSpace[] An array of ColorSpace values representing the allowed color spaces DisplayManager.setColorSpace()

---

​

getAllSupportedConfigs()

static getAllSupportedConfigs(): IDisplayConfig[] Query the list of all supported configs for this display.

​

Returns

IDisplayConfig[] Returns list of all supported configs for this display.

---

​

getColorDepth()

static getColorDepth(): ColorDepth Get current color depth.

​

Returns

ColorDepth color depth.

---

​

getColorSpace()

static getColorSpace(): ColorSpace Get current color space.

​

Returns

ColorSpace color space.

---

​

getCurrentConfig()

static getCurrentConfig(): IDisplayConfig Query the current config for this display.

​

Returns

IDisplayConfig Returns current config

​

See

IDisplayConfig

---

​

getCurrentHdcpLevel()

static getCurrentHdcpLevel(): HdcpLevel Query the current HDCP (High-bandwidth Digital Content Protection) level for this display.

​

Returns

HdcpLevel Returns current HDCP level for this display

​

See

HdcpLevel

---

​

getCurrentRefreshRateInMillihertz()

static getCurrentRefreshRateInMillihertz(): number Query the current vertical refresh rate in mHz (millihertz) for this display

​

Returns

number Returns current refresh rate for this display in mHz. If the current refresh rate changes, IDisplayListener.onRefreshRateChange will be called.

---

​

getHdrMode()

static getHdrMode(): HdrMode Get current HDR mode.

​

Returns

HdrMode HDR mode.

---

​

getLowLatencyModeState()

static getLowLatencyModeState(): LlmState Query the current Low latency mode state of the display.

​

Returns

LlmState Low latency mode state being used for the display.

---

​

getName()

static getName(): string Query the display connector name.

​

Returns

string The name of the display connector (not the panel name).

---

​

getOverscanBorder()

static getOverscanBorder(): IOverscanBorder Returns the current overscan border values of the display. The border value (left, top, right and bottom) represent the fraction of the width or height of the display that acts like a margin for the visible region on the display.

​

Returns

IOverscanBorder The current overscan border configuration.

​

Throws

DeviceError if the display device is not in active state

​

See

IOverscanBorder

---

​

getTransferFunctions()

static getTransferFunctions(): TransferFunction[] Query the supported transfer functions by the display.

​

Returns

TransferFunction[]

---

​

isAutoConfigSwitchEnabled()

static isAutoConfigSwitchEnabled(): boolean Query if auto config switch is enabled.

​

Returns

boolean true, if auto config switch is enabled, false otherwise

​

See

IDisplayConfig

---

​

isBT2020ColorimetrySupported()

static isBT2020ColorimetrySupported(): boolean Check if the display supports BT.2020 / Rec.2020 colorimetry standard.

​

Returns

boolean

---

​

isHDRSupported()

static isHDRSupported(): boolean Check if display supports HDR (High Definition Range) or not.

​

Returns

boolean

---

​

isLowLatencyModeSupported()

static isLowLatencyModeSupported(): boolean Query if any kind of display low latency mode is supported for this display.

​

Returns

boolean true if supported otherwise false

---

​

isMultipleRefreshRateEnabled()

static isMultipleRefreshRateEnabled(): boolean Query the Multiple Refresh Rate (MRR) state for this display. It allows clients to request alternate refresh rate which might be more appropriate for their content.

​

Returns

boolean MRR state being used for the display.

---

​

isSinkActive()

static isSinkActive(): boolean Check if the display sink port where this display source device is connected is active or not. A display sink (e.g. TV or monitor) may have multiple display ports. The port where this source device is connected may be inactive even if display source (this device) is powered ON.

​

Returns

boolean Returns true if display sink is active.

---