开始使用

安装

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

Permission state union including limited for platforms that can throttle motion access.

export type AccelerometerPermissionState = PermissionState | 'limited';

PermissionState

Capacitor支持的平台权限状态包括

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

真实来源

本页面是从插件生成的。 src/definitions.ts重新同步公共API时，请重新运行上游

从开始就继续

如果您正在使用 入门 为了计划仪表板和API操作，连接它与 使用@capgo/capacitor-加速计 使用@capgo/capacitor-加速计中的本机功能 API概述 API概述中的实现细节 介绍 介绍中的实现细节 API密钥 API密钥中的实现细节 设备 设备详细信息的实现细节。