> 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.

# setScreenBrightness

设置屏幕亮度。

## 扫码预览

![扫码预览 setScreenBrightness](https://api.qrserver.com/v1/create-qr-code/?size=200x200\&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fapi%252Fdevice%252Fget-screen-brightness%252Findex)

## 支持版本

前端库版本不低于 `0.4.0`。

## 支持平台

<table>
<thead>
<tr><th>平台</th><th>支持情况</th></tr>
</thead>
<tbody>
<tr><td>Android</td><td>支持</td></tr>
<tr><td>iOS</td><td>支持</td></tr>
<tr><td>PC</td><td>不支持</td></tr>
<tr><td>HarmonyOS</td><td>不支持</td></tr>
</tbody>
</table>

## 支持场景

<table>
<thead>
<tr><th>场景</th><th>支持情况</th></tr>
</thead>
<tbody>
<tr><td>页面</td><td>支持</td></tr>
<tr><td>卡片</td><td>不支持</td></tr>
</tbody>
</table>

## 接入准备

### 前置条件

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

## 使用说明

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

## 调用方式

### 异步 API

```typescript
setScreenBrightness(params: SetScreenBrightnessParams): Promise<object>
```

## 入参

<table>
<thead>
<tr><th>名称</th><th>类型</th><th>必填</th><th>默认值</th><th>约束</th><th>说明</th></tr>
</thead>
<tbody>
<tr><td><code>value</code></td><td><code>number</code></td><td>是</td><td>-</td><td>取值范围 0 到 1，0 最暗，1 最亮</td><td>屏幕亮度值。</td></tr>
</tbody>
</table>

## 调用示例

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

await setScreenBrightness({ value: 0.8 });
```

## 成功返回

无返回字段。

### 返回示例

```json
{}
```

## 错误处理

错误对象和通用错误码见 [通用错误处理](/apps-plugin/docs/js-api/common-errors.md#错误返回)。

### 错误码

#### 通用错误码

<table>
<thead>
<tr><th>errNo</th><th>errMsg</th><th>说明</th><th>平台</th></tr>
</thead>
<tbody>
<tr><td><code>102</code></td><td><code>internal error</code></td><td>内部错误</td><td>Android、iOS</td></tr>
<tr><td><code>103</code></td><td><code>feature not support</code></td><td>当前环境不支持该能力</td><td>Android、iOS</td></tr>
<tr><td><code>104</code></td><td><code>invalid parameter</code></td><td>参数不合法</td><td>Android、iOS</td></tr>
</tbody>
</table>

## 平台差异

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