Prise en main

Installation

Vous pouvez utiliser notre configuration assistée par l'IA pour installer le plugin. Ajoutez les Capgo compétences à votre outil IA en utilisant la commande suivante :

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

Ensuite, utilisez la prompt suivante :

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

Si vous préférez la configuration manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à la plateforme ci-dessous :

bun add @capgo/capacitor-accelerometer
bunx cap sync

Importer

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

API Vue d'ensemble

getMeasurement

Obtenez l'échantillon d'accéléromètre le plus récent enregistré par la couche native.

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

await CapacitorAccelerometer.getMeasurement();

isAvailable

Vérifiez si le dispositif actuel comporte un capteur d'accéléromètre.

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

await CapacitorAccelerometer.isAvailable();

startMeasurementUpdates

Commencez à diffuser les mises à jour d'accéléromètre vers la couche JavaScript.

Appelez avec le measurement événement pour recevoir les mises à jour.

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

await CapacitorAccelerometer.startMeasurementUpdates();

stopMeasurementUpdates

Arrêter la diffusion des mises à jour d'accéléromètre démarrées via .

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

await CapacitorAccelerometer.stopMeasurementUpdates();

checkPermissions

Renvoyer l'état actuel des permissions pour accéder aux données de mouvement.

Sur les plateformes sans permissions explicites, cela se résout à granted.

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

await CapacitorAccelerometer.checkPermissions();

requestPermissions

Demander la permission d'accéder aux données de mouvement si la plateforme le supporte.

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

await CapacitorAccelerometer.requestPermissions();

Référence de type

GetMeasurementResult

Alias pour la mesure la plus récente.

export type GetMeasurementResult = Measurement;

IsAvailableResult

Résultat retourné par .

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

PermissionStatus

Informations de permission retournées par et .

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

MeasurementEvent

Payload de l'événement émis lorsque l'accéléromètre est actif.

export type MeasurementEvent = Measurement;

Measurement

Les valeurs d'accélération des axes x, y et z signalées par les capteurs de mouvement du dispositif.

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

État de la permission incluant limited les états de permission pour les plateformes qui peuvent limiter l'accès au mouvement.

export type AccelerometerPermissionState = PermissionState | 'limited';

PermissionState

Platform permission states supported by Capacitor.

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

Source De Vérité

Cette page est générée à partir du plugin’s src/definitions.ts. Re-run la synchronisation lorsque le public API change en amont.

Continuez de là depuis Getting Started

Si vous utilisez Getting Started pour planifier le tableau de bord et les opérations API, connectez-l’avec Utilisez @capgo/capacitor-acceleromètre pour la capacité native dans Utilisez @capgo/capacitor-acceleromètre, API Vue d'ensemble pour les détails d'implémentation dans API Vue d'ensemble Introduction pour les détails d'implémentation dans Introduction API Clés pour les détails d'implémentation dans API Clés, et Appareils pour les détails d'implémentation dans Appareils.