Android APIs
public final class

VirtualDisplay

extends Object
java.lang.Object
   ↳ android.hardware.display.VirtualDisplay

Class Overview

Represents a virtual display. The content of a virtual display is rendered to a Surface that you must provide to 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.

See Also

Summary

Nested Classes
class VirtualDisplay.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.
void release()
Releases the virtual display and destroys its underlying surface.
void resize(int width, int height, int densityDpi)
Asks the virtual display to resize.
void setSurface(Surface surface)
Sets the surface that backs the virtual display.
String toString()
Returns a string containing a concise, human-readable description of this object.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public Display getDisplay ()

Added in API level 19

Gets the virtual display.

public Surface getSurface ()

Added in API level 20

Gets the surface that backs the virtual display.

public void release ()

Added in API level 19

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.

public void resize (int width, int height, int densityDpi)

Added in API level 21

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.

public void setSurface (Surface surface)

Added in API level 20

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 The surface to set, or null to detach the surface from the virtual display.

public String toString ()

Added in API level 19

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression: 

   getClass().getName() + '@' + Integer.toHexString(hashCode())

See Writing a useful toString method if you intend implementing your own toString method.

Returns
  • a printable representation of this object.