Added in API level 34

VirtualDisplayConfig

---

Kotlin |Java

class VirtualDisplayConfig : Parcelable

kotlin.Any
↳	android.hardware.display.VirtualDisplayConfig

Holds configuration used to create VirtualDisplay instances.

Summary

Nested classes
abstract	BrightnessListener Listener for display brightness changes.
	Builder A builder for VirtualDisplayConfig.

Inherited constants

From class Parcelable Int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. Int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public methods
Int	describeContents()
Boolean	equals(other: Any?)
Float	getDefaultBrightness() Returns the default brightness of the display.
Int	getDensityDpi() Returns the density of the virtual display in dpi.
Float	getDimBrightness() Returns the dim brightness of the display.
MutableSet<String!>	getDisplayCategories() Returns the display categories.
Int	getFlags() Returns the virtual display flags.
Int	getHeight() Returns the height of the virtual display in pixels.
String	getName() Returns the name of the virtual display.
Float	getRequestedRefreshRate() Returns the refresh rate of a virtual display in frames per second, or zero if it is using a default refresh rate chosen by the system.
Surface?	getSurface() Returns the surface to which the content of the virtual display should be rendered, if any.
Int	getWidth() Returns the width of the virtual display in pixels.
Int	hashCode()
String	toString() Returns a string representation of the object.
Unit	writeToParcel(dest: Parcel, flags: Int) Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<VirtualDisplayConfig!>	CREATOR

Public methods

describeContents

Added in API level 34

fun describeContents(): Int

Return
Int	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 34

fun equals(other: Any?): Boolean

Parameters
obj	the reference object with which to compare.

Return
Boolean	true if this object is the same as the obj argument; false otherwise.

getDefaultBrightness

Added in API level 36

fun getDefaultBrightness(): Float

Returns the default brightness of the display.

Value of 0.0 indicates the minimum supported brightness and value of 1.0 indicates the maximum supported brightness.

Return
Float	Value is between 0.0f and 1.0f inclusive

See Also

• android.hardware.display.VirtualDisplayConfig.Builder#setDefaultBrightness(float)

getDensityDpi

Added in API level 34

fun getDensityDpi(): Int

Returns the density of the virtual display in dpi.

getDimBrightness

Added in API level 36

fun getDimBrightness(): Float

Returns the dim brightness of the display.

Value of 0.0 indicates the minimum supported brightness and value of 1.0 indicates the maximum supported brightness.

Return
Float	Value is between 0.0f and 1.0f inclusive

See Also

• android.hardware.display.VirtualDisplayConfig.Builder#setDimBrightness(float)

getDisplayCategories

Added in API level 34

fun getDisplayCategories(): MutableSet<String!>

Returns the display categories.

Return
MutableSet<String!>	This value cannot be null.

See Also

• android.hardware.display.VirtualDisplayConfig.Builder#setDisplayCategories

getFlags

Added in API level 34

fun getFlags(): Int

Returns the virtual display flags.

See Also

• android.hardware.display.VirtualDisplayConfig.Builder#setFlags

getHeight

Added in API level 34

fun getHeight(): Int

Returns the height of the virtual display in pixels.

getName

Added in API level 34

fun getName(): String

Returns the name of the virtual display.

Return
String	This value cannot be null.

getRequestedRefreshRate

Added in API level 34

fun getRequestedRefreshRate(): Float

Returns the refresh rate of a virtual display in frames per second, or zero if it is using a default refresh rate chosen by the system.

See Also

• android.hardware.display.VirtualDisplayConfig.Builder#setRequestedRefreshRate

getSurface

Added in API level 34

fun getSurface(): Surface?

Returns the surface to which the content of the virtual display should be rendered, if any.

Return
Surface?	This value may be null.

See Also

• android.hardware.display.VirtualDisplayConfig.Builder#setSurface

getWidth

Added in API level 34

fun getWidth(): Int

Returns the width of the virtual display in pixels.

hashCode

Added in API level 34

fun hashCode(): Int

Return
Int	a hash code value for this object.

toString

Added in API level 34

fun toString(): String

Returns a string representation of the object.

Return
String	This value cannot be null.

writeToParcel

Added in API level 34

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
dest	Parcel: This value cannot be null.
flags	Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 34

static val CREATOR: Parcelable.Creator<VirtualDisplayConfig!>