使用 @capgo/capacitor-brightness
在 iOS 和 Android 上控制屏幕亮度。
安装
bun add @capgo/capacitor-brightness
bunx cap sync
bunx cap sync 将插件的原生 code 复制到你的原生项目中。每次升级插件后都要重新运行。
导入
import { CapgoBrightness } from '@capgo/capacitor-brightness';
API 概览
| 方法 | 描述 |
|---|---|
getBrightness |
获取设备主屏幕当前的亮度值。 |
setBrightness |
设置设备主屏幕的亮度值。 |
getSystemBrightness |
获取系统级屏幕亮度。 |
setSystemBrightness |
设置系统级屏幕亮度。Android 端需要 WRITE_SETTINGS 权限。此操作会将亮度模式切换为 MANUAL。 |
getSystemBrightnessMode |
获取当前的系统亮度模式（自动或手动）。Android 端需要 WRITE_SETTINGS 权限。 |
setSystemBrightnessMode |
设置系统亮度模式（自动或手动）。Android 端需要 WRITE_SETTINGS 权限。 |
isUsingSystemBrightness |
检查当前 Activity 是否正在使用系统级亮度值。 |
restoreSystemBrightness |
将当前 Activity 的亮度设置重置为使用系统级亮度值。 |
isAvailable |
检查当前设备是否支持 Brightness API。 |
checkPermissions |
检查用户是否拥有访问系统亮度的权限。 |
requestPermissions |
请求访问系统亮度的权限。在 Android 上，这将打开系统设置以授予 WRITE_SETTINGS 权限。 |
示例
getBrightness()
获取设备主屏幕当前的亮度值。
import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.getBrightness();
console.log(result);
setBrightness()
设置设备主屏幕的亮度值。
import { CapgoBrightness } from '@capgo/capacitor-brightness';
await CapgoBrightness.setBrightness({ brightness: 0.5 });
getSystemBrightness()
获取系统级屏幕亮度。
import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.getSystemBrightness();
console.log(result);
setSystemBrightness()
设置系统级屏幕亮度。Android 端需要 WRITE_SETTINGS 权限。此操作会将亮度模式切换为 MANUAL。
import { CapgoBrightness } from '@capgo/capacitor-brightness';
await CapgoBrightness.setSystemBrightness({ brightness: 0.5 });
getSystemBrightnessMode()
获取当前的系统亮度模式（自动或手动）。Android 端需要 WRITE_SETTINGS 权限。
import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.getSystemBrightnessMode();
console.log(result);
setSystemBrightnessMode()
设置系统亮度模式（自动或手动）。Android 端需要 WRITE_SETTINGS 权限。
import { CapgoBrightness, BrightnessMode } from '@capgo/capacitor-brightness';
await CapgoBrightness.setSystemBrightnessMode({ mode: BrightnessMode.AUTOMATIC });
上表列出了 11 个核心方法。有关 Listener、版本辅助函数以及每个方法的完整契约，请参阅 GitHub 仓库.
完整参考文档
继续阅读“使用 @capgo/capacitor-brightness”
如果你正在使用 使用 @capgo/capacitor-brightness 来规划原生媒体和界面行为，并将其与 @capgo/capacitor-brightness 查看 @capgo/capacitor-brightness 中的实现细节， 快速入门 有关“入门指南”中的实现细节， 使用 @capgo/capacitor-live-activities 用于使用 @capgo/capacitor-live-activities 时的原生能力， @capgo/capacitor-live-activities 关于 @capgo/capacitor-live-activities 中的实现细节，以及 使用 @capgo/capacitor-video-player 有关“使用 @capgo/capacitor-video-player.”中的原生能力