IDisplay3

​

Interface IDisplay3

interface IDisplay3

Extends IDisplay2 Version 3 of IDisplay This version provides apis to check if display output is active and get allowed color spaces (color formats) and color depths. [ColorDepth] [ColorSpace]

​

Methods

​

isSinkActive()

bool isSinkActive()

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. Please note, this method is different than IDisplay::getPowerState which indicates the power state of display source. Please see IDisplayListener3::onSinkStateChange.

​

Returns

bool Returns true if display sink is active.

---

​

getAllowedColorSpaces()

ColorSpace[] getAllowedColorSpaces()

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[] array of allowed color spaces

​

Throws

• DeviceError — if the display device is not in active state

---

​

getAllowedColorDepths()

ColorDepth[] getAllowedColorDepths(ColorSpace colorSpace)

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 — Required the color space for which allowed color depths are queried.

​

Returns

ColorDepth[] array of color depth for given color space.

​

Throws

• DeviceError — if the display device is not in active state

---