For AI agents: the complete documentation index is available at /apps-plugin/docs/llms.txt, the full documentation bundle is available at /apps-plugin/docs/llms-full.txt, and this page is available as Markdown at /apps-plugin/docs/js-api/device/screen/setScreenBrightness.md.

setScreenBrightness

设置屏幕亮度。

扫码预览

扫码预览 setScreenBrightness

支持版本

前端库版本不低于 0.4.0。

支持平台

平台支持情况
Android支持
iOS支持
PC不支持
HarmonyOS不支持

支持场景

场景支持情况
页面支持
卡片不支持

接入准备

前置条件

  • value 必须是 0 到 1 之间的有限数字

使用说明

  • 该设置仅在当前应用插件生命周期内生效,退出后自动恢复原亮度

调用方式

异步 API

setScreenBrightness(params: SetScreenBrightnessParams): Promise<object>

入参

名称类型必填默认值约束说明
valuenumber是-取值范围 0 到 1,0 最暗,1 最亮屏幕亮度值。

调用示例

import { setScreenBrightness } from '@doubao-dev/framework/api';

await setScreenBrightness({ value: 0.8 });

成功返回

无返回字段。

返回示例

{}

错误处理

错误对象和通用错误码见 通用错误处理。

错误码

通用错误码

errNoerrMsg说明平台
102internal error内部错误Android、iOS
103feature not support当前环境不支持该能力Android、iOS
104invalid parameter参数不合法Android、iOS

平台差异

  • Android:使用当前宿主窗口亮度,不修改系统全局亮度
  • iOS:应用插件进入后台时恢复系统亮度,回到前台时重新应用设置值