1# 屏幕亮度 2 3> **说明：** 4> - 从API Version 7 开始，该接口不再维护，推荐使用新接口[`@ohos.brightness`](js-apis-brightness.md)。 5> 6> - 本模块首批接口从API version 3开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 7 8 9## 导入模块 10 11 12```js 13import brightness from '@system.brightness'; 14``` 15 16 17## brightness.getValue 18 19getValue(Object): void 20 21获得设备当前的屏幕亮度值。 22 23**系统能力：** SystemCapability.PowerManager.DisplayPowerManager 24 25**参数：** 26 27| 参数名 | 类型 | 必填 | 说明 | 28| -------- | -------- | -------- | -------- | 29| success | (data: [BrightnessResponse](#brightnessresponse)) => void | 否 | 接口调用成功的回调函数。 | 30| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数。 | 31| complete | () => void | 否 | 接口调用结束的回调函数。 | 32 33success返回值： 34 35| 参数名 | 类型 | 说明 | 36| -------- | -------- | -------- | 37| value | number | 屏幕亮度，取值为1-255之间的整数。 | 38 39 40**示例：** 41 42 ```js 43 export default { 44 getValue() { 45 brightness.getValue({ 46 success: function(data){ 47 console.log('success get brightness value:' + data.value); 48 }, 49 fail: function(data, code) { 50 console.log('get brightness fail, code: ' + code + ', data: ' + data); 51 }, 52 }); 53 }, 54 } 55 ``` 56 57 58## brightness.setValue 59 60setValue(Object): void 61 62设置设备当前的屏幕亮度值。 63 64**系统能力：** SystemCapability.PowerManager.DisplayPowerManager 65 66**参数：** 67 68| 参数名 | 类型 | 必填 | 说明 | 69| -------- | -------- | -------- | -------- | 70| value | number | 是 | 屏幕亮度，值为1-255之间的整数。<br/>- 如果值小于等于0，系统按1处理。<br/>- 如果值大于255，系统按255处理。<br/>- 如果值为小数，系统将处理为整数。例如设置为8.1，系统按8处理。 | 71| success | () => void | 否 | 接口调用成功的回调函数。 | 72| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数。 | 73| complete | () => void | 否 | 接口调用结束的回调函数。 | 74 75**示例：** 76 77 ```js 78 export default { 79 setValue() { 80 brightness.setValue({ 81 value: 100, 82 success: function(){ 83 console.log('handling set brightness success.'); 84 }, 85 fail: function(data, code){ 86 console.log('handling set brightness value fail, code:' + code + ', data: ' + data); 87 }, 88 }); 89 }, 90 } 91 ``` 92 93 94## brightness.getMode 95 96getMode(Object): void 97 98获得当前屏幕亮度模式。 99 100**系统能力：** SystemCapability.PowerManager.DisplayPowerManager 101 102**参数：** 103 104| 参数名 | 类型 | 必填 | 说明 | 105| -------- | -------- | -------- | -------- | 106| success | (data: [BrightnessModeResponse](#brightnessmoderesponse)) => void | 否 | 接口调用成功的回调函数。 | 107| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数。 | 108| complete | () => void | 否 | 接口调用结束的回调函数。 | 109 110success返回值： 111 112| 参数名 | 类型 | 说明 | 113| -------- | -------- | -------- | 114| mode | number | 值为0或1：<br/>- 0为手动调节屏幕亮度模式<br/>- 1为自动调节屏幕亮度模式 | 115 116**示例：** 117 118 ```js 119 export default { 120 getMode() { 121 brightness.getMode({ 122 success: function(data){ 123 console.log('success get mode:' + data.mode); 124 }, 125 fail: function(data, code){ 126 console.log('handling get mode fail, code:' + code + ', data: ' + data); 127 }, 128 }); 129 }, 130 } 131 ``` 132 133 134## brightness.setMode 135 136setMode(Object): void 137 138设置设备当前的屏幕亮度模式。 139 140**系统能力：** SystemCapability.PowerManager.DisplayPowerManager 141 142**参数：** 143| 参数名 | 类型 | 必填 | 说明 | 144| -------- | -------- | -------- | -------- | 145| mode | number | 是 | 值为0或1<br/>- 0为手动调节屏幕亮度。<br/>- 1为自动调节屏幕亮度。 | 146| success | () => void | 否 | 接口调用成功的回调函数。 | 147| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数。 | 148| complete | () => void | 否 | 接口调用结束的回调函数。 | 149 150**示例：** 151 152 ```js 153 export default { 154 setMode() { 155 brightness.setMode({ 156 mode: 1, 157 success: function(){ 158 console.log('handling set mode success.'); 159 }, 160 fail: function(data, code){ 161 console.log('handling set mode fail, code:' + code + ', data: ' + data); 162 }, 163 }); 164 }, 165 } 166 ``` 167 168 169## brightness.setKeepScreenOn 170 171setKeepScreenOn(Object): void 172 173设置屏幕是否保持常亮状态，开启常亮模式推荐在onShow()阶段调用。 174 175**系统能力：** SystemCapability.PowerManager.DisplayPowerManager 176 177**参数：** 178| 参数名 | 类型 | 必填 | 说明 | 179| -------- | -------- | -------- | -------- | 180| keepScreenOn | boolean | 是 | 是否保持屏幕常亮。 | 181| success | () => void | 否 | 接口调用成功的回调函数。 | 182| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数。 | 183| complete | () => void | 否 | 接口调用结束的回调函数。 | 184 185**示例：** 186 187 ```js 188 export default { 189 setKeepScreenOn() { 190 brightness.setKeepScreenOn({ 191 keepScreenOn: true, 192 success: function () { 193 console.log('handling set keep screen on success.') 194 }, 195 fail: function (data, code) { 196 console.log('handling set keep screen on fail, code:' + code + ', data: ' + data); 197 }, 198 }); 199 }, 200 } 201 ``` 202## 203 204## BrightnessResponse 205 206| 名称 | 类型 | 说明 | 207| -------- | -------- | -------- | 208| value | number | 屏幕亮度，取值为1-255之间的整数。 | 209 210## BrightnessModeResponse 211 212| 名称 | 类型 | 说明 | 213| -------- | -------- | -------- | 214| mode | number | 值为0或1。<br> -0为手动调节屏幕亮度模式。<br>-1为手动调节屏幕亮度模式。 | 215 216