compass

使用@capgo/capacitor-compass

Capacitor Compass插件接口，用于读取设备compass方向

安装

bun add @capgo/capacitor-compass
bunx cap sync

此插件暴露的内容

• getCurrentHeading - 获取当前compass方向（度数）。在iOS上，方向会在后台更新，返回最新值。在Android上，方向会在调用方法时使用加速计和磁力计传感器计算。未在Web上实现。
• startListening - 开始监听compass方向变化的事件。这会启动compass传感器并发送'headingChange'事件。
• stopListening - 停止监听compass方向变化的事件。这会停止compass传感器并停止发送事件。
• checkPermissions - 检查访问compass数据的当前权限状态。 在iOS中，这检查位置权限状态。 在Android中，这始终返回'授权'，因为没有权限要求。

示例用法

getCurrentHeading

获取当前compass方向（以度为单位）。 在iOS中，方向在后台更新，返回最新值。 在Android中，方向在调用方法时使用加速计和磁力计传感器计算。 未在Web中实现。

import { CapgoCompass } from '@capgo/capacitor-compass';

const { value } = await CapgoCompass.getCurrentHeading();
console.log('Compass heading:', value, 'degrees');

startListening

开始监听compass方向变化的事件。 这开始compass传感器并发出'headingChange'事件。

import { CapgoCompass } from '@capgo/capacitor-compass';

// With default throttling (100ms interval, 2° minimum change)
await CapgoCompass.startListening();

// With custom throttling for high-frequency updates
await CapgoCompass.startListening({
  minInterval: 50,      // 50ms between events
  minHeadingChange: 1.0 // 1° minimum change
});

CapgoCompass.addListener('headingChange', (event) => {
  console.log('Heading:', event.value);
});

stopListening

停止监听compass方向变化的事件。 这停止compass传感器并停止发出事件。

import { CapgoCompass } from '@capgo/capacitor-compass';

await CapgoCompass.stopListening();

checkPermissions

检查访问compass数据的当前权限状态。 在iOS中，这检查位置权限状态。 在Android中，这始终返回'授权'，因为没有权限要求。

import { CapgoCompass } from '@capgo/capacitor-compass';

const status = await CapgoCompass.checkPermissions();
console.log('Compass permission:', status.compass);

全局参考

• GitHub: https://github.com/Cap-go/capacitor-compass/
• 文档：/docs/plugins/compass/