1# 壁纸 2 3>  **说明：** 4> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 5 6 7## 导入模块 8 9 10``` 11import wallpaper from '@ohos.wallpaper'; 12``` 13 14 15## WallpaperType 16 17定义壁纸类型。 18 19**系统能力**: 以下各项对应的系统能力均为SystemCapability.MiscServices.Wallpaper。 20 21| 名称 | 说明 | 22| -------- | -------- | 23| WALLPAPER_LOCKSCREEN | 锁屏壁纸标识。 | 24| WALLPAPER_SYSTEM | 主屏幕壁纸标识。 | 25 26 27## wallpaper.getColors 28 29getColors(wallpaperType: WallpaperType, callback: AsyncCallback<Array<RgbaColor>>): void 30 31获取指定类型壁纸的主要颜色信息。 32 33**系统能力**: SystemCapability.MiscServices.Wallpaper 34 35**参数：** 36 37 | 参数名 | 类型 | 必填 | 说明 | 38 | -------- | -------- | -------- | -------- | 39 | wallpaperType | [WallpaperType](#wallpapertype) | 是 | 壁纸类型。 | 40 | callback | AsyncCallback<Array<[RgbaColor](#rgbacolor)>> | 是 | 回调函数，返回壁纸的主要颜色信息。 | 41 42**示例：** 43 44 ```js 45 wallpaper.getColors(wallpaper.WallpaperType.WALLPAPER_SYSTEM, (error, data) => { 46 if (error) { 47 console.error(`failed to getColors because: ` + JSON.stringify(error)); 48 return; 49 } 50 console.log(`success to getColors.`); 51 }); 52 ``` 53 54 55## wallpaper.getColors 56 57getColors(wallpaperType: WallpaperType): Promise<Array<RgbaColor>> 58 59获取指定类型壁纸的主要颜色信息。 60 61**系统能力**: SystemCapability.MiscServices.Wallpaper 62 63**参数：** 64 65 | 参数名 | 类型 | 必填 | 说明 | 66 | -------- | -------- | -------- | -------- | 67 | wallpaperType | [WallpaperType](#wallpapertype) | 是 | 壁纸类型。 | 68 69**返回值：** 70 71 | 类型 | 说明 | 72 | -------- | -------- | 73 | Promise<Array<[RgbaColor](#rgbacolor)>> | 返回壁纸的主要颜色信息。 | 74 75**示例：** 76 77 ```js 78 wallpaper.getColors(wallpaper.WallpaperType.WALLPAPER_SYSTEM).then((data) => { 79 console.log(`success to getColors.`); 80 }).catch((error) => { 81 console.error(`failed to getColors because: ` + JSON.stringify(error)); 82 }); 83 ``` 84 85 86## wallpaper.getId 87 88getId(wallpaperType: WallpaperType, callback: AsyncCallback<number>): void 89 90获取指定类型壁纸的ID。 91 92**系统能力**: SystemCapability.MiscServices.Wallpaper 93 94**参数：** 95 96 | 参数名 | 类型 | 必填 | 说明 | 97 | -------- | -------- | -------- | -------- | 98 | wallpaperType | [WallpaperType](#wallpapertype) | 是 | 壁纸类型。 | 99 | callback | AsyncCallback<number> | 是 | 回调函数，返回壁纸的ID。如果配置了指定类型的壁纸就返回一个大于等于0的数，否则返回-1。取值范围是-1到（2^31-1）。 | 100 101**示例：** 102 103 ```js 104 wallpaper.getId(wallpaper.WallpaperType.WALLPAPER_SYSTEM, (error, data) => { 105 if (error) { 106 console.error(`failed to getId because: ` + JSON.stringify(error)); 107 return; 108 } 109 console.log(`success to getId: ` + JSON.stringify(data)); 110 }); 111 ``` 112 113 114## wallpaper.getId 115 116getId(wallpaperType: WallpaperType): Promise<number> 117 118获取指定类型壁纸的ID。 119 120**系统能力**: SystemCapability.MiscServices.Wallpaper 121 122 123**参数：** 124 125 | 参数名 | 类型 | 必填 | 说明 | 126 | -------- | -------- | -------- | -------- | 127 | wallpaperType | [WallpaperType](#wallpapertype) | 是 | 壁纸类型。 | 128 129**返回值：** 130 131 | 类型 | 说明 | 132 | -------- | -------- | 133 | Promise<number> | 壁纸的ID。如果配置了这种壁纸类型的壁纸就返回一个大于等于0的数，否则返回-1。取值范围是-1到（2^31-1）。 | 134 135**示例：** 136 137 ```js 138 wallpaper.getId(wallpaper.WallpaperType.WALLPAPER_SYSTEM).then((data) => { 139 console.log(`success to getId: ` + JSON.stringify(data)); 140 }).catch((error) => { 141 console.error(`failed to getId because: ` + JSON.stringify(error)); 142 }); 143 ``` 144 145 146## wallpaper.getMinHeight 147 148getMinHeight(callback: AsyncCallback<number>): void 149 150获取壁纸的最小高度值。 151 152**系统能力**: SystemCapability.MiscServices.Wallpaper 153 154**参数：** 155 156 | 参数名 | 类型 | 必填 | 说明 | 157 | -------- | -------- | -------- | -------- | 158 | callback | AsyncCallback<number> | 是 | 回调函数，返回壁纸的最小高度值，单位是像素。如果返回值等于0，说明没有设置壁纸，调用者应该使用默认显示的高度值代替。 | 159 160**示例：** 161 162 ```js 163 wallpaper.getMinHeight((error, data) => { 164 if (error) { 165 console.error(`failed to getMinHeight because: ` + JSON.stringify(error)); 166 return; 167 } 168 console.log(`success to getMinHeight: ` + JSON.stringify(data)); 169 }); 170 ``` 171 172 173## wallpaper.getMinHeight 174 175getMinHeight(): Promise<number> 176 177获取壁纸的最小高度值。 178 179**系统能力**: SystemCapability.MiscServices.Wallpaper 180 181 182**返回值：** 183 184 | 类型 | 说明 | 185 | -------- | -------- | 186 | Promise<number> | 返回壁纸的最小高度值，单位是像素。如果返回值等于0，说明没有设置壁纸，调用者应该使用默认显示的高度值代替。 | 187 188**示例：** 189 190 ```js 191 wallpaper.getMinHeight().then((data) => { 192 console.log(`success to getMinHeight: ` + JSON.stringify(data)); 193 }).catch((error) => { 194 console.error(`failed to getMinHeight because: ` + JSON.stringify(error)); 195 }); 196 ``` 197 198 199## wallpaper.getMinWidth 200 201getMinWidth(callback: AsyncCallback<number>): void 202 203获取壁纸的最小宽度值。 204 205**系统能力**: SystemCapability.MiscServices.Wallpaper 206 207 208**参数：** 209 210 | 参数名 | 类型 | 必填 | 说明 | 211 | -------- | -------- | -------- | -------- | 212 | callback | AsyncCallback<number> | 是 | 回调函数，壁纸的最小宽度值，单位是像素。如果返回值等于0，说明没有设置壁纸，调用者应该使用默认显示的宽度值代替。 | 213 214**示例：** 215 216 ```js 217 wallpaper.getMinWidth((error, data) => { 218 if (error) { 219 console.error(`failed to getMinWidth because: ` + JSON.stringify(error)); 220 return; 221 } 222 console.log(`success to getMinWidth: ` + JSON.stringify(data)); 223 }); 224 ``` 225 226 227## wallpaper.getMinWidth 228 229getMinWidth(): Promise<number> 230 231获取壁纸的最小宽度值。 232 233**系统能力**: SystemCapability.MiscServices.Wallpaper 234 235**返回值：** 236 237 | 类型 | 说明 | 238 | -------- | -------- | 239 | Promise<number> | 壁纸的最小宽度值，单位是像素。如果返回值等于0，说明没有设置壁纸，调用者应该使用默认显示的宽度值代替。 | 240 241**示例：** 242 243 ```js 244 wallpaper.getMinWidth().then((data) => { 245 console.log(`success to getMinWidth: ` + JSON.stringify(data)); 246 }).catch((error) => { 247 console.error(`failed to getMinWidth because: ` + JSON.stringify(error)); 248 }); 249 ``` 250 251 252## wallpaper.isChangePermitted 253 254isChangePermitted(callback: AsyncCallback<boolean>): void 255 256是否允许应用改变当前用户的壁纸。 257 258**系统能力**: SystemCapability.MiscServices.Wallpaper 259 260**参数：** 261 262 | 参数名 | 类型 | 必填 | 说明 | 263 | -------- | -------- | -------- | -------- | 264 | callback | AsyncCallback<boolean> | 是 | 回调函数，返回是否允许应用改变当前用户的壁纸。如果允许返回true，否则返回false。 | 265 266**示例：** 267 268 ```js 269 wallpaper.isChangePermitted((error, data) => { 270 if (error) { 271 console.error(`failed to isChangePermitted because: ` + JSON.stringify(error)); 272 return; 273 } 274 console.log(`success to isChangePermitted: ` + JSON.stringify(data)); 275 }); 276 ``` 277 278 279## wallpaper.isChangePermitted 280 281isChangePermitted(): Promise<boolean> 282 283是否允许应用改变当前用户的壁纸。 284 285**系统能力**: SystemCapability.MiscServices.Wallpaper 286 287**返回值：** 288 289 | 类型 | 说明 | 290 | -------- | -------- | 291 | Promise<boolean> | 返回是否允许应用改变当前用户的壁纸。如果允许返回true，否则返回false。 | 292 293**示例：** 294 295 ```js 296 wallpaper.isChangePermitted().then((data) => { 297 console.log(`success to isChangePermitted: ` + JSON.stringify(data)); 298 }).catch((error) => { 299 console.error(`failed to isChangePermitted because: ` + JSON.stringify(error)); 300 }); 301 ``` 302 303 304## wallpaper.isOperationAllowed 305 306isOperationAllowed(callback: AsyncCallback<boolean>): void 307 308是否允许用户设置壁纸。 309 310**系统能力**: SystemCapability.MiscServices.Wallpaper 311 312**参数：** 313 314 | 参数名 | 类型 | 必填 | 说明 | 315 | -------- | -------- | -------- | -------- | 316 | callback | AsyncCallback<boolean> | 是 | 回调函数，返回是否允许用户设置壁纸。如果允许返回true，否则返回false。 | 317 318**示例：** 319 320 ```js 321 wallpaper.isOperationAllowed((error, data) => { 322 if (error) { 323 console.error(`failed to isOperationAllowed because: ` + JSON.stringify(error)); 324 return; 325 } 326 console.log(`success to isOperationAllowed: ` + JSON.stringify(data)); 327 }); 328 ``` 329 330 331## wallpaper.isOperationAllowed 332 333isOperationAllowed(): Promise<boolean> 334 335是否允许用户设置壁纸。 336 337**系统能力**: SystemCapability.MiscServices.Wallpaper 338 339**返回值：** 340 341 | 类型 | 说明 | 342 | -------- | -------- | 343 | Promise<boolean> | 异步回调函数，返回是否允许用户设置壁纸。如果允许返回true，否则返回false。 | 344 345**示例：** 346 347 ```js 348 wallpaper.isOperationAllowed().then((data) => { 349 console.log(`success to isOperationAllowed: ` + JSON.stringify(data)); 350 }).catch((error) => { 351 console.error(`failed to isOperationAllowed because: ` + JSON.stringify(error)); 352 }); 353 ``` 354 355 356## wallpaper.reset 357 358reset(wallpaperType: WallpaperType, callback: AsyncCallback<void>): void 359 360移除指定类型的壁纸，恢复为默认显示的壁纸。 361 362**需要权限**：ohos.permission.SET_WALLPAPER 363 364**系统能力**: SystemCapability.MiscServices.Wallpaper 365 366**参数：** 367 368 | 参数名 | 类型 | 必填 | 说明 | 369 | -------- | -------- | -------- | -------- | 370 | wallpaperType | [WallpaperType](#wallpapertype) | 是 | 壁纸类型。 | 371 | callback | AsyncCallback<void> | 是 | 回调函数，调用成功则返回是否移除成功的结果，调用失败则返回error信息。 | 372 373**示例：** 374 375 ```js 376 wallpaper.reset(wallpaper.WallpaperType.WALLPAPER_SYSTEM, (error, data) => { 377 if (error) { 378 console.error(`failed to reset because: ` + JSON.stringify(error)); 379 return; 380 } 381 console.log(`success to reset.`); 382 }); 383 ``` 384 385 386## wallpaper.reset 387 388reset(wallpaperType: WallpaperType): Promise<void> 389 390移除指定类型的壁纸，恢复为默认显示的壁纸。 391 392**需要权限**：ohos.permission.SET_WALLPAPER 393 394**系统能力**: SystemCapability.MiscServices.Wallpaper 395 396**参数：** 397 398 | 参数名 | 类型 | 必填 | 说明 | 399 | -------- | -------- | -------- | -------- | 400 | wallpaperType | [WallpaperType](#wallpapertype) | 是 | 壁纸类型。 | 401 402**返回值：** 403 404 | 类型 | 说明 | 405 | -------- | -------- | 406 | Promise<void> | 调用成功则返回是否移除成功的结果，调用失败则返回error信息。 | 407 408**示例：** 409 410 ```js 411 wallpaper.reset(wallpaper.WallpaperType.WALLPAPER_SYSTEM).then((data) => { 412 console.log(`success to reset.`); 413 }).catch((error) => { 414 console.error(`failed to reset because: ` + JSON.stringify(error)); 415 }); 416 ``` 417 418 419## wallpaper.setWallpaper 420 421setWallpaper(source: string | image.PixelMap, wallpaperType: WallpaperType, callback: AsyncCallback<void>): void 422 423将指定资源设置为指定类型的壁纸。 424 425**需要权限**：ohos.permission.SET_WALLPAPER 426 427**系统能力**: SystemCapability.MiscServices.Wallpaper 428 429**参数：** 430 431 | 参数名 | 类型 | 必填 | 说明 | 432 | -------- | -------- | -------- | -------- | 433 | source | string \|[PixelMap](js-apis-image.md#pixelmap7) | | JPEG或PNG文件的Uri路径，或者PNG格式文件的位图。 | 434 | wallpaperType | [WallpaperType](#wallpapertype) | 是 | 壁纸类型。 | 435 | callback | AsyncCallback<void> | 是 | 回调函数，调用成功则返回是返回设置的结果，调用失败则返回error信息。 | 436 437**示例：** 438 439 ```js 440 // source类型为string 441 let wallpaperPath = "/data/data/ohos.acts.aafwk.plrdtest.form/files/Cup_ic.jpg"; 442 wallpaper.setWallpaper(wallpaperPath, wallpaper.WallpaperType.WALLPAPER_SYSTEM, (error, data) => { 443 if (error) { 444 console.error(`failed to setWallpaper because: ` + JSON.stringify(error)); 445 return; 446 } 447 console.log(`success to setWallpaper.`); 448 }); 449 450 // source类型为image.PixelMap 451 import image from '@ohos.multimedia.image'; 452 let imageSource = image.createImageSource("file://" + wallpaperPath); 453 let opts = { 454 "desiredSize": { 455 "height": 3648, 456 "width": 2736 457 } 458 }; 459 imageSource.createPixelMap(opts).then((pixelMap) => { 460 wallpaper.setWallpaper(pixelMap, wallpaper.WallpaperType.WALLPAPER_SYSTEM, (error, data) => { 461 if (error) { 462 console.error(`failed to setWallpaper because: ` + JSON.stringify(error)); 463 return; 464 } 465 console.log(`success to setWallpaper.`); 466 }); 467 }).catch((error) => { 468 console.error(`failed to createPixelMap because: ` + JSON.stringify(error)); 469 }); 470 ``` 471 472 473## wallpaper.setWallpaper 474 475setWallpaper(source: string | image.PixelMap, wallpaperType: WallpaperType): Promise<void> 476 477将指定资源设置为指定类型的壁纸。 478 479**需要权限**：ohos.permission.SET_WALLPAPER 480 481**系统能力**: SystemCapability.MiscServices.Wallpaper 482 483**参数：** 484 485 | 参数名 | 类型 | 必填 | 说明 | 486 | -------- | -------- | -------- | -------- | 487 | source | string \|[PixelMap](js-apis-image.md#pixelmap7) | 是 | JPEG或PNG文件的Uri路径，或者PNG格式文件的位图。 | 488 | wallpaperType | [WallpaperType](#wallpapertype) | 是 | 壁纸类型。 | 489 490**返回值：** 491 492 | 类型 | 说明 | 493 | -------- | -------- | 494 | Promise<void> | 调用成功则返回是返回设置的结果，调用失败则返回error信息。 | 495 496**示例：** 497 498 ```js 499 // source类型为string 500 let wallpaperPath = "/data/data/ohos.acts.aafwk.plrdtest.form/files/Cup_ic.jpg"; 501 wallpaper.setWallpaper(wallpaperPath, wallpaper.WallpaperType.WALLPAPER_SYSTEM).then((data) => { 502 console.log(`success to setWallpaper.`); 503 }).catch((error) => { 504 console.error(`failed to setWallpaper because: ` + JSON.stringify(error)); 505 }); 506 507 // source类型为image.PixelMap 508 import image from '@ohos.multimedia.image'; 509 let imageSource = image.createImageSource("file://" + wallpaperPath); 510 let opts = { 511 "desiredSize": { 512 "height": 3648, 513 "width": 2736 514 } 515 }; 516 imageSource.createPixelMap(opts).then((pixelMap) => { 517 wallpaper.setWallpaper(pixelMap, wallpaper.WallpaperType.WALLPAPER_SYSTEM).then((data) => { 518 console.log(`success to setWallpaper.`); 519 }).catch((error) => { 520 console.error(`failed to setWallpaper because: ` + JSON.stringify(error)); 521 }); 522 }).catch((error) => { 523 console.error(`failed to createPixelMap because: ` + JSON.stringify(error)); 524 }); 525 ``` 526 527## wallpaper.getFile<sup>8+</sup> 528 529getFile(wallpaperType: WallpaperType, callback: AsyncCallback<number>): void 530 531获取指定类型的壁纸文件。 532 533**需要权限**：ohos.permission.GET_WALLPAPER 和 ohos.permission.READ_USER_STORAGE 534 535**系统能力**: SystemCapability.MiscServices.Wallpaper 536 537**参数：** 538 539 | 参数名 | 类型 | 必填 | 说明 | 540 | -------- | -------- | -------- | -------- | 541 | wallpaperType | [WallpaperType](#wallpapertype) | 是 | 壁纸类型。 | 542 | callback | AsyncCallback<number> | 是 | 回调函数，调用成功则返回壁纸文件描述符ID，调用失败则返回error信息。 | 543 544**示例：** 545 546 ```js 547 wallpaper.getFile(wallpaper.WallpaperType.WALLPAPER_SYSTEM, (error, data) => { 548 if (error) { 549 console.error(`failed to getFile because: ` + JSON.stringify(error)); 550 return; 551 } 552 console.log(`success to getFile: ` + JSON.stringify(data)); 553 }); 554 ``` 555 556## wallpaper.getFile<sup>8+</sup> 557 558getFile(wallpaperType: WallpaperType): Promise<number> 559 560获取指定类型的壁纸文件。 561 562**需要权限**：ohos.permission.GET_WALLPAPER 和 ohos.permission.READ_USER_STORAGE 563 564**系统能力**: SystemCapability.MiscServices.Wallpaper 565 566**参数：** 567 568 | 参数名 | 类型 | 必填 | 说明 | 569 | -------- | -------- | -------- | -------- | 570 | wallpaperType | [WallpaperType](#wallpapertype) | 是 | 壁纸类型。 | 571 572**返回值：** 573 574 | 类型 | 说明 | 575 | -------- | -------- | 576 | Promise<number> | 调用成功则返回壁纸文件描述符ID，调用失败则返回error信息。 | 577 578**示例：** 579 580 ```js 581 wallpaper.getFile(wallpaper.WallpaperType.WALLPAPER_SYSTEM).then((data) => { 582 console.log(`success to getFile: ` + JSON.stringify(data)); 583 }).catch((error) => { 584 console.error(`failed to getFile because: ` + JSON.stringify(error)); 585 }); 586 ``` 587 588 589## wallpaper.getPixelMap 590 591getPixelMap(wallpaperType: WallpaperType, callback: AsyncCallback<image.PixelMap>): void; 592 593获取壁纸图片的像素图。 594 595**需要权限**：ohos.permission.GET_WALLPAPER 和 ohos.permission.READ_USER_STORAGE 596 597**系统能力**: SystemCapability.MiscServices.Wallpaper 598 599**系统API**：此接口为系统接口，三方应用不支持调用。 600 601**参数：** 602 603 | 参数名 | 类型 | 必填 | 说明 | 604 | -------- | -------- | -------- | -------- | 605 | wallpaperType | [WallpaperType](#wallpapertype) | 是 | 壁纸类型。 | 606 | callback | AsyncCallback<void> | 是 | 回调函数，调用成功则返回壁纸图片的像素图对象，调用失败则返回error信息。 | 607 608**示例：** 609 610 ```js 611 wallpaper.getPixelMap(wallpaper.WallpaperType.WALLPAPER_SYSTEM, function (err, data) { 612 console.info('wallpaperXTS ===> testGetPixelMapCallbackSystem err : ' + JSON.stringify(err)); 613 console.info('wallpaperXTS ===> testGetPixelMapCallbackSystem data : ' + JSON.stringify(data)); 614 }); 615 ``` 616 617 618## wallpaper.getPixelMap 619 620getPixelMap(wallpaperType: WallpaperType): Promise<image.PixelMap> 621 622获取壁纸图片的像素图。 623 624**需要权限**：ohos.permission.GET_WALLPAPER 和 ohos.permission.READ_USER_STORAGE 625 626**系统能力**: SystemCapability.MiscServices.Wallpaper 627 628**系统API**：此接口为系统接口，三方应用不支持调用。 629 630**参数：** 631 632 | 参数名 | 类型 | 必填 | 说明 | 633 | -------- | -------- | -------- | -------- | 634 | wallpaperType | [WallpaperType](#wallpapertype) | 是 | 壁纸类型。 | 635 636**返回值：** 637 638 | 类型 | 说明 | 639 | -------- | -------- | 640 | Promise<void> | 调用成功则返回壁纸图片的像素图对象，调用失败则返回error信息。 | 641 642**示例：** 643 644 ```js 645 wallpaper.getPixelMap(wallpaper.WallpaperType.WALLPAPER_SYSTEM).then((data) => { 646 console.info('wallpaperXTS ===> testGetPixelMapPromiseSystem data : ' + data); 647 console.info('wallpaperXTS ===> testGetPixelMapPromiseSystem data : ' + JSON.stringify(data)); 648 }).catch((err) => { 649 console.info('wallpaperXTS ===> testGetPixelMapPromiseSystem err : ' + err); 650 console.info('wallpaperXTS ===> testGetPixelMapPromiseSystem err : ' + JSON.stringify(err)); 651 }); 652 ``` 653 654 655## wallpaper.on('colorChange') 656 657on(type: 'colorChange', callback: (colors: Array<RgbaColor>, wallpaperType: WallpaperType) => void): void 658 659订阅壁纸颜色变化结果上报事件。 660 661**系统能力**: SystemCapability.MiscServices.Wallpaper 662 663**参数：** 664 665 | 参数名 | 类型 | 必填 | 说明 | 666 | -------- | -------- | -------- | -------- | 667 | type | string | 是 | 取值为'colorChange'，表示壁纸颜色变化结果上报事件。 | 668 | callback | function | 是 | 壁纸颜色变化触发该回调方法，返回壁纸类型和壁纸的主要颜色信息。<br/>- colors<br/> 壁纸的主要颜色信息，其类型见[RgbaColor](#rgbacolor)。<br/>- wallpaperType<br/> 壁纸类型。 | 669 670**示例：** 671 672 ```js 673 let listener = (colors, wallpaperType) => { 674 console.log(`wallpaper color changed.`); 675 }; 676 wallpaper.on('colorChange', listener); 677 ``` 678 679 680## wallpaper.off('colorChange') 681 682off(type: 'colorChange', callback?: (colors: Array<RgbaColor>, wallpaperType: WallpaperType) => void): void 683 684取消订阅壁纸颜色变化结果上报事件。 685 686**系统能力**: SystemCapability.MiscServices.Wallpaper 687 688**参数：** 689 690 | 参数名 | 类型 | 必填 | 说明 | 691 | -------- | -------- | -------- | -------- | 692 | type | string | 是 | 取值为'colorChange'，表示取消订阅壁纸颜色变化结果上报事件。 | 693 | callback | function | 否 | 表示取消壁纸颜色变化结果上报，不填写该参数则取消订阅该type对应的所有回调。<br/>- colors<br/> 壁纸的主要颜色信息，其类型见[RgbaColor](#rgbacolor)。<br/>- wallpaperType<br/> 壁纸类型。 | 694 695**示例：** 696 697 ```js 698 let listener = (colors, wallpaperType) => { 699 console.log(`wallpaper color changed.`); 700 }; 701 wallpaper.on('colorChange', listener); 702 // 取消订阅listener 703 wallpaper.off('colorChange', listener); 704 // 取消所有'colorChange'类型的订阅 705 wallpaper.off('colorChange'); 706 ``` 707 708 709## RgbaColor 710 711**系统能力**: 以下各项对应的系统能力均为SystemCapability.MiscServices.Wallpaper。 712 713| 名称 | 参数类型 | 可读 | 可写 | 说明 | 714| -------- | -------- | -------- | -------- | -------- | 715| red | number | 是 | 是 | 表示红色值，范围为 0 到 255。 | 716| green | number | 是 | 是 | 表示绿色值，范围为 0 到 255。 | 717| blue | number | 是 | 是 | 表示蓝色值，范围为 0 到 255。 | 718| alpha | number | 是 | 是 | 表示 alpha 值，范围为 0 到 255。 | 719
