js-apis-brightness.md 1.2 KB
Newer Older
Z
zengyawen 已提交
1
# 屏幕亮度
Z
zengyawen 已提交
2

3 4
该模块提供屏幕亮度的设置接口。

Z
zengyawen 已提交
5
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
A
aqxyjay 已提交
6 7 8 9
>
> - 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
> - 本模块接口为系统接口。
Z
zengyawen 已提交
10 11

## 导入模块
Z
zengyawen 已提交
12

A
aqxyjay 已提交
13
```js
Z
zengyawen 已提交
14
import brightness from '@ohos.brightness';
Z
zengyawen 已提交
15 16
```

Z
zengyawen 已提交
17
## brightness.setValue
Z
zengyawen 已提交
18

19
setValue(value: number): void
Z
zengyawen 已提交
20

Z
zengyawen 已提交
21
设置系统的屏幕亮度。
Z
zengyawen 已提交
22

A
aqxyjay 已提交
23
**系统接口:** 此接口为系统接口。
24

25
**系统能力:** SystemCapability.PowerManager.DisplayPowerManager
Z
zengyawen 已提交
26 27 28

**参数:**

A
aqxyjay 已提交
29 30 31 32 33 34 35 36 37 38 39 40 41
| 参数名 | 类型   | 必填 | 说明                    |
| ------ | ------ | ---- | ----------------------- |
| value  | number | 是   | 亮度的值。范围:0~255。 |

**错误码:**

以下错误码的详细介绍请参见[屏幕亮度错误码](../errorcodes/errorcode-brightness.md)

| 错误码ID   | 错误信息    |
|---------|---------|
| 201     | 权限校验失败。 |
| 401     | 参数检查失败。 |
| 4700101 | 连接服务失败。 |
Z
zengyawen 已提交
42

Z
zengyawen 已提交
43 44
**示例:**

A
aqxyjay 已提交
45
```js
A
aqxyjay 已提交
46 47 48 49 50
try {
    brightness.setValue(128);
} catch(err) {
    console.error('set brightness failed, err: ' + err);
}
Z
zengyawen 已提交
51
```