DisplayManagerCompat

public final class DisplayManagerCompat
extends Object

java.lang.Object
   ↳ androidx.core.hardware.display.DisplayManagerCompat

Helper for accessing features in DisplayManager.

Summary

Constants

String DISPLAY_CATEGORY_PRESENTATION

Display category: Presentation displays.

Public methods

Display getDisplay(int displayId)

Gets information about a logical display.

Display[] getDisplays()

Gets all currently valid logical displays.

Display[] getDisplays(String category)

Gets all currently valid logical displays of the specified category.

static DisplayManagerCompat getInstance(Context context)

Gets an instance of the display manager given the context.

Inherited methods

Constants

DISPLAY_CATEGORY_PRESENTATION

public static final String DISPLAY_CATEGORY_PRESENTATION

Display category: Presentation displays.

This category can be used to identify secondary displays that are suitable for use as presentation displays.

Constant Value: "android.hardware.display.category.PRESENTATION"

Public methods

getDisplay

public Display getDisplay (int displayId)

Gets information about a logical display. The display metrics may be adjusted to provide compatibility for legacy applications.

Parameters
displayId int: The logical display id.
Returns
Display The display object, or null if there is no valid display with the given id.

getDisplays

public Display[] getDisplays ()

Gets all currently valid logical displays.

Returns
Display[] An array containing all displays.

getDisplays

public Display[] getDisplays (String category)

Gets all currently valid logical displays of the specified category.

When there are multiple displays in a category the returned displays are sorted of preference. For example, if the requested category is DISPLAY_CATEGORY_PRESENTATION and there are multiple presentation displays then the displays are sorted so that the first display in the returned array is the most preferred presentation display. The application may simply use the first display or allow the user to choose.

Parameters
category String: The requested display category or null to return all displays.
Returns
Display[] An array containing all displays sorted by order of preference.

getInstance

public static DisplayManagerCompat getInstance (Context context)

Gets an instance of the display manager given the context.

Parameters
context Context

Returns
DisplayManagerCompat