PixelCopy.Result

Kotlin |Java

public static final class PixelCopy.Result
extends Object

java.lang.Object
↳	android.view.PixelCopy.Result

Contains the result of a PixelCopy request

Summary

Public methods
`Bitmap`	`getBitmap()` If the PixelCopy `Request` was given a destination bitmap with `PixelCopy.Request.Builder.setDestinationBitmap(Bitmap)` then the returned bitmap will be the same as the one given.
`int`	`getStatus()` Returns the status of the copy request.

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.

Public methods

getBitmap

Added in API level 34

public Bitmap getBitmap ()

If the PixelCopy Request was given a destination bitmap with PixelCopy.Request.Builder.setDestinationBitmap(Bitmap) then the returned bitmap will be the same as the one given. If no destination bitmap was provided, then this will contain the automatically allocated Bitmap to hold the result.

Returns
`Bitmap`	the Bitmap the copy request was stored in. This value cannot be `null`.

Throws
`IllegalStateException`	if `getStatus()` is not SUCCESS

getStatus

Added in API level 34

public int getStatus ()

Returns the status of the copy request.

Returns
`int`	Value is `PixelCopy.SUCCESS`, `PixelCopy.ERROR_UNKNOWN`, `PixelCopy.ERROR_TIMEOUT`, `PixelCopy.ERROR_SOURCE_NO_DATA`, `PixelCopy.ERROR_SOURCE_INVALID`, or `PixelCopy.ERROR_DESTINATION_INVALID`