Prise en main

Installer

Vous pouvez utiliser notre configuration assistée par IA pour installer le plugin. Ajoutez les skills Capgo à votre outil d'IA avec la commande suivante :

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Utilisez ensuite le prompt suivant :

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-flash` plugin in my project.

Si vous préférez une installation manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à chaque plateforme ci-dessous :

bun add @capgo/capacitor-flash
bunx cap sync

Importer

import { CapacitorFlash } from '@capgo/capacitor-flash';

Démarrage rapide

import { CapacitorFlash } from '@capgo/capacitor-flash';

const { value: available } = await CapacitorFlash.isAvailable();
if (!available) {
  toast('No flashlight on this device');
  return;
}
await CapacitorFlash.switchOn({ intensity: 0.5 });

Exemple : compagnon de scan QR

await CapacitorFlash.switchOn({ intensity: 1 });
const code = await scanFrame();
await CapacitorFlash.switchOff();

Erreurs courantes

• Éteindre dans le finally: laisser la lampe allumée vide la batterie et bloque les autres utilisateurs de la caméra.
• Permissions web : les navigateurs mobiles exigent l'autorisation caméra avant d'accéder à la torche.
• Prise en charge de l'intensité : les valeurs dépassant le maximum matériel sont bornées, vérifiez avec isSwitchedOn().

Aperçu de API

isAvailable

Vérifie si la torche est disponible sur l'appareil.

import { CapacitorFlash } from '@capgo/capacitor-flash';

const { value } = await CapacitorFlash.isAvailable();
if (value) {
  console.log('Flashlight is available');
}

switchOn

Allume la torche.

import { CapacitorFlash } from '@capgo/capacitor-flash';

// Turn on at full brightness
await CapacitorFlash.switchOn({ intensity: 1.0 });

// Turn on at half brightness
await CapacitorFlash.switchOn({ intensity: 0.5 });

switchOff

Désactive la lampe torche.

import { CapacitorFlash } from '@capgo/capacitor-flash';

await CapacitorFlash.switchOff();

isSwitchedOn

Vérifie si la torche est actuellement allumée ou éteinte.

import { CapacitorFlash } from '@capgo/capacitor-flash';

const { value } = await CapacitorFlash.isSwitchedOn();
console.log('Flashlight is on:', value);

toggle

Activez ou désactivez la lampe torche.

import { CapacitorFlash } from '@capgo/capacitor-flash';

const { value } = await CapacitorFlash.toggle();
console.log('Flashlight toggled, now on:', value);

Source de vérité

Cette page est générée à partir de src/definitions.ts. Relancez la synchronisation lorsque l’API public change en amont.

Continuer depuis Getting Started

Si vous utilisez Prise en main pour planifier les opérations du dashboard et de API, connectez-l’avec Utiliser @capgo/capacitor-flash pour la capacité native dans l'utilisation de @capgo/capacitor-flash, Aperçu de API pour les détails d'implémentation dans « Vue d'ensemble de API », Introduction pour les détails d'implémentation dans l'introduction, Clés API pour les détails d'implémentation dans « Clés API », et Appareils pour les détails d'implémentation dans Devices.