@capgo/capacitor-compass

概要

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

基本機能

• getCurrentHeading - iOSでは、現在のコンパス向きを度単位で取得します。iOSでは、背景で向きが更新され、最新の値が返されます。Androidでは、メソッドが呼び出されたときに加速度計と磁気センサを使用して向きが計算されます。Webでは実装されていません。
• startListening - コンパス向きの変更をイベントを介してリスンすることができます。このメソッドでコンパスセンサを開始し、‘headingChange’イベントを発行します。
• stopListening - コンパス向きの変更をリスンすることを停止します。このメソッドでコンパスセンサを停止し、イベントの発行を停止します。
• checkPermissions - コンパスデータへのアクセスを許可する現在の許可状態を確認します。iOSでは、位置許可の状態を確認します。Androidでは、許可が必要ないため常に‘granted’を返します。

Public API

メソッド	説明
getCurrentHeading	iOSでは、現在のコンパス向きを度単位で取得します。iOSでは、背景で向きが更新され、最新の値が返されます。Androidでは、メソッドが呼び出されたときに加速度計と磁気センサを使用して向きが計算されます。Webでは実装されていません。
getPluginVersion	Get the native Capacitor plugin version.
startListening	コンパス向きの変更をイベントを介してリスンすることができます。このメソッドでコンパスセンサを開始し、‘headingChange’イベントを発行します。
stopListening	コンパス向きの変更をリスンすることを停止します。このメソッドでコンパスセンサを停止し、イベントの発行を停止します。
addListener	コンパス向きの変更イベントにリスナーを追加します。
addListener	コンパス精度の変更イベントにリスナーを追加します。Androidのみサポート。iOSとWebではイベントを発行することはありません。
removeAllListeners	このプラグインのすべてのリスナーを削除します。
checkPermissions	コンパスデータへのアクセス許可の現在の状態を確認します。iOSでは位置許可の状態を確認します。Androidでは、許可が必要ないため常に‘許可済み’を返します。
requestPermissions	コンパスデータへのアクセス許可を要求します。iOSでは、向きデータのために位置許可を要求します。Androidでは、許可が必要ないためすぐに解決します。
watchAccuracy	コンパス精度の監視を開始します。Androidでは、磁気センサの精度を監視し、精度の変更イベントを発行します。開発者は、これらのイベントにリスナーを追加し、カリブレーション用のUIを実装できます。iOSとWebでは、このメソッドは何も行いません。コンパス精度の監視は利用できません。
unwatchAccuracy	コンパス精度の監視を停止します。この精度の監視を停止します。
getAccuracy	現在のコンパス精度のレベルを取得します。Androidでは、現在の磁気センサの精度を返します。iOSとWebでは、常にCompassAccuracy.UNKNOWNを返します。

ソース・オブ・トゥルース

このリファレンスはsyncdから src/definitions.ts in capacitor-compass.

capgoから続ける@capacitor-compass

Capgoを使用している場合 @capgo/capacitor-compass @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-compassを使用して @capgo/capacitor-compassのネイティブ機能と @capgo/capacitor-compassのネイティブ機能 Capgo Plugin Directory for the product workflow in Capgo Plugin Directory, Capacitor Plugins by Capgo for the implementation detail in Capacitor Plugins by Capgo, プラグインの追加または更新 プラグインの追加または更新の実装詳細については Ionic Enterprise プラグインの代替 Ionic Enterprise プラグインの代替の製品ワークフローについては