Device APIs
Screen Brightness
Get and set screen brightness.
Overview
The screen brightness APIs let you read and set the device screen brightness. Use my.getScreenBrightness to read the current value and my.setScreenBrightness to set it. Brightness is in the range 0–1.
my.getScreenBrightness
Gets the current screen brightness value.
Sample Code
my.getScreenBrightness({
success: (res) => {
my.alert({
content: "Current screen brightness: " + res.brightness,
});
},
});
Parameters
| Property | Type | Required | Description |
|---|---|---|---|
success | Function | No | Callback function upon call success. |
fail | Function | No | Callback function upon call failure. |
complete | Function | No | Callback function upon call completion (executed whether the call succeeds or fails). |
Success Callback Function
| Property | Type | Description |
|---|---|---|
brightness | Number | Current screen brightness, range 0–1. |
my.setScreenBrightness
Sets the screen brightness.
Sample Code
// Set brightness to 0.5 (50%)
my.setScreenBrightness({
brightness: 0.5,
success: () => {
my.alert({ content: "Brightness updated" });
},
});
Parameters
| Property | Type | Required | Description |
|---|---|---|---|
brightness | Number | Yes | Screen brightness to set, range 0–1. |
success | Function | No | Callback function upon call success. |
fail | Function | No | Callback function upon call failure. |
complete | Function | No | Callback function upon call completion (executed whether the call succeeds or fails). |
Usage Notes
- Brightness value must be between 0 and 1.
- Useful for in-app readers or night mode where you want to adjust screen brightness.
- Getting brightness on load helps restore the user’s previous setting.
Related Links
- my.getSystemInfo - Get system information
- my.vibrate - Device vibration