コンパス

コンパス機能を使用するには、@capgo/capacitor-compassを使用します。

Capacitorコンパス プラグインのインターフェイスは、デバイスのコンパス向きを読み取ることができます。

インストール

bun add @capgo/capacitor-compass
bunx cap sync

このプラグインが公開するもの

• getCurrentHeading - 度数で現在のコンパス向きを取得します。iOSでは、向きはバックグラウンドで更新され、最新の値が返されます。Androidでは、加速度計と磁気計センサーを使用してメソッドを呼び出すと、向きが計算されます。Webでは実装されていません。
• startListening - コンパス向きの変更をイベントを介してリスンすることを開始します。この操作により、コンパスセンサーを開始し、'headingChange'イベントを発行します。
• stopListening - コンパス向きの変更をリスンすることを停止します。この操作により、コンパスセンサーを停止し、イベントの発行を停止します。
• checkPermissions - __CAPGO_KEEP_0__のデータへのアクセス許可の現在の状態を確認してください。 iOSでは、位置情報の許可状態を確認します。 Androidでは、このメソッドは常に'許可されている'と返します。

Example Usage

getCurrentHeading

__CAPGO_KEEP_0__の現在の方位角度を取得します。 iOSでは、背景で方位角度が更新され、最新の値が返されます。 Androidでは、加速度計と磁気センサを使用してメソッドが呼び出されたときに方位角度が計算されます。 Webでは実装されていません。

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

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

startListening

__CAPGO_KEEP_0__の方位角度の変更をイベントを介してリスンすることができます。 このメソッドは、__CAPGO_KEEP_0__センサを開始し、'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

__CAPGO_KEEP_0__の方位角度の変更をリスンすることを停止します。 このメソッドは、__CAPGO_KEEP_0__センサを停止し、イベントの発行を停止します。

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

await CapgoCompass.stopListening();

checkPermissions

__CAPGO_KEEP_0__のデータへのアクセス許可の現在の状態を確認してください。 iOSでは、位置情報の許可状態を確認します。 Androidでは、このメソッドは常に'許可されている'と返します。

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

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

Full Reference

• GitHub: https://github.com/Cap-go/capacitor-compass/
• Docs: /docs/plugins/compass/