@capgo/capacitor-compass

Resumen

Interfaz del plugin de Capacitor para leer la dirección del compás del dispositivo.

Capacidades básicas

• getCurrentHeading - Obtenga la dirección actual del compás en grados. En iOS, la dirección se actualiza en segundo plano y se devuelve el valor más reciente. En Android, la dirección se calcula cuando se llama al método utilizando sensores de acelerómetro y magnetómetro. No implementado en Web.
• startListening - Inicie la escucha de cambios en la dirección del compás mediante eventos. Esto inicia los sensores del compás y emite eventos ‘headingChange’.
• stopListening - Detenga la escucha de cambios en la dirección del compás. Esto detiene los sensores del compás y detiene la emisión de eventos.
• checkPermissions - Verifique el estado de permiso actual para acceder a los datos del compás. En iOS, esto verifica el estado de permiso de ubicación. En Android, siempre devuelve ‘concedido’ ya que no se requieren permisos.

Público API

Método	Descripción
getCurrentHeading	Obtenga la dirección actual del compás en grados. En iOS, la dirección se actualiza en segundo plano y se devuelve el valor más reciente. En Android, la dirección se calcula cuando se llama al método utilizando sensores de acelerómetro y magnetómetro. No implementado en Web.
getPluginVersion	Obtenga la versión nativa del plugin Capacitor.
startListening	Inicie la escucha de cambios en la dirección del compás mediante eventos. Esto inicia los sensores del compás y emite eventos ‘headingChange’.
stopListening	Detenga la escucha de cambios en la dirección del compás. Esto detiene los sensores del compás y detiene la emisión de eventos.
addListener	Agregar un oyente para eventos de cambio de dirección del compás.
addListener	Agregar un oyente para eventos de cambio de precisión del compás. Solo soportado en Android. En iOS y Web, esto nunca emitirá eventos.
removeAllListeners	Quitar todos los oyentes para este plugin.
checkPermissions	Ver el estado de permiso actual para acceder a datos de brújula. En iOS, esto verifica el estado de permiso de ubicación. En Android, siempre devuelve ‘concedido’ ya que no se requieren permisos.
requestPermissions	Solicite permiso para acceder a datos de brújula. En iOS, esto solicita permiso de ubicación (requerido para datos de dirección). En Android, esto resuelve inmediatamente ya que no se requieren permisos.
watchAccuracy	Inicie la monitorización de la precisión de la brújula. En Android, esto monitoriza la precisión del magnetómetro y emite eventos de cambio de precisión. Los desarrolladores pueden escuchar estos eventos y implementar su propia interfaz de usuario para solicitudes de calibración. En iOS y Web, este método no hace nada ya que la monitorización de precisión de la brújula no está disponible.
unwatchAccuracy	Detenga la monitorización de precisión de la brújula. Esto detiene la monitorización de precisión.
getAccuracy	Obtenga el nivel de precisión actual de la brújula. En Android, devuelve la precisión actual del sensor de magnetómetro. En iOS y Web, siempre devuelve CompassAccuracy.UNKNOWN ya que la monitorización de precisión no está disponible.

Fuente de Verdad

Esta referencia está sincronizada desde src/definitions.ts en capacitor-brújula.