Skip to content

D
Docs

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

通知 161
Star 293
Fork 28
D
Docs
提交 64695707 编写于 作者: L LVB8189
浏览文件
操作

Signed-off-by: LVB8189 <lvbai1@huawei.com> 

 Changes to be committed:
上级 5e908941
显示空白变更内容
内联 并排
Showing with 727 addition and 21 deletion
zh-cn/application-dev/reference/apis/js-apis-screen-lock.md
浏览文件 @ 64695707
......@@ -20,6 +20,11 @@ isScreenLocked(callback: AsyncCallback&lt;boolean&gt;): void
判断屏幕是否锁屏，使用callback作为异步方法。
> **说明：**
> 从API version 9开始废弃。建议使用[screenlock.isScreenLockedSync<sup>9+</sup>](#isScreenLockedSync9)代替。
>
> 从 API version 7开始支持
**系统能力**: SystemCapability.MiscServices.ScreenLock
**参数：**
......@@ -47,6 +52,11 @@ isScreenLocked(): Promise&lt;boolean&gt;
判断屏幕是否锁屏，使用Promise作为异步方法。
> **说明：**
> 从API version 9开始废弃。建议使用[screenlock.isScreenLockedSync<sup>9+</sup>](#isScreenLockedSync9)代替。
>
> 从 API version 7开始支持
**系统能力**: SystemCapability.MiscServices.ScreenLock
**返回值**：
......@@ -66,17 +76,44 @@ isScreenLocked(): Promise&lt;boolean&gt;
```
## screenlock.isLocked<sup>9+</sup>
isLocked(): boolean;
判断屏幕是否锁屏，使用同步方法。
**系统能力**: SystemCapability.MiscServices.ScreenLock
**返回值**：
| 类型 | 说明 |
| -------- | -------- |
| boolean | 返回true表示当前屏幕已锁定，返回false表示当前屏幕未锁定。 |
**示例**：
```js
screenlock.isLocked().then((data) => {
console.log('isLocked success: data -> ${JSON.stringify(data)}');
}).catch((err) => {
console.error('isLocked fail：err -> ${JSON.stringify(err)}');
});
```
## screenlock.isSecureMode
isSecureMode(callback: AsyncCallback&lt;boolean&gt;): void
判断设备是否处于安全模式下，使用callback作为异步方法。
> **说明：**
> 从API version 9开始废弃。建议使用[screenlock.isSecureModeSync<sup>9+</sup>](#isSecureModeSync9)代替。
>
> 从 API version 7开始支持
**系统能力**: SystemCapability.MiscServices.ScreenLock
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
......@@ -102,6 +139,11 @@ isSecureMode(): Promise&lt;boolean&gt;
判断设备是否处于安全模式下，使用Promise作为异步方法。
> **说明：**
> 从API version 9开始废弃。建议使用[screenlock.isSecureModeSync<sup>9+</sup>](#isSecureModeSync9)代替。
>
> 从 API version 7开始支持
**系统能力**: SystemCapability.MiscServices.ScreenLock
**返回值**：
......@@ -121,17 +163,44 @@ isSecureMode(): Promise&lt;boolean&gt;
```
## screenlock.isSecure<sup>9+</sup>
isSecure(): boolean;
判断设备是否处于安全模式下，使用同步方法。
**系统能力**: SystemCapability.MiscServices.ScreenLock
**返回值**：
| 类型 | 说明 |
| -------- | -------- |
| boolean | 返回true表示屏幕处于安全模式下，返回false表示屏幕当前不在安全模式下。 |
**示例**：
```js
screenlock.isSecure().then((data) => {
console.log('isSecure success: data -> ${JSON.stringify(data)}');
}).catch((err) => {
console.error('isSecure fail：err -> ${JSON.stringify(err)}');
});
```
## screenlock.unlockScreen
unlockScreen(callback: AsyncCallback&lt;void&gt;): void
解锁屏幕，使用callback作为异步方法。
> **说明：**
> 从API version 9开始废弃。建议使用[screenlock.unlockScreenWithException<sup>9+</sup>](#unlockScreenWithException9)代替。
>
> 从 API version 7开始支持
**系统能力**: SystemCapability.MiscServices.ScreenLock
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
......@@ -157,6 +226,11 @@ unlockScreen(): Promise&lt;void&gt;
解锁屏幕，使用Promise作为异步方法。
> **说明：**
> 从API version 9开始废弃。建议使用[screenlock.unlockScreenWithException<sup>9+</sup>](#unlockScreenWithException9)代替。
>
> 从 API version 7开始支持
**系统能力**: SystemCapability.MiscServices.ScreenLock
**返回值**：
......@@ -176,13 +250,63 @@ unlockScreen(): Promise&lt;void&gt;
```
## screenlock.lockScreen<sup>9+</sup>
## screenlock.unlock<sup>9+</sup>
lockScreen(callback: AsyncCallback&lt;boolean&gt;): void
unlock(callback: AsyncCallback&lt;boolean&gt;): void
解锁屏幕，使用callback作为异步方法。
锁定屏幕，使用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>
unlock(): Promise&lt;boolean&gt;
解锁屏幕，使用Promise作为异步方法。
**系统能力**: 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 +316,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 +349,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
浏览文件 @ 64695707
......@@ -32,6 +32,11 @@ getColors(wallpaperType: WallpaperType, callback: AsyncCallback&lt;Array&lt;Rgba
获取指定类型壁纸的主要颜色信息。
> **说明：**
> 从API version 9开始废弃。建议使用[wallpaper.getColorsSync<sup>9+</sup>](#getColorsSync9)代替。
>
> 从 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>](#getColorsSync9)代替。
>
> 从 API version 7开始支持
**系统能力**: SystemCapability.MiscServices.Wallpaper
**参数：**
......@@ -85,12 +95,48 @@ getColors(wallpaperType: WallpaperType): Promise&lt;Array&lt;RgbaColor&gt;&gt;
```
## wallpaper.getColorsSync<sup>9+</sup>
getColorsSync(wallpaperType: WallpaperType): Arrayy&lt;RgbaColory&lt;;
获取指定类型壁纸的主要颜色信息。
**系统能力**: SystemCapability.MiscServices.Wallpaper
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| wallpaperType | [WallpaperType](#wallpapertype) | 是 | 壁纸类型。 |
**返回值**：
| 类型 | 说明 |
| -------- | -------- |
| Array&lt;[RgbaColor](#rgbacolor)&gt; | 返回壁纸的主要颜色信息。 |
**示例**：
```js
wallpaper.getColorsSync(wallpaper.WallpaperType.WALLPAPER_SYSTEM).then((data) => {
console.log('success to getColors.');
}).catch((err) => {
console.error('failed to getColors because: ' + JSON.stringify(error));
});
```
## wallpaper.getId
getId(wallpaperType: WallpaperType, callback: AsyncCallback&lt;number&gt;): void
获取指定类型壁纸的ID。
> **说明：**
> 从API version 9开始废弃。建议使用[wallpaper.getIdSync<sup>9+</sup>](#getIdSync9)代替。
>
> 从 API version 7开始支持
**系统能力**: SystemCapability.MiscServices.Wallpaper
**参数：**
......@@ -119,8 +165,12 @@ getId(wallpaperType: WallpaperType): Promise&lt;number&gt;
获取指定类型壁纸的ID。
**系统能力**: SystemCapability.MiscServices.Wallpaper
> **说明：**
> 从API version 9开始废弃。建议使用[wallpaper.getIdSync<sup>9+</sup>](#getIdSync9)代替。
>
> 从 API version 7开始支持
**系统能力**: SystemCapability.MiscServices.Wallpaper
**参数：**
......@@ -145,12 +195,47 @@ 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
wallpaper.getIdSync(wallpaper.WallpaperType.WALLPAPER_SYSTEM).then((data) => {
console.log('success to getIdSync: ' + JSON.stringify(data));
}).catch((err) => {
console.error('failed to getIdSync because: ' + JSON.stringify(error));
});
## wallpaper.getMinHeight
getMinHeight(callback: AsyncCallback&lt;number&gt;): void
获取壁纸的最小高度值。
> **说明：**
> 从API version 9开始废弃。建议使用[wallpaper.getMinHeightSync<sup>9+</sup>](#getMinHeightSync9)代替。
>
> 从 API version 7开始支持
**系统能力**: SystemCapability.MiscServices.Wallpaper
**参数：**
......@@ -178,8 +263,12 @@ getMinHeight(): Promise&lt;number&gt;
获取壁纸的最小高度值。
**系统能力**: SystemCapability.MiscServices.Wallpaper
> **说明：**
> 从API version 9开始废弃。建议使用[wallpaper.getMinHeightSync<sup>9+</sup>](#getMinHeightSync9)代替。
>
> 从 API version 7开始支持
**系统能力**: SystemCapability.MiscServices.Wallpaper
**返回值：**
......@@ -198,14 +287,43 @@ getMinHeight(): Promise&lt;number&gt;
```
## wallpaper.getMinHeightSync<sup>9+</sup>
getMinHeightSync(): number
获取壁纸的最小高度值。
**系统能力**: SystemCapability.MiscServices.Wallpaper
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| number | 返回壁纸的最小高度值，单位是像素。如果返回值等于0，说明没有设置壁纸，调用者应该使用默认显示的高度值代替。 |
**示例：**
```js
wallpaper.getMinHeightSync().then((data) => {
console.log(`success to getMinHeightSync: ` + JSON.stringify(data));
}).catch((error) => {
console.error(`failed to getMinHeightSync because: ` + JSON.stringify(error));
});
```
## wallpaper.getMinWidth
getMinWidth(callback: AsyncCallback&lt;number&gt;): void
获取壁纸的最小宽度值。
**系统能力**: SystemCapability.MiscServices.Wallpaper
> **说明：**
> 从API version 9开始废弃。建议使用[wallpaper.getMinWidthSync<sup>9+</sup>](#getMinWidthSync9)代替。
>
> 从 API version 7开始支持
**系统能力**: SystemCapability.MiscServices.Wallpaper
**参数：**
......@@ -232,6 +350,11 @@ getMinWidth(): Promise&lt;number&gt;
获取壁纸的最小宽度值。
> **说明：**
> 从API version 9开始废弃。建议使用[wallpaper.getMinWidthSync<sup>9+</sup>](#getMinWidthSync9)代替。
>
> 从 API version 7开始支持
**系统能力**: SystemCapability.MiscServices.Wallpaper
**返回值：**
......@@ -251,12 +374,42 @@ getMinWidth(): Promise&lt;number&gt;
```
## wallpaper.getMinWidthSync<sup>9+</sup>
getMinWidthSync(): number
获取壁纸的最小宽度值。
**系统能力**: SystemCapability.MiscServices.Wallpaper
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| number | 壁纸的最小宽度值，单位是像素。如果返回值等于0，说明没有设置壁纸，调用者应该使用默认显示的宽度值代替。 |
**示例：**
```js
wallpaper.getMinWidthSync().then((data) => {
console.log(`success to getMinWidthSync: ` + JSON.stringify(data));
}).catch((error) => {
console.error(`failed to getMinWidthSync because: ` + JSON.stringify(error));
});
```
## wallpaper.isChangePermitted
isChangePermitted(callback: AsyncCallback&lt;boolean&gt;): void
是否允许应用改变当前用户的壁纸。
> **说明：**
> 从API version 9开始废弃。建议使用[wallpaper.isChangeAllowed<sup>9+</sup>](#isChangeAllowed9)代替。
>
> 从 API version 7开始支持
**系统能力**: SystemCapability.MiscServices.Wallpaper
**参数：**
......@@ -284,6 +437,11 @@ isChangePermitted(): Promise&lt;boolean&gt;
是否允许应用改变当前用户的壁纸。
> **说明：**
> 从API version 9开始废弃。建议使用[wallpaper.isChangeAllowed<sup>9+</sup>](#isChangeAllowed9)代替。
>
> 从 API version 7开始支持
**系统能力**: SystemCapability.MiscServices.Wallpaper
**返回值：**
......@@ -303,12 +461,42 @@ isChangePermitted(): Promise&lt;boolean&gt;
```
## wallpaper.isChangeAllowed<sup>9+</sup>
isChangeAllowed(): boolean
是否允许应用改变当前用户的壁纸。
**系统能力**: SystemCapability.MiscServices.Wallpaper
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| boolean | 返回是否允许应用改变当前用户的壁纸。如果允许返回true，否则返回false。 |
**示例：**
```js
wallpaper.isChangeAllowed().then((data) => {
console.log(`success to isChangeAllowed: ` + JSON.stringify(data));
}).catch((error) => {
console.error(`failed to isChangeAllowed because: ` + JSON.stringify(error));
});
```
## wallpaper.isOperationAllowed
isOperationAllowed(callback: AsyncCallback&lt;boolean&gt;): void
是否允许用户设置壁纸。
> **说明：**
> 从API version 9开始废弃。建议使用[wallpaper.isUserChangeAllowed<sup>9+</sup>](#isUserChangeAllowed9)代替。
>
> 从 API version 7开始支持
**系统能力**: SystemCapability.MiscServices.Wallpaper
**参数：**
......@@ -336,6 +524,11 @@ isOperationAllowed(): Promise&lt;boolean&gt;
是否允许用户设置壁纸。
> **说明：**
> 从API version 9开始废弃。建议使用[wallpaper.isUserChangeAllowed<sup>9+</sup>](#isUserChangeAllowed9)代替。
>
> 从 API version 7开始支持
**系统能力**: SystemCapability.MiscServices.Wallpaper
**返回值：**
......@@ -355,12 +548,42 @@ isOperationAllowed(): Promise&lt;boolean&gt;
```
## wallpaper.isUserChangeAllowed<sup>9+</sup>
isUserChangeAllowed(): boolean
是否允许用户设置壁纸。
**系统能力**: SystemCapability.MiscServices.Wallpaper
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| boolean | 返回是否允许用户设置壁纸。如果允许返回true，否则返回false。 |
**示例：**
```js
wallpaper.isUserChangeAllowed().then((data) => {
console.log(`success to isUserChangeAllowed: ` + JSON.stringify(data));
}).catch((error) => {
console.error(`failed to isUserChangeAllowed because: ` + JSON.stringify(error));
});
```
## wallpaper.reset
reset(wallpaperType: WallpaperType, callback: AsyncCallback&lt;void&gt;): void
移除指定类型的壁纸，恢复为默认显示的壁纸。
> **说明：**
> 从API version 9开始废弃。建议使用[wallpaper.recovery<sup>9+</sup>](#recovery9)代替。
>
> 从 API version 7开始支持
**需要权限**：ohos.permission.SET_WALLPAPER
**系统能力**: SystemCapability.MiscServices.Wallpaper
......@@ -391,6 +614,11 @@ reset(wallpaperType: WallpaperType): Promise&lt;void&gt;
移除指定类型的壁纸，恢复为默认显示的壁纸。
> **说明：**
> 从API version 9开始废弃。建议使用[wallpaper.recovery<sup>9+</sup>](#recovery9)代替。
>
> 从 API version 7开始支持
**需要权限**：ohos.permission.SET_WALLPAPER
**系统能力**: SystemCapability.MiscServices.Wallpaper
......@@ -418,6 +646,69 @@ reset(wallpaperType: WallpaperType): Promise&lt;void&gt;
```
## wallpaper.recovery<sup>9+</sup>
recovery(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.recovery(wallpaper.WallpaperType.WALLPAPER_SYSTEM, (error, data) => {
if (error) {
console.error(`failed to recovery because: ` + JSON.stringify(error));
return;
}
console.log(`success to recovery.`);
});
```
## wallpaper.recovery<sup>9+</sup>
recovery(wallpaperType: WallpaperType): Promise&lt;void&gt;
移除指定类型的壁纸，恢复为默认显示的壁纸。
**需要权限**：ohos.permission.SET_WALLPAPER
**系统能力**: SystemCapability.MiscServices.Wallpaper
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| wallpaperType | [WallpaperType](#wallpapertype) | 是 | 壁纸类型。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | 调用成功则返回是否移除成功的结果，调用失败则返回error信息。 |
**示例：**
```js
wallpaper.recovery(wallpaper.WallpaperType.WALLPAPER_SYSTEM).then((data) => {
console.log(`success to recovery.`);
}).catch((error) => {
console.error(`failed to recovery because: ` + JSON.stringify(error));
});
```
## wallpaper.setWallpaper
setWallpaper(source: string | image.PixelMap, wallpaperType: WallpaperType, callback: AsyncCallback&lt;void&gt;): void
......@@ -526,12 +817,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>](#getFileSync9)代替。
>
> 从 API version 8开始支持
**需要权限**：ohos.permission.GET_WALLPAPER
**系统能力**: SystemCapability.MiscServices.Wallpaper
......@@ -561,6 +967,11 @@ getFile(wallpaperType: WallpaperType): Promise&lt;number&gt;
获取指定类型的壁纸文件。
> **说明：**
> 从API version 9开始废弃。建议使用[wallpaper.getFileSync<sup>9+</sup>](#getFileSync9)代替。
>
> 从 API version 8开始支持
**需要权限**：ohos.permission.GET_WALLPAPER
**系统能力**: SystemCapability.MiscServices.Wallpaper
......@@ -588,6 +999,39 @@ getFile(wallpaperType: WallpaperType): Promise&lt;number&gt;
```
## wallpaper.getFileSync<sup>8+</sup>
getFileSync(wallpaperType: WallpaperType): number;
获取指定类型的壁纸文件。
**需要权限**：ohos.permission.GET_WALLPAPER
**系统能力**: SystemCapability.MiscServices.Wallpaper
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| wallpaperType | [WallpaperType](#wallpapertype) | 是 | 壁纸类型。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| number | 调用成功则返回壁纸文件描述符ID，调用失败则返回error信息。 |
**示例：**
```js
wallpaper.getFileSync(wallpaper.WallpaperType.WALLPAPER_SYSTEM).then((data) => {
console.log(`success to getFileSync: ` + JSON.stringify(data));
}).catch((error) => {
console.error(`failed to getFileSync because: ` + JSON.stringify(error));
});
```
## wallpaper.getPixelMap
getPixelMap(wallpaperType: WallpaperType, callback: AsyncCallback&lt;image.PixelMap&gt;): void;
......@@ -654,7 +1098,145 @@ 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.screenshotLiveWallpaper<sup>9+</sup>
screenshotLiveWallpaper(scale: number, pixelFormat: image.PixelMapFormat, callback: AsyncCallback&lt;image.PixelMap&gt;): void;
截取当前屏幕壁纸，当前暂不支持该功能。
**需要权限**：ohos.permission.CAPTURE_SCREEN
**系统能力**: SystemCapability.MiscServices.Wallpaper
**系统接口**：此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| scale | number | 是 | 图片的缩放模式。 |
| pixelFormat | [PixelMap](js-apis-image.md#PixelMapFormat7) | 是 | 图片像素格式。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数，调用成功则返回当前壁纸图片的像素图大小，调用失败则返回error信息。 |
**示例：**
```js
import image from '@ohos.multimedia.image';
var pixelFormat = image.PixelMapFormat.UNKNOWN;
wallpaper.screenshotLiveWallpaper(0, pixelFormat, function (err, data) {
console.info('wallpaperXTS ===> screenShotLiveWallpaperCallback err : ' + JSON.stringify(err));
console.info('wallpaperXTS ===> screenShotLiveWallpaperCallback data : ' + JSON.stringify(data));
});
```
## wallpaper.screenshotLiveWallpaper<sup>9+</sup>
screenshotLiveWallpaper(scale: number, pixelFormat: image.PixelMapFormat): Promise&lt;image.PixelMap&gt;
截取当前屏幕壁纸, 当前暂不支持该功能。
**需要权限**：ohos.permission.CAPTURE_SCREEN
**系统能力**: SystemCapability.MiscServices.Wallpaper
**系统接口**：此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| scale | number | 是 | 图片的缩放模式。 |
| pixelFormat | [PixelMap](js-apis-image.md#PixelMapFormat7) | 是 | 图片像素格式。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | 调用成功则返回当前壁纸图片的像素图大小，调用失败则返回error信息。 |
**示例：**
```js
import image from '@ohos.multimedia.image';
var pixelFormat = image.PixelMapFormat.UNKNOWN;
wallpaper.screenshotLiveWallpaper(0, pixelFormat).then((data) => {
console.info('wallpaperXTS ===> screenShotLiveWallpaperPromise data : ' + data);
console.info('wallpaperXTS ===> screenShotLiveWallpaperPromise data : ' + JSON.stringify(data));
}).catch((err) => {
console.info('wallpaperXTS ===> screenShotLiveWallpaperPromise err : ' + err);
console.info('wallpaperXTS ===> screenShotLiveWallpaperPromise 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 +1261,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.
先完成此消息的编辑！
想要评论请 注册 或