Inizia

Installa

bun add @capgo/capacitor-barometer
bunx cap sync

Importa

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

API Panoramica

getMeasurement

Ottenere la lettura più recente del barometro catturata dal layer nativo.

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

await CapacitorBarometer.getMeasurement();

isAvailable

Verificare se il dispositivo corrente include un sensore di barometro.

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

await CapacitorBarometer.isAvailable();

startMeasurementUpdates

Iniziare a trasmettere aggiornamenti del barometro al layer JavaScript.

Chiamare con il measurement evento per ricevere le aggiornamenti.

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

await CapacitorBarometer.startMeasurementUpdates();

stopMeasurementUpdates

Sospendi gli aggiornamenti continui avviati tramite .

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

await CapacitorBarometer.stopMeasurementUpdates();

checkPermissions

Restituisci lo stato di autorizzazione corrente per l'accesso ai dati del barometro.

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

await CapacitorBarometer.checkPermissions();

requestPermissions

Richiedi l'autorizzazione per accedere ai dati del barometro se richiesta dalla piattaforma.

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

await CapacitorBarometer.requestPermissions();

Riferimento di tipo

GetMeasurementResult

Alias per l'ultimo campione di pressione.

export type GetMeasurementResult = Measurement;

IsAvailableResult

Risultato restituito da .

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

PermissionStatus

Informazioni di autorizzazione restituite da e .

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

MeasurementEvent

Payload dell'evento emesso quando è attivo.

export type MeasurementEvent = Measurement;

Measurement

Valori di pressione atmosferica e altitudine relativa campionati dal barometro 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

Stato di autorizzazione unione inclusa limited per piattaforme che possono limitare l'accesso ai sensori.

export type BarometerPermissionState = PermissionState | 'limited';

PermissionState

Stati di autorizzazione supportati da Capacitor per le piattaforme.

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

Fonte di Verità

Questa pagina è generata dal plugin’s src/definitions.tsRiepilogo: . Re-run the sync quando le informazioni pubbliche API cambiano upstream.