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

# onUserScreenRecord

监听用户录屏事件。

## 扫码预览

![扫码预览 onUserScreenRecord](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%252Fon-user-screen-record%252Findex)

## 支持版本

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

## 支持平台

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

## 使用说明

- iOS 订阅成功后会立即回报一次当前录屏状态

## 调用方式

### 事件监听 API

```typescript
onUserScreenRecord(callback: (event: UserScreenRecordEvent) => void): () => void
```

## 入参

无。

## 调用示例

```ts
import { onUserScreenRecord } from '@doubao-dev/framework/api';

const off = onUserScreenRecord(({ state }) => {
  console.log(state);
});

off();
```

## 回调参数

<table>
<thead>
<tr><th>名称</th><th>类型</th><th>必返</th><th>说明</th></tr>
</thead>
<tbody>
<tr><td><code>event.state</code></td><td><code>UserScreenRecordState</code></td><td>是</td><td>录屏状态，start 表示开始录屏，stop 表示停止录屏。</td></tr>
</tbody>
</table>

## 返回值

返回取消当前监听函数的函数。

### 回调示例

```json
{
  "state": "start"
}
```

## 平台差异

- **Android**：仅 Android 15 及以上上报录屏事件，低版本不生效
