diff --git a/zh-cn/application-dev/reference/apis/js-apis-wallpaper.md b/zh-cn/application-dev/reference/apis/js-apis-wallpaper.md index 6147c5a404c3ad81b3e16f31d35d3e745b52dd18..b26073f45b7d1cf4dfb0ad3b9de9a6ebe6a8dccc 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-wallpaper.md +++ b/zh-cn/application-dev/reference/apis/js-apis-wallpaper.md @@ -586,6 +586,68 @@ getFile(wallpaperType: WallpaperType): Promise<number> ``` +## wallpaper.getPixelMap + +getPixelMap(wallpaperType: WallpaperType, callback: AsyncCallback<image.PixelMap>): void; + +获取壁纸图片的像素图。 + +**需要权限**:ohos.permission.GET_WALLPAPER、ohos.permission.READ_USER_STORAGE + +**系统能力**: SystemCapability.MiscServices.Wallpaper + +**参数:** + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | wallpaperType | [WallpaperType](#wallpapertype) | 是 | 壁纸类型。 | + | callback | AsyncCallback<void> | 是 | 回调函数,调用成功则返回是否移除成功的结果,调用失败则返回error信息。 | + +**示例:** + + ```js + wallpaper.getPixelMap(WALLPAPER_SYSTEM, function (err, data) { + console.info('wallpaperXTS ===> testGetPixelMapCallbackSystem err : ' + JSON.stringify(err)); + console.info('wallpaperXTS ===> testGetPixelMapCallbackSystem data : ' + JSON.stringify(data)); + }); + ``` + + +## wallpaper.getPixelMap + +getPixelMap(wallpaperType: WallpaperType): Promise<image.PixelMap> + +获取壁纸图片的像素图。 + +**需要权限**:ohos.permission.GET_WALLPAPER、ohos.permission.READ_USER_STORAGE + +**系统能力**: SystemCapability.MiscServices.Wallpaper + +**参数:** + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | wallpaperType | [WallpaperType](#wallpapertype) | 是 | 壁纸类型。 | + +**返回值:** + + | 类型 | 说明 | + | -------- | -------- | + | Promise<void> | 调用成功则返回是否移除成功的结果,调用失败则返回error信息。 | + +**示例:** + + ```js + wallpaper.getPixelMap(WALLPAPER_SYSTEM).then((data) => { + console.info('wallpaperXTS ===> testGetPixelMapPromiseSystem data : ' + data); + console.info('wallpaperXTS ===> testGetPixelMapPromiseSystem data : ' + JSON.stringify(data)); + }).catch((err) => { + console.info('wallpaperXTS ===> testGetPixelMapPromiseSystem err : ' + err); + console.info('wallpaperXTS ===> testGetPixelMapPromiseSystem err : ' + JSON.stringify(err)); + }); + ``` + + ## wallpaper.on('colorChange') on(type: 'colorChange', callback: (colors: Array<RgbaColor>, wallpaperType: WallpaperType) => void): void