开始使用

安装

bun add @capgo/capacitor-barometer
bunx cap sync

导入

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

API 概述

getMeasurement

获取本地层捕获的最新气压计读数。

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

await CapacitorBarometer.getMeasurement();

isAvailable

检查当前设备是否具有气压计传感器。

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

await CapacitorBarometer.isAvailable();

startMeasurementUpdates

开始将气压计更新流式传输到 JavaScript层。

调用 measurement 接收更新事件。

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

await CapacitorBarometer.startMeasurementUpdates();

stopMeasurementUpdates

停止通过 . 开始的连续更新。

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

await CapacitorBarometer.stopMeasurementUpdates();

checkPermissions

复制到剪贴板

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

await CapacitorBarometer.checkPermissions();

requestPermissions

如果平台要求，请求访问加速度计数据的权限。

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

await CapacitorBarometer.requestPermissions();

类型参考

GetMeasurementResult

__CAPGO_KEEP_0__

export type GetMeasurementResult = Measurement;

IsAvailableResult

__CAPGO_KEEP_1__

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

PermissionStatus

权限信息

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

MeasurementEvent

当激活时发出的事件载荷

export type MeasurementEvent = Measurement;

Measurement

设备压力计采集的气压和相对海拔值。

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

包括 limited 对于可以限制传感器访问的平台。

export type BarometerPermissionState = PermissionState | 'limited';

PermissionState

Capacitor支持的平台权限状态。

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

真实数据源

该页面是由插件生成的 src/definitions.ts当公共 API 在上游发生变化时，请重新同步。