开始使用

安装

您可以使用我们的AI辅助设置来安装插件。使用以下命令将Capgo技能添加到您的AI工具中:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

然后使用以下提示:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-accelerometer` plugin in my project.

如果您更喜欢手动设置，请运行以下命令并按照以下平台特定的说明进行操作:

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 上游发生变化时，请重新运行同步。

继续从 Getting Started

如果您正在使用 Getting Started 来规划仪表板和 API 操作，请将其连接到 使用 @capgo/capacitor-accelerometer 使用 @capgo/capacitor-accelerometer API 概述 为 API 概述的实现细节 简介 为简介的实现细节 API 键 为 API 键和的实现细节 设备 为设备的实现细节