はじめに

インストール

AIアシストセットアップを使ってプラグインをインストールできます。以下のコマンドで、お使いのAIツールに Capgo スキルを追加してください：

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';

クイックスタート

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

await CapacitorAccelerometer.startMeasurementUpdates();
await CapacitorAccelerometer.addListener('measurement', ({ x, y, z }) => {
  detectShake(x, y, z);
});

例: Webの権限

Webでは、以下の方法でモーションへのアクセスをリクエストしてください： requestPermissions() 0以外のサンプル値を取得する前に、リクエストが必要です。

よくある落とし穴

• Webでのゼロ値: 最初のモーションイベントが発生する前は、 getMeasurement() ゼロを返します。
• ストリーミングを停止: stopMeasurementUpdates() 画面を離れる際に実行してください。
• 単位: ゲームの計算には、プラグインのドキュメントに記載されている軸の規約を使用してください。

API の概要

getMeasurement

ネイティブレイヤーで記録された最新の加速度センサーのサンプルを取得します。

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

const result = await CapacitorAccelerometer.getMeasurement();
console.log(result);

isAvailable

現在のデバイスに加速度センサーが搭載されているか確認します。

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

const result = await CapacitorAccelerometer.isAvailable();
console.log(result);

startMeasurementUpdates

JavaScriptレイヤーへの加速度センサーのストリーミングを開始します。

呼び出す addListener を使用して、 measurement 更新を受信するためのイベント。

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

await CapacitorAccelerometer.startMeasurementUpdates();

stopMeasurementUpdates

次のメソッドで開始された加速度センサーのストリーミングを停止します： startMeasurementUpdates.

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

await CapacitorAccelerometer.stopMeasurementUpdates();

checkPermissions

モーションデータへのアクセス権限の現在の状態を返します。

明示的な権限がないプラットフォームでは、次の値になります： granted.

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

const result = await CapacitorAccelerometer.checkPermissions();
console.log(result);

requestPermissions

プラットフォームが対応している場合、モーションデータへのアクセス権限をリクエストします。

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

const result = await CapacitorAccelerometer.requestPermissions();
console.log(result);

型リファレンス

GetMeasurementResult

最新の測定値のエイリアス。

export type GetMeasurementResult = Measurement;

IsAvailableResult

〜によって返される結果 isAvailable.

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

PermissionStatus

返される権限情報: checkPermissions と requestPermissions.

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

MeasurementEvent

〜の際に発行されるイベントペイロード: startMeasurementUpdates がアクティブな場合。

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 を再実行してください。

Getting Started から続ける

以下を使用している場合： はじめに ダッシュボードと API の操作を計画するには、以下と連携してください @capgo/capacitor-accelerometer の使用方法 @capgo/capacitor-accelerometer を使用してネイティブ機能を利用する場合、 API の概要 API Overview の実装の詳細については、 はじめに Introduction の実装の詳細については、 API キー API Keys の実装の詳細については、 デバイス Devices の実装の詳細については。