capacitor-camera-view 1.1.0 → 1.2.0

package/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.

package/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.")
+}

package/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
                 }
 
@@ -129,16 +130,15 @@ class CameraView(plugin: Plugin) {
         callback: (JSObject?, Exception?) -> Unit
     ) {
         val startTime = System.currentTimeMillis()
-        val controller =
-            this.cameraController
-                ?: run {
-                    callback(null, Exception("Camera controller not initialized"))
-                    return
-                }
+        val controller = cameraController
+            ?: run {
+                callback(null, CameraError.CameraNotInitialized())
+                return
+            }
 
         val preview = previewView
             ?: run {
-                callback(null, Exception("Camera preview not initialized"))
+                callback(null, CameraError.PreviewNotInitialized())
                 return
             }
 
@@ -250,7 +250,7 @@ class CameraView(plugin: Plugin) {
         val previewView =
             this.previewView
                 ?: run {
-                    callback(null, Exception("Camera preview not initialized"))
+                    callback(null, CameraError.PreviewNotInitialized())
                     return
                 }
 
@@ -306,14 +306,16 @@ class CameraView(plugin: Plugin) {
             else -> CameraSelector.DEFAULT_FRONT_CAMERA
         }
 
-        val controller =
-            this.cameraController
-                ?: run {
-                    callback(Exception("Camera controller not initialized"))
-                    return
-                }
+        val controller = cameraController
+            ?: run {
+                callback(CameraError.CameraNotInitialized())
+                return
+            }
 
-        mainHandler.post { controller.cameraSelector = currentCameraSelector }
+        mainHandler.post {
+            controller.cameraSelector = currentCameraSelector
+            callback(null)
+        }
     }
 
     /** Get the min, max, and current zoom values */
@@ -324,17 +326,16 @@ class CameraView(plugin: Plugin) {
     /** Set the zoom factor for the camera */
     fun setZoomFactor(zoomFactor: Float, callback: (((Exception?) -> Unit)?) = null) {
         mainHandler.post {
-            val cameraControl =
-                cameraController?.cameraControl
-                    ?: run {
-                        callback?.invoke(Exception("Camera controller not initialized"))
-                        return@post
-                    }
+            val cameraControl = cameraController?.cameraControl
+                ?: run {
+                    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
             }
 
@@ -369,12 +370,11 @@ class CameraView(plugin: Plugin) {
     /** Get supported flash modes */
     fun getSupportedFlashModes(callback: (supportedFlashModes: List<String>) -> Unit) {
         mainHandler.post {
-            val cameraInfo =
-                cameraController?.cameraInfo
-                    ?: run {
-                        callback(listOf("off"))
-                        return@post
-                    }
+            val cameraInfo = cameraController?.cameraInfo
+                ?: run {
+                    callback(listOf("off"))
+                    return@post
+                }
 
             callback(
                 if (cameraInfo.hasFlashUnit()) {
@@ -402,6 +402,49 @@ class CameraView(plugin: Plugin) {
         mainHandler.post { controller.imageCaptureFlashMode = currentFlashMode }
     }
 
+    /** Check if torch is available */
+    fun isTorchAvailable(callback: (Boolean) -> Unit) {
+        mainHandler.post {
+            val cameraInfo = cameraController?.cameraInfo
+                ?: run {
+                    callback(false)
+                    return@post
+                }
+
+            callback(cameraInfo.hasFlashUnit())
+        }
+    }
+
+    /** Get the current torch mode */
+    fun getTorchMode(): Boolean {
+        return isTorchEnabled
+    }
+
+    /** Set the torch mode */
+    fun setTorchMode(enabled: Boolean, callback: ((Exception?) -> Unit)? = null) {
+        mainHandler.post {
+            try {
+                val controller = cameraController
+                    ?: run {
+                        callback?.invoke(CameraError.CameraNotInitialized())
+                        return@post
+                    }
+
+                val cameraInfo = controller.cameraInfo
+                if (cameraInfo?.hasFlashUnit() != true) {
+                    callback?.invoke(CameraError.TorchUnavailable())
+                    return@post
+                }
+
+                controller.cameraControl?.enableTorch(enabled)
+                isTorchEnabled = enabled
+                callback?.invoke(null)
+            } catch (e: Exception) {
+                callback?.invoke(e)
+            }
+        }
+    }
+
     /** Get a list of available camera devices */
     fun getAvailableDevices(): List<CameraDevice> {
         try {

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

@@ -209,6 +209,49 @@ class CameraViewPlugin : Plugin() {
         }
     }
 
+    @PluginMethod
+    fun isTorchAvailable(call: PluginCall) {
+        implementation.isTorchAvailable { available ->
+            call.resolve(JSObject().apply {
+                put("available", available)
+            })
+        }
+    }
+
+    @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
+        }
+
+        implementation.setTorchMode(enabled) { error ->
+            if (error != null) {
+                call.reject("Failed to set torch mode: ${error.localizedMessage}", error)
+            } else {
+                call.resolve()
+            }
+        }
+    }
+
     /**
      * Called by the CameraView when a barcode is detected.
      */

package/dist/docs.json

@@ -330,6 +330,97 @@
         ],
         "slug": "setflashmode"
       },
+      {
+        "name": "isTorchAvailable",
+        "signature": "() => Promise<IsTorchAvailableResponse>",
+        "parameters": [],
+        "returns": "Promise<IsTorchAvailableResponse>",
+        "tags": [
+          {
+            "name": "remarks",
+            "text": "**Important**: You must call this method and verify torch availability before using\n`setTorchMode()` or `getTorchMode()`. Calling torch methods on devices without\ntorch support will throw an exception."
+          },
+          {
+            "name": "returns",
+            "text": "A promise that resolves with an object containing torch availability status"
+          },
+          {
+            "name": "since",
+            "text": "1.2.0"
+          }
+        ],
+        "docs": "Check if the device supports torch (flashlight) functionality.",
+        "complexTypes": [
+          "IsTorchAvailableResponse"
+        ],
+        "slug": "istorchavailable"
+      },
+      {
+        "name": "getTorchMode",
+        "signature": "() => Promise<GetTorchModeResponse>",
+        "parameters": [],
+        "returns": "Promise<GetTorchModeResponse>",
+        "tags": [
+          {
+            "name": "remarks",
+            "text": "**Important**: Call `isTorchAvailable()` first to ensure the device supports torch\nfunctionality. This method will throw an exception if torch is not supported."
+          },
+          {
+            "name": "returns",
+            "text": "A promise that resolves with an object containing the current torch state"
+          },
+          {
+            "name": "since",
+            "text": "1.2.0"
+          }
+        ],
+        "docs": "Get the current torch (flashlight) state.",
+        "complexTypes": [
+          "GetTorchModeResponse"
+        ],
+        "slug": "gettorchmode"
+      },
+      {
+        "name": "setTorchMode",
+        "signature": "(options: { enabled: boolean; level?: number; }) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "- Torch configuration options",
+            "type": "{ enabled: boolean; level?: number | undefined; }"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "remarks",
+            "text": "**Important**: Call `isTorchAvailable()` first to ensure the device supports torch\nfunctionality. This method will throw an exception if torch is not supported.\n\nThe torch provides continuous illumination, unlike flash which only activates during photo capture.\nOn iOS, you can control the torch intensity level. On Android, the torch is either on or off."
+          },
+          {
+            "name": "param",
+            "text": "options - Torch configuration options"
+          },
+          {
+            "name": "param",
+            "text": "options.enabled - Whether to enable or disable the torch"
+          },
+          {
+            "name": "param",
+            "text": "options.level - The torch intensity level (0.0 to 1.0, iOS only). Defaults to 1.0 when enabled"
+          },
+          {
+            "name": "returns",
+            "text": "A promise that resolves when the torch mode has been set"
+          },
+          {
+            "name": "since",
+            "text": "1.2.0"
+          }
+        ],
+        "docs": "Set the torch (flashlight) mode and intensity.",
+        "complexTypes": [],
+        "slug": "settorchmode"
+      },
       {
         "name": "checkPermissions",
         "signature": "() => Promise<PermissionStatus>",
@@ -760,6 +851,55 @@
         }
       ]
     },
+    {
+      "name": "IsTorchAvailableResponse",
+      "slug": "istorchavailableresponse",
+      "docs": "Response for checking torch availability.",
+      "tags": [
+        {
+          "text": "1.2.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "available",
+          "tags": [],
+          "docs": "Indicates if the device supports torch (flashlight) functionality",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
+    {
+      "name": "GetTorchModeResponse",
+      "slug": "gettorchmoderesponse",
+      "docs": "Response for getting the current torch mode.",
+      "tags": [
+        {
+          "text": "1.2.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "enabled",
+          "tags": [],
+          "docs": "Indicates if the torch is currently enabled",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "level",
+          "tags": [],
+          "docs": "The current torch intensity level (0.0 to 1.0, iOS only). Always 1.0 on Android when enabled",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
+    },
     {
       "name": "PermissionStatus",
       "slug": "permissionstatus",

package/dist/esm/definitions.d.ts

@@ -130,6 +130,52 @@ export interface CameraViewPlugin {
     setFlashMode(options: {
         mode: FlashMode;
     }): Promise<void>;
+    /**
+     * Check if the device supports torch (flashlight) functionality.
+     *
+     * @remarks
+     * **Important**: You must call this method and verify torch availability before using
+     * `setTorchMode()` or `getTorchMode()`. Calling torch methods on devices without
+     * torch support will throw an exception.
+     *
+     * @returns A promise that resolves with an object containing torch availability status
+     *
+     * @since 1.2.0
+     */
+    isTorchAvailable(): Promise<IsTorchAvailableResponse>;
+    /**
+     * Get the current torch (flashlight) state.
+     *
+     * @remarks
+     * **Important**: Call `isTorchAvailable()` first to ensure the device supports torch
+     * functionality. This method will throw an exception if torch is not supported.
+     *
+     * @returns A promise that resolves with an object containing the current torch state
+     *
+     * @since 1.2.0
+     */
+    getTorchMode(): Promise<GetTorchModeResponse>;
+    /**
+     * Set the torch (flashlight) mode and intensity.
+     *
+     * @remarks
+     * **Important**: Call `isTorchAvailable()` first to ensure the device supports torch
+     * functionality. This method will throw an exception if torch is not supported.
+     *
+     * The torch provides continuous illumination, unlike flash which only activates during photo capture.
+     * On iOS, you can control the torch intensity level. On Android, the torch is either on or off.
+     *
+     * @param options - Torch configuration options
+     * @param options.enabled - Whether to enable or disable the torch
+     * @param options.level - The torch intensity level (0.0 to 1.0, iOS only). Defaults to 1.0 when enabled
+     * @returns A promise that resolves when the torch mode has been set
+     *
+     * @since 1.2.0
+     */
+    setTorchMode(options: {
+        enabled: boolean;
+        level?: number;
+    }): Promise<void>;
     /**
      * Check camera permission status without requesting permissions.
      *
@@ -355,6 +401,26 @@ export interface GetSupportedFlashModesResponse {
     /** An array of flash modes supported by the current camera */
     flashModes: FlashMode[];
 }
+/**
+ * Response for checking torch availability.
+ *
+ * @since 1.2.0
+ */
+export interface IsTorchAvailableResponse {
+    /** Indicates if the device supports torch (flashlight) functionality */
+    available: boolean;
+}
+/**
+ * Response for getting the current torch mode.
+ *
+ * @since 1.2.0
+ */
+export interface GetTorchModeResponse {
+    /** Indicates if the torch is currently enabled */
+    enabled: boolean;
+    /** The current torch intensity level (0.0 to 1.0, iOS only). Always 1.0 on Android when enabled */
+    level: number;
+}
 /**
  * Data for a detected barcode.
  *

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["import type { PermissionState, PluginListenerHandle } from '@capacitor/core';\n\n/**\n * Main plugin interface for Capacitor Camera View functionality.\n *\n * @since 1.0.0\n */\nexport interface CameraViewPlugin {\n  /**\n   * Start the camera view with optional configuration.\n   *\n   * @param options - Configuration options for the camera session\n   * @returns A promise that resolves when the camera has started\n   *\n   * @since 1.0.0\n   */\n  start(options?: CameraSessionConfiguration): Promise<void>;\n\n  /**\n   * Stop the camera view and release resources.\n   *\n   * @returns A promise that resolves when the camera has stopped\n   *\n   * @since 1.0.0\n   */\n  stop(): Promise<void>;\n\n  /**\n   * Check if the camera view is currently running.\n   *\n   * @returns A promise that resolves with an object containing the running state of the camera\n   *\n   * @since 1.0.0\n   */\n  isRunning(): Promise<IsRunningResponse>;\n\n  /**\n   * Capture a photo using the current camera configuration.\n   *\n   * @param options - Capture configuration options\n   * @returns A promise that resolves with an object containing either a base64 encoded string or file path of the captured photo\n   *\n   * @since 1.0.0\n   */\n  capture<T extends CaptureOptions>(options: T): Promise<CaptureResponse<T>>;\n\n  /**\n   * Captures a frame from the current camera preview without using the full camera capture pipeline.\n   *\n   * Unlike `capture()` which may trigger hardware-level photo capture on native platforms,\n   * this method quickly samples the current video stream. This is suitable computer vision or\n   * simple snapshots where high fidelity is not required.\n   *\n   * On web this method does exactly the same as `capture()` as it only captures a frame from the video stream\n   * because unfortunately [ImageCapture API](https://developer.mozilla.org/en-US/docs/Web/API/ImageCapture) is\n   * not yet well supported on the web.\n   *\n   * @param options - Capture configuration options\n   * @returns A promise that resolves with an object containing either a base64 encoded string or file path of the captured sample\n   *\n   * @since 1.0.0\n   */\n  captureSample<T extends CaptureOptions>(options: T): Promise<CaptureResponse<T>>;\n\n  /**\n   * Switch between front and back camera.\n   *\n   * @returns A promise that resolves when the camera has been flipped\n   *\n   * @since 1.0.0\n   */\n  flipCamera(): Promise<void>;\n\n  /**\n   * Get available camera devices for capturing photos.\n   *\n   * @returns A promise that resolves with an object containing an array of available capture devices\n   *\n   * @since 1.0.0\n   */\n  getAvailableDevices(): Promise<GetAvailableDevicesResponse>;\n\n  /**\n   * Get current zoom level information and available range.\n   *\n   * @remarks\n   * Make sure the camera is properly initialized before calling this method. Otherwise, this might\n   * lead to returning default values on android.\n   *\n   * @returns A promise that resolves with an object containing min, max and current zoom levels\n   *\n   * @since 1.0.0\n   */\n  getZoom(): Promise<GetZoomResponse>;\n\n  /**\n   * Set the camera zoom level.\n   *\n   * @param options - Zoom configuration options\n   * @param options.level - The zoom level to set\n   * @param options.ramp - Whether to animate the zoom level change, defaults to false (iOS only)\n   * @returns A promise that resolves when the zoom level has been set\n   *\n   * @remarks\n   * On web platforms, zoom functionality may be limited by browser support.\n   * When native zoom is not available, a CSS-based zoom simulation is applied.\n   *\n   * @since 1.0.0\n   */\n  setZoom(options: { level: number; ramp?: boolean }): Promise<void>;\n\n  /**\n   * Get current flash mode setting.\n   *\n   * @returns A promise that resolves with an object containing the current flash mode\n   *\n   * @since 1.0.0\n   */\n  getFlashMode(): Promise<GetFlashModeResponse>;\n\n  /**\n   * Get supported flash modes for the current camera.\n   *\n   * @returns A promise that resolves with an object containing an array of supported flash modes\n   *\n   * @since 1.0.0\n   */\n  getSupportedFlashModes(): Promise<GetSupportedFlashModesResponse>;\n\n  /**\n   * Set the camera flash mode.\n   *\n   * @param options - Flash mode configuration options\n   * @param options.mode - The flash mode to set\n   * @returns A promise that resolves when the flash mode has been set\n   *\n   * @since 1.0.0\n   */\n  setFlashMode(options: { mode: FlashMode }): Promise<void>;\n\n  /**\n   * Check camera permission status without requesting permissions.\n   *\n   * @returns A promise that resolves with an object containing the camera permission status\n   *\n   * @since 1.0.0\n   */\n  checkPermissions(): Promise<PermissionStatus>;\n\n  /**\n   * Request camera permission from the user.\n   *\n   * @returns A promise that resolves with an object containing the camera permission status\n   *\n   * @since 1.0.0\n   */\n  requestPermissions(): Promise<PermissionStatus>;\n\n  /**\n   * Listen for barcode detection events.\n   * This event is emitted when a barcode is detected in the camera preview.\n   *\n   * @param eventName - The name of the event to listen for ('barcodeDetected')\n   * @param listenerFunc - The callback function to execute when a barcode is detected\n   * @returns A promise that resolves with an event subscription\n   *\n   * @since 1.0.0\n   */\n  addListener(\n    eventName: 'barcodeDetected',\n    listenerFunc: (data: BarcodeDetectionData) => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * Remove all listeners for this plugin.\n   *\n   * @param eventName - Optional event name to remove listeners for\n   * @returns A promise that resolves when the listeners are removed\n   *\n   * @since 1.0.0\n   */\n  removeAllListeners(eventName?: string): Promise<void>;\n}\n\n// ------------------------------------------------------------------------------\n// Camera Configuration Types\n// ------------------------------------------------------------------------------\n\n/**\n * Position options for the camera.\n * - 'front': Front-facing camera\n * - 'back': Rear-facing camera\n *\n * @since 1.0.0\n */\nexport type CameraPosition = 'front' | 'back';\n\n/**\n * Flash mode options for the camera.\n * - 'off': Flash disabled\n * - 'on': Flash always on\n * - 'auto': Flash automatically enabled in low-light conditions\n *\n * @since 1.0.0\n */\nexport type FlashMode = 'off' | 'on' | 'auto';\n\n/**\n * Represents a physical camera device on the device.\n *\n * @since 1.0.0\n */\nexport interface CameraDevice {\n  /** The unique identifier of the camera device */\n  id: string;\n\n  /** The human-readable name of the camera device */\n  name: string;\n\n  /** The position of the camera device (front or back) */\n  position: CameraPosition;\n\n  /** The type of the camera device (e.g., wide, ultra-wide, telephoto) - iOS only */\n  deviceType?: CameraDeviceType;\n}\n\n/**\n * Available camera device types for iOS.\n * Maps to AVCaptureDevice DeviceTypes in iOS.\n *\n * @see https://developer.apple.com/documentation/avfoundation/avcapturedevice/devicetype-swift.struct\n *\n * @since 1.0.0\n */\nexport type CameraDeviceType =\n  /** builtInWideAngleCamera - standard camera */\n  | 'wideAngle'\n  /** builtInUltraWideCamera - 0.5x zoom level */\n  | 'ultraWide'\n  /** builtInTelephotoCamera - 2x/3x zoom level */\n  | 'telephoto'\n  /** builtInDualCamera - wide + telephoto combination */\n  | 'dual'\n  /** builtInDualWideCamera - wide + ultraWide combination */\n  | 'dualWide'\n  /** builtInTripleCamera - wide + ultraWide + telephoto */\n  | 'triple'\n  /** builtInTrueDepthCamera - front-facing camera with depth sensing */\n  | 'trueDepth';\n\n/**\n * Configuration options for starting a camera session.\n *\n * @since 1.0.0\n */\nexport interface CameraSessionConfiguration {\n  /**\n   * Enables the barcode detection functionality\n   * @default false\n   */\n  enableBarcodeDetection?: boolean;\n\n  /**\n   * Position of the camera to use\n   * @default 'back'\n   */\n  position?: CameraPosition;\n\n  /**\n   * Specific device ID of the camera to use\n   * If provided, takes precedence over position\n   */\n  deviceId?: string;\n\n  /**\n   * Whether to use the triple camera if available (iPhone Pro models only)\n   * @default false\n   */\n  useTripleCameraIfAvailable?: boolean;\n\n  /**\n   * Ordered list of preferred camera device types to use (iOS only).\n   * The system will attempt to use the first available camera type in the list.\n   * If position is also provided, the system will use the first available camera type\n   * that matches the position and is in the list.\n   *\n   * This will fallback to the default camera type if none of the preferred types are available.\n   *\n   * @example [CameraDeviceType.WideAngle, CameraDeviceType.UltraWide, CameraDeviceType.Telephoto]\n   * @default undefined - system will decide based on position/deviceId\n   */\n  preferredCameraDeviceTypes?: CameraDeviceType[];\n\n  /**\n   * The initial zoom factor to use\n   * @default 1.0\n   */\n  zoomFactor?: number;\n\n  /**\n   * Optional HTML ID of the container element where the camera view should be rendered.\n   * If not provided, the camera view will be appended to the document body. Web only.\n   * @example 'cameraContainer'\n   */\n  containerElementId?: string;\n}\n\n/**\n * Configuration options for capturing photos and samples.\n *\n * @since 1.1.0\n */\nexport interface CaptureOptions {\n  /**\n   * The JPEG quality of the captured photo/sample on a scale of 0-100\n   * @since 1.1.0\n   */\n  quality: number;\n\n  /**\n   * If true, saves to a temporary file and returns the web path instead of base64.\n   * The web path can be used to set the src attribute of an image for efficient loading and rendering.\n   * This reduces the data that needs to be transferred over the bridge, which can improve performance\n   * especially for high-resolution images.\n   * @default false\n   * @since 1.1.0\n   */\n  saveToFile?: boolean;\n}\n\n// ------------------------------------------------------------------------------\n// Response Interfaces\n// ------------------------------------------------------------------------------\n\n/**\n * Response for checking if the camera view is running.\n *\n * @since 1.0.0\n */\nexport interface IsRunningResponse {\n  /** Indicates if the camera view is currently active and running */\n  isRunning: boolean;\n}\n\n/**\n * Response for capturing a photo\n * This will contain either a base64 encoded string or a web path to the captured photo,\n * depending on the `saveToFile` option in the CaptureOptions.\n * @since 1.0.0\n */\nexport type CaptureResponse<T extends CaptureOptions = CaptureOptions> = T['saveToFile'] extends true\n  ? {\n      /** The web path to the captured photo that can be used to set the src attribute of an image for efficient loading and rendering (when saveToFile is true) */\n      webPath: string;\n    }\n  : {\n      /** The base64 encoded string of the captured photo (when saveToFile is false or undefined) */\n      photo: string;\n    };\n\n/**\n * Response for getting available camera devices.\n *\n * @since 1.0.0\n */\nexport interface GetAvailableDevicesResponse {\n  /** An array of available camera devices */\n  devices: CameraDevice[];\n}\n\n/**\n * Response for getting zoom level information.\n *\n * @since 1.0.0\n */\nexport interface GetZoomResponse {\n  /** The minimum zoom level supported */\n  min: number;\n\n  /** The maximum zoom level supported */\n  max: number;\n\n  /** The current zoom level */\n  current: number;\n}\n\n/**\n * Response for getting the current flash mode.\n *\n * @since 1.0.0\n */\nexport interface GetFlashModeResponse {\n  /** The current flash mode setting */\n  flashMode: FlashMode;\n}\n\n/**\n * Response for getting supported flash modes.\n *\n * @since 1.0.0\n */\nexport interface GetSupportedFlashModesResponse {\n  /** An array of flash modes supported by the current camera */\n  flashModes: FlashMode[];\n}\n\n/**\n * Data for a detected barcode.\n *\n * @since 1.0.0\n */\nexport interface BarcodeDetectionData {\n  /** The decoded string value of the barcode */\n  value: string;\n\n  /** The display value of the barcode (may differ from the raw value) */\n  displayValue?: string;\n\n  /** The type/format of the barcode (e.g., 'qr', 'code128', etc.) */\n  type: string;\n\n  /** The bounding rectangle of the barcode in the camera frame. */\n  boundingRect: BoundingRect;\n}\n\n/**\n * Rectangle defining the boundary of the barcode in the camera frame.\n * Coordinates are normalized between 0 and 1 relative to the camera frame.\n *\n * @since 1.0.0\n */\nexport interface BoundingRect {\n  /** X-coordinate of the top-left corner */\n  x: number;\n  /** Y-coordinate of the top-left corner */\n  y: number;\n  /** Width of the bounding rectangle (should match the actual width of the barcode) */\n  width: number;\n  /** Height of the bounding rectangle (should match the actual height of the barcode) */\n  height: number;\n}\n\n/**\n * Response for the camera permission status.\n *\n * @since 1.0.0\n */\nexport interface PermissionStatus {\n  /** The state of the camera permission */\n  camera: PermissionState;\n}\n"]}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["import type { PermissionState, PluginListenerHandle } from '@capacitor/core';\n\n/**\n * Main plugin interface for Capacitor Camera View functionality.\n *\n * @since 1.0.0\n */\nexport interface CameraViewPlugin {\n  /**\n   * Start the camera view with optional configuration.\n   *\n   * @param options - Configuration options for the camera session\n   * @returns A promise that resolves when the camera has started\n   *\n   * @since 1.0.0\n   */\n  start(options?: CameraSessionConfiguration): Promise<void>;\n\n  /**\n   * Stop the camera view and release resources.\n   *\n   * @returns A promise that resolves when the camera has stopped\n   *\n   * @since 1.0.0\n   */\n  stop(): Promise<void>;\n\n  /**\n   * Check if the camera view is currently running.\n   *\n   * @returns A promise that resolves with an object containing the running state of the camera\n   *\n   * @since 1.0.0\n   */\n  isRunning(): Promise<IsRunningResponse>;\n\n  /**\n   * Capture a photo using the current camera configuration.\n   *\n   * @param options - Capture configuration options\n   * @returns A promise that resolves with an object containing either a base64 encoded string or file path of the captured photo\n   *\n   * @since 1.0.0\n   */\n  capture<T extends CaptureOptions>(options: T): Promise<CaptureResponse<T>>;\n\n  /**\n   * Captures a frame from the current camera preview without using the full camera capture pipeline.\n   *\n   * Unlike `capture()` which may trigger hardware-level photo capture on native platforms,\n   * this method quickly samples the current video stream. This is suitable computer vision or\n   * simple snapshots where high fidelity is not required.\n   *\n   * On web this method does exactly the same as `capture()` as it only captures a frame from the video stream\n   * because unfortunately [ImageCapture API](https://developer.mozilla.org/en-US/docs/Web/API/ImageCapture) is\n   * not yet well supported on the web.\n   *\n   * @param options - Capture configuration options\n   * @returns A promise that resolves with an object containing either a base64 encoded string or file path of the captured sample\n   *\n   * @since 1.0.0\n   */\n  captureSample<T extends CaptureOptions>(options: T): Promise<CaptureResponse<T>>;\n\n  /**\n   * Switch between front and back camera.\n   *\n   * @returns A promise that resolves when the camera has been flipped\n   *\n   * @since 1.0.0\n   */\n  flipCamera(): Promise<void>;\n\n  /**\n   * Get available camera devices for capturing photos.\n   *\n   * @returns A promise that resolves with an object containing an array of available capture devices\n   *\n   * @since 1.0.0\n   */\n  getAvailableDevices(): Promise<GetAvailableDevicesResponse>;\n\n  /**\n   * Get current zoom level information and available range.\n   *\n   * @remarks\n   * Make sure the camera is properly initialized before calling this method. Otherwise, this might\n   * lead to returning default values on android.\n   *\n   * @returns A promise that resolves with an object containing min, max and current zoom levels\n   *\n   * @since 1.0.0\n   */\n  getZoom(): Promise<GetZoomResponse>;\n\n  /**\n   * Set the camera zoom level.\n   *\n   * @param options - Zoom configuration options\n   * @param options.level - The zoom level to set\n   * @param options.ramp - Whether to animate the zoom level change, defaults to false (iOS only)\n   * @returns A promise that resolves when the zoom level has been set\n   *\n   * @remarks\n   * On web platforms, zoom functionality may be limited by browser support.\n   * When native zoom is not available, a CSS-based zoom simulation is applied.\n   *\n   * @since 1.0.0\n   */\n  setZoom(options: { level: number; ramp?: boolean }): Promise<void>;\n\n  /**\n   * Get current flash mode setting.\n   *\n   * @returns A promise that resolves with an object containing the current flash mode\n   *\n   * @since 1.0.0\n   */\n  getFlashMode(): Promise<GetFlashModeResponse>;\n\n  /**\n   * Get supported flash modes for the current camera.\n   *\n   * @returns A promise that resolves with an object containing an array of supported flash modes\n   *\n   * @since 1.0.0\n   */\n  getSupportedFlashModes(): Promise<GetSupportedFlashModesResponse>;\n\n  /**\n   * Set the camera flash mode.\n   *\n   * @param options - Flash mode configuration options\n   * @param options.mode - The flash mode to set\n   * @returns A promise that resolves when the flash mode has been set\n   *\n   * @since 1.0.0\n   */\n  setFlashMode(options: { mode: FlashMode }): Promise<void>;\n\n  /**\n   * Check if the device supports torch (flashlight) functionality.\n   *\n   * @remarks\n   * **Important**: You must call this method and verify torch availability before using\n   * `setTorchMode()` or `getTorchMode()`. Calling torch methods on devices without\n   * torch support will throw an exception.\n   *\n   * @returns A promise that resolves with an object containing torch availability status\n   *\n   * @since 1.2.0\n   */\n  isTorchAvailable(): Promise<IsTorchAvailableResponse>;\n\n  /**\n   * Get the current torch (flashlight) state.\n   *\n   * @remarks\n   * **Important**: Call `isTorchAvailable()` first to ensure the device supports torch\n   * functionality. This method will throw an exception if torch is not supported.\n   *\n   * @returns A promise that resolves with an object containing the current torch state\n   *\n   * @since 1.2.0\n   */\n  getTorchMode(): Promise<GetTorchModeResponse>;\n\n  /**\n   * Set the torch (flashlight) mode and intensity.\n   *\n   * @remarks\n   * **Important**: Call `isTorchAvailable()` first to ensure the device supports torch\n   * functionality. This method will throw an exception if torch is not supported.\n   *\n   * The torch provides continuous illumination, unlike flash which only activates during photo capture.\n   * On iOS, you can control the torch intensity level. On Android, the torch is either on or off.\n   *\n   * @param options - Torch configuration options\n   * @param options.enabled - Whether to enable or disable the torch\n   * @param options.level - The torch intensity level (0.0 to 1.0, iOS only). Defaults to 1.0 when enabled\n   * @returns A promise that resolves when the torch mode has been set\n   *\n   * @since 1.2.0\n   */\n  setTorchMode(options: { enabled: boolean; level?: number }): Promise<void>;\n\n  /**\n   * Check camera permission status without requesting permissions.\n   *\n   * @returns A promise that resolves with an object containing the camera permission status\n   *\n   * @since 1.0.0\n   */\n  checkPermissions(): Promise<PermissionStatus>;\n\n  /**\n   * Request camera permission from the user.\n   *\n   * @returns A promise that resolves with an object containing the camera permission status\n   *\n   * @since 1.0.0\n   */\n  requestPermissions(): Promise<PermissionStatus>;\n\n  /**\n   * Listen for barcode detection events.\n   * This event is emitted when a barcode is detected in the camera preview.\n   *\n   * @param eventName - The name of the event to listen for ('barcodeDetected')\n   * @param listenerFunc - The callback function to execute when a barcode is detected\n   * @returns A promise that resolves with an event subscription\n   *\n   * @since 1.0.0\n   */\n  addListener(\n    eventName: 'barcodeDetected',\n    listenerFunc: (data: BarcodeDetectionData) => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * Remove all listeners for this plugin.\n   *\n   * @param eventName - Optional event name to remove listeners for\n   * @returns A promise that resolves when the listeners are removed\n   *\n   * @since 1.0.0\n   */\n  removeAllListeners(eventName?: string): Promise<void>;\n}\n\n// ------------------------------------------------------------------------------\n// Camera Configuration Types\n// ------------------------------------------------------------------------------\n\n/**\n * Position options for the camera.\n * - 'front': Front-facing camera\n * - 'back': Rear-facing camera\n *\n * @since 1.0.0\n */\nexport type CameraPosition = 'front' | 'back';\n\n/**\n * Flash mode options for the camera.\n * - 'off': Flash disabled\n * - 'on': Flash always on\n * - 'auto': Flash automatically enabled in low-light conditions\n *\n * @since 1.0.0\n */\nexport type FlashMode = 'off' | 'on' | 'auto';\n\n/**\n * Represents a physical camera device on the device.\n *\n * @since 1.0.0\n */\nexport interface CameraDevice {\n  /** The unique identifier of the camera device */\n  id: string;\n\n  /** The human-readable name of the camera device */\n  name: string;\n\n  /** The position of the camera device (front or back) */\n  position: CameraPosition;\n\n  /** The type of the camera device (e.g., wide, ultra-wide, telephoto) - iOS only */\n  deviceType?: CameraDeviceType;\n}\n\n/**\n * Available camera device types for iOS.\n * Maps to AVCaptureDevice DeviceTypes in iOS.\n *\n * @see https://developer.apple.com/documentation/avfoundation/avcapturedevice/devicetype-swift.struct\n *\n * @since 1.0.0\n */\nexport type CameraDeviceType =\n  /** builtInWideAngleCamera - standard camera */\n  | 'wideAngle'\n  /** builtInUltraWideCamera - 0.5x zoom level */\n  | 'ultraWide'\n  /** builtInTelephotoCamera - 2x/3x zoom level */\n  | 'telephoto'\n  /** builtInDualCamera - wide + telephoto combination */\n  | 'dual'\n  /** builtInDualWideCamera - wide + ultraWide combination */\n  | 'dualWide'\n  /** builtInTripleCamera - wide + ultraWide + telephoto */\n  | 'triple'\n  /** builtInTrueDepthCamera - front-facing camera with depth sensing */\n  | 'trueDepth';\n\n/**\n * Configuration options for starting a camera session.\n *\n * @since 1.0.0\n */\nexport interface CameraSessionConfiguration {\n  /**\n   * Enables the barcode detection functionality\n   * @default false\n   */\n  enableBarcodeDetection?: boolean;\n\n  /**\n   * Position of the camera to use\n   * @default 'back'\n   */\n  position?: CameraPosition;\n\n  /**\n   * Specific device ID of the camera to use\n   * If provided, takes precedence over position\n   */\n  deviceId?: string;\n\n  /**\n   * Whether to use the triple camera if available (iPhone Pro models only)\n   * @default false\n   */\n  useTripleCameraIfAvailable?: boolean;\n\n  /**\n   * Ordered list of preferred camera device types to use (iOS only).\n   * The system will attempt to use the first available camera type in the list.\n   * If position is also provided, the system will use the first available camera type\n   * that matches the position and is in the list.\n   *\n   * This will fallback to the default camera type if none of the preferred types are available.\n   *\n   * @example [CameraDeviceType.WideAngle, CameraDeviceType.UltraWide, CameraDeviceType.Telephoto]\n   * @default undefined - system will decide based on position/deviceId\n   */\n  preferredCameraDeviceTypes?: CameraDeviceType[];\n\n  /**\n   * The initial zoom factor to use\n   * @default 1.0\n   */\n  zoomFactor?: number;\n\n  /**\n   * Optional HTML ID of the container element where the camera view should be rendered.\n   * If not provided, the camera view will be appended to the document body. Web only.\n   * @example 'cameraContainer'\n   */\n  containerElementId?: string;\n}\n\n/**\n * Configuration options for capturing photos and samples.\n *\n * @since 1.1.0\n */\nexport interface CaptureOptions {\n  /**\n   * The JPEG quality of the captured photo/sample on a scale of 0-100\n   * @since 1.1.0\n   */\n  quality: number;\n\n  /**\n   * If true, saves to a temporary file and returns the web path instead of base64.\n   * The web path can be used to set the src attribute of an image for efficient loading and rendering.\n   * This reduces the data that needs to be transferred over the bridge, which can improve performance\n   * especially for high-resolution images.\n   * @default false\n   * @since 1.1.0\n   */\n  saveToFile?: boolean;\n}\n\n// ------------------------------------------------------------------------------\n// Response Interfaces\n// ------------------------------------------------------------------------------\n\n/**\n * Response for checking if the camera view is running.\n *\n * @since 1.0.0\n */\nexport interface IsRunningResponse {\n  /** Indicates if the camera view is currently active and running */\n  isRunning: boolean;\n}\n\n/**\n * Response for capturing a photo\n * This will contain either a base64 encoded string or a web path to the captured photo,\n * depending on the `saveToFile` option in the CaptureOptions.\n * @since 1.0.0\n */\nexport type CaptureResponse<T extends CaptureOptions = CaptureOptions> = T['saveToFile'] extends true\n  ? {\n      /** The web path to the captured photo that can be used to set the src attribute of an image for efficient loading and rendering (when saveToFile is true) */\n      webPath: string;\n    }\n  : {\n      /** The base64 encoded string of the captured photo (when saveToFile is false or undefined) */\n      photo: string;\n    };\n\n/**\n * Response for getting available camera devices.\n *\n * @since 1.0.0\n */\nexport interface GetAvailableDevicesResponse {\n  /** An array of available camera devices */\n  devices: CameraDevice[];\n}\n\n/**\n * Response for getting zoom level information.\n *\n * @since 1.0.0\n */\nexport interface GetZoomResponse {\n  /** The minimum zoom level supported */\n  min: number;\n\n  /** The maximum zoom level supported */\n  max: number;\n\n  /** The current zoom level */\n  current: number;\n}\n\n/**\n * Response for getting the current flash mode.\n *\n * @since 1.0.0\n */\nexport interface GetFlashModeResponse {\n  /** The current flash mode setting */\n  flashMode: FlashMode;\n}\n\n/**\n * Response for getting supported flash modes.\n *\n * @since 1.0.0\n */\nexport interface GetSupportedFlashModesResponse {\n  /** An array of flash modes supported by the current camera */\n  flashModes: FlashMode[];\n}\n\n/**\n * Response for checking torch availability.\n *\n * @since 1.2.0\n */\nexport interface IsTorchAvailableResponse {\n  /** Indicates if the device supports torch (flashlight) functionality */\n  available: boolean;\n}\n\n/**\n * Response for getting the current torch mode.\n *\n * @since 1.2.0\n */\nexport interface GetTorchModeResponse {\n  /** Indicates if the torch is currently enabled */\n  enabled: boolean;\n  /** The current torch intensity level (0.0 to 1.0, iOS only). Always 1.0 on Android when enabled */\n  level: number;\n}\n\n/**\n * Data for a detected barcode.\n *\n * @since 1.0.0\n */\nexport interface BarcodeDetectionData {\n  /** The decoded string value of the barcode */\n  value: string;\n\n  /** The display value of the barcode (may differ from the raw value) */\n  displayValue?: string;\n\n  /** The type/format of the barcode (e.g., 'qr', 'code128', etc.) */\n  type: string;\n\n  /** The bounding rectangle of the barcode in the camera frame. */\n  boundingRect: BoundingRect;\n}\n\n/**\n * Rectangle defining the boundary of the barcode in the camera frame.\n * Coordinates are normalized between 0 and 1 relative to the camera frame.\n *\n * @since 1.0.0\n */\nexport interface BoundingRect {\n  /** X-coordinate of the top-left corner */\n  x: number;\n  /** Y-coordinate of the top-left corner */\n  y: number;\n  /** Width of the bounding rectangle (should match the actual width of the barcode) */\n  width: number;\n  /** Height of the bounding rectangle (should match the actual height of the barcode) */\n  height: number;\n}\n\n/**\n * Response for the camera permission status.\n *\n * @since 1.0.0\n */\nexport interface PermissionStatus {\n  /** The state of the camera permission */\n  camera: PermissionState;\n}\n"]}

package/dist/esm/web.d.ts

@@ -1,5 +1,5 @@
 import { WebPlugin } from '@capacitor/core';
-import type { CameraSessionConfiguration, CameraViewPlugin, GetAvailableDevicesResponse, GetFlashModeResponse, GetSupportedFlashModesResponse, GetZoomResponse, IsRunningResponse, PermissionStatus, CaptureResponse, FlashMode, CaptureOptions } from './definitions';
+import type { CameraSessionConfiguration, CameraViewPlugin, GetAvailableDevicesResponse, GetFlashModeResponse, GetSupportedFlashModesResponse, GetTorchModeResponse, GetZoomResponse, IsTorchAvailableResponse, IsRunningResponse, PermissionStatus, CaptureResponse, FlashMode, CaptureOptions } from './definitions';
 /**
  * Web implementation of the CameraViewPlugin.
  * Optimized for performance and battery efficiency.
@@ -69,6 +69,18 @@ export declare class CameraViewWeb extends WebPlugin implements CameraViewPlugin
     setFlashMode(options: {
         mode: FlashMode;
     }): Promise<void>;
+    /**
+     * Check if torch is available (not supported in web)
+     */
+    isTorchAvailable(): Promise<IsTorchAvailableResponse>;
+    /**
+     * Get torch mode (not supported in web)
+     */
+    getTorchMode(): Promise<GetTorchModeResponse>;
+    /**
+     * Set torch mode (not supported in web)
+     */
+    setTorchMode(): Promise<void>;
     /**
      * Check camera permission without requesting
      */