Empezar

Instalar

bun add @capgo/capacitor-barometer
bunx cap sync

Importar

import { CapacitorBarometer } from '@capgo/capacitor-barometer';

API Resumen

getMeasurement

Obtenga la lectura más reciente del barómetro capturada por la capa nativa.

import { CapacitorBarometer } from '@capgo/capacitor-barometer';

await CapacitorBarometer.getMeasurement();

isAvailable

Verifique si el dispositivo actual incluye un sensor de barómetro.

import { CapacitorBarometer } from '@capgo/capacitor-barometer';

await CapacitorBarometer.isAvailable();

startMeasurementUpdates

Comience a transmitir actualizaciones del barómetro a la capa de JavaScript.

Llame a con el measurement evento para recibir las actualizaciones.

import { CapacitorBarometer } from '@capgo/capacitor-barometer';

await CapacitorBarometer.startMeasurementUpdates();

stopMeasurementUpdates

Detener las actualizaciones continuas iniciadas mediante .

import { CapacitorBarometer } from '@capgo/capacitor-barometer';

await CapacitorBarometer.stopMeasurementUpdates();

checkPermissions

Devuelve el estado de permiso actual para acceder a los datos del barómetro.

import { CapacitorBarometer } from '@capgo/capacitor-barometer';

await CapacitorBarometer.checkPermissions();

requestPermissions

Solicita permiso para acceder a los datos del barómetro si es necesario por la plataforma.

import { CapacitorBarometer } from '@capgo/capacitor-barometer';

await CapacitorBarometer.requestPermissions();

Referencia de tipos

GetMeasurementResult

Alias para la muestra de presión más reciente.

export type GetMeasurementResult = Measurement;

IsAvailableResult

Resultado devuelto por .

export interface IsAvailableResult {
  /**
   * Indicates whether the device exposes a barometer sensor.
   *
   * @since 1.0.0
   */
  isAvailable: boolean;
}

PermissionStatus

Información de permiso devuelta por y .

export interface PermissionStatus {
  /**
   * The permission state for accessing barometer measurements on the current platform.
   *
   * @since 1.0.0
   */
  barometer: BarometerPermissionState;
}

MeasurementEvent

Payload del evento emitido cuando está activo.

export type MeasurementEvent = Measurement;

Measurement

Valores de presión atmosférica y altitud relativa obtenidos del barómetro del dispositivo.

export interface Measurement {
  /**
   * The static air pressure in hectopascals (hPa).
   *
   * @since 1.0.0
   */
  pressure: number;

  /**
   * The change in altitude relative to the time updates started.
   * Only available on iOS; Android will always return `0`.
   *
   * @since 1.0.0
   */
  relativeAltitude: number;

  /**
   * The timestamp of the measurement in milliseconds since the Unix epoch.
   *
   * @since 1.0.0
   */
  timestamp: number;
}

BarometerPermissionState

Unión de estados de permiso incluyendo limited para plataformas que pueden ralentizar el acceso a los sensores.

export type BarometerPermissionState = PermissionState | 'limited';

PermissionState

Estados de permiso de plataforma soportados por Capacitor.

export type PermissionState = 'prompt' | 'prompt-with-rationale' | 'granted' | 'denied';

Fuente De Verdad

Esta página se genera a partir del plugin’s src/definitions.tsRe-ejecutar la sincronización cuando el público API cambie en la fuente.