スタートガイド

インストール

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 では、0 以外のサンプル値を取得する前に、 requestPermissions() を通じてモーションへのアクセスをリクエストしてください。

よくある落とし穴

• Web でのゼロ値: 最初のモーションイベントが発生する前は、 getMeasurement() 0 を返します。
• ストリーミングを停止: 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';

Source of Truth

このページはプラグインの src/definitions.tsから生成されています。upstream で公開 API が変更されたら、再度 sync を実行してください。

Getting Startedの続きを進める

使用している場合 スタートガイド ダッシュボードと API の運用を計画するには、これを次と連携させます @capgo/capacitor-accelerometer の使い方 @capgo/capacitor-accelerometer を使用する際のネイティブ機能については、 API の概要 「API の概要」の実装の詳細については、 はじめに 「はじめに」における実装の詳細については、 API キー および「API Keys」の実装の詳細については、 デバイス 実装の詳細については Devices を参照してください。