Skip to main content
Use this API to get the current screen brightness level.

​
Parameters

PropertyTypeRequiredDescription
successFunctionNoCallback on success
failFunctionNoCallback on failure
completeFunctionNoCallback that always executes

​
Success Callback Parameters

PropertyTypeDescription
brightnessNumberScreen brightness value (0-1)

​
Code Example

​
Basic Usage

my.getScreenBrightness({
  success(res) {
    console.log('Current brightness:', res.brightness);
  }
});

​
Display Brightness Percentage

Page({
  data: {
    brightnessPercent: 0
  },

  onLoad() {
    my.getScreenBrightness({
      success: (res) => {
        this.setData({
          brightnessPercent: Math.round(res.brightness * 100)
        });
      }
    });
  }
});

​
Brightness Adjustment UI

Page({
  data: {
    brightness: 0.5
  },

  onLoad() {
    my.getScreenBrightness({
      success: (res) => {
        this.setData({ brightness: res.brightness });
      }
    });
  },

  onBrightnessChange(e) {
    const value = e.detail.value / 100;
    my.setScreenBrightness({
      brightness: value,
      success: () => {
        this.setData({ brightness: value });
      }
    });
  }
});

my.setScreenBrightness

Set screen brightness