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

# onCompassChange

监听罗盘数据变化事件。

## 扫码预览

![扫码预览 onCompassChange](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%252Fcompass%252Findex)

## 支持版本

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

## 支持平台

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

## 接入准备

### 前置条件

- 调用 `startCompass` 后事件才会持续回调

## 使用说明

- 取消函数只移除本地回调，需要停止采集时调用 `stopCompass`

## 调用方式

### 事件监听 API

```typescript
onCompassChange(callback: (event: CompassChangeEvent) => void): () => void
```

## 入参

无。

## 调用示例

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

const off = onCompassChange(({ direction }) => {
  console.log(direction);
});

off();
```

## 回调参数

<table>
<thead>
<tr><th>名称</th><th>类型</th><th>必返</th><th>说明</th></tr>
</thead>
<tbody>
<tr><td><code>event.direction</code></td><td><code>number</code></td><td>是</td><td>面对的方向度数，范围 0 到 360。</td></tr>
</tbody>
</table>

## 返回值

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

### 回调示例

```json
{
  "direction": 128.5
}
```
