鸿蒙开发系统基础能力：【@ohos.wallpaper (壁纸)】

壁纸

说明： 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import wallpaper from '@ohos.wallpaper';

WallpaperType

定义壁纸类型。

系统能力: 以下各项对应的系统能力均为SystemCapability.MiscServices.Wallpaper。

名称	说明
WALLPAPER_LOCKSCREEN	锁屏壁纸标识。
WALLPAPER_SYSTEM	主屏幕壁纸标识。

wallpaper.getColors

getColors(wallpaperType: WallpaperType, callback: AsyncCallback<Array>): void

获取指定类型壁纸的主要颜色信息。

系统能力: SystemCapability.MiscServices.Wallpaper

参数：

参数名	类型	必填	说明
wallpaperType	[WallpaperType]	是	壁纸类型。
callback	AsyncCallback<Array<[RgbaColor]>>	是	回调函数，返回壁纸的主要颜色信息。

示例：

wallpaper.getColors(wallpaper.WallpaperType.WALLPAPER_SYSTEM, (error, data) => {
    if (error) {
        console.error(`failed to getColors because: ` + JSON.stringify(error));
        return;
    }
    console.log(`success to getColors.`);
});

wallpaper.getColors

getColors(wallpaperType: WallpaperType): Promise<Array>

获取指定类型壁纸的主要颜色信息。

系统能力: SystemCapability.MiscServices.Wallpaper

参数：

参数名	类型	必填	说明
wallpaperType	[WallpaperType]	是	壁纸类型。

返回值：

类型	说明
Promise<Array<[RgbaColor]>>	返回壁纸的主要颜色信息。

示例：

wallpaper.getColors(wallpaper.WallpaperType.WALLPAPER_SYSTEM).then((data) => {
    console.log(`success to getColors.`);
}).catch((error) => {
    console.error(`failed to getColors because: ` + JSON.stringify(error));
});

wallpaper.getId

getId(wallpaperType: WallpaperType, callback: AsyncCallback): void

获取指定类型壁纸的ID。

系统能力: SystemCapability.MiscServices.Wallpaper

参数：

参数名	类型	必填	说明
wallpaperType	[WallpaperType]	是	壁纸类型。
callback	AsyncCallback	是	回调函数，返回壁纸的ID。如果配置了指定类型的壁纸就返回一个大于等于0的数，否则返回-1。取值范围是-1~2^31-1。

示例：

wallpaper.getId(wallpaper.WallpaperType.WALLPAPER_SYSTEM, (error, data) => {
    if (error) {
        console.error(`failed to getId because: ` + JSON.stringify(error));
        return;
    }
    console.log(`success to getId: ` + JSON.stringify(data));
});

wallpaper.getId

getId(wallpaperType: WallpaperType): Promise

获取指定类型壁纸的ID。

系统能力: SystemCapability.MiscServices.Wallpaper

参数：

参数名	类型	必填	说明
wallpaperType	[WallpaperType]	是	壁纸类型。

返回值：

类型	说明
Promise	壁纸的ID。如果配置了这种壁纸类型的壁纸就返回一个大于等于0的数，否则返回-1。取值范围是-1~2^31-1。

示例：

wallpaper.getId(wallpaper.WallpaperType.WALLPAPER_SYSTEM).then((data) => {
    console.log(`success to getId: ` + JSON.stringify(data));
}).catch((error) => {
    console.error(`failed to getId because: ` + JSON.stringify(error));
});

wallpaper.getMinHeight

getMinHeight(callback: AsyncCallback): void

获取壁纸的最小高度值。

系统能力: SystemCapability.MiscServices.Wallpaper

参数：

参数名	类型	必填	说明
callback	A