Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Nested Classes](https://developer.android.com/reference/android/hardware/display/VirtualDisplayConfig#nestedclasses) \| [Inherited Constants](https://developer.android.com/reference/android/hardware/display/VirtualDisplayConfig#inhconstants) \| [Fields](https://developer.android.com/reference/android/hardware/display/VirtualDisplayConfig#lfields) \| [Methods](https://developer.android.com/reference/android/hardware/display/VirtualDisplayConfig#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/hardware/display/VirtualDisplayConfig#inhmethods)
# VirtualDisplayConfig
*** ** * ** ***
`
public
final
class
VirtualDisplayConfig
`
`
extends https://developer.android.com/reference/java/lang/Object
`
`
implements
https://developer.android.com/reference/android/os/Parcelable
`
|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.hardware.display.VirtualDisplayConfig |
*** ** * ** ***
Holds configuration used to create `https://developer.android.com/reference/android/hardware/display/VirtualDisplay` instances.
**See also:**
- `https://developer.android.com/reference/android/hardware/display/DisplayManager#createVirtualDisplay(android.hardware.display.VirtualDisplayConfig,%20android.os.Handler,%20android.hardware.display.VirtualDisplay.Callback)`
- `https://developer.android.com/reference/android/media/projection/MediaProjection#createVirtualDisplay(java.lang.String,%20int,%20int,%20int,%20int,%20android.view.Surface,%20android.hardware.display.VirtualDisplay.Callback,%20android.os.Handler)`
## Summary
| ### Nested classes ||
|---|---|
| ` interface` | `https://developer.android.com/reference/android/hardware/display/VirtualDisplayConfig.BrightnessListener` Listener for display brightness changes. |
| ` class` | `https://developer.android.com/reference/android/hardware/display/VirtualDisplayConfig.Builder` A builder for `https://developer.android.com/reference/android/hardware/display/VirtualDisplayConfig`. |
| ### Inherited constants |
|---|
| From interface `https://developer.android.com/reference/android/os/Parcelable` |---|---| | `int` | `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `https://developer.android.com/reference/android/os/Parcelable#describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor. | | `int` | `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`: 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)`". | |
| ### Fields ||
|---|---|
| ` public static final https://developer.android.com/reference/android/os/Parcelable.Creator` | `https://developer.android.com/reference/android/hardware/display/VirtualDisplayConfig#CREATOR` |
| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/hardware/display/VirtualDisplayConfig#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` boolean` | ` https://developer.android.com/reference/android/hardware/display/VirtualDisplayConfig#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object o) ` Indicates whether some other object is "equal to" this one. |
| ` float` | ` https://developer.android.com/reference/android/hardware/display/VirtualDisplayConfig#getDefaultBrightness()() ` Returns the default brightness of the display. |
| ` int` | ` https://developer.android.com/reference/android/hardware/display/VirtualDisplayConfig#getDensityDpi()() ` Returns the density of the virtual display in dpi. |
| ` float` | ` https://developer.android.com/reference/android/hardware/display/VirtualDisplayConfig#getDimBrightness()() ` Returns the dim brightness of the display. |
| ` https://developer.android.com/reference/java/util/Set` | ` https://developer.android.com/reference/android/hardware/display/VirtualDisplayConfig#getDisplayCategories()() ` Returns the display categories. |
| ` int` | ` https://developer.android.com/reference/android/hardware/display/VirtualDisplayConfig#getFlags()() ` Returns the virtual display flags. |
| ` int` | ` https://developer.android.com/reference/android/hardware/display/VirtualDisplayConfig#getHeight()() ` Returns the height of the virtual display in pixels. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/hardware/display/VirtualDisplayConfig#getName()() ` Returns the name of the virtual display. |
| ` float` | ` https://developer.android.com/reference/android/hardware/display/VirtualDisplayConfig#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. |
| ` https://developer.android.com/reference/android/view/Surface` | ` https://developer.android.com/reference/android/hardware/display/VirtualDisplayConfig#getSurface()() ` Returns the surface to which the content of the virtual display should be rendered, if any. |
| ` int` | ` https://developer.android.com/reference/android/hardware/display/VirtualDisplayConfig#getWidth()() ` Returns the width of the virtual display in pixels. |
| ` int` | ` https://developer.android.com/reference/android/hardware/display/VirtualDisplayConfig#hashCode()() ` Returns a hash code value for the object. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/hardware/display/VirtualDisplayConfig#toString()() ` Returns a string representation of the object. |
| ` void` | ` https://developer.android.com/reference/android/hardware/display/VirtualDisplayConfig#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) ` Flatten this object in to a Parcel. |
| ### Inherited methods |
|---|---|
| From class ` https://developer.android.com/reference/java/lang/Object ` |---|---| | ` https://developer.android.com/reference/java/lang/Object` | ` https://developer.android.com/reference/java/lang/Object#clone()() ` Creates and returns a copy of this object. | | ` boolean` | ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` https://developer.android.com/reference/java/lang/Object#finalize()() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final https://developer.android.com/reference/java/lang/Class` | ` https://developer.android.com/reference/java/lang/Object#getClass()() ` Returns the runtime class of this `Object`. | | ` int` | ` https://developer.android.com/reference/java/lang/Object#hashCode()() ` Returns a hash code value for the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notify()() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notifyAll()() ` Wakes up all threads that are waiting on this object's monitor. | | ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/Object#toString()() ` Returns a string representation of the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(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` | ` https://developer.android.com/reference/java/lang/Object#wait(long)(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` | ` https://developer.android.com/reference/java/lang/Object#wait()() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. | ||
| From interface ` https://developer.android.com/reference/android/os/Parcelable ` |---|---| | ` abstract int` | ` https://developer.android.com/reference/android/os/Parcelable#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. | | ` abstract void` | ` https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) ` Flatten this object in to a Parcel. | ||
## Fields
### CREATOR
Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final Creator CREATOR
```
## Public methods
### describeContents
Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public int describeContents ()
```
Describe the kinds of special objects contained in this Parcelable
instance's marshaled representation. For example, if the object will
include a file descriptor in the output of `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`,
the return value of this method must include the
`https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` bit.
| Returns ||
|---|---|
| `int` | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or - `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` |
### equals
Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public boolean equals (Object o)
```
Indicates whether some other object is "equal to" this one.
The `equals` method implements an equivalence relation
on non-null object references:
- It is *reflexive*: for any non-null reference value `x`, `x.equals(x)` should return `true`.
- It is *symmetric*: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`.
- It is *transitive*: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`.
- It is *consistent*: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified.
- For any non-null reference value `x`, `x.equals(null)` should return `false`.
An equivalence relation partitions the elements it operates on
into *equivalence classes*; all the members of an
equivalence class are equal to each other. Members of an
equivalence class are substitutable for each other, at least
for some purposes.
| Parameters ||
|---|---|
| `o` | `Object`: the reference object with which to compare.
|
| Returns ||
|---|---|
| `boolean` | `true` if this object is the same as the obj argument; `false` otherwise.
|
### getDefaultBrightness
Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public float getDefaultBrightness ()
```
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.
| Returns ||
|---|---|
| `float` | Value is between 0.0f and 1.0f inclusive
|
**See also:**
- `https://developer.android.com/reference/android/hardware/display/VirtualDisplayConfig.Builder#setDefaultBrightness(float)`
### getDensityDpi
Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public int getDensityDpi ()
```
Returns the density of the virtual display in dpi.
| Returns ||
|---|---|
| `int` |
|
### getDimBrightness
Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public float getDimBrightness ()
```
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.
| Returns ||
|---|---|
| `float` | Value is between 0.0f and 1.0f inclusive
|
**See also:**
- `https://developer.android.com/reference/android/hardware/display/VirtualDisplayConfig.Builder#setDimBrightness(float)`
### getDisplayCategories
Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public Set getDisplayCategories ()
```
Returns the display categories.
| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/Set` | This value cannot be `null`.
|
**See also:**
- `https://developer.android.com/reference/android/hardware/display/VirtualDisplayConfig.Builder#setDisplayCategories(java.util.Set)`
### getFlags
Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public int getFlags ()
```
Returns the virtual display flags.
| Returns ||
|---|---|
| `int` |
|
**See also:**
- `https://developer.android.com/reference/android/hardware/display/VirtualDisplayConfig.Builder#setFlags(int)`
### getHeight
Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public int getHeight ()
```
Returns the height of the virtual display in pixels.
| Returns ||
|---|---|
| `int` |
|
### getName
Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public String getName ()
```
Returns the name of the virtual display.
| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | This value cannot be `null`.
|
### getRequestedRefreshRate
Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public 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.
| Returns ||
|---|---|
| `float` |
|
**See also:**
- `https://developer.android.com/reference/android/hardware/display/VirtualDisplayConfig.Builder#setRequestedRefreshRate(float)`
### getSurface
Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public Surface getSurface ()
```
Returns the surface to which the content of the virtual display should be rendered, if any.
| Returns ||
|---|---|
| `https://developer.android.com/reference/android/view/Surface` | This value may be `null`.
|
**See also:**
- `https://developer.android.com/reference/android/hardware/display/VirtualDisplayConfig.Builder#setSurface(android.view.Surface)`
### getWidth
Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public int getWidth ()
```
Returns the width of the virtual display in pixels.
| Returns ||
|---|---|
| `int` |
|
### hashCode
Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public int hashCode ()
```
Returns a hash code value for the object. This method is
supported for the benefit of hash tables such as those provided by
`https://developer.android.com/reference/java/util/HashMap`.
The general contract of `hashCode` is:
- Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
- If two objects are equal according to the `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` method, then calling the `hashCode` method on each of the two objects must produce the same integer result.
- It is *not* required that if two objects are unequal according to the `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
| Returns ||
|---|---|
| `int` | a hash code value for this object.
|
### toString
Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public String toString ()
```
Returns a string representation of the object.
| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | This value cannot be `null`.
|
### writeToParcel
Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void writeToParcel (Parcel dest,
int flags)
```
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 `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` |