Getting Started

安装

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

最近压力样本的别名

export type GetMeasurementResult = Measurement;

IsAvailableResult

由 .返回的结果

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上游更改时，请重新运行同步。

继续从 Getting Started

如果您正在使用 Getting Started 来规划仪表板和 API 操作，连接它与 使用 @capgo/capacitor-barometer 对于在 Using @capgo/capacitor-barometer 中的本地能力 API Overview 对于在 API Overview 中的实现细节 Introduction 对于在 Introduction 中的实现细节 API Keys 为API Keys的实现细节，和 设备 为设备的实现细节，