スタートガイド

インストール

AIアシストによるセットアップでプラグインをインストールできます。以下のコマンドを使用して、お使いのAIツールに Capgo のスキルを追加してください：

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

次に、以下のプロンプトを使用します：

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

手動セットアップを希望する場合は、以下のコマンドを実行してプラグインをインストールし、下記のプラットフォーム別の手順に従ってください：

bun add @capgo/capacitor-flash
bunx cap sync

インポート

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

クイックスタート

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 });

例：QRスキャナーのコンパニオン

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

よくある落とし穴

• finally ブロックでオフにする：ライトを点灯させたままにすると、バッテリーを消耗し、他のカメラ利用を妨げます。
• Webの権限：モバイルブラウザでライトを使用するには、カメラの権限が必要です。
• 輝度（Intensity）のサポート：ハードウェアの最大値を超える値は制限されます。以下で確認してください： isSwitchedOn().

API の概要

isAvailable

デバイスでフラッシュライトが利用可能か確認します。

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

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

switchOn

フラッシュライトをオンにします。

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

フラッシュライトをオフにします。

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

await CapacitorFlash.switchOff();

isSwitchedOn

現在フラッシュライトがオンかオフかを確認します。

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

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

toggle

フラッシュライトのON/OFFを切り替えます。

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

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

Source of Truth

このページはプラグインの src/definitions.tsから生成されています。upstream で公開 API が変更されたら、再度 sync を実行してください。

Getting Startedの続きを進める

使用している場合 スタートガイド ダッシュボードと API の運用を計画するには、これを次と連携させます @capgo/capacitor-flash の使用方法 @capgo/capacitor-flash でネイティブ機能を使用する場合、 API の概要 「API の概要」の実装の詳細については、 はじめに 「はじめに」における実装の詳細については、 API キー および「API Keys」の実装の詳細については、 デバイス 実装の詳細については Devices を参照してください。