Empezar

Instalar

bun add @capgo/capacitor-accelerometer
bunx cap sync

Importar

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

API Resumen

getMeasurement

Obtenga la muestra de acelerómetro más reciente que se registró en la capa nativa.

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

await CapacitorAccelerometer.getMeasurement();

isAvailable

Verifique si el dispositivo actual incluye un sensor de acelerómetro.

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

await CapacitorAccelerometer.isAvailable();

startMeasurementUpdates

Comience a transmitir actualizaciones de acelerómetro a la capa de JavaScript.

Llame a con el measurement evento para recibir las actualizaciones.

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

await CapacitorAccelerometer.startMeasurementUpdates();

stopMeasurementUpdates

Detener la transmisión de actualizaciones del acelerómetro iniciada mediante .

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

await CapacitorAccelerometer.stopMeasurementUpdates();

checkPermissions

Devuelve el estado de permiso actual para acceder a datos de movimiento.

En plataformas sin permisos explícitos, esto resuelve a granted.

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

await CapacitorAccelerometer.checkPermissions();

requestPermissions

Solicitar permiso para acceder a datos de movimiento si lo admite la plataforma.

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

await CapacitorAccelerometer.requestPermissions();

Referencia de tipos

GetMeasurementResult

Alias para la medición más reciente.

export type GetMeasurementResult = Measurement;

IsAvailableResult

Resultado devuelto por .

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

PermissionStatus

Información de permiso devuelta por y .

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

MeasurementEvent

Payload de evento emitido cuando está activo.

export type MeasurementEvent = Measurement;

Measurement

Los valores de aceleración en las coordenadas x, y y z reportados por los sensores de movimiento 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

Unión de estados de permiso incluyendo limited para plataformas que pueden ralentizar el acceso a la movimiento.

export type AccelerometerPermissionState = PermissionState | 'limited';

PermissionState

Estados de permiso de plataforma soportados por Capacitor.

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

Fuente de Verdad

Esta página se genera a partir del plugin’s src/definitions.tsRe-ejecutar la sincronización cuando el público API cambia en la fuente.