# WallpaperInfo Added in[API level 7](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary:[XML Attrs](https://developer.android.com/reference/android/app/WallpaperInfo#lattrs)\|[Inherited Constants](https://developer.android.com/reference/android/app/WallpaperInfo#inhconstants)\|[Fields](https://developer.android.com/reference/android/app/WallpaperInfo#lfields)\|[Ctors](https://developer.android.com/reference/android/app/WallpaperInfo#pubctors)\|[Methods](https://developer.android.com/reference/android/app/WallpaperInfo#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/android/app/WallpaperInfo#inhmethods) # WallpaperInfo *** ** * ** *** [Kotlin](https://developer.android.com/reference/kotlin/android/app/WallpaperInfo "View this page in Kotlin")\|Java ` public final class WallpaperInfo ` ` 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.WallpaperInfo |
*** ** * ** *** This class is used to specify meta information of a wallpaper service. ## Summary | ### XML attributes || |---------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------| | [`android:shouldUseDefaultUnfoldTransition`](https://developer.android.com/reference/android/app/WallpaperInfo#attr_android:shouldUseDefaultUnfoldTransition) | Indicates that this wallpaper service should receive zoom transition updates when changing the structural state of the device (e.g. | | [`android:supportsMultipleDisplays`](https://developer.android.com/reference/android/app/WallpaperInfo#attr_android:supportsMultipleDisplays) | Indicates that this wallpaper service can support multiple engines to render on each surface independently. | | ### 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)`<`[WallpaperInfo](https://developer.android.com/reference/android/app/WallpaperInfo)`>` | [CREATOR](https://developer.android.com/reference/android/app/WallpaperInfo#CREATOR) Used to make this class parcelable. | | ### Public constructors || |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---| | ` `[WallpaperInfo](https://developer.android.com/reference/android/app/WallpaperInfo#WallpaperInfo(android.content.Context,%20android.content.pm.ResolveInfo))`(`[Context](https://developer.android.com/reference/android/content/Context)` context, `[ResolveInfo](https://developer.android.com/reference/android/content/pm/ResolveInfo)` service) ` Constructor. | | ### Public methods || |-------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` int` | ` `[describeContents](https://developer.android.com/reference/android/app/WallpaperInfo#describeContents())`() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. | | ` void` | ` `[dump](https://developer.android.com/reference/android/app/WallpaperInfo#dump(android.util.Printer,%20java.lang.String))`(`[Printer](https://developer.android.com/reference/android/util/Printer)` pw, `[String](https://developer.android.com/reference/java/lang/String)` prefix) ` | | ` `[ComponentName](https://developer.android.com/reference/android/content/ComponentName) | ` `[getComponent](https://developer.android.com/reference/android/app/WallpaperInfo#getComponent())`() ` Return the component of the service that implements this wallpaper. | | ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[getPackageName](https://developer.android.com/reference/android/app/WallpaperInfo#getPackageName())`() ` Return the .apk package that implements this wallpaper. | | ` `[ServiceInfo](https://developer.android.com/reference/android/content/pm/ServiceInfo) | ` `[getServiceInfo](https://developer.android.com/reference/android/app/WallpaperInfo#getServiceInfo())`() ` Return the raw information about the Service implementing this wallpaper. | | ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[getServiceName](https://developer.android.com/reference/android/app/WallpaperInfo#getServiceName())`() ` Return the class name of the service component that implements this wallpaper. | | ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[getSettingsActivity](https://developer.android.com/reference/android/app/WallpaperInfo#getSettingsActivity())`() ` Return the class name of an activity that provides a settings UI for the wallpaper. | | ` `[Uri](https://developer.android.com/reference/android/net/Uri) | ` `[getSettingsSliceUri](https://developer.android.com/reference/android/app/WallpaperInfo#getSettingsSliceUri())`() ` Returns an URI that provides a settings[Slice](https://developer.android.com/reference/android/app/slice/Slice)for this wallpaper. | | ` boolean` | ` `[getShowMetadataInPreview](https://developer.android.com/reference/android/app/WallpaperInfo#getShowMetadataInPreview())`() ` Queries whether any metadata should be shown when previewing the wallpaper. | | ` `[CharSequence](https://developer.android.com/reference/java/lang/CharSequence) | ` `[loadAuthor](https://developer.android.com/reference/android/app/WallpaperInfo#loadAuthor(android.content.pm.PackageManager))`(`[PackageManager](https://developer.android.com/reference/android/content/pm/PackageManager)` pm) ` Return a string indicating the author(s) of this wallpaper. | | ` `[CharSequence](https://developer.android.com/reference/java/lang/CharSequence) | ` `[loadContextDescription](https://developer.android.com/reference/android/app/WallpaperInfo#loadContextDescription(android.content.pm.PackageManager))`(`[PackageManager](https://developer.android.com/reference/android/content/pm/PackageManager)` pm) ` Retrieves a title of the URI that specifies a link for further context about this wallpaper. | | ` `[Uri](https://developer.android.com/reference/android/net/Uri) | ` `[loadContextUri](https://developer.android.com/reference/android/app/WallpaperInfo#loadContextUri(android.content.pm.PackageManager))`(`[PackageManager](https://developer.android.com/reference/android/content/pm/PackageManager)` pm) ` Returns an URI that specifies a link for further context about this wallpaper. | | ` `[CharSequence](https://developer.android.com/reference/java/lang/CharSequence) | ` `[loadDescription](https://developer.android.com/reference/android/app/WallpaperInfo#loadDescription(android.content.pm.PackageManager))`(`[PackageManager](https://developer.android.com/reference/android/content/pm/PackageManager)` pm) ` Return a brief summary of this wallpaper's behavior. | | ` `[Drawable](https://developer.android.com/reference/android/graphics/drawable/Drawable) | ` `[loadIcon](https://developer.android.com/reference/android/app/WallpaperInfo#loadIcon(android.content.pm.PackageManager))`(`[PackageManager](https://developer.android.com/reference/android/content/pm/PackageManager)` pm) ` Load the user-displayed icon for this wallpaper. | | ` `[CharSequence](https://developer.android.com/reference/java/lang/CharSequence) | ` `[loadLabel](https://developer.android.com/reference/android/app/WallpaperInfo#loadLabel(android.content.pm.PackageManager))`(`[PackageManager](https://developer.android.com/reference/android/content/pm/PackageManager)` pm) ` Load the user-displayed label for this wallpaper. | | ` `[Drawable](https://developer.android.com/reference/android/graphics/drawable/Drawable) | ` `[loadThumbnail](https://developer.android.com/reference/android/app/WallpaperInfo#loadThumbnail(android.content.pm.PackageManager))`(`[PackageManager](https://developer.android.com/reference/android/content/pm/PackageManager)` pm) ` Load the thumbnail image for this wallpaper. | | ` boolean` | ` `[shouldUseDefaultUnfoldTransition](https://developer.android.com/reference/android/app/WallpaperInfo#shouldUseDefaultUnfoldTransition())`() ` Returns whether this wallpaper should receive default zooming updates when the device changes its state (e.g. when folding or unfolding a foldable device). | | ` boolean` | ` `[supportsMultipleDisplays](https://developer.android.com/reference/android/app/WallpaperInfo#supportsMultipleDisplays())`() ` Returns whether this wallpaper service can support multiple engines to render on each surface independently. | | ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[toString](https://developer.android.com/reference/android/app/WallpaperInfo#toString())`() ` Returns a string representation of the object. | | ` void` | ` `[writeToParcel](https://developer.android.com/reference/android/app/WallpaperInfo#writeToParcel(android.os.Parcel,%20int))`(`[Parcel](https://developer.android.com/reference/android/os/Parcel)` dest, int flags) ` Used to package this object into a[Parcel](https://developer.android.com/reference/android/os/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. | || ## XML attributes ### android:shouldUseDefaultUnfoldTransition Indicates that this wallpaper service should receive zoom transition updates when changing the structural state of the device (e.g. when folding or unfolding a foldable device). When this value is set to true[WallpaperService.Engine](https://developer.android.com/reference/android/service/wallpaper/WallpaperService.Engine)could receive zoom updates before or after changing the device state. Wallpapers receive zoom updates using[WallpaperService.Engine.onZoomChanged(float)](https://developer.android.com/reference/android/service/wallpaper/WallpaperService.Engine#onZoomChanged(float))and zoom rendering should be handled manually. Zoom updates are delivered only when[WallpaperService.Engine](https://developer.android.com/reference/android/service/wallpaper/WallpaperService.Engine)is created and not destroyed. Default value is true. Corresponds to[WallpaperInfo.shouldUseDefaultUnfoldTransition()](https://developer.android.com/reference/android/app/WallpaperInfo#shouldUseDefaultUnfoldTransition()) May be a boolean value, such as "`true`" or "`false`".
**Related methods:** - [shouldUseDefaultUnfoldTransition()](https://developer.android.com/reference/android/app/WallpaperInfo#shouldUseDefaultUnfoldTransition()) ### android:supportsMultipleDisplays Indicates that this wallpaper service can support multiple engines to render on each surface independently. An example use case is a multi-display set-up where the wallpaper service can render surfaces to each of the connected displays. Corresponds to[WallpaperInfo.supportsMultipleDisplays()](https://developer.android.com/reference/android/app/WallpaperInfo#supportsMultipleDisplays()) May be a boolean value, such as "`true`" or "`false`".
**Related methods:** - [supportsMultipleDisplays()](https://developer.android.com/reference/android/app/WallpaperInfo#supportsMultipleDisplays()) ## Fields ### CREATOR Added in[API level 7](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public static final Creator CREATOR ``` Used to make this class parcelable.
## Public constructors ### WallpaperInfo Added in[API level 7](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public WallpaperInfo (Context context, ResolveInfo service) ``` Constructor.
| Parameters || |-----------|-----------------------------------------------------------------------------------------------------------| | `context` | `Context`: The Context in which we are parsing the wallpaper.
| | `service` | `ResolveInfo`: The ResolveInfo returned from the package manager about this wallpaper's component.
| | Throws || |---------------------------------------------------------------------------------------------------------|---| | [IOException](https://developer.android.com/reference/java/io/IOException) | | | [XmlPullParserException](https://developer.android.com/reference/org/xmlpull/v1/XmlPullParserException) | | ## Public methods ### describeContents Added in[API level 7](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)
| ### dump Added in[API level 7](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public void dump (Printer pw, String prefix) ```

| Parameters || |----------|------------------| | `pw` | `Printer`
| | `prefix` | `String`
| ### getComponent Added in[API level 7](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public ComponentName getComponent () ``` Return the component of the service that implements this wallpaper.
| Returns || |----------------------------------------------------------------------------------------|--------| | [ComponentName](https://developer.android.com/reference/android/content/ComponentName) |
| ### getPackageName Added in[API level 7](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public String getPackageName () ``` Return the .apk package that implements this wallpaper.
| Returns || |--------------------------------------------------------------------|--------| | [String](https://developer.android.com/reference/java/lang/String) |
| ### getServiceInfo Added in[API level 7](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public ServiceInfo getServiceInfo () ``` Return the raw information about the Service implementing this wallpaper. Do not modify the returned object.
| Returns || |---------------------------------------------------------------------------------------|--------| | [ServiceInfo](https://developer.android.com/reference/android/content/pm/ServiceInfo) |
| ### getServiceName Added in[API level 7](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public String getServiceName () ``` Return the class name of the service component that implements this wallpaper.
| Returns || |--------------------------------------------------------------------|--------| | [String](https://developer.android.com/reference/java/lang/String) |
| ### getSettingsActivity Added in[API level 7](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public String getSettingsActivity () ``` Return the class name of an activity that provides a settings UI for the wallpaper. You can launch this activity be starting it with an[Intent](https://developer.android.com/reference/android/content/Intent)whose action is MAIN and with an explicit[ComponentName](https://developer.android.com/reference/android/content/ComponentName)composed of[getPackageName()](https://developer.android.com/reference/android/app/WallpaperInfo#getPackageName())and the class name returned here. `null`will be returned if there is no settings activity associated with the wallpaper.
| Returns || |--------------------------------------------------------------------|--------| | [String](https://developer.android.com/reference/java/lang/String) |
| ### getSettingsSliceUri Added in[API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public Uri getSettingsSliceUri () ``` Returns an URI that provides a settings[Slice](https://developer.android.com/reference/android/app/slice/Slice)for this wallpaper. The wallpaper should implement a SliceProvider associated with this URI. The system will display the Slice in the customization section while previewing the live wallpaper. Because this URI is accessible to other apps, it is recommended to protect it with the android.permission.BIND_WALLPAPER permission. `null`will be returned if there is no settings Slice URI associated with the wallpaper.
| Returns || |----------------------------------------------------------------|-----------------| | [Uri](https://developer.android.com/reference/android/net/Uri) | The URI.
| ### getShowMetadataInPreview Added in[API level 25](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public boolean getShowMetadataInPreview () ``` Queries whether any metadata should be shown when previewing the wallpaper. If this value is set to true, any component that shows a preview of this live wallpaper should also show accompanying information like[loadLabel(PackageManager)](https://developer.android.com/reference/android/app/WallpaperInfo#loadLabel(android.content.pm.PackageManager)),[loadDescription(PackageManager)](https://developer.android.com/reference/android/app/WallpaperInfo#loadDescription(android.content.pm.PackageManager)),[loadAuthor(PackageManager)](https://developer.android.com/reference/android/app/WallpaperInfo#loadAuthor(android.content.pm.PackageManager))and[loadContextDescription(android.content.pm.PackageManager)](https://developer.android.com/reference/android/app/WallpaperInfo#loadContextDescription(android.content.pm.PackageManager)), so the user gets to know further information about this wallpaper.
| Returns || |-----------|----------------------------------------------------------------------------| | `boolean` | Whether any metadata should be shown when previewing the wallpaper.
| ### loadAuthor Added in[API level 7](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public CharSequence loadAuthor (PackageManager pm) ``` Return a string indicating the author(s) of this wallpaper.
| Parameters || |------|-------------------------| | `pm` | `PackageManager`
| | Returns || |--------------------------------------------------------------------------------|--------| | [CharSequence](https://developer.android.com/reference/java/lang/CharSequence) |
| | Throws || |------------------------------------------------------------------------------------------------------------------------|---| | [Resources.NotFoundException](https://developer.android.com/reference/android/content/res/Resources.NotFoundException) | | ### loadContextDescription Added in[API level 25](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public CharSequence loadContextDescription (PackageManager pm) ``` Retrieves a title of the URI that specifies a link for further context about this wallpaper.
| Parameters || |------|----------------------------------------------------------------------------------------------------------------------------------------------------------| | `pm` | `PackageManager`: An instance of[PackageManager](https://developer.android.com/reference/android/content/pm/PackageManager)to retrieve the title.
| | Returns || |--------------------------------------------------------------------------------|-------------------| | [CharSequence](https://developer.android.com/reference/java/lang/CharSequence) | The title.
| | Throws || |------------------------------------------------------------------------------------------------------------------------|---| | [Resources.NotFoundException](https://developer.android.com/reference/android/content/res/Resources.NotFoundException) | | ### loadContextUri Added in[API level 25](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public Uri loadContextUri (PackageManager pm) ``` Returns an URI that specifies a link for further context about this wallpaper.
| Parameters || |------|--------------------------------------------------------------------------------------------------------------------------------------------------------| | `pm` | `PackageManager`: An instance of[PackageManager](https://developer.android.com/reference/android/content/pm/PackageManager)to retrieve the URI.
| | Returns || |----------------------------------------------------------------|-----------------| | [Uri](https://developer.android.com/reference/android/net/Uri) | The URI.
| | Throws || |------------------------------------------------------------------------------------------------------------------------|---| | [Resources.NotFoundException](https://developer.android.com/reference/android/content/res/Resources.NotFoundException) | | ### loadDescription Added in[API level 7](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public CharSequence loadDescription (PackageManager pm) ``` Return a brief summary of this wallpaper's behavior.
| Parameters || |------|-------------------------| | `pm` | `PackageManager`
| | Returns || |--------------------------------------------------------------------------------|--------| | [CharSequence](https://developer.android.com/reference/java/lang/CharSequence) |
| | Throws || |------------------------------------------------------------------------------------------------------------------------|---| | [Resources.NotFoundException](https://developer.android.com/reference/android/content/res/Resources.NotFoundException) | | ### loadIcon Added in[API level 7](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public Drawable loadIcon (PackageManager pm) ``` Load the user-displayed icon for this wallpaper.
| Parameters || |------|------------------------------------------------------------------------------------------| | `pm` | `PackageManager`: Supply a PackageManager used to load the wallpaper's resources.
| | Returns || |----------------------------------------------------------------------------------------|--------| | [Drawable](https://developer.android.com/reference/android/graphics/drawable/Drawable) |
| ### loadLabel Added in[API level 7](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public CharSequence loadLabel (PackageManager pm) ``` Load the user-displayed label for this wallpaper.
| Parameters || |------|------------------------------------------------------------------------------------------| | `pm` | `PackageManager`: Supply a PackageManager used to load the wallpaper's resources.
| | Returns || |--------------------------------------------------------------------------------|--------| | [CharSequence](https://developer.android.com/reference/java/lang/CharSequence) |
| ### loadThumbnail Added in[API level 7](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public Drawable loadThumbnail (PackageManager pm) ``` Load the thumbnail image for this wallpaper.
| Parameters || |------|------------------------------------------------------------------------------------------| | `pm` | `PackageManager`: Supply a PackageManager used to load the wallpaper's resources.
| | Returns || |----------------------------------------------------------------------------------------|--------| | [Drawable](https://developer.android.com/reference/android/graphics/drawable/Drawable) |
| ### shouldUseDefaultUnfoldTransition Added in[API level 32](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public boolean shouldUseDefaultUnfoldTransition () ``` Returns whether this wallpaper should receive default zooming updates when the device changes its state (e.g. when folding or unfolding a foldable device). If set to false the wallpaper will not receive zoom events when changing the device state, so it can implement its own transition instead. This corresponds to the value[R.styleable.Wallpaper_shouldUseDefaultUnfoldTransition](https://developer.android.com/reference/android/R.styleable#Wallpaper_shouldUseDefaultUnfoldTransition)in the XML description of the wallpaper. The default value is`true`.
**Related XML Attributes:** - [android:shouldUseDefaultUnfoldTransition](https://developer.android.com/reference/android/app/WallpaperInfo#attr_android:shouldUseDefaultUnfoldTransition) | Returns || |-----------|-----------------------------------------------------------------------------------------| | `boolean` | `true`if wallpaper should receive default device state change transition updates
| **See also:** - [R.styleable.Wallpaper_shouldUseDefaultUnfoldTransition](https://developer.android.com/reference/android/R.styleable#Wallpaper_shouldUseDefaultUnfoldTransition) ### supportsMultipleDisplays Added in[API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public boolean supportsMultipleDisplays () ``` Returns whether this wallpaper service can support multiple engines to render on each surface independently. An example use case is a multi-display set-up where the wallpaper service can render surfaces to each of the connected displays. This corresponds to the value[R.styleable.Wallpaper_supportsMultipleDisplays](https://developer.android.com/reference/android/R.styleable#Wallpaper_supportsMultipleDisplays)in the XML description of the wallpaper. The default value is`false`.
**Related XML Attributes:** - [android:supportsMultipleDisplays](https://developer.android.com/reference/android/app/WallpaperInfo#attr_android:supportsMultipleDisplays) | Returns || |-----------|----------------------------------------------------------------------------| | `boolean` | `true`if multiple engines can render independently on each surface.
| **See also:** - [WallpaperService.onCreateEngine()](https://developer.android.com/reference/android/service/wallpaper/WallpaperService#onCreateEngine()) - [WallpaperService.Engine.onCreate(SurfaceHolder)](https://developer.android.com/reference/android/service/wallpaper/WallpaperService.Engine#onCreate(android.view.SurfaceHolder)) ### toString Added in[API level 7](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public String toString () ``` Returns a string representation of the object.
| Returns || |--------------------------------------------------------------------|-----------------------------------------------| | [String](https://developer.android.com/reference/java/lang/String) | a string representation of the object.
| ### writeToParcel Added in[API level 7](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public void writeToParcel (Parcel dest, int flags) ``` Used to package this object into a[Parcel](https://developer.android.com/reference/android/os/Parcel).
| Parameters || |---------|-------------------------------------------------------------------------------------------------------| | `dest` | `Parcel`: The[Parcel](https://developer.android.com/reference/android/os/Parcel)to be written.
| | `flags` | `int`: The flags used for parceling.
|