コンパス

@capgo/capacitor プレビュー QR

Capacitor コンパス プラグイン インターフェイス (コンパス向きを読み取る)

インストール

bun add @capgo/capacitor-compass
bunx cap sync

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

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

使用例

getCurrentHeading

iOSではバックグラウンドでコンパス向きを更新し、最新の値を返します。Androidでは、加速度計と磁気計センサーを使用してメソッドを呼び出すと、コンパス向きが計算されます。Webでは実装されていません。

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

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

startListening

コンパスヘッドの変更をイベントで待ち受ける。コンパスセンサを開始し、'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

コンパスヘッドの変更を待ち受ける停止。コンパスセンサを停止し、イベントの発行を停止します。

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

await CapgoCompass.stopListening();

checkPermissions

iOS の場合、iOS の位置許可の状態を確認し、Android の場合、コンパスデータへのアクセス許可の状態を常に 'granted' として返します。

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/

Using @capgo/capacitor-compass

@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-compass を使用している場合 @capgo/capacitor-compass を使用してダッシュボードと capgo のオペレーションを計画する場合、@capgo/capacitor-compass を接続します。 @API/__CAPGO_KEEP_1__-compass を使用してください @capgo/capacitor-compass を使用してください 実装詳細については @capgo/capacitor-compass に Getting Started 実装詳細については Getting Started に API Overview 実装詳細については API Overview に Introduction 実装詳細については Introduction、 API Keys 実装詳細については API Keys。