# 屏幕亮度 brightness

# 接口声明

{ "name": "system.brightness" }
1

# 导入模块

import brightness from '@system.brightness' 或 const brightness = require('@system.brightness')
1

# 接口定义

# brightness.getValue(OBJECT)

获得当前屏幕亮度值

# 参数：

参数名 类型 必填 说明
success Function 否 成功回调
fail Function 否 失败回调
complete Function 否 执行结束后的回调
# success 返回值：
参数值 类型 说明
value Integer 屏幕亮度，取值范围 0-255

# 示例：

brightness.getValue({
  success: function(data) {
    console.log(`handling success, value = ${data.value}`)
  },
  fail: function(data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})
1
2
3
4
5
6
7
8

# brightness.setValue(OBJECT)

设置当前屏幕亮度值

# 参数：

参数名 类型 必填 说明
value Integer 是 屏幕亮度，取值范围 0-255
success Function 否 成功回调
fail Function 否 失败回调
complete Function 否 执行结束后的回调

# 示例：

brightness.setValue({
  value: 100,
  success: function() {
    console.log('handling success')
  },
  fail: function(data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})
1
2
3
4
5
6
7
8
9

# brightness.getMode(OBJECT)

获得当前屏幕亮度模式

# 参数：

参数名 类型 必填 说明
success Function 否 成功回调
fail Function 否 失败回调
complete Function 否 执行结束后的回调
# success 返回值：
参数值 类型 说明
mode Integer 0 为手动调节屏幕亮度,1 为自动调节屏幕亮度

# 示例：

brightness.getMode({
  success: function(data) {
    console.log(`handling success, mode = ${data.mode}`)
  },
  fail: function(data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})
1
2
3
4
5
6
7
8

# brightness.setMode(OBJECT)

设置当前屏幕亮度模式

# 参数：

参数名 类型 必填 说明
mode Integer 是 0 为手动调节屏幕亮度,1 为自动调节屏幕亮度
success Function 否 成功回调
fail Function 否 失败回调
complete Function 否 执行结束后的回调

# 示例：

brightness.setMode({
  mode: 1,
  success: function() {
    console.log('handling success')
  },
  fail: function(data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})
1
2
3
4
5
6
7
8
9

# brightness.setKeepScreenOn(OBJECT)

设置是否保持常亮状态

# 参数：

参数名 类型 必填 说明
keepScreenOn Boolean 是 是否保持屏幕常亮
success Function 否 成功回调
fail Function 否 失败回调
complete Function 否 执行结束后的回调

# 示例：

brightness.setKeepScreenOn({
  keepScreenOn: true,
  success: function() {
    console.log('handling success')
  },
  fail: function(data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})
1
2
3
4
5
6
7
8
9

# brightness.wakeScreenOn(OBJECT)

点亮或熄灭屏幕

# 参数：

参数名 类型 必填 说明
screenOn Boolean 是 是否点亮
timeout Number 否 自动熄灭时间，不填则不限时间
success Function 否 成功回调
fail Function 否 失败回调
complete Function 否 执行结束后的回调

# 示例：

brightness.wakeScreenOn({
  screenOn: true,
  timeout: 3 * 60 * 1000
  success: function() {
    console.log('handling success')
  },
  fail: function(data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})
1
2
3
4
5
6
7
8
9
10