# WallpaperInstance Added in[API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary:[Inherited Constants](https://developer.android.com/reference/android/app/wallpaper/WallpaperInstance#inhconstants)\|[Fields](https://developer.android.com/reference/android/app/wallpaper/WallpaperInstance#lfields)\|[Ctors](https://developer.android.com/reference/android/app/wallpaper/WallpaperInstance#pubctors)\|[Methods](https://developer.android.com/reference/android/app/wallpaper/WallpaperInstance#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/android/app/wallpaper/WallpaperInstance#inhmethods) # WallpaperInstance *** ** * ** *** [Kotlin](https://developer.android.com/reference/kotlin/android/app/wallpaper/WallpaperInstance "View this page in Kotlin")\|Java ` public final class WallpaperInstance ` ` extends `[Object](https://developer.android.com/reference/java/lang/Object)` `` implements `[Parcelable](https://developer.android.com/reference/android/os/Parcelable)` ` |---|-----------------------------------------| | [java.lang.Object](https://developer.android.com/reference/java/lang/Object) || | ↳ | android.app.wallpaper.WallpaperInstance |
*** ** * ** *** Describes a wallpaper that has been set as a current wallpaper. This class is used by[WallpaperManager](https://developer.android.com/reference/android/app/WallpaperManager)to store information about a wallpaper that is currently in use. Because it has been set as an active wallpaper it offers some guarantees that[WallpaperDescription](https://developer.android.com/reference/android/app/wallpaper/WallpaperDescription)does not: - It contains the[WallpaperInfo](https://developer.android.com/reference/android/app/WallpaperInfo)corresponding to the[ComponentName](https://developer.android.com/reference/android/content/ComponentName) specified in the description - [getId()](https://developer.android.com/reference/android/app/wallpaper/WallpaperInstance#getId())is guaranteed to be non-null

## Summary | ### Inherited constants | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | From interface[android.os.Parcelable](https://developer.android.com/reference/android/os/Parcelable) |-------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `int` | [CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR) Descriptor bit used with[describeContents()](https://developer.android.com/reference/android/os/Parcelable#describeContents()): indicates that the Parcelable object's flattened representation includes a file descriptor. | | `int` | [PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE) Flag for use with[writeToParcel(Parcel, int)](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 `[Creator](https://developer.android.com/reference/android/os/Parcelable.Creator)`<`[WallpaperInstance](https://developer.android.com/reference/android/app/wallpaper/WallpaperInstance)`>` | [CREATOR](https://developer.android.com/reference/android/app/wallpaper/WallpaperInstance#CREATOR)
| | ### Public constructors || |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---| | ` `[WallpaperInstance](https://developer.android.com/reference/android/app/wallpaper/WallpaperInstance#WallpaperInstance(android.app.WallpaperInfo,%20android.app.wallpaper.WallpaperDescription))`(`[WallpaperInfo](https://developer.android.com/reference/android/app/WallpaperInfo)` info, `[WallpaperDescription](https://developer.android.com/reference/android/app/wallpaper/WallpaperDescription)` description) ` Create a WallpaperInstance for the wallpaper given by[WallpaperDescription](https://developer.android.com/reference/android/app/wallpaper/WallpaperDescription). | | ### Public methods || |---------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` int` | ` `[describeContents](https://developer.android.com/reference/android/app/wallpaper/WallpaperInstance#describeContents())`() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. | | ` boolean` | ` `[equals](https://developer.android.com/reference/android/app/wallpaper/WallpaperInstance#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` o) ` Indicates whether some other object is "equal to" this one. | | ` `[WallpaperDescription](https://developer.android.com/reference/android/app/wallpaper/WallpaperDescription) | ` `[getDescription](https://developer.android.com/reference/android/app/wallpaper/WallpaperInstance#getDescription())`() ` | | ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[getId](https://developer.android.com/reference/android/app/wallpaper/WallpaperInstance#getId())`() ` See[WallpaperDescription.Builder.getId()](https://developer.android.com/reference/android/app/wallpaper/WallpaperDescription#getId())for rules about id uniqueness. | | ` `[WallpaperInfo](https://developer.android.com/reference/android/app/WallpaperInfo) | ` `[getInfo](https://developer.android.com/reference/android/app/wallpaper/WallpaperInstance#getInfo())`() ` | | ` int` | ` `[hashCode](https://developer.android.com/reference/android/app/wallpaper/WallpaperInstance#hashCode())`() ` Returns a hash code value for the object. | | ` void` | ` `[writeToParcel](https://developer.android.com/reference/android/app/wallpaper/WallpaperInstance#writeToParcel(android.os.Parcel,%20int))`(`[Parcel](https://developer.android.com/reference/android/os/Parcel)` dest, int flags) ` Flatten this object in to a Parcel. | | ### Inherited methods | |-----------------------|---| | From class` `[java.lang.Object](https://developer.android.com/reference/java/lang/Object)` ` |--------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](https://developer.android.com/reference/java/lang/Object) | ` `[clone](https://developer.android.com/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object. | | ` boolean` | ` `[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` `[finalize](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 `[Class](https://developer.android.com/reference/java/lang/Class)`` | ` `[getClass](https://developer.android.com/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this`Object`. | | ` int` | ` `[hashCode](https://developer.android.com/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object. | | ` final void` | ` `[notify](https://developer.android.com/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` `[notifyAll](https://developer.android.com/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor. | | ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[toString](https://developer.android.com/reference/java/lang/Object#toString())`() ` Returns a string representation of the object. | | ` final void` | ` `[wait](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` | ` `[wait](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` | ` `[wait](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` `[android.os.Parcelable](https://developer.android.com/reference/android/os/Parcelable)` ` |------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` abstract int` | ` `[describeContents](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` | ` `[writeToParcel](https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int))`(`[Parcel](https://developer.android.com/reference/android/os/Parcel)` dest, int flags) ` Flatten this object in to a Parcel. | || ## Fields ### CREATOR Added in[API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public static final Creator CREATOR ```

## Public constructors ### WallpaperInstance Added in[API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public WallpaperInstance (WallpaperInfo info, WallpaperDescription description) ``` Create a WallpaperInstance for the wallpaper given by[WallpaperDescription](https://developer.android.com/reference/android/app/wallpaper/WallpaperDescription).
| Parameters || |---------------|---------------------------------------------------------------------------------------| | `info` | `WallpaperInfo`: the live wallpaper info for this wallpaper, or null if static
| | `description` | `WallpaperDescription`: description of the wallpaper for this instance
| ## Public methods ### describeContents Added in[API level 36](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[writeToParcel(android.os.Parcel, int)](https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)), the return value of this method must include the[CONTENTS_FILE_DESCRIPTOR](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[CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR)
| ### equals Added in[API level 36](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.
| ### getDescription Added in[API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public WallpaperDescription getDescription () ```

| Returns || |------------------------------------------------------------------------------------------------------------|-------------------------------------------| | [WallpaperDescription](https://developer.android.com/reference/android/app/wallpaper/WallpaperDescription) | the description for this wallpaper
| ### getId Added in[API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public String getId () ``` See[WallpaperDescription.Builder.getId()](https://developer.android.com/reference/android/app/wallpaper/WallpaperDescription#getId())for rules about id uniqueness.
| Returns || |--------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------| | [String](https://developer.android.com/reference/java/lang/String) | the ID of the wallpaper instance if given by the wallpaper description, otherwise a default value
| ### getInfo Added in[API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public WallpaperInfo getInfo () ```

| Returns || |------------------------------------------------------------------------------------|---------------------------------------------------| | [WallpaperInfo](https://developer.android.com/reference/android/app/WallpaperInfo) | the live wallpaper info, or`null`if static
| ### hashCode Added in[API level 36](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[HashMap](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[equals](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[equals](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.
| ### writeToParcel Added in[API level 36](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`: The Parcel in which the object should be written. 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](https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE). Value is either`0`or a combination of[Parcelable.PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE), and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES
|