Getting Started

Installazione

bun add @capgo/capacitor-accelerometer
bunx cap sync

Importa

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

Panoramica API

getMeasurement

Ottenere l'ultima misura accelerometro registrata dal layer nativo.

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

await CapacitorAccelerometer.getMeasurement();

isAvailable

Verificare se il dispositivo corrente dispone di un sensore accelerometro.

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

await CapacitorAccelerometer.isAvailable();

startMeasurementUpdates

Iniziare la trasmissione di aggiornamenti accelerometro al layer JavaScript.

Chiamare con l' measurement evento per ricevere gli aggiornamenti.

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

await CapacitorAccelerometer.startMeasurementUpdates();

stopMeasurementUpdates

Smettere di inviare aggiornamenti di accelerometro avviati tramite .

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

await CapacitorAccelerometer.stopMeasurementUpdates();

checkPermissions

Restituire lo stato di autorizzazione corrente per l'accesso ai dati di movimento.

Sui piattaforme senza autorizzazioni esplicite questo risolve a granted.

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

await CapacitorAccelerometer.checkPermissions();

requestPermissions

Richiedere l'autorizzazione per l'accesso ai dati di movimento se supportato dalla piattaforma.

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

await CapacitorAccelerometer.requestPermissions();

Riferimento di tipo

GetMeasurementResult

Alias per la misura più recente.

export type GetMeasurementResult = Measurement;

IsAvailableResult

Risultato restituito da .

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

PermissionStatus

Informazioni sulla autorizzazione restituite da e .

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

MeasurementEvent

Payload dell'evento emesso quando è attivo.

export type MeasurementEvent = Measurement;

Measurement

The valori di accelerazione degli assi x, y e z riferiti dai sensori di movimento del dispositivo.

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

Unione di stati di autorizzazione che include limited per piattaforme che possono limitare l'accesso alla movimentazione.

export type AccelerometerPermissionState = PermissionState | 'limited';

PermissionState

Gli stati di autorizzazione delle piattaforme supportate da Capacitor.

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

Punto di verità

Questa pagina è generata dal plugin’s src/definitions.ts. Riavvia la sincronizzazione quando il pubblico API cambia in alto.

Continua da Inizia con Capgo

Se stai utilizzando Inizia con Capgo per pianificare dashboard e API operazioni, connettilo con Utilizza @capgo/capacitor-accelerometro per la capacità nativa in Utilizza @capgo/capacitor-accelerometro, API Overview per i dettagli di implementazione in API Overview, __CAPGO_KEEP_0__ per i dettagli di implementazione in __CAPGO_KEEP_0__, API Chiavi per i dettagli di implementazione in API Chiavi, e Dispositivi per i dettagli di implementazione in Dispositivi.