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/startCompass.md.

startCompass

开始监听罗盘。

扫码预览

扫码预览 startCompass

支持版本

前端库版本不低于 0.0.25。

支持平台

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

支持场景

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

接入准备

前置条件

  • 无额外前置条件;建议在启动前注册 onCompassChange

使用说明

需配对调用 stopCompass。

  • 不再需要时及时调用 stopCompass,避免持续采集造成额外功耗

调用方式

异步 API

startCompass(params?: object): Promise<object>

入参

无。

调用示例

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

await startCompass();

成功返回

无返回字段。

返回示例

{}

错误处理

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

失败示例

{
  "errNo": 103,
  "errMsg": "feature not support"
}

错误码

errNoerrMsg平台触发条件处理建议
103feature not supportAndroid、iOS当前设备不支持罗盘传感器或无法注册监听在具备罗盘传感器的设备上调用,或提前提示用户设备不支持。

通用错误码

errNoerrMsg说明平台
102internal error内部错误Android、iOS