feat(*): add torch support

Author: michaelwolz

README.md

@@ -31,7 +31,7 @@
 - 📸 Capture photos or frames from the camera preview.
 - 🔍 **Barcode detection** support.
 - 📱 **Virtual device support** for automatic lens selection based on zoom level and focus (iOS only).
-- 🔎 Control **zoom** and **flash** modes programmatically.
+- 🔦 Control **zoom**, **flash** and **torch** modes programmatically.
 - ⚡ **High performance** with optimized native implementations.
 - 🎯 **Simple to use** with a clean and intuitive API.
 - 🌐 Works seamlessly on **iOS**, **Android**, and **Web**.
@@ -210,6 +210,9 @@ chore: update dependencies
 * [`getFlashMode()`](#getflashmode)
 * [`getSupportedFlashModes()`](#getsupportedflashmodes)
 * [`setFlashMode(...)`](#setflashmode)
+* [`isTorchAvailable()`](#istorchavailable)
+* [`getTorchMode()`](#gettorchmode)
+* [`setTorchMode(...)`](#settorchmode)
 * [`checkPermissions()`](#checkpermissions)
 * [`requestPermissions()`](#requestpermissions)
 * [`addListener('barcodeDetected', ...)`](#addlistenerbarcodedetected-)
@@ -422,6 +425,53 @@ Set the camera flash mode.
 --------------------
 
 
+### isTorchAvailable()
+
+```typescript
+isTorchAvailable() => Promise<IsTorchAvailableResponse>
+```
+
+Check if the device supports torch (flashlight) functionality.
+
+**Returns:** <code>Promise&lt;<a href="#istorchavailableresponse">IsTorchAvailableResponse</a>&gt;</code>
+
+**Since:** 1.2.0
+
+--------------------
+
+
+### getTorchMode()
+
+```typescript
+getTorchMode() => Promise<GetTorchModeResponse>
+```
+
+Get the current torch (flashlight) state.
+
+**Returns:** <code>Promise&lt;<a href="#gettorchmoderesponse">GetTorchModeResponse</a>&gt;</code>
+
+**Since:** 1.2.0
+
+--------------------
+
+
+### setTorchMode(...)
+
+```typescript
+setTorchMode(options: { enabled: boolean; level?: number; }) => Promise<void>
+```
+
+Set the torch (flashlight) mode and intensity.
+
+| Param         | Type                                               | Description                   |
+| ------------- | -------------------------------------------------- | ----------------------------- |
+| **`options`** | <code>{ enabled: boolean; level?: number; }</code> | - Torch configuration options |
+
+**Since:** 1.2.0
+
+--------------------
+
+
 ### checkPermissions()
 
 ```typescript
@@ -577,6 +627,25 @@ Response for getting supported flash modes.
 | **`flashModes`** | <code>FlashMode[]</code> | An array of flash modes supported by the current camera |
 
 
+#### IsTorchAvailableResponse
+
+Response for checking torch availability.
+
+| Prop            | Type                 | Description                                                       |
+| --------------- | -------------------- | ----------------------------------------------------------------- |
+| **`available`** | <code>boolean</code> | Indicates if the device supports torch (flashlight) functionality |
+
+
+#### GetTorchModeResponse
+
+Response for getting the current torch mode.
+
+| Prop          | Type                 | Description                                                                                  |
+| ------------- | -------------------- | -------------------------------------------------------------------------------------------- |
+| **`enabled`** | <code>boolean</code> | Indicates if the torch is currently enabled                                                  |
+| **`level`**   | <code>number</code>  | The current torch intensity level (0.0 to 1.0, iOS only). Always 1.0 on Android when enabled |
+
+
 #### PermissionStatus
 
 Response for the camera permission status.

android/src/main/java/com/michaelwolz/capacitorcameraview/CameraError.kt

@@ -0,0 +1,9 @@
+package com.michaelwolz.capacitorcameraview
+
+sealed class CameraError(message: String) : Exception(message) {
+    class TorchUnavailable : CameraError("Torch is not available on this device")
+    class CameraNotInitialized : CameraError("Camera controller not initialized")
+    class PreviewNotInitialized : CameraError("Camera preview not initialized")
+    class LifecycleOwnerMissing : CameraError("WebView context must be a LifecycleOwner")
+    class ZoomFactorOutOfRange : CameraError("The requested zoom factor is out of range.")
+}

android/src/main/java/com/michaelwolz/capacitorcameraview/CameraView.kt

@@ -55,6 +55,7 @@ class CameraView(plugin: Plugin) {
     // Camera state
     private var currentCameraSelector = CameraSelector.DEFAULT_BACK_CAMERA
     private var currentFlashMode: Int = ImageCapture.FLASH_MODE_OFF
+    private var isTorchEnabled: Boolean = false
 
     // Plugin context
     private var lifecycleOwner: LifecycleOwner? = null
@@ -71,7 +72,7 @@ class CameraView(plugin: Plugin) {
         val lifecycleOwner =
             context as? LifecycleOwner
                 ?: run {
-                    callback(Exception("WebView context must be a LifecycleOwner"))
+                    callback(CameraError.LifecycleOwnerMissing())
                     return
                 }
 
@@ -132,13 +133,13 @@ class CameraView(plugin: Plugin) {
         val controller =
             this.cameraController
                 ?: run {
-                    callback(null, Exception("Camera controller not initialized"))
+                    callback(null, CameraError.CameraNotInitialized())
                     return
                 }
 
         val preview = previewView
             ?: run {
-                callback(null, Exception("Camera preview not initialized"))
+                callback(null, CameraError.PreviewNotInitialized())
                 return
             }
 
@@ -250,7 +251,7 @@ class CameraView(plugin: Plugin) {
         val previewView =
             this.previewView
                 ?: run {
-                    callback(null, Exception("Camera preview not initialized"))
+                    callback(null, CameraError.PreviewNotInitialized())
                     return
                 }
 
@@ -309,7 +310,7 @@ class CameraView(plugin: Plugin) {
         val controller =
             this.cameraController
                 ?: run {
-                    callback(Exception("Camera controller not initialized"))
+                    callback(CameraError.CameraNotInitialized())
                     return
                 }
 
@@ -327,14 +328,14 @@ class CameraView(plugin: Plugin) {
             val cameraControl =
                 cameraController?.cameraControl
                     ?: run {
-                        callback?.invoke(Exception("Camera controller not initialized"))
+                        callback?.invoke(CameraError.CameraNotInitialized())
                         return@post
                     }
 
             val availableZoomFactors = getZoomFactorsInternal()
 
             if (zoomFactor !in availableZoomFactors.min..availableZoomFactors.max) {
-                callback?.invoke(Exception("The requested zoom factor is out of range."))
+                callback?.invoke(CameraError.ZoomFactorOutOfRange())
                 return@post
             }
 
@@ -402,6 +403,33 @@ class CameraView(plugin: Plugin) {
         mainHandler.post { controller.imageCaptureFlashMode = currentFlashMode }
     }
 
+    /** Check if torch is available */
+    fun isTorchAvailable(): Boolean {
+        val cameraInfo = cameraController?.cameraInfo ?: return false
+        return cameraInfo.hasFlashUnit()
+    }
+
+    /** Get the current torch mode */
+    fun getTorchMode(): Boolean {
+        return isTorchEnabled
+    }
+
+    /** Set the torch mode */
+    fun setTorchMode(enabled: Boolean) {
+        val controller = this.cameraController
+            ?: run { throw CameraError.CameraNotInitialized() }
+
+        val cameraInfo = controller.cameraInfo
+        if (cameraInfo?.hasFlashUnit() != true) {
+            throw CameraError.TorchUnavailable()
+        }
+
+        isTorchEnabled = enabled
+        mainHandler.post {
+            controller.cameraControl?.enableTorch(enabled)
+        }
+    }
+
     /** Get a list of available camera devices */
     fun getAvailableDevices(): List<CameraDevice> {
         try {

android/src/main/java/com/michaelwolz/capacitorcameraview/CameraViewPlugin.kt

@@ -209,6 +209,51 @@ class CameraViewPlugin : Plugin() {
         }
     }
 
+    @PluginMethod
+    fun isTorchAvailable(call: PluginCall) {
+        try {
+            val available = implementation.isTorchAvailable()
+            call.resolve(JSObject().apply {
+                put("available", available)
+            })
+        } catch (e: Exception) {
+            call.reject("Failed to check torch availability: ${e.localizedMessage}", e)
+        }
+    }
+
+    @PluginMethod
+    fun getTorchMode(call: PluginCall) {
+        try {
+            val enabled = implementation.getTorchMode()
+            call.resolve(JSObject().apply {
+                put("enabled", enabled)
+                put(
+                    "level",
+                    // Android always uses full intensity when enabled
+                    if (enabled) 1.0f else 0.0f
+                )
+            })
+        } catch (e: Exception) {
+            call.reject("Failed to get torch mode: ${e.localizedMessage}", e)
+        }
+    }
+
+    @PluginMethod
+    fun setTorchMode(call: PluginCall) {
+        val enabled = call.getBoolean("enabled")
+        if (enabled == null) {
+            call.reject("Enabled parameter is required")
+            return
+        }
+
+        try {
+            implementation.setTorchMode(enabled)
+            call.resolve()
+        } catch (e: Exception) {
+            call.reject("Failed to set torch mode: ${e.localizedMessage}", e)
+        }
+    }
+
     /**
      * Called by the CameraView when a barcode is detected.
      */

example-app/.vscode/extensions.json

@@ -1,5 +1,3 @@
 {
-    "recommendations": [
-      "ionic.ionic"
-    ]
+  "recommendations": ["ionic.ionic"]
 }

example-app/package.json

@@ -9,7 +9,8 @@
     "build": "ng build",
     "watch": "ng build --watch --configuration development",
     "test": "ng test",
-    "lint": "ng lint"
+    "lint": "ng lint",
+    "format": "prettier --write \"src/**/*.{ts,js,html,scss,css,json}\""
   },
   "private": true,
   "dependencies": {

example-app/src/app/app.component.ts

@@ -11,6 +11,7 @@ import {
   closeCircle,
   flash,
   flashOff,
+  flashlightOutline,
   imagesSharp,
   qrCodeOutline,
   remove,
@@ -38,6 +39,7 @@ export class AppComponent {
       closeCircle,
       flash,
       flashOff,
+      flashlightOutline,
       imagesSharp,
       qrCodeOutline,
       remove,

example-app/src/app/components/camera-modal/camera-modal.component.html

@@ -40,6 +40,23 @@
         }
       </ion-fab-button>
 
+      <ion-fab-button
+        (click)="toggleTorch()"
+        size="small"
+        [disabled]="!torchAvailable()"
+      >
+        @if (torchEnabled() && torchAvailable()) {
+          <div style="line-height: 0.5; margin-top: -5px">
+            <ion-icon name="flashlight-outline" size="small"></ion-icon><br />
+            <span style="font-size: 0.5rem"
+              >{{ (torchLevel() * 100).toFixed(0) }}%</span
+            >
+          </div>
+        } @else {
+          <ion-icon name="flashlight-outline" size="small"></ion-icon>
+        }
+      </ion-fab-button>
+
       <ion-fab-button size="small" (click)="flipCamera()">
         <ion-icon name="camera-reverse"></ion-icon>
       </ion-fab-button>

example-app/src/app/components/camera-modal/camera-modal.component.scss

@@ -100,4 +100,4 @@ ion-chip.barcode-detected {
     opacity: 1;
     transform: translate(-50%, 0);
   }
-}
+}