search

Cap-go / capacitor-flash

Switch the Flashlight / Torch of your device.
https://capgo.app
13 stars 4 forks source link
capacitor capacitor-plugin ionic

readme

capacitor-flash

Capgo - Instant updates for capacitor

➡️ Get Instant updates for your App with Capgo 🚀

Fix your annoying bug now, Hire a Capacitor expert 💪

Switch the Flashlight / Torch of your device.

Install

npm install @capgo/capacitor-flash
npx cap sync

iOS

Works out of the box

Android

  1. Declare permissions in your app's AndroidManifest.xml file
<!-- Permissions: Allows access to flashlight -->
<uses-permission android:name="android.permission.CAMERA" android:maxSdkVersion="23" />
<uses-permission android:name="android.permission.FLASHLIGHT" />

<!-- Actual Hardware Features Used-->
<uses-feature android:name="android.hardware.camera.flash" android:required="true" />

API

* [`isAvailable()`](#isavailable) * [`switchOn(...)`](#switchon) * [`switchOff()`](#switchoff) * [`isSwitchedOn()`](#isswitchedon) * [`toggle()`](#toggle) ### isAvailable() ```typescript isAvailable() => any ``` Checks if flashlight is available **Returns:** any -------------------- ### switchOn(...) ```typescript switchOn(options: { intensity?: number; }) => any ``` Turns the flashlight on | Param | Type | | ------------- | ------------------------------------ | | **`options`** | { intensity?: number; } | **Returns:** any -------------------- ### switchOff() ```typescript switchOff() => any ``` Turns the flashlight off **Returns:** any -------------------- ### isSwitchedOn() ```typescript isSwitchedOn() => any ``` Checks if the flashlight is turned on or off **Returns:** any -------------------- ### toggle() ```typescript toggle() => any ``` Toggle the flashlight **Returns:** any --------------------