Added in API level 34

Summary: Inherited Constants | Fields | Methods | Inherited Methods

VirtualDevice

Kotlin |Java

public final class VirtualDevice
extends Object implements Parcelable

java.lang.Object
↳	android.companion.virtual.VirtualDevice

Details of a particular virtual device.

Read-only device representation exposing the properties of an existing virtual device.

Summary

Inherited constants

From interface android.os.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(Parcel, int)`: 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 Creator<VirtualDevice>`	`CREATOR`

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`int`	`getDeviceId()` Returns the unique ID of the virtual device.
`int[]`	`getDisplayIds()` Returns the IDs of all virtual displays that belong to this device, if any.
`CharSequence`	`getDisplayName()` Returns the human-readable name of the virtual device, if defined, which is suitable to be shown in UI.
`String`	`getName()` Returns the name of the virtual device (optionally) provided during its creation.
`String`	`getPersistentDeviceId()` Returns the persistent identifier of this virtual device, if any.
`boolean`	`hasCustomSensorSupport()` Returns whether this device may have custom sensors.
`String`	`toString()` Returns a string representation of the object.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(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`	`wait(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`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 34

public static final Creator<VirtualDevice> CREATOR

Public methods

describeContents

Added in API level 34

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 writeToParcel(android.os.Parcel, int), the return value of this method must include the 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 `CONTENTS_FILE_DESCRIPTOR`

getDeviceId

Added in API level 34

public int getDeviceId ()

Returns the unique ID of the virtual device.

This identifier corresponds to 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.

Returns
`int`

See also:

Context.createDeviceContext(int)

getDisplayIds

Added in API level 35

public int[] getDisplayIds ()

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

The actual Display objects can be obtained by passing the returned IDs to DisplayManager.getDisplay(int).

Returns
`int[]`	This value cannot be `null`.

getDisplayName

Added in API level 35

public CharSequence getDisplayName ()

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

Returns
`CharSequence`	This value may be `null`.

getName

Added in API level 34

public String getName ()

Returns the name of the virtual device (optionally) provided during its creation.

Returns
`String`	This value may be `null`.

getPersistentDeviceId

Added in API level 35

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.

Returns
`String`

hasCustomSensorSupport

Added in API level 35

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 SensorManager instance created from a Context associated with this device will return this device's sensors, if any.

Returns
`boolean`

See also:

toString

Added in API level 34

public String toString ()

Returns a string representation of the object.

Returns
`String`	This value cannot be `null`.

writeToParcel

Added in API level 34

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 `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES