Einstieg

Installieren

bun add @capgo/capacitor-accelerometer
bunx cap sync

Importieren

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

API Übersicht

getMeasurement

Abrufen Sie das neueste Beschleunigungsmesswert, das vom native Layer aufgezeichnet wurde.

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

await CapacitorAccelerometer.getMeasurement();

isAvailable

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

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

await CapacitorAccelerometer.isAvailable();

startMeasurementUpdates

Beginnen Sie die Streaming von Beschleunigungsmesswerten zur JavaScript-Schicht.

Aufrufen Sie mit dem measurement ereignis, um die Aktualisierungen zu empfangen.

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

await CapacitorAccelerometer.startMeasurementUpdates();

stopMeasurementUpdates

Stoppen Sie die Streaming von Beschleunigungsmessungen, die über . gestartet wurden.

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

await CapacitorAccelerometer.stopMeasurementUpdates();

checkPermissions

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

Bei 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();

Typenreferenz

GetMeasurementResult

Alias für die letzte Messung.

export type GetMeasurementResult = Measurement;

IsAvailableResult

Ergbnis, das von . zurückgegeben wird

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

PermissionStatus

Zugriffsrechte, die von und zurückgegeben werden

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

MeasurementEvent

Event Payload, 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

Zulassungsstatusunion einschließlich limited für Plattformen, die die Zugriffsbewegung drosseln können.

export type AccelerometerPermissionState = PermissionState | 'limited';

PermissionState

Die von Capacitor unterstützten Plattformzulassungsstatus.

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

Quelle der Wahrheit

Diese Seite wird aus dem Plugin generiert. src/definitions.tsRe-run die Synchronisation, wenn die öffentliche API upstream geändert wird.