Added in API level 34

Summary: Ctors | Methods | Inherited Methods

VirtualDisplayConfig.Builder

Kotlin |Java

public static final class VirtualDisplayConfig.Builder
extends Object

java.lang.Object
↳	android.hardware.display.VirtualDisplayConfig.Builder

A builder for VirtualDisplayConfig.

Summary

Public constructors
`Builder(String name, int width, int height, int densityDpi)` Creates a new Builder.

Public methods
`VirtualDisplayConfig.Builder`	`addDisplayCategory(String displayCategory)` Adds a display category.
`VirtualDisplayConfig`	`build()` Builds the `VirtualDisplayConfig` instance.
`VirtualDisplayConfig.Builder`	`setDisplayCategories(Set<String> displayCategories)` Sets the display categories.
`VirtualDisplayConfig.Builder`	`setFlags(int flags)` Sets the virtual display flags, a combination of `DisplayManager.VIRTUAL_DISPLAY_FLAG_PUBLIC`, `DisplayManager.VIRTUAL_DISPLAY_FLAG_PRESENTATION`, `DisplayManager.VIRTUAL_DISPLAY_FLAG_SECURE`, `DisplayManager.VIRTUAL_DISPLAY_FLAG_OWN_CONTENT_ONLY`, or `DisplayManager.VIRTUAL_DISPLAY_FLAG_AUTO_MIRROR`.
`VirtualDisplayConfig.Builder`	`setRequestedRefreshRate(float requestedRefreshRate)` Sets the refresh rate of a virtual display in frames per second.
`VirtualDisplayConfig.Builder`	`setSurface(Surface surface)` Sets the surface to which the content of the virtual display should be rendered.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

Builder

Added in API level 34

public Builder (String name, 
                int width, 
                int height, 
                int densityDpi)

Creates a new Builder.

Parameters
`name`	`String`: The name of the virtual display, must be non-empty. This value cannot be `null`.
`width`	`int`: The width of the virtual display in pixels. Must be greater than 0. Value is 1 or greater
`height`	`int`: The height of the virtual display in pixels. Must be greater than 0. Value is 1 or greater
`densityDpi`	`int`: The density of the virtual display in dpi. Must be greater than 0. Value is 1 or greater

Public methods

addDisplayCategory

Added in API level 34

public VirtualDisplayConfig.Builder addDisplayCategory (String displayCategory)

Adds a display category.

Parameters
`displayCategory`	`String`: This value cannot be `null`.

Returns
`VirtualDisplayConfig.Builder`	This value cannot be `null`.

See also:

setDisplayCategories(Set)

build

Added in API level 34

public VirtualDisplayConfig build ()

Builds the VirtualDisplayConfig instance.

Returns
`VirtualDisplayConfig`	This value cannot be `null`.

setDisplayCategories

Added in API level 34

public VirtualDisplayConfig.Builder setDisplayCategories (Set<String> displayCategories)

Sets the display categories.

The categories of the display indicate the type of activities allowed to run on that display. Activities can declare a display category using ActivityInfo.requiredDisplayCategory.

Parameters
`displayCategories`	`Set`: This value cannot be `null`.

Returns
`VirtualDisplayConfig.Builder`	This value cannot be `null`.

setFlags

Added in API level 34

public VirtualDisplayConfig.Builder setFlags (int flags)

Sets the virtual display flags, a combination of DisplayManager.VIRTUAL_DISPLAY_FLAG_PUBLIC, DisplayManager.VIRTUAL_DISPLAY_FLAG_PRESENTATION, DisplayManager.VIRTUAL_DISPLAY_FLAG_SECURE, DisplayManager.VIRTUAL_DISPLAY_FLAG_OWN_CONTENT_ONLY, or DisplayManager.VIRTUAL_DISPLAY_FLAG_AUTO_MIRROR.

Parameters

Parameters
`flags`	`int`: Value is either `0` or a combination of `DisplayManager.VIRTUAL_DISPLAY_FLAG_PUBLIC`, `DisplayManager.VIRTUAL_DISPLAY_FLAG_PRESENTATION`, `DisplayManager.VIRTUAL_DISPLAY_FLAG_SECURE`, `DisplayManager.VIRTUAL_DISPLAY_FLAG_OWN_CONTENT_ONLY`, `DisplayManager.VIRTUAL_DISPLAY_FLAG_AUTO_MIRROR`, android.hardware.display.DisplayManager.VIRTUAL_DISPLAY_FLAG_CAN_SHOW_WITH_INSECURE_KEYGUARD, android.hardware.display.DisplayManager.VIRTUAL_DISPLAY_FLAG_SUPPORTS_TOUCH, android.hardware.display.DisplayManager.VIRTUAL_DISPLAY_FLAG_ROTATES_WITH_CONTENT, android.hardware.display.DisplayManager.VIRTUAL_DISPLAY_FLAG_DESTROY_CONTENT_ON_REMOVAL, android.hardware.display.DisplayManager.VIRTUAL_DISPLAY_FLAG_SHOULD_SHOW_SYSTEM_DECORATIONS, android.hardware.display.DisplayManager.VIRTUAL_DISPLAY_FLAG_TRUSTED, android.hardware.display.DisplayManager.VIRTUAL_DISPLAY_FLAG_OWN_DISPLAY_GROUP, android.hardware.display.DisplayManager.VIRTUAL_DISPLAY_FLAG_ALWAYS_UNLOCKED, android.hardware.display.DisplayManager.VIRTUAL_DISPLAY_FLAG_TOUCH_FEEDBACK_DISABLED, android.hardware.display.DisplayManager.VIRTUAL_DISPLAY_FLAG_OWN_FOCUS, and android.hardware.display.DisplayManager.VIRTUAL_DISPLAY_FLAG_STEAL_TOP_FOCUS_DISABLED

flags

int: Value is either 0 or a combination of DisplayManager.VIRTUAL_DISPLAY_FLAG_PUBLIC, DisplayManager.VIRTUAL_DISPLAY_FLAG_PRESENTATION, DisplayManager.VIRTUAL_DISPLAY_FLAG_SECURE, DisplayManager.VIRTUAL_DISPLAY_FLAG_OWN_CONTENT_ONLY, DisplayManager.VIRTUAL_DISPLAY_FLAG_AUTO_MIRROR, android.hardware.display.DisplayManager.VIRTUAL_DISPLAY_FLAG_CAN_SHOW_WITH_INSECURE_KEYGUARD, android.hardware.display.DisplayManager.VIRTUAL_DISPLAY_FLAG_SUPPORTS_TOUCH, android.hardware.display.DisplayManager.VIRTUAL_DISPLAY_FLAG_ROTATES_WITH_CONTENT, android.hardware.display.DisplayManager.VIRTUAL_DISPLAY_FLAG_DESTROY_CONTENT_ON_REMOVAL, android.hardware.display.DisplayManager.VIRTUAL_DISPLAY_FLAG_SHOULD_SHOW_SYSTEM_DECORATIONS, android.hardware.display.DisplayManager.VIRTUAL_DISPLAY_FLAG_TRUSTED, android.hardware.display.DisplayManager.VIRTUAL_DISPLAY_FLAG_OWN_DISPLAY_GROUP, android.hardware.display.DisplayManager.VIRTUAL_DISPLAY_FLAG_ALWAYS_UNLOCKED, android.hardware.display.DisplayManager.VIRTUAL_DISPLAY_FLAG_TOUCH_FEEDBACK_DISABLED, android.hardware.display.DisplayManager.VIRTUAL_DISPLAY_FLAG_OWN_FOCUS, and android.hardware.display.DisplayManager.VIRTUAL_DISPLAY_FLAG_STEAL_TOP_FOCUS_DISABLED

Returns
`VirtualDisplayConfig.Builder`	This value cannot be `null`.

setRequestedRefreshRate

Added in API level 34

public VirtualDisplayConfig.Builder setRequestedRefreshRate (float requestedRefreshRate)

Sets the refresh rate of a virtual display in frames per second.

For best results, specify a divisor of the physical refresh rate, e.g., 30 or 60 on a 120hz display. If an arbitrary refresh rate is specified, the rate will be rounded up to a divisor of the physical display. If unset or zero, the virtual display will be refreshed at the physical display refresh rate.

Parameters
`requestedRefreshRate`	`float`: Value is 0.0f or greater

Returns
`VirtualDisplayConfig.Builder`	This value cannot be `null`.

See also:

Display.getRefreshRate()

setSurface

Added in API level 34

public VirtualDisplayConfig.Builder setSurface (Surface surface)

Sets the surface to which the content of the virtual display should be rendered.

The surface can also be set after the display creation using VirtualDisplay.setSurface(Surface).

Parameters
`surface`	`Surface`: This value may be `null`.

Returns
`VirtualDisplayConfig.Builder`	This value cannot be `null`.