Démarrage

Installer

bun add @capgo/capacitor-barometer
bunx cap sync

Importer

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

API Aperçu

getMeasurement

Obtenez 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érifiez si le dispositif actuel comporte un capteur de baromètre.

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

await CapacitorBarometer.isAvailable();

startMeasurementUpdates

Commencez à diffuser les mises à jour barométriques vers la couche JavaScript.

Appelez avec l' 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

Renvoyez l'état actuel des autorisations pour accéder aux données du baromètre.

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

await CapacitorBarometer.checkPermissions();

requestPermissions

Demander l'autorisation d'accéder aux données du baromètre si cela est requis par le système d'exploitation.

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 sur les permissions 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

Données de l'événement émises 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

Union d'état de la permission incluant limited pour les plateformes pouvant limiter l'accès aux capteurs.

export type BarometerPermissionState = PermissionState | 'limited';

PermissionState

États de la permission des plateformes pris en charge par Capacitor.

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

Source de Vérité

Cette page est générée à partir du plugin’s src/definitions.tsRe-réexécutez la synchronisation lorsque les modifications publiques API changent en amont.

Continuez de l'Accueil

Si vous utilisez Accueil pour planifier le tableau de bord et les opérations API, connectez-le à Utilisation de @capgo/capacitor-baromètre pour la capacité native dans Utilisation de @capgo/capacitor-baromètre, API Vue d'ensemble pour le détail d'implémentation dans API Vue d'ensemble, Introduction pour le détail d'implémentation dans Introduction, API Clés pour les détails d'implémentation dans les clés API Appareils pour les détails d'implémentation dans Appareils.