VirtualDisplay

Kotlin |Java

class VirtualDisplay

kotlin.Any
↳	android.hardware.display.VirtualDisplay

Represents a virtual display. The content of a virtual display is rendered to a android.view.Surface that you must provide to android.hardware.display.DisplayManager#createVirtualDisplay.

Because a virtual display renders to a surface provided by the application, it will be released automatically when the process terminates and all remaining windows on it will be forcibly removed. However, you should also explicitly call release when you're done with it.

Summary

Nested classes
abstract	`Callback` Interface for receiving information about a `VirtualDisplay`'s state changes.

Public methods
Display!	`getDisplay()` Gets the virtual display.
Surface!	`getSurface()` Gets the surface that backs the virtual display.
Unit	`release()` Releases the virtual display and destroys its underlying surface.
Unit	`resize(width: Int, height: Int, densityDpi: Int)` Asks the virtual display to resize.
Unit	`setSurface(surface: Surface!)` Sets the surface that backs the virtual display.
String	`toString()`

Public methods

getDisplay

Added in API level 19

fun getDisplay(): Display!

Gets the virtual display.

getSurface

Added in API level 20

fun getSurface(): Surface!

Gets the surface that backs the virtual display.

release

Added in API level 19

fun release(): Unit

Releases the virtual display and destroys its underlying surface.

All remaining windows on the virtual display will be forcibly removed as part of releasing the virtual display.

resize

Added in API level 21

fun resize(
    width: Int, 
    height: Int, 
    densityDpi: Int
): Unit

Asks the virtual display to resize.

This is really just a convenience to allow applications using virtual displays to adapt to changing conditions without having to tear down and recreate the display.

setSurface

Added in API level 20

fun setSurface(surface: Surface!): Unit

Sets the surface that backs the virtual display.

Detaching the surface that backs a virtual display has a similar effect to turning off the screen.

It is still the caller's responsibility to destroy the surface after it has been detached.

Parameters
`surface`	Surface!: The surface to set, or null to detach the surface from the virtual display.

toString

Added in API level 19

fun toString(): String

Return
`String`	a string representation of the object.