WallpaperManager

ACTION_CHANGE_LIVE_WALLPAPER

String ACTION_CHANGE_LIVE_WALLPAPER

Directly launch live wallpaper preview, allowing the user to immediately confirm to switch to a specific live wallpaper. You must specify EXTRA_LIVE_WALLPAPER_COMPONENT with the ComponentName of a live wallpaper component that is to be shown.

Constant Value: "android.service.wallpaper.CHANGE_LIVE_WALLPAPER"

ACTION_CROP_AND_SET_WALLPAPER

String ACTION_CROP_AND_SET_WALLPAPER

Activity Action: Show settings for choosing wallpaper. Do not use directly to construct an intent; instead, use getCropAndSetWallpaperIntent(Uri).

Input: getData() is the URI of the image to crop and set as wallpaper.

Output: RESULT_OK if user decided to crop/set the wallpaper, RESULT_CANCEL otherwise Activities that support this intent should specify a MIME filter of "image/*"

Constant Value: "android.service.wallpaper.CROP_AND_SET_WALLPAPER"

ACTION_LIVE_WALLPAPER_CHOOSER

String ACTION_LIVE_WALLPAPER_CHOOSER

Launch an activity for the user to pick the current global live wallpaper.

Constant Value: "android.service.wallpaper.LIVE_WALLPAPER_CHOOSER"

COMMAND_DROP

String COMMAND_DROP

Command for sendWallpaperCommand(IBinder, String, int, int, int, Bundle): reported by the wallpaper host when the user drops an object into an area of the host. The x and y arguments are the location of the drop.

Constant Value: "android.home.drop"

COMMAND_SECONDARY_TAP

String COMMAND_SECONDARY_TAP

Command for sendWallpaperCommand(IBinder, String, int, int, int, Bundle): reported by the wallpaper host when the user releases a secondary pointer on an empty area (not performing an action in the host). The x and y arguments are the location of the secondary tap in screen coordinates.

Constant Value: "android.wallpaper.secondaryTap"

COMMAND_TAP

String COMMAND_TAP

Command for sendWallpaperCommand(IBinder, String, int, int, int, Bundle): reported by the wallpaper host when the user taps on an empty area (not performing an action in the host). The x and y arguments are the location of the tap in screen coordinates.

Constant Value: "android.wallpaper.tap"

EXTRA_LIVE_WALLPAPER_COMPONENT

String EXTRA_LIVE_WALLPAPER_COMPONENT

Extra in ACTION_CHANGE_LIVE_WALLPAPER that specifies the ComponentName of a live wallpaper that should be shown as a preview, for the user to confirm.

Constant Value: "android.service.wallpaper.extra.LIVE_WALLPAPER_COMPONENT"

FLAG_LOCK

int FLAG_LOCK

Flag: set or retrieve the lock-screen-specific wallpaper.

Constant Value: 2 (0x00000002)

FLAG_SYSTEM

int FLAG_SYSTEM

Flag: set or retrieve the general system wallpaper.

Constant Value: 1 (0x00000001)

WALLPAPER_PREVIEW_META_DATA

String WALLPAPER_PREVIEW_META_DATA

Manifest entry for activities that respond to ACTION_SET_WALLPAPER which allows them to provide a custom large icon associated with this action.

Constant Value: "android.wallpaper.preview"

clear

void clear (int which)

Remove one or more currently set wallpapers, reverting to the system default display for each one. If FLAG_SYSTEM is set in the which parameter, the intent ACTION_WALLPAPER_CHANGED will be broadcast upon success.

clear

void clear ()

Remove any currently set system wallpaper, reverting to the system's built-in wallpaper. On success, the intent ACTION_WALLPAPER_CHANGED is broadcast.

This method requires the caller to hold the permission SET_WALLPAPER.

clearWallpaperOffsets

void clearWallpaperOffsets (IBinder windowToken)

Clear the offsets previously associated with this window through setWallpaperOffsets(IBinder, float, float). This reverts the window to its default state, where it does not cause the wallpaper to scroll from whatever its last offsets were.

forgetLoadedWallpaper

void forgetLoadedWallpaper ()

Remove all internal references to the last loaded wallpaper. Useful for apps that want to reduce memory usage when they only temporarily need to have the wallpaper. After calling, the next request for the wallpaper will require reloading it again from disk.

getBuiltInDrawable

Drawable getBuiltInDrawable (int outWidth, 
                int outHeight, 
                boolean scaleToFit, 
                float horizontalAlignment, 
                float verticalAlignment, 
                int which)

Returns a drawable for the built-in static wallpaper of the specified type. Based on the parameters, the drawable can be cropped and scaled.

getBuiltInDrawable

Drawable getBuiltInDrawable (int which)

Obtain a drawable for the specified built-in static system wallpaper.

getBuiltInDrawable

Drawable getBuiltInDrawable (int outWidth, 
                int outHeight, 
                boolean scaleToFit, 
                float horizontalAlignment, 
                float verticalAlignment)

Returns a drawable for the system built-in static wallpaper. Based on the parameters, the drawable can be cropped and scaled

getBuiltInDrawable

Drawable getBuiltInDrawable ()

Obtain a drawable for the built-in static system wallpaper.

getCropAndSetWallpaperIntent

Intent getCropAndSetWallpaperIntent (Uri imageUri)

Gets an Intent that will launch an activity that crops the given image and sets the device's wallpaper. If there is a default HOME activity that supports cropping wallpapers, it will be preferred as the default. Use this method instead of directly creating a ACTION_CROP_AND_SET_WALLPAPER intent.

getDesiredMinimumHeight

int getDesiredMinimumHeight ()

Returns the desired minimum height for the wallpaper. Callers of setBitmap(android.graphics.Bitmap) or setStream(java.io.InputStream) should check this value beforehand to make sure the supplied wallpaper respects the desired minimum height. If the returned value is <= 0, the caller should use the height of the default display instead.

getDesiredMinimumWidth

int getDesiredMinimumWidth ()

Returns the desired minimum width for the wallpaper. Callers of setBitmap(android.graphics.Bitmap) or setStream(java.io.InputStream) should check this value beforehand to make sure the supplied wallpaper respects the desired minimum width. If the returned value is <= 0, the caller should use the width of the default display instead.

getDrawable

Drawable getDrawable ()

Retrieve the current system wallpaper; if no wallpaper is set, the system built-in static wallpaper is returned. This is returned as an abstract Drawable that you can install in a View to display whatever wallpaper the user has currently set.

getFastDrawable

Drawable getFastDrawable ()

Like getDrawable(), but the returned Drawable has a number of limitations to reduce its overhead as much as possible. It will never scale the wallpaper (only centering it if the requested bounds do match the bitmap bounds, which should not be typical), doesn't allow setting an alpha, color filter, or other attributes, etc. The bounds of the returned drawable will be initialized to the same bounds as the wallpaper, so normally you will not need to touch it. The drawable also assumes that it will be used in a context running in the same density as the screen (not in density compatibility mode).

getInstance

WallpaperManager getInstance (Context context)

Retrieve a WallpaperManager associated with the given Context.

getWallpaperFile

ParcelFileDescriptor getWallpaperFile (int which)

Get an open, readable file descriptor to the given wallpaper image file. The caller is responsible for closing the file descriptor when done ingesting the file.

If no lock-specific wallpaper has been configured for the given user, then this method will return null when requesting FLAG_LOCK rather than returning the system wallpaper's image file.

getWallpaperId

int getWallpaperId (int which)

Get the ID of the current wallpaper of the given kind. If there is no such wallpaper configured, returns a negative number.

Every time the wallpaper image is set, a new ID is assigned to it. This method allows the caller to determine whether the wallpaper imagery has changed, regardless of how that change happened.

getWallpaperInfo

WallpaperInfo getWallpaperInfo ()

If the current wallpaper is a live wallpaper component, return the information about that wallpaper. Otherwise, if it is a static image, simply return null.

hasResourceWallpaper

boolean hasResourceWallpaper (int resid)

Return whether any users are currently set to use the wallpaper with the given resource ID. That is, their wallpaper has been set through setResource(int) with the same resource id.

isSetWallpaperAllowed

boolean isSetWallpaperAllowed ()

Returns whether the calling package is allowed to set the wallpaper for the calling user. If this function returns false, any attempts to change the wallpaper will have no effect. Always returns true for device owner and profile owner.

isWallpaperSupported

boolean isWallpaperSupported ()

Returns whether wallpapers are supported for the calling user. If this function returns false, any attempts to changing the wallpaper will have no effect, and any attempt to obtain of the wallpaper will return null.

peekDrawable

Drawable peekDrawable ()

Retrieve the current system wallpaper; if there is no wallpaper set, a null pointer is returned. This is returned as an abstract Drawable that you can install in a View to display whatever wallpaper the user has currently set.

peekFastDrawable

Drawable peekFastDrawable ()

Like getFastDrawable(), but if there is no wallpaper set, a null pointer is returned.

sendWallpaperCommand

void sendWallpaperCommand (IBinder windowToken, 
                String action, 
                int x, 
                int y, 
                int z, 
                Bundle extras)

Send an arbitrary command to the current active wallpaper.

setBitmap

int setBitmap (Bitmap fullImage, 
                Rect visibleCropHint, 
                boolean allowBackup, 
                int which)

Version of setBitmap(Bitmap, Rect, boolean) that allows the caller to specify which of the supported wallpaper categories to set.

setBitmap

void setBitmap (Bitmap bitmap)

Change the current system wallpaper to a bitmap. The given bitmap is converted to a PNG and stored as the wallpaper. On success, the intent ACTION_WALLPAPER_CHANGED is broadcast.

This method is equivalent to calling setBitmap(Bitmap, Rect, boolean) and passing null for the visibleCrop rectangle and true for the allowBackup parameter.

This method requires the caller to hold the permission SET_WALLPAPER.

setBitmap

int setBitmap (Bitmap fullImage, 
                Rect visibleCropHint, 
                boolean allowBackup)

Change the current system wallpaper to a bitmap, specifying a hint about which subrectangle of the full image is to be visible. The OS will then try to best present the given portion of the full image as the static system wallpaper image. On success, the intent ACTION_WALLPAPER_CHANGED is broadcast.

Passing null as the visibleHint parameter is equivalent to passing (0, 0, fullImage.getWidth(), fullImage.getHeight()).

This method requires the caller to hold the permission SET_WALLPAPER.

setResource

int setResource (int resid, 
                int which)

Version of setResource(int) that allows the caller to specify which of the supported wallpaper categories to set.

setResource

void setResource (int resid)

Change the current system wallpaper to the bitmap in the given resource. The resource is opened as a raw data stream and copied into the wallpaper; it must be a valid PNG or JPEG image. On success, the intent ACTION_WALLPAPER_CHANGED is broadcast.

This method requires the caller to hold the permission SET_WALLPAPER.

setStream

void setStream (InputStream bitmapData)

Change the current system wallpaper to a specific byte stream. The give InputStream is copied into persistent storage and will now be used as the wallpaper. Currently it must be either a JPEG or PNG image. On success, the intent ACTION_WALLPAPER_CHANGED is broadcast.

This method is equivalent to calling setStream(InputStream, Rect, boolean) and passing null for the visibleCrop rectangle and true for the allowBackup parameter.

This method requires the caller to hold the permission SET_WALLPAPER.

setStream

int setStream (InputStream bitmapData, 
                Rect visibleCropHint, 
                boolean allowBackup, 
                int which)

Version of setStream(InputStream, Rect, boolean) that allows the caller to specify which of the supported wallpaper categories to set.

setStream

int setStream (InputStream bitmapData, 
                Rect visibleCropHint, 
                boolean allowBackup)

Change the current system wallpaper to a specific byte stream, specifying a hint about which subrectangle of the full image is to be visible. The OS will then try to best present the given portion of the full image as the static system wallpaper image. The data from the given InputStream is copied into persistent storage and will then be used as the system wallpaper. Currently the data must be either a JPEG or PNG image. On success, the intent ACTION_WALLPAPER_CHANGED is broadcast.

This method requires the caller to hold the permission SET_WALLPAPER.

setWallpaperOffsetSteps

void setWallpaperOffsetSteps (float xStep, 
                float yStep)

For applications that use multiple virtual screens showing a wallpaper, specify the step size between virtual screens. For example, if the launcher has 3 virtual screens, it would specify an xStep of 0.5, since the X offset for those screens are 0.0, 0.5 and 1.0

setWallpaperOffsets

void setWallpaperOffsets (IBinder windowToken, 
                float xOffset, 
                float yOffset)

Set the display position of the current wallpaper within any larger space, when that wallpaper is visible behind the given window. The X and Y offsets are floating point numbers ranging from 0 to 1, representing where the wallpaper should be positioned within the screen space. These only make sense when the wallpaper is larger than the display.

suggestDesiredDimensions

void suggestDesiredDimensions (int minimumWidth, 
                int minimumHeight)

For use only by the current home application, to specify the size of wallpaper it would like to use. This allows such applications to have a virtual wallpaper that is larger than the physical screen, matching the size of their workspace.

Note developers, who don't seem to be reading this. This is for home apps to tell what size wallpaper they would like. Nobody else should be calling this! Certainly not other non-home apps that change the wallpaper. Those apps are supposed to retrieve the suggested size so they can construct a wallpaper that matches it.

This method requires the caller to hold the permission SET_WALLPAPER_HINTS.