Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Constants](https://developer.android.com/reference/android/companion/virtual/VirtualDevice#constants) \| [Inherited Constants](https://developer.android.com/reference/android/companion/virtual/VirtualDevice#inhconstants) \| [Fields](https://developer.android.com/reference/android/companion/virtual/VirtualDevice#lfields) \| [Methods](https://developer.android.com/reference/android/companion/virtual/VirtualDevice#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/companion/virtual/VirtualDevice#inhmethods)

# VirtualDevice

*** ** * ** ***


`
public

final

class
VirtualDevice
`


`

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.companion.virtual.VirtualDevice |

<br />

*** ** * ** ***

Details of a particular virtual device.

Read-only device representation exposing the properties of an existing virtual device.
**See also:**

- `https://developer.android.com/reference/android/companion/virtual/VirtualDeviceManager#registerVirtualDeviceListener(java.util.concurrent.Executor,%20android.companion.virtual.VirtualDeviceManager.VirtualDeviceListener)`

## Summary

| ### Constants ||
|---|---|
| `int` | `https://developer.android.com/reference/android/companion/virtual/VirtualDevice#DEVICE_PROFILE_APP_STREAMING` |
| `int` | `https://developer.android.com/reference/android/companion/virtual/VirtualDevice#DEVICE_PROFILE_AUTOMOTIVE_PROJECTION` |
| `int` | `https://developer.android.com/reference/android/companion/virtual/VirtualDevice#DEVICE_PROFILE_NEARBY_DEVICE_STREAMING` |
| `int` | `https://developer.android.com/reference/android/companion/virtual/VirtualDevice#DEVICE_PROFILE_UNKNOWN` An unknown virtual device profile, indicating an error. |

### 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/companion/virtual/VirtualDevice>` | `https://developer.android.com/reference/android/companion/virtual/VirtualDevice#CREATOR` |

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/companion/virtual/VirtualDevice#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` int` | ` https://developer.android.com/reference/android/companion/virtual/VirtualDevice#getDeviceId()() ` Returns the unique ID of the virtual device. |
| ` int` | ` https://developer.android.com/reference/android/companion/virtual/VirtualDevice#getDeviceProfile()() ` Returns the device profile of the virtual device. |
| ` int[]` | ` https://developer.android.com/reference/android/companion/virtual/VirtualDevice#getDisplayIds()() ` Returns the IDs of all virtual displays that belong to this device, if any. |
| ` https://developer.android.com/reference/java/lang/CharSequence` | ` https://developer.android.com/reference/android/companion/virtual/VirtualDevice#getDisplayName()() ` Returns the human-readable name of the virtual device, if defined, which is suitable to be shown in UI. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/companion/virtual/VirtualDevice#getName()() ` Returns the name of the virtual device (optionally) provided during its creation. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/companion/virtual/VirtualDevice#getPersistentDeviceId()() ` Returns the persistent identifier of this virtual device, if any. |
| ` boolean` | ` https://developer.android.com/reference/android/companion/virtual/VirtualDevice#hasCustomSensorSupport()() ` Returns whether this device may have custom sensors. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/companion/virtual/VirtualDevice#toString()() ` Returns a string representation of the object. |
| ` void` | ` https://developer.android.com/reference/android/companion/virtual/VirtualDevice#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.


## Constants

### DEVICE_PROFILE_APP_STREAMING

Added in [version 37.2](https://developer.android.com/topic/libraries/support-library/revisions)

```
public static final int DEVICE_PROFILE_APP_STREAMING
```

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/companion/AssociationRequest#DEVICE_PROFILE_APP_STREAMING`

Constant Value:

102
(0x00000066)


### DEVICE_PROFILE_AUTOMOTIVE_PROJECTION

Added in [version 37.2](https://developer.android.com/topic/libraries/support-library/revisions)

```
public static final int DEVICE_PROFILE_AUTOMOTIVE_PROJECTION
```

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/companion/AssociationRequest#DEVICE_PROFILE_AUTOMOTIVE_PROJECTION`

Constant Value:

101
(0x00000065)


### DEVICE_PROFILE_NEARBY_DEVICE_STREAMING

Added in [version 37.2](https://developer.android.com/topic/libraries/support-library/revisions)

```
public static final int DEVICE_PROFILE_NEARBY_DEVICE_STREAMING
```

<br />

<br />

**See also:**

- `https://developer.android.com/reference/android/companion/AssociationRequest#DEVICE_PROFILE_NEARBY_DEVICE_STREAMING`

Constant Value:

103
(0x00000067)


### DEVICE_PROFILE_UNKNOWN

Added in [version 37.2](https://developer.android.com/topic/libraries/support-library/revisions)

```
public static final int DEVICE_PROFILE_UNKNOWN
```

An unknown virtual device profile, indicating an error.

<br />

Constant Value:

-1
(0xffffffff)


## Fields

### CREATOR

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Creator<VirtualDevice> CREATOR
```

<br />

<br />

## 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.

<br />

| 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` |

### getDeviceId

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getDeviceId ()
```

Returns the unique ID of the virtual device.

This identifier corresponds to `https://developer.android.com/reference/android/content/Context#getDeviceId()` and can be used to access
device-specific system capabilities.

This identifier is ephemeral and should not be used for persisting any data
per device.

<br />

| Returns ||
|---|---|
| `int` | <br /> |

**See also:**

- `https://developer.android.com/reference/android/content/Context#createDeviceContext(int)`
- `https://developer.android.com/reference/android/companion/virtual/VirtualDevice#getPersistentDeviceId()`

### getDeviceProfile

Added in [version 37.2](https://developer.android.com/topic/libraries/support-library/revisions)

```
public int getDeviceProfile ()
```

Returns the device profile of the virtual device.

The device profile indicates the intended use and capabilities of the device.

<br />

<br />

| Returns ||
|---|---|
| `int` | <br /> |

### getDisplayIds

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int[] getDisplayIds ()
```

Returns the IDs of all virtual displays that belong to this device, if any.

The actual `https://developer.android.com/reference/android/view/Display` objects can be obtained by passing the returned
IDs to `https://developer.android.com/reference/android/hardware/display/DisplayManager#getDisplay(int)`.

<br />

<br />

| Returns ||
|---|---|
| `int[]` | This value cannot be `null`. <br /> |

### getDisplayName

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public CharSequence getDisplayName ()
```

Returns the human-readable name of the virtual device, if defined, which is suitable to be
shown in UI.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/CharSequence` | This value may be `null`. <br /> |

### 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 device (optionally) provided during its creation.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | This value may be `null`. <br /> |

### getPersistentDeviceId

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String getPersistentDeviceId ()
```

Returns the persistent identifier of this virtual device, if any.

If there is no stable identifier for this virtual device, then this returns `null`.

This identifier may correspond to a physical device. In that case it remains valid for as
long as that physical device is associated with the host device and may be used to persist
data per device.

This identifier may not be unique across virtual devices, in case there are
more than one virtual devices corresponding to the same physical device.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | <br /> |

### hasCustomSensorSupport

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean hasCustomSensorSupport ()
```

Returns whether this device may have custom sensors.

Returning `true` does not necessarily mean that this device has sensors, it only
means that a `https://developer.android.com/reference/android/hardware/SensorManager` instance created from a `https://developer.android.com/reference/android/content/Context`
associated with this device will return this device's sensors, if any.

<br />

<br />

| Returns ||
|---|---|
| `boolean` | <br /> |

**See also:**

- `https://developer.android.com/reference/android/content/Context#getDeviceId()`
- `https://developer.android.com/reference/android/content/Context#createDeviceContext(int)`

### 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.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | This value cannot be `null`. <br /> |

### 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.

<br />

| Parameters ||
|---|---|
| `dest` | `Parcel`: This value cannot be `null`. <br /> |
| `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` |