Démarrage

Installer

bun add @capgo/capacitor-light-sensor
bunx cap sync

Importer

import { LightSensor } from '@capgo/capacitor-light-sensor';

API Overview

isAvailable

Vérifiez si le capteur de lumière est disponible sur le dispositif actuel. Il est toujours recommandé de vérifier la disponibilité du capteur avant de tenter d'utiliser celui-ci.

import { LightSensor } from '@capgo/capacitor-light-sensor';

const { available } = await LightSensor.isAvailable();

start

Commencez à écouter les mises à jour du capteur de lumière. Cela commencera les mesures du capteur à l'intervalle spécifié. Utilisez addListener pour recevoir les données du capteur.

import { LightSensor } from '@capgo/capacitor-light-sensor';

await LightSensor.start({ updateInterval: 500 });

stop

Arrêtez d'écouter les mises à jour du capteur de lumière. Cela arrêtera le capteur et économisera la batterie.

import { LightSensor } from '@capgo/capacitor-light-sensor';

await LightSensor.stop();

checkPermissions

Vérifiez l'état de permission actuel pour les capteurs à haute fréquence d'échantillonnage.

import { LightSensor } from '@capgo/capacitor-light-sensor';

const status = await LightSensor.checkPermissions();

requestPermissions

Demander la permission pour les capteurs à haute fréquence d'échantillonnage.

import { LightSensor } from '@capgo/capacitor-light-sensor';

const status = await LightSensor.requestPermissions();

Référence de type

IsAvailableResult

Résultat indiquant si le capteur est disponible.

export interface IsAvailableResult {
  /**
   * Whether the light sensor is available on this device.
   * Always false on iOS as the light sensor API is not available.
   *
   * @since 0.0.1
   */
  available: boolean;
}

StartOptions

Options pour démarrer l'écouteur de capteur de lumière.

export interface StartOptions {
  /**
   * The desired interval between sensor updates in milliseconds.
   * On Android 12+, there's a minimum interval of 200ms unless the app
   * has the HIGH_SAMPLING_RATE_SENSORS permission.
   *
   * @default 200
   * @since 0.0.1
   */
  updateInterval?: number;
}

LightSensorCallback

Fonction de rappel pour les mises à jour du capteur de lumière.

export type LightSensorCallback = (measurement: LightSensorMeasurement) => void;

PermissionStatus

Résultat d'une demande ou d'une vérification de permission.

export interface PermissionStatus {
  /**
   * Whether the high sampling rate sensor permission is granted.
   * On Android 12+, this permission is required for update intervals below 200ms.
   *
   * @since 0.0.1
   */
  highSamplingRate: 'prompt' | 'prompt-with-rationale' | 'granted' | 'denied';
}

VersionResult

Informations sur la version du plugin.

export interface VersionResult {
  /**
   * The current version of the plugin.
   *
   * @since 0.0.1
   */
  version: string;
}

LightSensorMeasurement

Une seule mesure du capteur de lumière.

export interface LightSensorMeasurement {
  /**
   * Ambient light level in lux (lx).
   *
   * @since 0.0.1
   */
  illuminance: number;

  /**
   * Timestamp of the measurement in seconds since epoch.
   *
   * @since 0.0.1
   */
  timestamp: number;
}

Source de Vérité

Cette page est générée à partir du plugin’s src/definitions.tsRe-faire la synchronisation lorsque les public API changent en amont.

Continuez de l'étape « Getting Started »

Si vous utilisez Getting Started pour planifier le tableau de bord et les API opérations, connectez-le avec Utilisez @capgo/capacitor-light-sensor pour la capacité native dans Utilisez @capgo/capacitor-light-sensor, API Présentation pour le détail d'implémentation dans API Présentation, Introduction pour le détail d'implémentation dans Introduction, API Clés pour le détail d'implémentation dans API Clés, et Appareils pour le détail d'implémentation dans Appareils.