IDisplay

​

Interface IDisplay

interface IDisplay

Extends com.amazon.apmf.IStandard Display interface representing a screen. This gives a set of API to retrieve various information about a display. [IDisplayController#getDisplayList] [IDisplayController#getPrimaryDisplay]

​

Methods

​

getId()

i32 getId()

Query the unique id of the display. Identifiers should not be expected to be consistent across DisplayDevice instances, or even for a future instance representing the same physical display device (i.e., after a disconnect/connect cycle). No assumptions should be made regarding identifier sequencing: the API is free to select any value within the i32 range.

​

Returns

i32 id of display

​

Throws

• DeviceError — if the display device is not in active state [IDisplayController#getDisplayList] or [IDisplayController#getPrimaryDisplay]

---

​

getName()

string getName()

Query the name of this display. This is not the panel name but display connector name.

​

Returns

string name of the display

​

Throws

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

---

​

getAllSupportedConfigs()

IDisplayConfig*[] getAllSupportedConfigs()

Query the list of all supported configs for this display.

​

Returns

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

​

Throws

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

---

​

getCurrentConfig()

IDisplayConfig* getCurrentConfig()

Query the current config for this display.

​

Returns

IDisplayConfig* Returns current config

​

Throws

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

---

​

getCurrentRefreshRateInMillihertz()

i32 getCurrentRefreshRateInMillihertz()

Query the current vertical refresh rate in mHz (millihertz) for this display

​

Returns

i32 Returns current refresh rate for this display in mHz. If the current refresh rate changes,

​

Throws

• DeviceError — if the display device is not in active state IDisplayListener.onRefreshRateChange will be called.

---

​

getSupportedHardwareCapabilities()

DisplayHardwareCapabilityType[] getSupportedHardwareCapabilities()

Query the list of supported hardware capabilities for this display.

​

Returns

DisplayHardwareCapabilityType[] Returns the list of supported capabilities

​

Throws

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

---

​

getCurrentHdcpLevel()

HdcpLevel getCurrentHdcpLevel()

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

​

Returns

HdcpLevel Returns current HDCP level for this display

​

Throws

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

---

​

isHdcpRepeaterModeOn()

bool isHdcpRepeaterModeOn()

Query the HDCP (High-bandwidth Digital Content Protection) repeater mode status for this display.

​

Returns

bool Returns true if HDCP repeater mode is ON otherwise false

​

Throws

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

---

​

isLowLatencyModeSupported()

bool isLowLatencyModeSupported()

Query if any kind of display low latency mode is supported for this display.

​

Returns

bool true if supported otherwise false

---

​

isAutoConfigSwitchEnabled()

bool isAutoConfigSwitchEnabled()

Query if auto config switch is enabled.

​

Returns

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

​

Throws

• DeviceError — if the display device is not in active state [IDisplayConfig] [IDisplayListener] [IDisplay#addDisplayListener] [IDisplayManager#enableAutoConfigSwitch] [IDisplayManager#requestConfigChange]

---

​

isMultipleRefreshRateEnabled()

bool isMultipleRefreshRateEnabled()

Query the Multiple Refresh Rate (MRR) state for this display. MRR is a feature which allows clients to request alternate refresh rate which might be more appropriate for their content. If isMultipleRefreshRateEnabled() returns ‘false’, then ISurfaceControl# setPreferredRefreshRateInMillihertz() will have no effect and shouldn’t be called by clients.

​

Returns

bool MRR state being used for the display.

​

Throws

• DeviceError — if the display device is not in active state
• OutOfMemoryError — if device doesn’t have enough memory to complete the operation [IDisplayListener#onMultipleRefreshRateStateChange], [IDisplayManager#enableMultipleRefreshRate] and [ISurfaceControl#setPreferredRefreshRateInMillihertz]

---

​

getLowLatencyModeState()

LlmState getLowLatencyModeState()

Query the current LLM state of the display

​

Returns

LlmState LLM state being used for the display.

​

Throws

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

---

​

getColorDepth()

ColorDepth getColorDepth()

Query the current color depth mode.

​

Returns

ColorDepth ColorDepth being used for the display.

​

Throws

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

---

​

getColorSpace()

ColorSpace getColorSpace()

Query the current color space of the display

​

Returns

ColorSpace ColorSpace being used for the display.

​

Throws

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

---

​

getRawEdid()

u8[] getRawEdid()

Query the raw EDID binary information blob. This API requires the client to have com.amazon.graphics.privilege.display.edid application privilege.

​

Returns

u8[] Raw EDID binary as byte string. An empty string is returned if no valid EDID binary is available.

​

Throws

• DeviceError — if the display device is not in active state
• OutOfMemoryError — if device is out of memory
• SecurityError — if client doesn’t have the required set of application privileges

---

​

getContentType()

ContentType getContentType()

Query the type of current content type on this display.

​

Returns

ContentType Content type being displayed on the screen.

​

Throws

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

---

​

getPowerState()

PowerState getPowerState()

Query the current power state of this display.

​

Returns

PowerState power state of the display. [PowerState]

---

​

addDisplayListener()

com.amazon.apmf.ISubscription* addDisplayListener(IDisplayListener* listener)

Add IDisplayListener. The listener will continue to receive events until ISubscription#unsubscribe() is called or until the event source is destroyed.

​

Parameters

listener

IDisplayListener* — Required IDisplayListener interface

​

Returns

com.amazon.apmf.ISubscription* ISubscription related to this listener interface

​

Throws

• NullPointerError — if any input argument is null pointer while a non-null one is expected
• InvalidArgumentError — if any input argument is invalid
• DeviceError — if the display device is not in active state
• OutOfMemoryError — if device is out of memory [IDisplayListener]

---

​

addVsyncListener()

com.amazon.apmf.ISubscription* addVsyncListener(IVsyncListener* listener)

Add IVsyncListener. The listener will continue to receive events until ISubscription#unsubscribe() is called or until the event source is destroyed.

​

Parameters

listener

IVsyncListener* — Required IVsyncListener interface

​

Returns

com.amazon.apmf.ISubscription* ISubscription related to this listener interface

​

Throws

• NullPointerError — if any input argument is null pointer while a non-null one is expected
• InvalidArgumentError — if any input argument is invalid
• DeviceError — if the display device is not in active state
• OutOfMemoryError — if device is out of memory [IVsyncListener]

---

​

addContentTypeListener()

com.amazon.apmf.ISubscription* addContentTypeListener(IContentTypeListener* listener)

Add IContentTypeListener. The listener will continue to receive events until ISubscription#unsubscribe() is called or until the event source is destroyed. This API is only expected to work for system clients.

​

Parameters

listener

IContentTypeListener* — Required IContentTypeListener interface

​

Returns

com.amazon.apmf.ISubscription* ISubscription related to this listener interface

​

Throws

• NullPointerError — if any input argument is null pointer while a non-null one is expected
• InvalidArgumentError — if any input argument is invalid
• DeviceError — if the display device is not in active state
• OutOfMemoryError — if device is out of memory
• SecurityError — if client doesn’t have the required permission. [IContentTypeListener]

---

​

addPowerStateListener()

com.amazon.apmf.ISubscription* addPowerStateListener(IPowerStateListener* listener)

Add IPowerStateListener. The listener will continue to receive events until ISubscription#unsubscribe() is called or until the event source is destroyed.

​

Parameters

listener

IPowerStateListener* — Required IPowerStateListener interface

​

Returns

com.amazon.apmf.ISubscription* ISubscription related to this listener interface

​

Throws

• NullPointerError — if any input argument is null pointer while a non-null one is expected
• InvalidArgumentError — if any input argument is invalid
• DeviceError — if the display device is not in active state
• OutOfMemoryError — if device is out of memory [IPowerStateListener]

---

​

isBufferFormatSupported()

bool isBufferFormatSupported(BufferPixelFormat* format, BufferUsage* usage)

Check whether format is supported based on buffer usage flags.

​

Parameters

format

BufferPixelFormat* — Required Buffer format

usage

BufferUsage* — Required Buffer usage

​

Returns

bool True if buffer usage and format is supported

​

Throws

• NullPointerError — if any input argument is null pointer while a non-null one is expected
• InvalidArgumentError — if any input argument is invalid
• DeviceError — if the display device is not in active state

---

​

getPreferred3dFormats()

BufferPixelFormat[] getPreferred3dFormats()

Query the list of preferred (for performance and compatibility reasons) 3d formats

​

Returns

BufferPixelFormat[] list of 3d formats

​

Throws

• DeviceError — if the display device is not in active state
• OutOfMemoryError — if device is out of memory

---

​

getPreferredVideoDecoderFormats()

BufferPixelFormat[] getPreferredVideoDecoderFormats()

Query the list of preferred (for performance and compatibility reasons) video decoder formats

​

Returns

BufferPixelFormat[] list of video decode formats

​

Throws

• DeviceError — if the display device is not in active state
• OutOfMemoryError — if device is out of memory

---

​

getPreferredSecureVideoDecoderFormats()

BufferPixelFormat[] getPreferredSecureVideoDecoderFormats()

Query the list of preferred (for performance and compatibility reasons) secure video formats

​

Returns

BufferPixelFormat[] list of secure video formats

​

Throws

• DeviceError — if the display device is not in active state
• OutOfMemoryError — if device is out of memory

---

​

preferredCameraFormats()

BufferPixelFormat[] preferredCameraFormats()

Query the list of preferred (for performance and compatibility reasons) camera formats

​

Returns

BufferPixelFormat[] list of camera formats

​

Throws

• DeviceError — if the display device is not in active state
• OutOfMemoryError — if device is out of memory

---

​

getHdrMode()

HdrMode getHdrMode()

Get current HDR mode

​

Returns

HdrMode HDR mode

---