capacitor-camera-view 2.4.0 → 3.0.0

package/dist/docs.json

@@ -2,7 +2,7 @@
   "api": {
     "name": "CameraViewPlugin",
     "slug": "cameraviewplugin",
-    "docs": "Main plugin interface for Capacitor Camera View functionality.",
+    "docs": "Main plugin interface for Capacitor Camera View functionality.\n\nWhen a method below rejects, the resulting error carries a `code` property\nset to one of the stable `CameraErrorCode` strings so consumers can\n`switch` on `error.code` instead of matching on the human-readable message.\nSee the `CameraErrorCode` type for the full vocabulary, including the one\ndivergence on web for methods with no web implementation.",
     "tags": [
       {
         "text": "1.0.0",
@@ -35,7 +35,7 @@
             "text": "1.0.0"
           }
         ],
-        "docs": "Start the camera view with optional configuration.",
+        "docs": "Start the camera view with optional configuration.\n\nRejects if a camera session is already running. Call `stop()` first if you need to\nstart a new session with different options.",
         "complexTypes": [
           "CameraSessionConfiguration"
         ],
@@ -83,12 +83,12 @@
       },
       {
         "name": "capture",
-        "signature": "<T extends CaptureOptions>(options: T) => Promise<CaptureResponse<T>>",
+        "signature": "<T extends CaptureOptions = CaptureOptions & { saveToFile?: undefined; }>(options?: T | undefined) => Promise<CaptureResponse<T>>",
         "parameters": [
           {
             "name": "options",
             "docs": "- Capture configuration options",
-            "type": "T"
+            "type": "T | undefined"
           }
         ],
         "returns": "Promise<CaptureResponse<T>>",
@@ -116,12 +116,12 @@
       },
       {
         "name": "captureSample",
-        "signature": "<T extends CaptureOptions>(options: T) => Promise<CaptureResponse<T>>",
+        "signature": "<T extends CaptureOptions = CaptureOptions & { saveToFile?: undefined; }>(options?: T | undefined) => Promise<CaptureResponse<T>>",
         "parameters": [
           {
             "name": "options",
             "docs": "- Capture configuration options",
-            "type": "T"
+            "type": "T | undefined"
           }
         ],
         "returns": "Promise<CaptureResponse<T>>",
@@ -214,7 +214,7 @@
             "text": "1.0.0"
           }
         ],
-        "docs": "Switch between front and back camera.",
+        "docs": "Switch between front and back camera.\n\nRejects with `RECORDING_ALREADY_IN_PROGRESS` while a video recording is active, on\niOS, Android, and web alike: swapping the camera input/device mid-recording would\neither drop the audio track or interrupt the recording outright, so the recording is\nleft intact and must be stopped before flipping.",
         "complexTypes": [],
         "slug": "flipcamera"
       },
@@ -258,7 +258,7 @@
             "text": "1.0.0"
           }
         ],
-        "docs": "Get current zoom level information and available range.",
+        "docs": "Get current zoom level information and available range.\n\nOn iOS, when the camera is a virtual device (e.g. the triple camera enabled via\n`useTripleCameraIfAvailable`), the returned values are in the device's raw zoom domain and are\nnot UI multipliers like \"0.5x\"/\"1x\"/\"2x\". A `min` of `1.0` corresponds to the widest constituent\nlens (the ultra-wide \"0.5x\" lens), so a session started at the default zoom reports a `current`\nof the wide-lens switch-over factor (typically `2.0`) rather than `1.0`. Treat these numbers as\ndevice-relative and derive the usable range from `min`/`max` instead of assuming `1.0` is the\ndefault.",
         "complexTypes": [
           "GetZoomResponse"
         ],
@@ -301,10 +301,51 @@
             "text": "1.0.0"
           }
         ],
-        "docs": "Set the camera zoom level.",
+        "docs": "Set the camera zoom level.\n\nOn iOS virtual devices (e.g. the triple camera) `level` is a raw device zoom factor, not a UI\nmultiplier. Derive valid values from the `min`/`max` returned by `getZoom()` rather than assuming\n`1.0` maps to the wide \"1x\" lens.",
         "complexTypes": [],
         "slug": "setzoom"
       },
+      {
+        "name": "setFocusPoint",
+        "signature": "(options: { x: number; y: number; }) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "- The point to focus on",
+            "type": "{ x: number; y: number; }"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options - The point to focus on"
+          },
+          {
+            "name": "param",
+            "text": "options.x - The horizontal coordinate in CSS/viewport pixels, measured\nfrom the left edge of the viewport. This is the same coordinate space the\nplugin emits for barcode `boundingRect`, just in the opposite direction."
+          },
+          {
+            "name": "param",
+            "text": "options.y - The vertical coordinate in CSS/viewport pixels, measured\nfrom the top edge of the viewport."
+          },
+          {
+            "name": "returns",
+            "text": "A promise that resolves when the focus/metering point has been applied"
+          },
+          {
+            "name": "remarks",
+            "text": "On fixed-focus cameras (e.g. some front cameras) the plugin degrades to\nexposure-only metering where possible. If neither focus nor exposure metering\nat a point is supported, the promise rejects with the `FOCUS_NOT_SUPPORTED`\nerror code. Rejects with `SESSION_NOT_RUNNING` when the camera is not running.\n\nNot supported on web: this method rejects with an `unimplemented` error there,\nbecause the `pointsOfInterest` media-track constraint has effectively no\nbrowser support."
+          },
+          {
+            "name": "since",
+            "text": "3.0.0"
+          }
+        ],
+        "docs": "Focus and meter the camera at a specific point (tap-to-focus).\n\nBecause the WebView sits above the native camera preview and consumes every\ntouch, the native preview can never receive tap gestures itself. Instead,\nthe app catches the tap in the DOM and forwards its coordinates here; since\nthe native preview is always rendered fullscreen behind the WebView, the\nmapping to the sensor is deterministic.\n\nThe camera runs a one-shot focus/exposure at the given point and then\nautomatically restores continuous auto-focus/auto-exposure (immediately on a\nsubsequent tap, or after a short timeout), so focus is never left\npermanently locked.",
+        "complexTypes": [],
+        "slug": "setfocuspoint"
+      },
       {
         "name": "getFlashMode",
         "signature": "() => Promise<GetFlashModeResponse>",
@@ -446,7 +487,7 @@
         "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."
+            "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.\nYou can control the torch intensity level on both iOS and, on API 33+ devices with\nmulti-level torch hardware, Android. On older Android versions or single-level torch\nhardware, `level` is best-effort and ignored - the torch is simply switched on or off."
           },
           {
             "name": "param",
@@ -458,7 +499,7 @@
           },
           {
             "name": "param",
-            "text": "options.level - The torch intensity level (0.0 to 1.0, iOS only). Defaults to 1.0 when enabled"
+            "text": "options.level - The torch intensity level (0.0 to 1.0). Defaults to 1.0 when enabled"
           },
           {
             "name": "returns",
@@ -543,6 +584,10 @@
         ],
         "returns": "Promise<PluginListenerHandle>",
         "tags": [
+          {
+            "name": "remarks",
+            "text": "Events are rate-controlled to avoid flooding the bridge. Repeated detections\nof the same barcode (identical `value` and `type`) are suppressed while the\ncode stays in view: after an initial event, the same code re-emits at most\nonce per ~500 ms suppression window. Pointing the camera at a different\nbarcode (a different `value` or `type`) emits immediately rather than waiting\nfor the window to elapse. This behavior is consistent across iOS, Android,\nand web."
+          },
           {
             "name": "param",
             "text": "eventName - The name of the event to listen for ('barcodeDetected')"
@@ -568,20 +613,148 @@
         "slug": "addlistenerbarcodedetected-"
       },
       {
-        "name": "removeAllListeners",
-        "signature": "(eventName?: string | undefined) => Promise<void>",
+        "name": "addListener",
+        "signature": "(eventName: 'cameraInterrupted', listenerFunc: (data: CameraInterruptedData) => void) => Promise<PluginListenerHandle>",
         "parameters": [
           {
             "name": "eventName",
-            "docs": "- Optional event name to remove listeners for",
-            "type": "string | undefined"
+            "docs": "- The name of the event to listen for ('cameraInterrupted')",
+            "type": "'cameraInterrupted'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "- The callback function to execute when the camera is interrupted",
+            "type": "(data: CameraInterruptedData) => void"
           }
         ],
-        "returns": "Promise<void>",
+        "returns": "Promise<PluginListenerHandle>",
         "tags": [
+          {
+            "name": "remarks",
+            "text": "Currently emitted on iOS only. Android and web will follow."
+          },
           {
             "name": "param",
-            "text": "eventName - Optional event name to remove listeners for"
+            "text": "eventName - The name of the event to listen for ('cameraInterrupted')"
+          },
+          {
+            "name": "param",
+            "text": "listenerFunc - The callback function to execute when the camera is interrupted"
+          },
+          {
+            "name": "returns",
+            "text": "A promise that resolves with an event subscription"
+          },
+          {
+            "name": "since",
+            "text": "3.0.0"
+          }
+        ],
+        "docs": "Listen for camera interruption events.\n\nEmitted when the capture session is interrupted by the system, for example\nan incoming phone call, another app claiming the camera or microphone,\nlosing the camera in iPad Split View, or system pressure. The preview\ntypically freezes for the duration of the interruption.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "CameraInterruptedData"
+        ],
+        "slug": "addlistenercamerainterrupted-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'cameraResumed', listenerFunc: () => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "- The name of the event to listen for ('cameraResumed')",
+            "type": "'cameraResumed'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "- The callback function to execute when the camera resumes",
+            "type": "() => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "remarks",
+            "text": "Currently emitted on iOS only. Android and web will follow."
+          },
+          {
+            "name": "param",
+            "text": "eventName - The name of the event to listen for ('cameraResumed')"
+          },
+          {
+            "name": "param",
+            "text": "listenerFunc - The callback function to execute when the camera resumes"
+          },
+          {
+            "name": "returns",
+            "text": "A promise that resolves with an event subscription"
+          },
+          {
+            "name": "since",
+            "text": "3.0.0"
+          }
+        ],
+        "docs": "Listen for camera resume events.\n\nEmitted when a previous interruption ends and the capture session resumes,\nfor example after an incoming phone call finishes. Pair this with\n`cameraInterrupted` to update your UI when the preview recovers.",
+        "complexTypes": [
+          "PluginListenerHandle"
+        ],
+        "slug": "addlistenercameraresumed-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'cameraRuntimeError', listenerFunc: (data: CameraRuntimeErrorData) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "- The name of the event to listen for ('cameraRuntimeError')",
+            "type": "'cameraRuntimeError'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "- The callback function to execute when a runtime error occurs",
+            "type": "(data: CameraRuntimeErrorData) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "remarks",
+            "text": "Currently emitted on iOS only. Android and web will follow."
+          },
+          {
+            "name": "param",
+            "text": "eventName - The name of the event to listen for ('cameraRuntimeError')"
+          },
+          {
+            "name": "param",
+            "text": "listenerFunc - The callback function to execute when a runtime error occurs"
+          },
+          {
+            "name": "returns",
+            "text": "A promise that resolves with an event subscription"
+          },
+          {
+            "name": "since",
+            "text": "3.0.0"
+          }
+        ],
+        "docs": "Listen for camera runtime error events.\n\nEmitted when the capture session hits a runtime error. When the underlying\nmedia services are reset, the plugin restarts the session automatically, so\nthis event is primarily informational for logging and diagnostics.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "CameraRuntimeErrorData"
+        ],
+        "slug": "addlistenercameraruntimeerror-"
+      },
+      {
+        "name": "removeAllListeners",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "remarks",
+            "text": "This removes *every* listener registered on this plugin instance, regardless of event\nname, on iOS, Android, and web. There is no way to remove listeners for a single event\nname only; if you need that, keep track of the `PluginListenerHandle` returned by\n`addListener()` and call `remove()` on it instead."
           },
           {
             "name": "returns",
@@ -675,7 +848,7 @@
               "name": "default"
             }
           ],
-          "docs": "Whether to use the triple camera if available (iPhone Pro models only)",
+          "docs": "Whether to use the triple camera if available (iPhone Pro models only).\n\nThe session starts directly on the virtual device, which lets iOS switch\nbetween the ultra-wide, wide and telephoto lenses automatically. Takes\nprecedence over `preferredCameraDeviceTypes` for the rear camera.",
           "complexTypes": [],
           "type": "boolean | undefined"
         },
@@ -697,6 +870,62 @@
           ],
           "type": "CameraDeviceType[] | undefined"
         },
+        {
+          "name": "aspectRatio",
+          "tags": [
+            {
+              "text": "undefined - platform default (see above)",
+              "name": "default"
+            },
+            {
+              "text": "3.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The sensor aspect ratio to use for the camera session, applied to both\nthe live preview stream and photo capture so the captured image matches\nthe framing the user sees.\n\n**Preview-vs-capture framing contract** (identical on iOS, Android and\nweb when this option is set):\n\n- By default (`previewScaleMode: 'cover'`) the preview fills its container\n  (the fullscreen view behind the WebView on iOS/Android, the container\n  element on web) using cover semantics: when the chosen sensor ratio\n  differs from the container ratio, the preview is center-cropped to fill\n  it — never letterboxed. `capture()` returns the full sensor-ratio image\n  (matching this option), NOT the on-screen crop. Parts of the image that\n  were cropped out of the preview by cover-scaling are therefore included\n  in the capture.\n- With `previewScaleMode: 'fit'` the whole sensor frame is letterboxed to\n  fit inside the container, so the preview shows exactly the full captured\n  frame: `capture()` returns what the preview shows, with nothing cropped\n  out of view. See {@link previewScaleMode} for the letterbox-background\n  note.\n\nWhen this option is omitted, each platform keeps its long-standing\ndefault behavior: iOS uses the sensor's native photo format (4:3),\nAndroid prefers 16:9 with an automatic fallback, and web requests a\n16:9 stream and returns the visible (cover-cropped) preview region from\n`capture()` instead of the full frame. Captured output stays JPEG on all\nplatforms either way.",
+          "complexTypes": [
+            "CameraAspectRatio"
+          ],
+          "type": "CameraAspectRatio"
+        },
+        {
+          "name": "captureMaxDimension",
+          "tags": [
+            {
+              "text": "1280 // capture photos at most 1280px wide (longer edge)",
+              "name": "example"
+            },
+            {
+              "text": "undefined - platform default resolution",
+              "name": "default"
+            },
+            {
+              "text": "3.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Optional capture-resolution hint: an upper bound, in pixels, for the\nlonger edge of captured photos. The platform picks the largest supported\ncapture resolution whose longer edge does not exceed this value (falling\nback to the closest supported resolution when none fits) while keeping\nthe configured `aspectRatio`.\n\nThis is a best-effort hint: the exact output dimensions depend on the\nresolutions the sensor/browser actually supports.\n\n- iOS: constrains `AVCapturePhotoOutput.maxPhotoDimensions`. Only affects\n  `capture()`; `captureSample()` keeps sampling the preview stream.\n- Android: bounds the CameraX ImageCapture resolution. Only affects\n  `capture()`.\n- Web: used as the ideal `getUserMedia` width constraint, so it affects\n  the stream (preview and capture alike).",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "previewScaleMode",
+          "tags": [
+            {
+              "text": "'cover'",
+              "name": "default"
+            },
+            {
+              "text": "3.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "How the live preview is scaled into its container when the sensor aspect\nratio differs from the container's aspect ratio.\n\n- `'cover'` (default): the preview fills the container, center-cropping the\n  frame. This is the long-standing behavior and is unchanged when the\n  option is omitted.\n- `'fit'`: the whole sensor frame is scaled to fit inside the container\n  (letterboxed), so the user sees the entire frame they are about to\n  capture. In `fit` mode the preview shows exactly the full captured frame,\n  and `capture()` returns what the preview shows.\n\nApplied consistently on iOS (`AVCaptureVideoPreviewLayer.videoGravity`),\nAndroid (`PreviewView.ScaleType`) and web (`object-fit`). Barcode\n`boundingRect` and `setFocusPoint` coordinates stay correct in both modes.\n\n**Letterbox background**: the empty bars shown in `fit` mode are not painted\nby the plugin — they show whatever is visually behind/around the preview.\nOn iOS/Android that is the app's own background showing through the\ntransparent WebView; on web it is the container element's background. Style\nthat background (e.g. a black or themed color) to control how the\nletterbox bars look.",
+          "complexTypes": [
+            "PreviewScaleMode"
+          ],
+          "type": "PreviewScaleMode"
+        },
         {
           "name": "zoomFactor",
           "tags": [
@@ -705,10 +934,26 @@
               "name": "default"
             }
           ],
-          "docs": "The initial zoom factor to use",
+          "docs": "The initial zoom factor to use.\n\nExpressed relative to the wide-angle lens, so `1.0` is the familiar \"1x\" field of view on every\ncamera. On iOS virtual devices whose raw `1.0` is the ultra-wide lens (e.g. the triple camera\nenabled via `useTripleCameraIfAvailable`) the factor is scaled into the device's own zoom domain,\nwhich is why `getZoom()` reports a larger `current` than the value passed here.",
           "complexTypes": [],
           "type": "number | undefined"
         },
+        {
+          "name": "prioritizeQuality",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            },
+            {
+              "text": "3.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Prioritize photo quality over capture responsiveness (iOS 17+ only).\n\nBy default the plugin opts into the iOS 17+ responsive-capture pipeline\n(zero-shutter-lag, responsive capture and fast capture prioritization) so\nconsecutive `capture()` calls have a lower shot-to-shot latency. Rapid\nconsecutive captures may then be delivered at a slightly reduced quality\ninstead of queueing.\n\nSet this to `true` to opt out of that behavior and always prioritize photo\nquality. Has no effect on iOS versions or hardware without support for the\nresponsive-capture APIs, and no effect on Android or Web.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
         {
           "name": "containerElementId",
           "tags": [
@@ -744,6 +989,60 @@
         }
       ]
     },
+    {
+      "name": "CaptureFileResult",
+      "slug": "capturefileresult",
+      "docs": "The file-path shaped result returned when `saveToFile` is `true`.",
+      "tags": [
+        {
+          "text": "1.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "webPath",
+          "tags": [],
+          "docs": "The web path to the captured photo that can be used to set the src attribute of an image\nfor efficient loading and rendering (when saveToFile is true).\n\nOn web, this is a blob URL created with `URL.createObjectURL()`. The plugin does not revoke\nit automatically; once you are done with it (e.g. after the image has been displayed or\nuploaded), call `URL.revokeObjectURL(webPath)` to release the underlying memory. On\niOS/Android this is a Capacitor bridge path served by the local web server and does not\nneed to be revoked.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "path",
+          "tags": [
+            {
+              "text": "2.4.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The full, platform-specific file URL (`file://...`) to the captured photo,\nusable with the Filesystem API or `Capacitor.convertFileSrc()`.\nNative only (iOS/Android); `undefined` on web.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "CaptureBase64Result",
+      "slug": "capturebase64result",
+      "docs": "The base64 shaped result returned when `saveToFile` is `false` or `undefined`.",
+      "tags": [
+        {
+          "text": "1.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "photo",
+          "tags": [],
+          "docs": "The base64 encoded string of the captured photo (when saveToFile is false or undefined)",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
     {
       "name": "CaptureOptions",
       "slug": "captureoptions",
@@ -759,14 +1058,18 @@
         {
           "name": "quality",
           "tags": [
+            {
+              "text": "90",
+              "name": "default"
+            },
             {
               "text": "1.1.0",
               "name": "since"
             }
           ],
-          "docs": "The JPEG quality of the captured photo/sample on a scale of 0-100",
+          "docs": "The JPEG quality of the captured photo/sample on a scale of 0-100. Cross-platform note:\nfor `quality >= 90`, iOS returns the original, unmodified JPEG produced by the camera\nhardware instead of re-encoding it, to avoid unnecessary quality loss and CPU overhead.\nAndroid and Web always encode at the exact requested quality. As a result, the same\n`quality` value (90-100) can produce different file sizes on iOS versus Android/Web.",
           "complexTypes": [],
-          "type": "number"
+          "type": "number | undefined"
         },
         {
           "name": "saveToFile",
@@ -854,7 +1157,7 @@
               "name": "since"
             }
           ],
-          "docs": "Web-accessible path to the recorded video file that can be used to set the\n`src` attribute of a video element for efficient loading and rendering.\nOn web, this is a blob URL.\nOn iOS/Android, this is a Capacitor bridge path served by the local web server.",
+          "docs": "Web-accessible path to the recorded video file that can be used to set the\n`src` attribute of a video element for efficient loading and rendering.\nOn web, this is a blob URL created with `URL.createObjectURL()`; the plugin does not\nrevoke it automatically, so call `URL.revokeObjectURL(webPath)` once you are done with\nit (e.g. after playback or upload) to release the underlying memory.\nOn iOS/Android, this is a Capacitor bridge path served by the local web server and does\nnot need to be revoked.",
           "complexTypes": [],
           "type": "string"
         },
@@ -946,6 +1249,10 @@
       "slug": "getzoomresponse",
       "docs": "Response for getting zoom level information.",
       "tags": [
+        {
+          "text": "On iOS virtual devices (e.g. the triple camera) these values are in the device's raw zoom domain,\nnot UI multipliers: `min` of `1.0` is the ultra-wide (\"0.5x\") lens and `current` reports the\nwide-lens switch-over factor rather than `1.0` at the default zoom. See {@link CameraViewPlugin.getZoom}.",
+          "name": "remarks"
+        },
         {
           "text": "1.0.0",
           "name": "since"
@@ -956,21 +1263,21 @@
         {
           "name": "min",
           "tags": [],
-          "docs": "The minimum zoom level supported",
+          "docs": "The minimum zoom level supported. On iOS virtual devices `1.0` maps to the ultra-wide lens.",
           "complexTypes": [],
           "type": "number"
         },
         {
           "name": "max",
           "tags": [],
-          "docs": "The maximum zoom level supported",
+          "docs": "The maximum zoom level supported. On iOS virtual devices this is a raw device factor (capped at a 10x wide-equivalent zoom).",
           "complexTypes": [],
           "type": "number"
         },
         {
           "name": "current",
           "tags": [],
-          "docs": "The current zoom level",
+          "docs": "The current zoom level. On iOS virtual devices this is a raw device factor, not a UI multiplier.",
           "complexTypes": [],
           "type": "number"
         }
@@ -1065,7 +1372,7 @@
         {
           "name": "level",
           "tags": [],
-          "docs": "The current torch intensity level (0.0 to 1.0, iOS only). Always 1.0 on Android when enabled",
+          "docs": "The current torch intensity level (0.0 to 1.0).\n\nOn Android this reflects the real hardware strength only on API 33+ devices with\nmulti-level torch hardware; below API 33, or on single-level hardware, the torch is\nbinary, so this is always 1.0 when enabled and 0.0 when off.",
           "complexTypes": [],
           "type": "number"
         }
@@ -1160,8 +1467,10 @@
         {
           "name": "type",
           "tags": [],
-          "docs": "The type/format of the barcode (e.g., 'qr', 'code128', etc.)",
-          "complexTypes": [],
+          "docs": "The type/format of the detected barcode.\n\nFor formats that are part of the `BarcodeType` union, all platforms emit\nidentical values, so scanning the same barcode yields the same `type` on\nweb, iOS, and Android (e.g. `'qr'`, `'code128'`, `'dataMatrix'`).\n\nThe type is `BarcodeType | string` rather than `BarcodeType` because a\nplatform detector can occasionally report a format that has no\ncross-platform union member; in that case the raw platform string is\nforwarded unchanged instead of being dropped. In practice this is Android's\n`'unknown'` (ML Kit's `FORMAT_UNKNOWN`) and the equivalent `'unknown'` from\nthe web BarcodeDetector. Narrow against the `BarcodeType` members you care\nabout and treat anything else as an opaque string.\n\nPlatform-specific notes:\n- iOS distinguishes `interleaved2of5` from `itf14`, whereas Android and web\n  cannot tell them apart and always report `itf14` for their shared\n  interleaved-2-of-5/ITF detector format.\n- UPC-A is reported as `'upcA'` on Android and web, but as `'ean13'` on iOS:\n  AVFoundation has no UPC-A metadata type and surfaces UPC-A codes as EAN-13\n  (a UPC-A value is an EAN-13 with a leading `0`). This is a hardware/OS\n  limitation, not a normalization choice.\n- Codabar is reported as `'codabar'` on all three platforms.",
+          "complexTypes": [
+            "BarcodeType"
+          ],
           "type": "string"
         },
         {
@@ -1178,7 +1487,7 @@
     {
       "name": "BoundingRect",
       "slug": "boundingrect",
-      "docs": "Rectangle defining the boundary of the barcode in the camera frame.\nCoordinates are normalized between 0 and 1 relative to the camera frame.",
+      "docs": "Rectangle defining the boundary of the barcode in the camera frame.\nCoordinates are given in display/CSS pixels within the webview (display)\ncoordinate space, not normalized values. This lets you position an overlay\ndirectly on top of the detected barcode without further scaling.",
       "tags": [
         {
           "text": "1.0.0",
@@ -1216,6 +1525,57 @@
           "type": "number"
         }
       ]
+    },
+    {
+      "name": "CameraInterruptedData",
+      "slug": "camerainterrupteddata",
+      "docs": "Data for a camera interruption event.",
+      "tags": [
+        {
+          "text": "3.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "reason",
+          "tags": [],
+          "docs": "The reason the camera session was interrupted.",
+          "complexTypes": [
+            "CameraInterruptionReason"
+          ],
+          "type": "CameraInterruptionReason"
+        }
+      ]
+    },
+    {
+      "name": "CameraRuntimeErrorData",
+      "slug": "cameraruntimeerrordata",
+      "docs": "Data for a camera runtime error event.",
+      "tags": [
+        {
+          "text": "3.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "message",
+          "tags": [],
+          "docs": "A human-readable description of the runtime error.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "code",
+          "tags": [],
+          "docs": "The underlying platform error code, when available.\nOn iOS this is the `AVError` code.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        }
+      ]
     }
   ],
   "enums": [],
@@ -1245,6 +1605,10 @@
           "text": "'code93'",
           "complexTypes": []
         },
+        {
+          "text": "'codabar'",
+          "complexTypes": []
+        },
         {
           "text": "'ean8'",
           "complexTypes": []
@@ -1273,6 +1637,10 @@
           "text": "'dataMatrix'",
           "complexTypes": []
         },
+        {
+          "text": "'upcA'",
+          "complexTypes": []
+        },
         {
           "text": "'upce'",
           "complexTypes": []
@@ -1329,13 +1697,59 @@
         }
       ]
     },
+    {
+      "name": "CameraAspectRatio",
+      "slug": "cameraaspectratio",
+      "docs": "Sensor aspect ratio for a camera session, applied consistently to both the\nlive preview stream and photo capture.\n- '4:3': The native photo aspect ratio of most mobile camera sensors\n- '16:9': The typical video aspect ratio",
+      "types": [
+        {
+          "text": "'4:3'",
+          "complexTypes": []
+        },
+        {
+          "text": "'16:9'",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "PreviewScaleMode",
+      "slug": "previewscalemode",
+      "docs": "How the camera preview is scaled to fill its container when the sensor\naspect ratio differs from the container's aspect ratio.\n- 'cover': The preview fills the whole container, center-cropping the frame\n  so no empty bars are shown. Parts of the frame outside the container are\n  hidden from the preview (long-standing default behavior).\n- 'fit': The whole sensor frame is scaled to fit inside the container\n  (letterboxed), so the user sees the entire frame they are about to\n  capture. Empty bars appear on the short axis.",
+      "types": [
+        {
+          "text": "'cover'",
+          "complexTypes": []
+        },
+        {
+          "text": "'fit'",
+          "complexTypes": []
+        }
+      ]
+    },
     {
       "name": "CaptureResponse",
       "slug": "captureresponse",
       "docs": "Response for capturing a photo\nThis will contain either a base64 encoded string or a web path to the captured photo,\ndepending on the `saveToFile` option in the CaptureOptions.",
       "types": [
         {
-          "text": "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 full, platform-specific file URL (`file://...`) to the captured photo,\n       * usable with the Filesystem API or `Capacitor.convertFileSrc()`.\n       * Native only (iOS/Android); `undefined` on web.\n       * @since 2.4.0\n       */\n      path?: string;\n    }\n  : {\n      /** The base64 encoded string of the captured photo (when saveToFile is false or undefined) */\n      photo: string;\n    }",
+          "text": "SaveToFileOf<T> extends true\n    ? CaptureFileResult\n    : SaveToFileOf<T> extends false | undefined\n      ? CaptureBase64Result\n      : CaptureFileResult | CaptureBase64Result",
+          "complexTypes": [
+            "SaveToFileOf",
+            "T",
+            "CaptureFileResult",
+            "CaptureBase64Result"
+          ]
+        }
+      ]
+    },
+    {
+      "name": "SaveToFileOf",
+      "slug": "savetofileof",
+      "docs": "`T['saveToFile']` resolves through the `CaptureOptions` constraint to `boolean | undefined`\nwhen `T` omits the key, which would widen the result to the union. Treat an absent key as\n`undefined` instead.",
+      "types": [
+        {
+          "text": "'saveToFile' extends keyof T ? T['saveToFile'] : undefined",
           "complexTypes": [
             "T"
           ]
@@ -1429,6 +1843,37 @@
           "complexTypes": []
         }
       ]
+    },
+    {
+      "name": "CameraInterruptionReason",
+      "slug": "camerainterruptionreason",
+      "docs": "Reason why the camera session was interrupted.\n\nMirrors `AVCaptureSession.InterruptionReason` on iOS. Unknown or future\nreasons fall back to `'unknown'`.",
+      "types": [
+        {
+          "text": "'videoDeviceNotAvailableInBackground'",
+          "complexTypes": []
+        },
+        {
+          "text": "'audioDeviceInUseByAnotherClient'",
+          "complexTypes": []
+        },
+        {
+          "text": "'videoDeviceInUseByAnotherClient'",
+          "complexTypes": []
+        },
+        {
+          "text": "'videoDeviceNotAvailableWithMultipleForegroundApps'",
+          "complexTypes": []
+        },
+        {
+          "text": "'videoDeviceNotAvailableDueToSystemPressure'",
+          "complexTypes": []
+        },
+        {
+          "text": "'unknown'",
+          "complexTypes": []
+        }
+      ]
     }
   ],
   "pluginConfigs": []