Démarrage

Installation

bun add @capgo/capacitor-accelerometer
bunx cap sync

Importer

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

API Présentation

getMeasurement

Obtenir 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érifier si le dispositif actuel comporte un capteur d'accéléromètre.

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

await CapacitorAccelerometer.isAvailable();

startMeasurementUpdates

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

Appeler 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 de l'accéléromètre démarrées via .

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

await CapacitorAccelerometer.stopMeasurementUpdates();

checkPermissions

Renvoyer l'état de permission actuel 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'application est active.

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 union incluant limited pour les plateformes qui peuvent limiter l'accès au mouvement.

export type AccelerometerPermissionState = PermissionState | 'limited';

PermissionState

États de la permission des plateformes pris en charge par Capacitor.

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

Source Of Truth

Cette page est générée à partir du plugin’s src/definitions.tsRe-run the sync when the public API changes upstream.