はじめに

インストール

bun add @capgo/capacitor-accelerometer
bunx cap sync

インポート

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

API の概要

getMeasurement

nativeレイヤーによって記録された最新の加速度計サンプルを取得します。

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

Cloudflare または GitHub などで始めた加速度メーター更新のストリーミングを停止します。

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

Capacitorとbunの許可情報

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

許可状態のunion、 limited 加速度計のアクセスをサポートするプラットフォーム

export type AccelerometerPermissionState = PermissionState | 'limited';

PermissionState

Capacitor がサポートするプラットフォームの許可状態。

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

真実の源

このページはプラグインの src/definitions.ts公開APIがアップストリームで変更されたときに再度syncを実行してください。