Einstieg

Installieren

bun add @capgo/capacitor-barometer
bunx cap sync

Importieren

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

API Übersicht

getMeasurement

Holen Sie sich die neueste Barometer-Lesezeichen, die vom native Layer erfasst wurden.

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

await CapacitorBarometer.getMeasurement();

isAvailable

Überprüfen Sie, ob das aktuelle Gerät einen Barometer-Sensor enthält.

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

await CapacitorBarometer.isAvailable();

startMeasurementUpdates

Beginnen Sie mit dem Streamen von Barometer-Updates in die JavaScript-Schicht.

Aufrufen Sie mit dem measurement Ereignis zum Empfang der Updates.

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

await CapacitorBarometer.startMeasurementUpdates();

stopMeasurementUpdates

Die laufenden Updates, die über . gestartet wurden, beenden.

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

await CapacitorBarometer.stopMeasurementUpdates();

checkPermissions

Die aktuelle Berechtigungsstellung für den Zugriff auf Daten des Barometers zurückgeben.

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

await CapacitorBarometer.checkPermissions();

requestPermissions

Die Berechtigung zum Zugriff auf Barometerdaten anfordern, wenn dies durch die Plattform erforderlich ist.

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

await CapacitorBarometer.requestPermissions();

Typenverweis

GetMeasurementResult

Alias für das neueste Drucksample.

export type GetMeasurementResult = Measurement;

IsAvailableResult

Resultat zurückgegeben durch .

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

PermissionStatus

Zugriffsinformationen zurückgegeben durch und .

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

MeasurementEvent

Ereignisdaten, die bei Aktivierung von ausgestoßen werden.

export type MeasurementEvent = Measurement;

Measurement

Luftdruck- und relativer Höhenwerte, die vom Gerätebarometer abgeleitet werden.

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

Zustand der Berechtigung einschließlich limited für Plattformen, die den Zugriff auf den Sensor einschränken können.

export type BarometerPermissionState = PermissionState | 'limited';

PermissionState

Berechtigungsstatus der Plattform, die von Capacitor unterstützt werden.

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

Quelle der Wahrheit

Diese Seite wurde aus dem Plugin generiert. src/definitions.tsRe-run die Synchronisation, wenn die öffentliche API upstream geändert wird.