Stay organized with collections
Save and categorize content based on your preferences.
PixelCopy.Result
public
static
final
class
PixelCopy.Result
extends Object
Contains the result of a PixelCopy request
Summary
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
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. |
getStatus
public int getStatus ()
Returns the status of the copy request.
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[],null,["# PixelCopy.Result\n\nAdded in [API level 34](/guide/topics/manifest/uses-sdk-element#ApiLevels) \nSummary: [Methods](#pubmethods) \\| [Inherited Methods](#inhmethods) \n\nPixelCopy.Result\n================\n\n*** ** * ** ***\n\n[Kotlin](/reference/kotlin/android/view/PixelCopy.Result \"View this page in Kotlin\") \\|Java\n\n\n`\npublic\nstatic\nfinal\n\nclass\nPixelCopy.Result\n`\n\n\n`\n\nextends `[Object](/reference/java/lang/Object)`\n\n\n`\n\n`\n\n\n`\n\n|---|-------------------------------|\n| [java.lang.Object](/reference/java/lang/Object) ||\n| ↳ | android.view.PixelCopy.Result |\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nContains the result of a PixelCopy request\n\nSummary\n-------\n\n| ### Public methods ||\n|-------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ` `[Bitmap](/reference/android/graphics/Bitmap) | ` `[getBitmap](/reference/android/view/PixelCopy.Result#getBitmap())`() ` If the PixelCopy [Request](/reference/android/view/PixelCopy.Request) was given a destination bitmap with [PixelCopy.Request.Builder.setDestinationBitmap(Bitmap)](/reference/android/view/PixelCopy.Request.Builder#setDestinationBitmap(android.graphics.Bitmap)) then the returned bitmap will be the same as the one given. |\n| ` int` | ` `[getStatus](/reference/android/view/PixelCopy.Result#getStatus())`() ` Returns the status of the copy request. |\n\n| ### Inherited methods |\n|-----------------------|---|\n| From class ` `[java.lang.Object](/reference/java/lang/Object)` ` |---------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](/reference/java/lang/Object) | ` `[clone](/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object. | | ` boolean` | ` `[equals](/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](/reference/java/lang/Object)` obj) ` Indicates whether some other object is \"equal to\" this one. | | ` void` | ` `[finalize](/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 `[Class](/reference/java/lang/Class)`\u003c?\u003e` | ` `[getClass](/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this `Object`. | | ` int` | ` `[hashCode](/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object. | | ` final void` | ` `[notify](/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` `[notifyAll](/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor. | | ` `[String](/reference/java/lang/String) | ` `[toString](/reference/java/lang/Object#toString())`() ` Returns a string representation of the object. | | ` final void` | ` `[wait](/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` | ` `[wait](/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` | ` `[wait](/reference/java/lang/Object#wait())`() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. | ||\n\nPublic methods\n--------------\n\n### getBitmap\n\nAdded in [API level 34](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic Bitmap getBitmap ()\n```\n\nIf the PixelCopy [Request](/reference/android/view/PixelCopy.Request) was given a destination bitmap with\n[PixelCopy.Request.Builder.setDestinationBitmap(Bitmap)](/reference/android/view/PixelCopy.Request.Builder#setDestinationBitmap(android.graphics.Bitmap)) then the returned bitmap will be\nthe same as the one given. If no destination bitmap was provided, then this\nwill contain the automatically allocated Bitmap to hold the result.\n\n\u003cbr /\u003e\n\n| Returns ||\n|----------------------------------------------|--------------------------------------------------------------------------------|\n| [Bitmap](/reference/android/graphics/Bitmap) | the Bitmap the copy request was stored in. This value cannot be `null`. \u003cbr /\u003e |\n\n| Throws ||\n|---------------------------------------------------------------------|---------------------------------------------------------------------------------------|\n| [IllegalStateException](/reference/java/lang/IllegalStateException) | if [getStatus()](/reference/android/view/PixelCopy.Result#getStatus()) is not SUCCESS |\n\n### getStatus\n\nAdded in [API level 34](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic int getStatus ()\n```\n\nReturns the status of the copy request.\n\n\u003cbr /\u003e\n\n| Returns ||\n|-------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `int` | Value is [PixelCopy.SUCCESS](/reference/android/view/PixelCopy#SUCCESS), [PixelCopy.ERROR_UNKNOWN](/reference/android/view/PixelCopy#ERROR_UNKNOWN), [PixelCopy.ERROR_TIMEOUT](/reference/android/view/PixelCopy#ERROR_TIMEOUT), [PixelCopy.ERROR_SOURCE_NO_DATA](/reference/android/view/PixelCopy#ERROR_SOURCE_NO_DATA), [PixelCopy.ERROR_SOURCE_INVALID](/reference/android/view/PixelCopy#ERROR_SOURCE_INVALID), or [PixelCopy.ERROR_DESTINATION_INVALID](/reference/android/view/PixelCopy#ERROR_DESTINATION_INVALID) \u003cbr /\u003e |"]]
