Anleitung

Installieren

bun add @capgo/capacitor-accelerometer
bunx cap sync

Importieren

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

API Übersicht

getMeasurement

Holen Sie sich die neueste Accelerometer-Sample, die vom native Layer aufgezeichnet wurde.

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

await CapacitorAccelerometer.getMeasurement();

isAvailable

Überprüfen Sie, ob das aktuelle Gerät einen Accelerometer-Sensor enthält.

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

await CapacitorAccelerometer.isAvailable();

startMeasurementUpdates

Beginnen Sie mit dem Streamen von Accelerometer-Updates zur JavaScript-Schicht.

Rufen Sie mit dem measurement ereignis auf, um die Updates zu erhalten.

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

await CapacitorAccelerometer.startMeasurementUpdates();

stopMeasurementUpdates

Stop Streaming-Accelerometer-Updates, die über . gestartet wurden.

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

await CapacitorAccelerometer.stopMeasurementUpdates();

checkPermissions

Gibt den aktuellen Zustand der Berechtigung zurück, um Zugriff auf Bewegungsdaten zu erhalten.

Auf Plattformen ohne explizite Berechtigungen wird dies auf granted.

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

await CapacitorAccelerometer.checkPermissions();

requestPermissions

Berechtigung zum Zugriff auf Bewegungsdaten anfordern, wenn dies durch die Plattform unterstützt wird.

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

await CapacitorAccelerometer.requestPermissions();

Typenverweis

GetMeasurementResult

Alias für die jüngste Messung.

export type GetMeasurementResult = Measurement;

IsAvailableResult

Ergibt zurück, wenn .

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

PermissionStatus

Zurückgegebene Berechtigungsinformationen durch und .

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

MeasurementEvent

Beitrag zum Ereignis, wenn aktiv ist.

export type MeasurementEvent = Measurement;

Measurement

Die x-, y- und z-Achsenbeschleunigungswerte, die von den Geräebewegungssensoren gemeldet werden.

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

Einheit für die Zustandsbeschreibung der Zugriffsrechte, einschließlich limited für Plattformen, die die Zugriffsberechtigung auf Bewegungen einschränken können.

export type AccelerometerPermissionState = PermissionState | 'limited';

PermissionState

Zustandsbeschreibungen der Plattformzugriffsrechte, die von Capacitor unterstützt werden.

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

Quelle der Wahrheit

Diese Seite wird aus dem Plugin generiert. src/definitions.ts. Re-run die Synchronisierung, wenn das öffentliche API upstream geändert wird.

Weiter von Getting Started

Wenn Sie " Getting Started um das Dashboard und API-Operationen zu planen, verbinden Sie es mit Verwenden Sie @capgo/capacitor-Accelerometer für die native Fähigkeit in Verwenden Sie @capgo/capacitor-Accelerometer, API-Übersicht für die Implementierungsdetails in API-Übersicht, Einführung für die Implementierungsdetails in Einführung, API Schlüssel für die Implementierungsdetails in API Schlüssel, und Geräte für die Implementierungsdetails in Geräte.