Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
未验证 提交 168ece0f 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!10239 【锁屏】【壁纸】api 接口变更整改 资料同步 

Merge pull request !10239 from LVB8189/master
上级 af822aea 2e80a0f8
显示空白变更内容
内联 并排
Showing with 640 addition and 21 deletion
zh-cn/application-dev/reference/apis/js-apis-screen-lock.md
浏览文件 @ 168ece0f
......@@ -20,6 +20,11 @@ isScreenLocked(callback: AsyncCallback<boolean>): void
判断屏幕是否锁屏，使用callback作为异步方法。
> **说明：**
> 从API version 9开始废弃。建议使用[screenlock.isLocked<sup>9+</sup>](#screenlockislocked9)代替。
>
> 从 API version 7开始支持。
**系统能力**: SystemCapability.MiscServices.ScreenLock
**参数：**
......@@ -47,6 +52,11 @@ isScreenLocked(): Promise&lt;boolean&gt;
判断屏幕是否锁屏，使用Promise作为异步方法。
> **说明：**
> 从API version 9开始废弃。建议使用[screenlock.isLocked<sup>9+</sup>](#screenlockislocked9)代替。
>
> 从 API version 7开始支持。
**系统能力**: SystemCapability.MiscServices.ScreenLock
**返回值**：
......@@ -66,17 +76,40 @@ isScreenLocked(): Promise&lt;boolean&gt;
```
## screenlock.isLocked<sup>9+</sup>
isLocked(): boolean;
判断屏幕是否锁屏，使用同步方法。
**系统能力**: SystemCapability.MiscServices.ScreenLock
**返回值**：
| 类型 | 说明 |
| -------- | -------- |
| boolean | 返回true表示当前屏幕已锁定，返回false表示当前屏幕未锁定。 |
**示例**：
```js
var isLocked = screenlock.isLocked();
```
## screenlock.isSecureMode
isSecureMode(callback: AsyncCallback&lt;boolean&gt;): void
判断设备是否处于安全模式下，使用callback作为异步方法。
> **说明：**
> 从API version 9开始废弃。建议使用[screenlock.isSecure<sup>9+</sup>](#screenlockissecure9)代替。
>
> 从 API version 7开始支持。
**系统能力**: SystemCapability.MiscServices.ScreenLock
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
......@@ -102,6 +135,11 @@ isSecureMode(): Promise&lt;boolean&gt;
判断设备是否处于安全模式下，使用Promise作为异步方法。
> **说明：**
> 从API version 9开始废弃。建议使用[screenlock.isSecure<sup>9+</sup>](#screenlockissecure9)代替。
>
> 从 API version 7开始支持。
**系统能力**: SystemCapability.MiscServices.ScreenLock
**返回值**：
......@@ -121,17 +159,40 @@ isSecureMode(): Promise&lt;boolean&gt;
```
## screenlock.isSecure<sup>9+</sup>
isSecure(): boolean;
判断设备是否处于安全模式下，使用同步方法。
**系统能力**: SystemCapability.MiscServices.ScreenLock
**返回值**：
| 类型 | 说明 |
| -------- | -------- |
| boolean | 返回true表示屏幕处于安全模式下，返回false表示屏幕当前不在安全模式下。 |
**示例**：
```js
var isSecure = screenlock.isSecure();
```
## screenlock.unlockScreen
unlockScreen(callback: AsyncCallback&lt;void&gt;): void
解锁屏幕，使用callback作为异步方法。
> **说明：**
> 从API version 9开始废弃。建议使用[screenlock.unlock<sup>9+</sup>](#screenlockunlock9)代替。
>
> 从 API version 7开始支持。
**系统能力**: SystemCapability.MiscServices.ScreenLock
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
......@@ -157,6 +218,11 @@ unlockScreen(): Promise&lt;void&gt;
解锁屏幕，使用Promise作为异步方法。
> **说明：**
> 从API version 9开始废弃。建议使用[screenlock.unlock<sup>9+</sup>](#screenlockunlock9)代替。
>
> 从 API version 7开始支持。
**系统能力**: SystemCapability.MiscServices.ScreenLock
**返回值**：
......@@ -176,14 +242,64 @@ unlockScreen(): Promise&lt;void&gt;
```
## screenlock.lockScreen<sup>9+</sup>
## screenlock.unlock<sup>9+</sup>
unlock(callback: AsyncCallback&lt;boolean&gt;): void
解锁屏幕，使用callback作为异步方法。
**系统能力**: SystemCapability.MiscServices.ScreenLock
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。返回true表示屏幕解锁成功，返回false表示屏幕解锁失败。 |
**示例**：
```js
screenlock.unlock((err,data) => {
if (err) {
console.error('unlock error -> ${JSON.stringify(err)}');
return;
}
console.info('unlock success data -> ${JSON.stringify(data)}');
});
```
## screenlock.unlock<sup>9+</sup>
lockScreen(callback: AsyncCallback&lt;boolean&gt;): void
unlock(): Promise&lt;boolean&gt;
解锁屏幕，使用Promise作为异步方法。
锁定屏幕，使用callback作为异步方法。
**系统能力**: SystemCapability.MiscServices.ScreenLock
**返回值**：
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | 以Promise形式返回结果。 |
**示例**：
```js
screenlock.unlock().then((data) => {
console.log('unlock success');
}).catch((err) => {
console.error('unlock fail, : err->${JSON.stringify(err)}');
});
```
## screenlock.lock<sup>9+</sup>
lock(callback: AsyncCallback&lt;boolean&gt;): void
锁定屏幕，使用callback作为异步方法。
**系统能力**: SystemCapability.MiscServices.ScreenLock
**系统接口**：此接口为系统接口，三方应用不支持调用。
......@@ -192,23 +308,23 @@ lockScreen(callback: AsyncCallback&lt;boolean&gt;): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数，失败时返回错误信息。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。返回true表示屏幕锁定成功，返回false表示屏幕锁定失败。 |
**示例**：
```js
screenlock.lockScreen((err) => {
screenlock.lock((err) => {
if (err) {
console.error('lockScreen callback error -> ${JSON.stringify(err)}');
console.error('lock callback error -> ${JSON.stringify(err)}');
return;
}
console.info('lockScreen callback success');
console.info('lock callback success');
});
```
## screenlock.lockScreen<sup>9+</sup>
## screenlock.lock<sup>9+</sup>
lockScreen(): Promise&lt;boolean&gt;
lock(): Promise&lt;boolean&gt;
锁定屏幕，使用Promise作为异步方法。
......@@ -225,10 +341,10 @@ lockScreen(): Promise&lt;boolean&gt;
**示例**：
```js
screenlock.lockScreen().then(() => {
console.log('lockScreen success');
screenlock.lock().then(() => {
console.log('lock success');
}).catch((err) => {
console.error('lockScreen fail, promise: err->${JSON.stringify(err)}');
console.error('lock fail, promise: err->${JSON.stringify(err)}');
});
```
......
zh-cn/application-dev/reference/apis/js-apis-wallpaper.md
浏览文件 @ 168ece0f
......@@ -32,6 +32,11 @@ getColors(wallpaperType: WallpaperType, callback: AsyncCallback&lt;Array&lt;Rgba
获取指定类型壁纸的主要颜色信息。
> **说明：**
> 从API version 9开始废弃。建议使用[wallpaper.getColorsSync<sup>9+</sup>](#wallpapergetcolorssync9)代替。
>
> 从 API version 7开始支持。
**系统能力**: SystemCapability.MiscServices.Wallpaper
**参数：**
......@@ -60,6 +65,11 @@ getColors(wallpaperType: WallpaperType): Promise&lt;Array&lt;RgbaColor&gt;&gt;
获取指定类型壁纸的主要颜色信息。
> **说明：**
> 从API version 9开始废弃。建议使用[wallpaper.getColorsSync<sup>9+</sup>](#wallpapergetcolorssync9)代替。
>
> 从 API version 7开始支持。
**系统能力**: SystemCapability.MiscServices.Wallpaper
**参数：**
......@@ -85,12 +95,44 @@ getColors(wallpaperType: WallpaperType): Promise&lt;Array&lt;RgbaColor&gt;&gt;
```
## wallpaper.getColorsSync<sup>9+</sup>
getColorsSync(wallpaperType: WallpaperType): Arrayy&lt;RgbaColory&gt;;
获取指定类型壁纸的主要颜色信息。
**系统能力**: SystemCapability.MiscServices.Wallpaper
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| wallpaperType | [WallpaperType](#wallpapertype) | 是 | 壁纸类型。 |
**返回值**：
| 类型 | 说明 |
| -------- | -------- |
| Array&lt;[RgbaColor](#rgbacolor)&gt; | 返回壁纸的主要颜色信息。 |
**示例**：
```js
var colors = wallpaper.getColorsSync(wallpaper.WallpaperType.WALLPAPER_SYSTEM);
```
## wallpaper.getId
getId(wallpaperType: WallpaperType, callback: AsyncCallback&lt;number&gt;): void
获取指定类型壁纸的ID。
> **说明：**
> 从API version 9开始废弃。建议使用[wallpaper.getIdSync<sup>9+</sup>](#wallpapergetidsync9)代替。
>
> 从 API version 7开始支持。
**系统能力**: SystemCapability.MiscServices.Wallpaper
**参数：**
......@@ -119,8 +161,12 @@ getId(wallpaperType: WallpaperType): Promise&lt;number&gt;
获取指定类型壁纸的ID。
**系统能力**: SystemCapability.MiscServices.Wallpaper
> **说明：**
> 从API version 9开始废弃。建议使用[wallpaper.getIdSync<sup>9+</sup>](#wallpapergetidsync9)代替。
>
> 从 API version 7开始支持。
**系统能力**: SystemCapability.MiscServices.Wallpaper
**参数：**
......@@ -145,12 +191,44 @@ getId(wallpaperType: WallpaperType): Promise&lt;number&gt;
```
## wallpaper.getIdSync<sup>9+</sup>
getIdSync(wallpaperType: WallpaperType): number;
获取指定类型壁纸的ID。
**系统能力**: SystemCapability.MiscServices.Wallpaper
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| wallpaperType | [WallpaperType](#wallpapertype) | 是 | 壁纸类型。 |
**返回值**：
| 类型 | 说明 |
| -------- | -------- |
| number | 返回壁纸的ID。如果配置了这种壁纸类型的壁纸就返回一个大于等于0的数，否则返回-1。取值范围是-1~2^31-1。 |
**示例**：
```js
var id = wallpaper.getIdSync(wallpaper.WallpaperType.WALLPAPER_SYSTEM);
```
## wallpaper.getMinHeight
getMinHeight(callback: AsyncCallback&lt;number&gt;): void
获取壁纸的最小高度值。
> **说明：**
> 从API version 9开始废弃。建议使用[wallpaper.getMinHeightSync<sup>9+</sup>](#wallpapergetminheightsync9)代替。
>
> 从 API version 7开始支持。
**系统能力**: SystemCapability.MiscServices.Wallpaper
**参数：**
......@@ -178,8 +256,12 @@ getMinHeight(): Promise&lt;number&gt;
获取壁纸的最小高度值。
**系统能力**: SystemCapability.MiscServices.Wallpaper
> **说明：**
> 从API version 9开始废弃。建议使用[wallpaper.getMinHeightSync<sup>9+</sup>](#wallpapergetminheightsync9)代替。
>
> 从 API version 7开始支持。
**系统能力**: SystemCapability.MiscServices.Wallpaper
**返回值：**
......@@ -198,14 +280,39 @@ getMinHeight(): Promise&lt;number&gt;
```
## wallpaper.getMinHeightSync<sup>9+</sup>
getMinHeightSync(): number
获取壁纸的最小高度值。
**系统能力**: SystemCapability.MiscServices.Wallpaper
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| number | 返回壁纸的最小高度值，单位是像素。如果返回值等于0，说明没有设置壁纸，调用者应该使用默认显示的高度值代替。 |
**示例：**
```js
var minHeight = wallpaper.getMinHeightSync();
```
## wallpaper.getMinWidth
getMinWidth(callback: AsyncCallback&lt;number&gt;): void
获取壁纸的最小宽度值。
**系统能力**: SystemCapability.MiscServices.Wallpaper
> **说明：**
> 从API version 9开始废弃。建议使用[wallpaper.getMinWidthSync<sup>9+</sup>](#wallpapergetminwidthsync9)代替。
>
> 从 API version 7开始支持。
**系统能力**: SystemCapability.MiscServices.Wallpaper
**参数：**
......@@ -232,6 +339,11 @@ getMinWidth(): Promise&lt;number&gt;
获取壁纸的最小宽度值。
> **说明：**
> 从API version 9开始废弃。建议使用[wallpaper.getMinWidthSync<sup>9+</sup>](#wallpapergetminwidthsync9)代替。
>
> 从 API version 7开始支持。
**系统能力**: SystemCapability.MiscServices.Wallpaper
**返回值：**
......@@ -251,12 +363,38 @@ getMinWidth(): Promise&lt;number&gt;
```
## wallpaper.getMinWidthSync<sup>9+</sup>
getMinWidthSync(): number
获取壁纸的最小宽度值。
**系统能力**: SystemCapability.MiscServices.Wallpaper
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| number | 壁纸的最小宽度值，单位是像素。如果返回值等于0，说明没有设置壁纸，调用者应该使用默认显示的宽度值代替。 |
**示例：**
```js
var minWidth = wallpaper.getMinWidthSync();
```
## wallpaper.isChangePermitted
isChangePermitted(callback: AsyncCallback&lt;boolean&gt;): void
是否允许应用改变当前用户的壁纸。
> **说明：**
> 从API version 9开始废弃。建议使用[wallpaper.isChangeAllowed<sup>9+</sup>](#wallpaperischangeallowed9)代替。
>
> 从 API version 7开始支持。
**系统能力**: SystemCapability.MiscServices.Wallpaper
**参数：**
......@@ -284,6 +422,11 @@ isChangePermitted(): Promise&lt;boolean&gt;
是否允许应用改变当前用户的壁纸。
> **说明：**
> 从API version 9开始废弃。建议使用[wallpaper.isChangeAllowed<sup>9+</sup>](#wallpaperischangeallowed9)代替。
>
> 从 API version 7开始支持。
**系统能力**: SystemCapability.MiscServices.Wallpaper
**返回值：**
......@@ -303,12 +446,38 @@ isChangePermitted(): Promise&lt;boolean&gt;
```
## wallpaper.isChangeAllowed<sup>9+</sup>
isChangeAllowed(): boolean
是否允许应用改变当前用户的壁纸。
**系统能力**: SystemCapability.MiscServices.Wallpaper
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| boolean | 返回是否允许应用改变当前用户的壁纸。如果允许返回true，否则返回false。 |
**示例：**
```js
var isChangeAllowed = wallpaper.isChangeAllowed();
```
## wallpaper.isOperationAllowed
isOperationAllowed(callback: AsyncCallback&lt;boolean&gt;): void
是否允许用户设置壁纸。
> **说明：**
> 从API version 9开始废弃。建议使用[wallpaper.isUserChangeAllowed<sup>9+</sup>](#wallpaperisuserchangeallowed9)代替。
>
> 从 API version 7开始支持。
**系统能力**: SystemCapability.MiscServices.Wallpaper
**参数：**
......@@ -336,6 +505,11 @@ isOperationAllowed(): Promise&lt;boolean&gt;
是否允许用户设置壁纸。
> **说明：**
> 从API version 9开始废弃。建议使用[wallpaper.isUserChangeAllowed<sup>9+</sup>](#wallpaperisuserchangeallowed9)代替。
>
> 从 API version 7开始支持。
**系统能力**: SystemCapability.MiscServices.Wallpaper
**返回值：**
......@@ -355,12 +529,38 @@ isOperationAllowed(): Promise&lt;boolean&gt;
```
## wallpaper.isUserChangeAllowed<sup>9+</sup>
isUserChangeAllowed(): boolean
是否允许用户设置壁纸。
**系统能力**: SystemCapability.MiscServices.Wallpaper
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| boolean | 返回是否允许用户设置壁纸。如果允许返回true，否则返回false。 |
**示例：**
```js
var isUserChangeAllowed = wallpaper.isUserChangeAllowed();
```
## wallpaper.reset
reset(wallpaperType: WallpaperType, callback: AsyncCallback&lt;void&gt;): void
移除指定类型的壁纸，恢复为默认显示的壁纸。
> **说明：**
> 从API version 9开始废弃。建议使用[wallpaper.restore<sup>9+</sup>](#wallpaperrestore9)代替。
>
> 从 API version 7开始支持。
**需要权限**：ohos.permission.SET_WALLPAPER
**系统能力**: SystemCapability.MiscServices.Wallpaper
......@@ -391,6 +591,11 @@ reset(wallpaperType: WallpaperType): Promise&lt;void&gt;
移除指定类型的壁纸，恢复为默认显示的壁纸。
> **说明：**
> 从API version 9开始废弃。建议使用[wallpaper.restore<sup>9+</sup>](#wallpaperrestore9)代替。
>
> 从 API version 7开始支持。
**需要权限**：ohos.permission.SET_WALLPAPER
**系统能力**: SystemCapability.MiscServices.Wallpaper
......@@ -418,12 +623,80 @@ reset(wallpaperType: WallpaperType): Promise&lt;void&gt;
```
## wallpaper.restore<sup>9+</sup>
restore(wallpaperType: WallpaperType, callback: AsyncCallback&lt;void&gt;): void
移除指定类型的壁纸，恢复为默认显示的壁纸。
**需要权限**：ohos.permission.SET_WALLPAPER
**系统能力**: SystemCapability.MiscServices.Wallpaper
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| wallpaperType | [WallpaperType](#wallpapertype) | 是 | 壁纸类型。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数，调用成功则返回是否移除成功的结果，调用失败则返回error信息。 |
**示例：**
```js
wallpaper.restore(wallpaper.WallpaperType.WALLPAPER_SYSTEM, (error, data) => {
if (error) {
console.error(`failed to restore because: ` + JSON.stringify(error));
return;
}
console.log(`success to restore.`);
});
```
## wallpaper.restore<sup>9+</sup>
restore(wallpaperType: WallpaperType): Promise&lt;void&gt;
移除指定类型的壁纸，恢复为默认显示的壁纸。
**需要权限**：ohos.permission.SET_WALLPAPER
**系统能力**: SystemCapability.MiscServices.Wallpaper
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| wallpaperType | [WallpaperType](#wallpapertype) | 是 | 壁纸类型。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | 调用成功则返回是否移除成功的结果，调用失败则返回error信息。 |
**示例：**
```js
wallpaper.restore(wallpaper.WallpaperType.WALLPAPER_SYSTEM).then((data) => {
console.log(`success to restore.`);
}).catch((error) => {
console.error(`failed to restore because: ` + JSON.stringify(error));
});
```
## wallpaper.setWallpaper
setWallpaper(source: string | image.PixelMap, wallpaperType: WallpaperType, callback: AsyncCallback&lt;void&gt;): void
将指定资源设置为指定类型的壁纸。
> **说明：**
> 从API version 9开始废弃。建议使用[wallpaper.setImage<sup>9+</sup>](#wallpapersetimage9)代替。
>
> 从 API version 7开始支持。
**需要权限**：ohos.permission.SET_WALLPAPER
**系统能力**: SystemCapability.MiscServices.Wallpaper
......@@ -478,6 +751,11 @@ setWallpaper(source: string | image.PixelMap, wallpaperType: WallpaperType): Pro
将指定资源设置为指定类型的壁纸。
> **说明：**
> 从API version 9开始废弃。建议使用[wallpaper.setImage<sup>9+</sup>](#wallpapersetimage9)代替。
>
> 从 API version 7开始支持。
**需要权限**：ohos.permission.SET_WALLPAPER
**系统能力**: SystemCapability.MiscServices.Wallpaper
......@@ -526,12 +804,127 @@ setWallpaper(source: string | image.PixelMap, wallpaperType: WallpaperType): Pro
});
```
## wallpaper.setImage<sup>9+</sup>
setImage(source: string | image.PixelMap, wallpaperType: WallpaperType, callback: AsyncCallback&lt;void&gt;): void
将指定资源设置为指定类型的壁纸。
**需要权限**：ohos.permission.SET_WALLPAPER
**系统能力**: SystemCapability.MiscServices.Wallpaper
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| source | string&nbsp;\|[PixelMap](js-apis-image.md#pixelmap7) | | JPEG或PNG文件的Uri路径，或者PNG格式文件的位图。 |
| wallpaperType | [WallpaperType](#wallpapertype) | 是 | 壁纸类型。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数，调用成功则返回是返回设置的结果，调用失败则返回error信息。 |
**示例：**
```js
// source类型为string
let wallpaperPath = "/data/data/ohos.acts.aafwk.plrdtest.form/files/Cup_ic.jpg";
wallpaper.setImage(wallpaperPath, wallpaper.WallpaperType.WALLPAPER_SYSTEM, (error, data) => {
if (error) {
console.error(`failed to setImage because: ` + JSON.stringify(error));
return;
}
console.log(`success to setImage.`);
});
// source类型为image.PixelMap
import image from '@ohos.multimedia.image';
let imageSource = image.createImageSource("file://" + wallpaperPath);
let opts = {
"desiredSize": {
"height": 3648,
"width": 2736
}
};
imageSource.createPixelMap(opts).then((pixelMap) => {
wallpaper.setImage(pixelMap, wallpaper.WallpaperType.WALLPAPER_SYSTEM, (error, data) => {
if (error) {
console.error(`failed to setImage because: ` + JSON.stringify(error));
return;
}
console.log(`success to setImage.`);
});
}).catch((error) => {
console.error(`failed to createPixelMap because: ` + JSON.stringify(error));
});
```
## wallpaper.setImage<sup>9+</sup>
setImage(source: string | image.PixelMap, wallpaperType: WallpaperType): Promise&lt;void&gt;
将指定资源设置为指定类型的壁纸。
**需要权限**：ohos.permission.SET_WALLPAPER
**系统能力**: SystemCapability.MiscServices.Wallpaper
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| source | string&nbsp;\|[PixelMap](js-apis-image.md#pixelmap7) | 是 | JPEG或PNG文件的Uri路径，或者PNG格式文件的位图。 |
| wallpaperType | [WallpaperType](#wallpapertype) | 是 | 壁纸类型。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | 调用成功则返回是返回设置的结果，调用失败则返回error信息。 |
**示例：**
```js
// source类型为string
let wallpaperPath = "/data/data/ohos.acts.aafwk.plrdtest.form/files/Cup_ic.jpg";
wallpaper.setImage(wallpaperPath, wallpaper.WallpaperType.WALLPAPER_SYSTEM).then((data) => {
console.log(`success to setImage.`);
}).catch((error) => {
console.error(`failed to setImage because: ` + JSON.stringify(error));
});
// source类型为image.PixelMap
import image from '@ohos.multimedia.image';
let imageSource = image.createImageSource("file://" + wallpaperPath);
let opts = {
"desiredSize": {
"height": 3648,
"width": 2736
}
};
imageSource.createPixelMap(opts).then((pixelMap) => {
wallpaper.setImage(pixelMap, wallpaper.WallpaperType.WALLPAPER_SYSTEM).then((data) => {
console.log(`success to setImage.`);
}).catch((error) => {
console.error(`failed to setImage because: ` + JSON.stringify(error));
});
}).catch((error) => {
console.error(`failed to createPixelMap because: ` + JSON.stringify(error));
});
```
## wallpaper.getFile<sup>8+</sup>
getFile(wallpaperType: WallpaperType, callback: AsyncCallback&lt;number&gt;): void
获取指定类型的壁纸文件。
> **说明：**
> 从API version 9开始废弃。建议使用[wallpaper.getFileSync<sup>9+</sup>](#wallpapergetfilesync9)代替。
>
> 从 API version 8开始支持。
**需要权限**：ohos.permission.GET_WALLPAPER
**系统能力**: SystemCapability.MiscServices.Wallpaper
......@@ -561,6 +954,11 @@ getFile(wallpaperType: WallpaperType): Promise&lt;number&gt;
获取指定类型的壁纸文件。
> **说明：**
> 从API version 9开始废弃。建议使用[wallpaper.getFileSync<sup>9+</sup>](#wallpapergetfilesync9)代替。
>
> 从 API version 8开始支持。
**需要权限**：ohos.permission.GET_WALLPAPER
**系统能力**: SystemCapability.MiscServices.Wallpaper
......@@ -588,12 +986,46 @@ getFile(wallpaperType: WallpaperType): Promise&lt;number&gt;
```
## wallpaper.getFileSync<sup>9+</sup>
getFileSync(wallpaperType: WallpaperType): number;
获取指定类型的壁纸文件。
**需要权限**：ohos.permission.GET_WALLPAPER
**系统能力**: SystemCapability.MiscServices.Wallpaper
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| wallpaperType | [WallpaperType](#wallpapertype) | 是 | 壁纸类型。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| number | 调用成功则返回壁纸文件描述符ID，调用失败则返回error信息。 |
**示例：**
```js
var file = wallpaper.getFileSync(wallpaper.WallpaperType.WALLPAPER_SYSTEM);
```
## wallpaper.getPixelMap
getPixelMap(wallpaperType: WallpaperType, callback: AsyncCallback&lt;image.PixelMap&gt;): void;
获取壁纸图片的像素图。
> **说明：**
> 从API version 9开始废弃。建议使用[wallpaper.getImage<sup>9+</sup>](#wallpapergetimage9)代替。
>
> 从 API version 7开始支持。
**需要权限**：ohos.permission.GET_WALLPAPER
**系统能力**: SystemCapability.MiscServices.Wallpaper
......@@ -623,6 +1055,11 @@ getPixelMap(wallpaperType: WallpaperType): Promise&lt;image.PixelMap&gt;
获取壁纸图片的像素图。
> **说明：**
> 从API version 9开始废弃。建议使用[wallpaper.getImage<sup>9+</sup>](#wallpapergetimage9)代替。
>
> 从 API version 7开始支持。
**需要权限**：ohos.permission.GET_WALLPAPER
**系统能力**: SystemCapability.MiscServices.Wallpaper
......@@ -654,7 +1091,73 @@ getPixelMap(wallpaperType: WallpaperType): Promise&lt;image.PixelMap&gt;
```
## wallpaper.on('colorChange')
## wallpaper.getImage<sup>9+</sup>
getImage(wallpaperType: WallpaperType, callback: AsyncCallback&lt;image.PixelMap&gt;): void;
获取壁纸图片的像素图。
**需要权限**：ohos.permission.GET_WALLPAPER
**系统能力**: SystemCapability.MiscServices.Wallpaper
**系统接口**：此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| wallpaperType | [WallpaperType](#wallpapertype) | 是 | 壁纸类型。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数，调用成功则返回壁纸图片的像素图大小，调用失败则返回error信息。 |
**示例：**
```js
wallpaper.getImage(wallpaper.WallpaperType.WALLPAPER_SYSTEM, function (err, data) {
console.info('wallpaperXTS ===> testgetImageCallbackSystem err : ' + JSON.stringify(err));
console.info('wallpaperXTS ===> testgetImageCallbackSystem data : ' + JSON.stringify(data));
});
```
## wallpaper.getImage<sup>9+</sup>
getImage(wallpaperType: WallpaperType): Promise&lt;image.PixelMap&gt;
获取壁纸图片的像素图。
**需要权限**：ohos.permission.GET_WALLPAPER
**系统能力**: SystemCapability.MiscServices.Wallpaper
**系统接口**：此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| wallpaperType | [WallpaperType](#wallpapertype) | 是 | 壁纸类型。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | 调用成功则返回壁纸图片的像素图大小，调用失败则返回error信息。 |
**示例：**
```js
wallpaper.getImage(wallpaper.WallpaperType.WALLPAPER_SYSTEM).then((data) => {
console.info('wallpaperXTS ===> testgetImagePromiseSystem data : ' + data);
console.info('wallpaperXTS ===> testgetImagePromiseSystem data : ' + JSON.stringify(data));
}).catch((err) => {
console.info('wallpaperXTS ===> testgetImagePromiseSystem err : ' + err);
console.info('wallpaperXTS ===> testgetImagePromiseSystem err : ' + JSON.stringify(err));
});
```
## wallpaper.on('colorChange')<sup>9+</sup>
on(type: 'colorChange', callback: (colors: Array&lt;RgbaColor&gt;, wallpaperType: WallpaperType) =&gt; void): void
......@@ -679,7 +1182,7 @@ on(type: 'colorChange', callback: (colors: Array&lt;RgbaColor&gt;, wallpaperType
```
## wallpaper.off('colorChange')
## wallpaper.off('colorChange')<sup>9+</sup>
off(type: 'colorChange', callback?: (colors: Array&lt;RgbaColor&gt;, wallpaperType: WallpaperType) =&gt; void): void
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或