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/compass/onCompassChange.md.

onCompassChange

监听罗盘数据变化事件。

扫码预览

扫码预览 onCompassChange

支持版本

前端库版本不低于 0.0.26。

支持平台

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

支持场景

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

接入准备

前置条件

  • 调用 startCompass 后事件才会持续回调

使用说明

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

调用方式

事件监听 API

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

入参

无。

调用示例

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

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

off();

回调参数

名称类型必返说明
event.directionnumber是面对的方向度数,范围 0 到 360。

返回值

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

回调示例

{
  "direction": 128.5
}