跳过主要内容
返回到插件
@capgo/capacitor-compass
教程
@capgo/capacitor-compass

compass

实时获取设备磁场角度并处理权限

指南

compass上的教程

在设备上测试

下载Capgo应用程序,然后扫描code中的二维码。

Compass插件预览二维码code

使用@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中,这始终返回'granted',因为没有权限要求。

示例使用

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中,这始终返回'granted',因为没有权限要求。

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

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

全局参考

Keep going from Using @capgo/capacitor-compass

使用@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-compass Using @capgo/capacitor-compass @API/__CAPGO_KEEP_1__-compass @capgo/capacitor-compass 关于 @capgo/capacitor-compass 的实现细节 开始使用 关于开始使用的实现细节 API概述 关于API概述的实现细节 介绍 关于介绍的实现细节 API密钥 关于API密钥的实现细节