WallpaperController

java.lang.Object
- ohos.miscservices.wallpaper.WallpaperController

```
public class WallpaperController
extends Object
```
Provides the access to the wallpaper management service.

从以下版本开始:

3

SystemCapability

SystemCapability.Miscservices#WALLPAPER

字段概要

字段
限定符和类型字段说明

static int WALLPAPER_LOCK
Indicates the lock screen wallpaper.

static int WALLPAPER_SYSTEM
Indicates the home screen wallpaper.

字段
限定符和类型	字段	说明
`static int`	`WALLPAPER_LOCK`	Indicates the lock screen wallpaper.
`static int`	`WALLPAPER_SYSTEM`	Indicates the home screen wallpaper.

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法	说明
`WallpaperColorsCollection`	`getColors(int wallpaperType)`	Obtains the `WallpaperColorsCollection` instance for the wallpaper of the specified type.
`Element`	`getDefaultElement(int outWidth, int outHeight, boolean scaleToFit, float horizontalAlignment, float verticalAlignment, int wallpaperType)`	Obtains the `Element` instance of the default built-in static wallpaper.
`Element`	`getElement()`	Obtains the `Element` instance of the current system wallpaper.
`FileDescriptor`	`getFile(int wallpaperType)`	Obtains a file descriptor to the wallpaper of the specified type.
`int`	`getId(int wallpaperType)`	Obtains the ID of the wallpaper of the specified type.
`static WallpaperController`	`getInstance(Context context)`	Obtains a `WallpaperController` instance.
`int`	`getMinHeight()`	Obtains the minimum height of the wallpaper.
`int`	`getMinWidth()`	Obtains the minimum width of the wallpaper.
`boolean`	`isChangePermitted()`	Checks whether to allow the application to change the wallpaper for the current user.
`boolean`	`isOperationAllowed()`	Checks whether a user is allowed to set wallpapers.
`void`	`registerColorsChangedListener(IWallpaperColorsChangedListener listener)`	Registers a listener for wallpaper color changes to receive notifications about the changes.
`void`	`reset(int wallpaperType)`	Removes a wallpaper of the specified type and restores the default one.
`void`	`setPadding(Rect padding)`	Sets wallpaper padding that exceeds the display area.
`void`	`setWallpaper(InputStream inputStream, int wallpaperType)`	Sets a wallpaper of the specified type based on the data stream from a JPEG or PNG file.
`void`	`setWallpaper(PixelMap pixelMap, int wallpaperType)`	Sets a wallpaper of the specified type based on the pixel map of a PNG file.
`void`	`unregisterColorsChangedListener(IWallpaperColorsChangedListener listener)`	Unregisters a listener for wallpaper color changes.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - WALLPAPER_LOCK
```
public static final int WALLPAPER_LOCK
```
    Indicates the lock screen wallpaper.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - WALLPAPER_SYSTEM
```
public static final int WALLPAPER_SYSTEM
```
    Indicates the home screen wallpaper.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
- 方法详细资料
  - getInstance
```
public static WallpaperController getInstance(Context context)
```
    Obtains a WallpaperController instance.
    
    参数:
    
    context - Indicates the application context. If this parameter is invalid, your application cannot access the wallpaper management service.
    
    返回:
    
    Returns the WallpaperController instance.
    
    从以下版本开始:
    
    3
  - registerColorsChangedListener
```
public void registerColorsChangedListener(IWallpaperColorsChangedListener listener)
```
    Registers a listener for wallpaper color changes to receive notifications about the changes.
    
    参数:
    
    listener - Indicates the listener for wallpaper color changes. The caller can customize follow-up operations when your application is notified of the changes.
    
    从以下版本开始:
    
    3
  - unregisterColorsChangedListener
```
public void unregisterColorsChangedListener(IWallpaperColorsChangedListener listener)
```
    Unregisters a listener for wallpaper color changes.
    
    参数:
    
    listener - Indicates the listener to unregister.
    
    从以下版本开始:
    
    3
  - getMinHeight
```
public int getMinHeight()
```
    Obtains the minimum height of the wallpaper. You should call this method before WallpaperController#setWallpaper(PixelMap, int) and WallpaperController#setWallpaper(InputStream, int).
    
    返回:
    
    Returns the minimum height, in pixels; returns 0 if no wallpaper has been set. In this case, you should use the default height.
    
    从以下版本开始:
    
    3
  - getMinWidth
```
public int getMinWidth()
```
    Obtains the minimum width of the wallpaper. You should call this method before WallpaperController#setWallpaper(PixelMap, int) and WallpaperController#setWallpaper(InputStream, int).
    
    返回:
    
    Returns the minimum width, in pixels; returns 0 if no wallpaper has been set. In this case, you should use the default width.
    
    从以下版本开始:
    
    3
  - isChangePermitted
```
public boolean isChangePermitted()
```
    Checks whether to allow the application to change the wallpaper for the current user.
    
    返回:
    
    Returns true if the application is allowed to set a wallpaper for the current user; returns false otherwise.
    
    从以下版本开始:
    
    3
  - isOperationAllowed
```
public boolean isOperationAllowed()
```
    Checks whether a user is allowed to set wallpapers.
    
    返回:
    
    Returns true if a user is allowed to set wallpapers; returns false otherwise.
    
    从以下版本开始:
    
    3
  - getId
```
public int getId(int wallpaperType)
```
    Obtains the ID of the wallpaper of the specified type.
    The ID of a wallpaper changes each time the wallpaper is set. You can call this method to know whether the wallpaper has changed.
    
    参数:
    
    wallpaperType - Indicates the type of the wallpaper whose ID will be returned. The value can be WALLPAPER_SYSTEM or WALLPAPER_LOCK.
    
    返回:
    
    Returns an integer greater than or equal to 0 representing the wallpaper ID if the specified type of wallpaper has been set; returns -1 otherwise. The return value is an integer ranging from -1 to 2^31 - 1.
    
    从以下版本开始:
    
    3
  - setWallpaper
```
public void setWallpaper(PixelMap pixelMap,
                         int wallpaperType)
```
    Sets a wallpaper of the specified type based on the pixel map of a PNG file. Calling this method requires the SystemPermission#SET_WALLPAPER permission.
    
    参数:
    
    pixelMap - Indicates the pixel map of the PNG file.
    
    wallpaperType - Indicates the wallpaper type. The value can be WALLPAPER_SYSTEM or WALLPAPER_LOCK.
    
    从以下版本开始:
    
    3
  - setWallpaper
```
public void setWallpaper(InputStream inputStream,
                         int wallpaperType)
```
    Sets a wallpaper of the specified type based on the data stream from a JPEG or PNG file. Calling this method requires the SystemPermission#SET_WALLPAPER permission.
    
    参数:
    
    inputStream - Indicates the data stream from a JPEG or PNG file.
    
    wallpaperType - Indicates the wallpaper type. The value can be WALLPAPER_SYSTEM or WALLPAPER_LOCK.
    
    从以下版本开始:
    
    3
  - getFile
```
public FileDescriptor getFile(int wallpaperType)
```
    Obtains a file descriptor to the wallpaper of the specified type. After the file is accessed, the file descriptor needs to be closed.
    Calling this method requires the SystemPermission#GET_WALLPAPER and SystemPermission#READ_USER_STORAGE permissions.
    
    参数:
    
    wallpaperType - Indicates the wallpaper type. The value can be WALLPAPER_SYSTEM or WALLPAPER_LOCK.
    
    返回:
    
    Returns the file descriptor if the wallpaper of the specified type has been set; returns null if no wallpaper of the specified type is set, or the application does not have the permission to access the wallpaper.
    
    从以下版本开始:
    
    3
  - reset
```
public void reset(int wallpaperType)
```
    Removes a wallpaper of the specified type and restores the default one.
    Calling this method requires the SystemPermission#SET_WALLPAPER permission.
    
    参数:
    
    wallpaperType - Indicates the wallpaper type. The value can be WALLPAPER_SYSTEM or WALLPAPER_LOCK.
    
    从以下版本开始:
    
    3
  - setPadding
```
public void setPadding(Rect padding)
```
    Sets wallpaper padding that exceeds the display area.
    Calling this method requires the SystemPermission#SET_WALLPAPER_DIMENSION permission.
    
    参数:
    
    padding - Indicates the number of additional pixels outside of the display on left, right, top, and bottom sides of the wallpaper.
    
    从以下版本开始:
    
    3
  - getColors
```
public WallpaperColorsCollection getColors(int wallpaperType)
```
    Obtains the WallpaperColorsCollection instance for the wallpaper of the specified type.
    
    参数:
    
    wallpaperType - Indicates the wallpaper type. The value can be WALLPAPER_SYSTEM or WALLPAPER_LOCK.
    
    返回:
    
    Returns the WallpaperColorsCollection instance if any; returns null if a color is unknown.
    
    从以下版本开始:
    
    3
  - getDefaultElement
```
public Element getDefaultElement(int outWidth,
                                 int outHeight,
                                 boolean scaleToFit,
                                 float horizontalAlignment,
                                 float verticalAlignment,
                                 int wallpaperType)
```
    Obtains the Element instance of the default built-in static wallpaper.
    
    参数:
    
    outWidth - Indicates the width of the Element instance.
    
    outHeight - Indicates the height of the Element instance.
    
    scaleToFit - Specifies whether the wallpaper can be scaled. Value true indicates that the wallpaper can be scaled and cropped to fit the screen, and false indicates that the wallpaper can be cropped only.
    
    horizontalAlignment - Indicates the horizontal alignment mode. The value ranges from 0 to 1. Value 0 indicates left alignment, 0.5 indicates center alignment, and 1 indicates right alignment.
    
    verticalAlignment - Indicates the vertical alignment mode. The value ranges from 0 to 1. Value 0 indicates top alignment, 0.5 indicates center alignment, and 1 indicates bottom alignment.
    
    wallpaperType - Indicates the wallpaper type. The value can be WALLPAPER_SYSTEM or WALLPAPER_LOCK.
    
    返回:
    
    Returns the Element instance of the default built-in static wallpaper.
    
    从以下版本开始:
    
    4
  - getElement
```
public Element getElement()
```
    Obtains the Element instance of the current system wallpaper.
    返回:
    Returns the Element instance of the current system wallpaper; returns the default built-in static wallpaper if no wallpaper is set; returns null if any of the following occurs:
    No system wallpaper is available.
    
    The user does not have the permission to operate the wallpaper.
    
    Your application does not have the permission to operate the wallpaper.
    从以下版本开始:
    
    4

类 WallpaperController

字段概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

WALLPAPER_LOCK

WALLPAPER_SYSTEM

方法详细资料

getInstance

registerColorsChangedListener

unregisterColorsChangedListener

getMinHeight

getMinWidth

isChangePermitted

isOperationAllowed

getId

setWallpaper

setWallpaper

getFile

reset

setPadding

getColors

getDefaultElement

getElement