开始使用

安装

bun add @capgo/capacitor-accelerometer
bunx cap sync

导入

import { CapacitorAccelerometer } from '@capgo/capacitor-accelerometer';

API 简介

getMeasurement

获取本地层最近记录的加速度计样本。

import { CapacitorAccelerometer } from '@capgo/capacitor-accelerometer';

await CapacitorAccelerometer.getMeasurement();

isAvailable

检查当前设备是否包含加速度计传感器。

import { CapacitorAccelerometer } from '@capgo/capacitor-accelerometer';

await CapacitorAccelerometer.isAvailable();

startMeasurementUpdates

开始将加速度计更新流式传输到 JavaScript 层。

使用 measurement 接收更新事件。

import { CapacitorAccelerometer } from '@capgo/capacitor-accelerometer';

await CapacitorAccelerometer.startMeasurementUpdates();

stopMeasurementUpdates

停止通过 . 开始的加速计更新流

import { CapacitorAccelerometer } from '@capgo/capacitor-accelerometer';

await CapacitorAccelerometer.stopMeasurementUpdates();

checkPermissions

获取当前访问运动数据的权限状态。

在没有明确权限的平台上，这个值解析为 granted.

import { CapacitorAccelerometer } from '@capgo/capacitor-accelerometer';

await CapacitorAccelerometer.checkPermissions();

requestPermissions

如果平台支持，请求访问运动数据的权限。

import { CapacitorAccelerometer } from '@capgo/capacitor-accelerometer';

await CapacitorAccelerometer.requestPermissions();

类型参考

GetMeasurementResult

最近测量的别名

export type GetMeasurementResult = Measurement;

IsAvailableResult

返回结果

export interface IsAvailableResult {
  /**
   * Whether an accelerometer sensor is available on the device.
   *
   * @since 1.0.0
   */
  isAvailable: boolean;
}

PermissionStatus

返回的权限信息

export interface PermissionStatus {
  /**
   * The permission state for accessing motion data on the current platform.
   *
   * @since 1.0.0
   */
  accelerometer: AccelerometerPermissionState;
}

MeasurementEvent

当设备处于活跃状态时，发出事件载荷。

export type MeasurementEvent = Measurement;

Measurement

设备运动传感器报告的x、y和z轴加速度值。

export interface Measurement {
  /**
   * The acceleration on the x-axis in G's.
   *
   * @since 1.0.0
   */
  x: number;

  /**
   * The acceleration on the y-axis in G's.
   *
   * @since 1.0.0
   */
  y: number;

  /**
   * The acceleration on the z-axis in G's.
   *
   * @since 1.0.0
   */
  z: number;
}

AccelerometerPermissionState

包括 limited 对于可以限制运动访问的平台。

export type AccelerometerPermissionState = PermissionState | 'limited';

PermissionState

Capacitor支持的平台权限状态。

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

真实来源

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