継続的な更新と権限管理を備えた、デバイスのコンパス方位（度）の取得
まずはこちらから getCurrentHeading() および以下に示すその他のコアメソッド。
プラットフォーム対応
「プラットフォーム対応」という見出しのセクション| プラットフォーム | サポート | 備考 |
|---|---|---|
| iOSと | はい | ネイティブ |
| Androidでは | はい | ネイティブ |
| Web | いいえ | Capacitor.getPlatform() でガード |
コア機能
「コア機能」セクションgetCurrentHeading- 現在のコンパスの向きを度数で取得します。iOSでは、バックグラウンドで向きが更新され、最新の値が返されます。Androidでは、メソッド呼び出し時に加速度計と磁力計センサーを使用して向きが計算されます。Webでは実装されていません。startListening- イベント経由でコンパスの向きの変化を監視します。これによりコンパスセンサーが起動し、‘headingChange’ イベントが発行されます。stopListening- コンパスの向きの変化の監視を停止します。これによりコンパスセンサーが停止し、イベントの発行も止まります。checkPermissions- コンパスデータへのアクセスに関する現在の権限ステータスを確認します。iOSでは位置情報の権限ステータスを確認します。Androidでは、権限は不要なため常に ‘granted’ を返します。
公開 API
「Public API」セクション| メソッド | 説明 |
|---|---|
getCurrentHeading | 現在のコンパスの方位を度数で取得します。iOS では方位はバックグラウンドで更新され、最新の値が返されます。Android では、メソッド呼び出し時に加速度センサーと磁力計を使って方位が計算されます。Web では実装されていません。 |
getPluginVersion | ネイティブの Capacitor プラグインのバージョンを取得します。 |
startListening | イベント経由でコンパスの向きの変化を監視します。これによりコンパスセンサーが起動し、‘headingChange’ イベントが発行されます。 |
stopListening | コンパスの方位変化の監視を停止します。これによりコンパスセンサーが停止し、イベントの発行も停止します。 |
addListener | コンパスの向きの変化イベントのリスナーを追加します。 |
addListener | コンパスの精度変化イベントのリスナーを追加します。Androidのみ対応しています。iOSおよびWebではイベントは発行されません。 |
removeAllListeners | このプラグインのすべてのリスナーを削除します。 |
checkPermissions | コンパスデータへのアクセス権限の状態を確認します。iOSでは位置情報の権限を確認します。Androidでは権限は不要なため、常に ‘granted’ を返します。 |
requestPermissions | コンパスデータへのアクセス権限をリクエストします。iOS では位置情報の権限（方位データに必要）をリクエストします。Android では権限が不要なため、即座に解決されます。 |
watchAccuracy | コンパスの精度モニタリングを開始します。Android では磁力計の精度を監視し、accuracyChange イベントを発行します。開発者はこれらのイベントをリッスンして、キャリブレーションのプロンプト向けに独自の UI を実装できます。iOS と Web ではコンパス精度のモニタリングが利用できないため、このメソッドは何もしません。 |
unwatchAccuracy | コンパスの精度モニタリングを停止します。これにより精度監視が停止します。 |
getAccuracy | 現在のコンパス精度レベルを取得します。Androidでは現在の磁力計センサー精度を返します。iOSとWebでは精度モニタリングが利用できないため、常にCompassAccuracy.UNKNOWNを返します。 |
Source of Truth
「Source Of Truth」セクションこのリファレンスは以下から同期されています： src/definitions.ts における capacitor-compass.
@capgo/capacitor-compass から続ける
「@capgo/capacitor-compass から続ける」というセクション使用している場合 @capgo/capacitor-compass ネイティブプラグインの作業を計画するには、次と連携してください： @capgo/capacitor-compass を使用 @capgo/capacitor-compass を使う場合のネイティブ機能については、 Capgo プラグインディレクトリ Capgo プラグインディレクトリのプロダクトワークフローについては、 Capgo による Capacitor プラグイン Capgo による Capacitor プラグインの実装詳細については、 プラグインの追加または更新 プラグインの追加または更新における実装詳細については、および Ionic Enterprise プラグインの代替案 Ionic Enterprise プラグインの代替案におけるプロダクトワークフローについては。
