@capgo/capacitor-compass

概述

Capacitor Compass Plugin接口，用于读取设备的compass方向。

Core Capabilities

• getCurrentHeading - 获取当前compass方向（以度为单位）。在iOS中，方向在后台更新，返回最新值。在Android中，方法调用时使用加速计和磁力计传感器计算方向。Web未实现。
• startListening - 开始监听compass方向变化的事件。这会启动compass传感器并触发‘headingChange’事件。
• stopListening - 停止监听compass方向变化的事件。这会停止compass传感器并停止触发事件。
• checkPermissions - 检查访问compass数据的当前权限状态。在iOS中，检查位置权限状态。在Android中，始终返回‘granted’，因为不需要权限。

Public API

Method	描述
getCurrentHeading	获取当前compass方向（以度为单位）。在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

此参考资料是从 src/definitions.ts 在 capacitor-compass.