Mulai

Pasang

bun add @capgo/capacitor-barometer
bunx cap sync

Impor

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

API Pengenalan

getMeasurement

Dapatkan bacaan barometer terkini yang ditangkap oleh layer native.

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

await CapacitorBarometer.getMeasurement();

isAvailable

Periksa apakah perangkat saat ini memiliki sensor barometer.

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

await CapacitorBarometer.isAvailable();

startMeasurementUpdates

Mulai mengalirkan pembaruan barometer ke layer JavaScript.

Panggil dengan measurement acara untuk menerima pembaruan.

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

await CapacitorBarometer.startMeasurementUpdates();

stopMeasurementUpdates

Hentikan pembaruan berkelanjutan yang dimulai melalui .

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

await CapacitorBarometer.stopMeasurementUpdates();

checkPermissions

Kembalikan status izin saat ini untuk mengakses data barometer.

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

await CapacitorBarometer.checkPermissions();

requestPermissions

Minta izin untuk mengakses data barometer jika diperlukan oleh platform.

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

await CapacitorBarometer.requestPermissions();

Referensi Tipe

GetMeasurementResult

Alias untuk contoh tekanan terbaru.

export type GetMeasurementResult = Measurement;

IsAvailableResult

Hasil yang dikembalikan oleh .

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

PermissionStatus

Informasi ijin yang dikembalikan oleh dan .

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

MeasurementEvent

Payload acara yang dikeluarkan ketika aktif.

export type MeasurementEvent = Measurement;

Measurement

Nilai tekanan udara dan ketinggian relatif yang diambil dari barometer perangkat.

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 status izin termasuk limited untuk platform yang dapat mengurangi akses sensor.

export type BarometerPermissionState = PermissionState | 'limited';

PermissionState

Status izin platform yang didukung oleh Capacitor.

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

Sumber Kebenaran

Halaman ini dibuat dari plugin’s src/definitions.tsRe-run sinkronisasi ketika publik API berubah di atas.