@capgo/capacitor-compass

概要

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

主な機能

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

パブリック API

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

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

このリファレンスは src/definitions.ts から capacitor-コンパス.

@capgo/capacitor-コンパスから続きます

Capgoを使用している場合 @capgo/capacitor-compass Capgoを使用してネイティブプラグインの作業を計画する場合、@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-compassを接続してください @capgo/capacitor-compassを使用してネイティブ機能を使用する @capgo/capacitor-compassを使用してネイティブ機能を使用する Capgo プラグイン ディレクトリ Capgo プラグイン ディレクトリを使用して製品ワークフローを実行する Capacitor Plugins by Capgo for the implementation detail in Capacitor Plugins by Capgo, __CAPGO_KEEP_0__ プラグイン __CAPGO_KEEP_0__ プラグイン __CAPGO_KEEP_0__ プラグインの実装詳細 Capacitor製品ワークフローにおけるIonic Enterprise Plugin代替。