Démarrage

Installation

bun add @capgo/capacitor-barometer
bunx cap sync

Importer

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

API Vue d'ensemble

getMeasurement

Obtenir la lecture barométrique la plus récente capturée par la couche native.

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

await CapacitorBarometer.getMeasurement();

isAvailable

Vérifier si le dispositif actuel comporte un capteur de baromètre.

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

await CapacitorBarometer.isAvailable();

startMeasurementUpdates

Commencer à diffuser des mises à jour de baromètre vers la couche JavaScript.

Appelez avec le measurement événement pour recevoir les mises à jour.

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

await CapacitorBarometer.startMeasurementUpdates();

stopMeasurementUpdates

Arrêtez les mises à jour continues démarrées via .

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

await CapacitorBarometer.stopMeasurementUpdates();

checkPermissions

Renvoie l'état de permission actuel pour accéder aux données du baromètre.

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

await CapacitorBarometer.checkPermissions();

requestPermissions

Demandez la permission d'accéder aux données du baromètre si nécessaire par le système.

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

await CapacitorBarometer.requestPermissions();

Référence de type

GetMeasurementResult

Alias pour l'échantillon de pression le plus récent.

export type GetMeasurementResult = Measurement;

IsAvailableResult

Résultat retourné par .

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

PermissionStatus

Informations de permission retournées par et .

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

MeasurementEvent

Payload de l'événement émis lorsqu'est active.

export type MeasurementEvent = Measurement;

Measurement

Valeurs de pression atmosphérique et d'altitude relative prises à partir du baromètre du dispositif.

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

État de la permission incluant limited pour les plateformes qui peuvent limiter l'accès aux capteurs.

export type BarometerPermissionState = PermissionState | 'limited';

PermissionState

Platform permission states supported by Capacitor.

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

État de la permission pris en charge par __CAPGO_KEEP_0__.

Cette page est générée à partir du plugin’s src/definitions.tsRe-run the sync when the public API changes upstream.