@capgo/camera-preview 7.4.0-alpha.13 → 7.4.0-alpha.17

package/README.md

@@ -262,6 +262,8 @@ Documentation for the [uploader](https://github.com/Cap-go/capacitor-uploader)
 * [`setPreviewSize(...)`](#setpreviewsize)
 * [`setFocus(...)`](#setfocus)
 * [`addListener('screenResize', ...)`](#addlistenerscreenresize-)
+* [`deleteFile(...)`](#deletefile)
+* [`getSafeAreaInsets()`](#getsafeareainsets)
 * [Interfaces](#interfaces)
 * [Type Aliases](#type-aliases)
 * [Enums](#enums)
@@ -734,6 +736,41 @@ addListener(eventName: "screenResize", listenerFunc: (data: { width: number; hei
 --------------------
 
 
+### deleteFile(...)
+
+```typescript
+deleteFile(options: { path: string; }) => Promise<{ success: boolean; }>
+```
+
+Deletes a file at the given absolute path on the device.
+Use this to quickly clean up temporary images created with `storeToFile`.
+On web, this is not supported and will throw.
+
+| Param         | Type                           |
+| ------------- | ------------------------------ |
+| **`options`** | <code>{ path: string; }</code> |
+
+**Returns:** <code>Promise&lt;{ success: boolean; }&gt;</code>
+
+**Since:** 8.2.0
+
+--------------------
+
+
+### getSafeAreaInsets()
+
+```typescript
+getSafeAreaInsets() => Promise<SafeAreaInsets>
+```
+
+Gets the safe area insets for Android devices.
+Returns the top and bottom insets in dp and the current orientation.
+
+**Returns:** <code>Promise&lt;<a href="#safeareainsets">SafeAreaInsets</a>&gt;</code>
+
+--------------------
+
+
 ### Interfaces
 
 
@@ -874,6 +911,18 @@ Represents the detailed information of the currently active lens.
 | **`remove`** | <code>() =&gt; Promise&lt;void&gt;</code> |
 
 
+#### SafeAreaInsets
+
+Represents safe area insets on Android.
+Values are expressed in logical pixels (dp) to match JS layout units.
+
+| Prop              | Type                | Description                                                      |
+| ----------------- | ------------------- | ---------------------------------------------------------------- |
+| **`orientation`** | <code>number</code> | Current device orientation as reported by Android configuration. |
+| **`top`**         | <code>number</code> | Top inset (e.g., status bar or cutout) in dp.                    |
+| **`bottom`**      | <code>number</code> | Bottom inset (e.g., navigation bar) in dp.                       |
+
+
 ### Type Aliases
 
 

package/android/src/main/java/com/ahm/capacitor/camera/preview/CameraPreview.java

@@ -5,13 +5,18 @@ import static android.Manifest.permission.RECORD_AUDIO;
 
 import android.Manifest;
 import android.content.pm.ActivityInfo;
+import android.content.res.Configuration;
 import android.location.Location;
 import android.util.DisplayMetrics;
 import android.util.Log;
 import android.util.Size;
+import android.view.OrientationEventListener;
 import android.view.View;
 import android.view.ViewGroup;
 import android.webkit.WebView;
+import androidx.core.graphics.Insets;
+import androidx.core.view.ViewCompat;
+import androidx.core.view.WindowInsetsCompat;
 import com.ahm.capacitor.camera.preview.model.CameraDevice;
 import com.ahm.capacitor.camera.preview.model.CameraSessionConfiguration;
 import com.ahm.capacitor.camera.preview.model.LensInfo;
@@ -69,6 +74,8 @@ public class CameraPreview
   private CameraXView cameraXView;
   private FusedLocationProviderClient fusedLocationClient;
   private Location lastLocation;
+  private OrientationEventListener orientationListener;
+  private int lastOrientation = Configuration.ORIENTATION_UNDEFINED;
 
   @PluginMethod
   public void start(PluginCall call) {
@@ -205,6 +212,13 @@ public class CameraPreview
           .getActivity()
           .setRequestedOrientation(previousOrientationRequest);
 
+        // Disable and clear orientation listener
+        if (orientationListener != null) {
+          orientationListener.disable();
+          orientationListener = null;
+          lastOrientation = Configuration.ORIENTATION_UNDEFINED;
+        }
+
         if (cameraXView != null && cameraXView.isRunning()) {
           cameraXView.stopSession();
           cameraXView = null;
@@ -215,6 +229,10 @@ public class CameraPreview
 
   @PluginMethod
   public void getSupportedFlashModes(PluginCall call) {
+    if (cameraXView == null || !cameraXView.isRunning()) {
+      call.reject("Camera is not running");
+      return;
+    }
     List<String> supportedFlashModes = cameraXView.getSupportedFlashModes();
     JSArray jsonFlashModes = new JSArray();
     for (String mode : supportedFlashModes) {
@@ -268,6 +286,10 @@ public class CameraPreview
 
   @PluginMethod
   public void getZoom(PluginCall call) {
+    if (cameraXView == null || !cameraXView.isRunning()) {
+      call.reject("Camera is not running");
+      return;
+    }
     ZoomFactors zoomFactors = cameraXView.getZoomFactors();
     JSObject result = new JSObject();
     result.put("min", zoomFactors.getMin());
@@ -278,6 +300,10 @@ public class CameraPreview
 
   @PluginMethod
   public void getZoomButtonValues(PluginCall call) {
+    if (cameraXView == null || !cameraXView.isRunning()) {
+      call.reject("Camera is not running");
+      return;
+    }
     // Build a sorted set to dedupe and order ascending
     java.util.Set<Double> sorted = new java.util.TreeSet<>();
     sorted.add(1.0);
@@ -968,6 +994,50 @@ public class CameraPreview
         bridge.saveCall(call);
         cameraStartCallbackId = call.getCallbackId();
         cameraXView.startSession(config);
+
+        // Setup orientation listener to mirror iOS screenResize emission
+        if (orientationListener == null) {
+          lastOrientation = getContext()
+            .getResources()
+            .getConfiguration()
+            .orientation;
+          orientationListener = new OrientationEventListener(getContext()) {
+            @Override
+            public void onOrientationChanged(int orientation) {
+              if (orientation == ORIENTATION_UNKNOWN) return;
+              int current = getContext()
+                .getResources()
+                .getConfiguration()
+                .orientation;
+              if (current != lastOrientation) {
+                lastOrientation = current;
+                handleOrientationChange();
+              }
+            }
+          };
+          if (orientationListener.canDetectOrientation()) {
+            orientationListener.enable();
+          }
+        }
+      });
+  }
+
+  private void handleOrientationChange() {
+    if (cameraXView == null || !cameraXView.isRunning()) return;
+    getBridge()
+      .getActivity()
+      .runOnUiThread(() -> {
+        // Reapply current aspect ratio to recompute layout, then emit screenResize
+        String ar = cameraXView.getAspectRatio();
+        cameraXView.setAspectRatio(ar, null, null, () -> {
+          int[] bounds = cameraXView.getCurrentPreviewBounds();
+          JSObject data = new JSObject();
+          data.put("x", bounds[0]);
+          data.put("y", bounds[1]);
+          data.put("width", bounds[2]);
+          data.put("height", bounds[3]);
+          notifyListeners("screenResize", data);
+        });
       });
   }
 
@@ -1255,4 +1325,120 @@ public class CameraPreview
       call.reject("Failed to delete file: " + e.getMessage());
     }
   }
+
+  @PluginMethod
+  public void getSafeAreaInsets(PluginCall call) {
+    JSObject ret = new JSObject();
+    int orientation = getContext()
+      .getResources()
+      .getConfiguration()
+      .orientation;
+
+    int topPx = 0;
+    int bottomPx = 0;
+    try {
+      View webView = getBridge().getWebView();
+      if (webView != null) {
+        DisplayMetrics metrics = getBridge()
+          .getActivity()
+          .getResources()
+          .getDisplayMetrics();
+        int screenHeight = metrics.heightPixels;
+        int[] location = new int[2];
+        webView.getLocationOnScreen(location);
+        int webViewTop = location[1];
+        int webViewBottom = webViewTop + webView.getHeight();
+        int webViewBottomGap = Math.max(0, screenHeight - webViewBottom);
+
+        // System insets (status/navigation/cutout)
+        int systemTop = 0;
+        int systemBottom = 0;
+        View decorView = getBridge().getActivity().getWindow().getDecorView();
+        WindowInsetsCompat insets = ViewCompat.getRootWindowInsets(decorView);
+        if (insets != null) {
+          Insets sysBars = insets.getInsets(
+            WindowInsetsCompat.Type.systemBars()
+          );
+          Insets cutout = insets.getInsets(
+            WindowInsetsCompat.Type.displayCutout()
+          );
+          systemTop = Math.max(sysBars.top, cutout.top);
+          systemBottom = Math.max(sysBars.bottom, cutout.bottom);
+        } else {
+          systemTop = getStatusBarHeightPx();
+          systemBottom = getNavigationBarHeightPx();
+        }
+
+        // Top: report the gap between screen and WebView (useful when not edge-to-edge)
+        topPx = Math.max(0, webViewTop);
+
+        // Bottom logic:
+        // - If WebView has a bottom gap equal to the system nav bar height (3-button mode),
+        //   it means layout already accounts for it -> return 0 as requested.
+        // - If WebView has no gap (edge-to-edge or overlay), return system bottom inset.
+        // - Otherwise, default to system bottom inset (avoid counting app UI like tab bars).
+        if (
+          webViewBottomGap > 0 && approxEqualPx(webViewBottomGap, systemBottom)
+        ) {
+          bottomPx = 0; // already offset by system nav bar
+        } else if (webViewBottomGap == 0) {
+          bottomPx = systemBottom;
+        } else {
+          bottomPx = systemBottom;
+        }
+      } else {
+        // Fallback if WebView is unavailable
+        View decorView = getBridge().getActivity().getWindow().getDecorView();
+        WindowInsetsCompat insets = ViewCompat.getRootWindowInsets(decorView);
+        if (insets != null) {
+          Insets sysBars = insets.getInsets(
+            WindowInsetsCompat.Type.systemBars()
+          );
+          Insets cutout = insets.getInsets(
+            WindowInsetsCompat.Type.displayCutout()
+          );
+          topPx = Math.max(sysBars.top, cutout.top);
+          bottomPx = Math.max(sysBars.bottom, cutout.bottom);
+        } else {
+          topPx = getStatusBarHeightPx();
+          bottomPx = getNavigationBarHeightPx();
+        }
+      }
+    } catch (Exception e) {
+      topPx = getStatusBarHeightPx();
+      bottomPx = getNavigationBarHeightPx();
+    }
+
+    float density = getContext().getResources().getDisplayMetrics().density;
+    ret.put("orientation", orientation);
+    ret.put("top", topPx / density);
+    ret.put("bottom", bottomPx / density);
+    call.resolve(ret);
+  }
+
+  private boolean approxEqualPx(int a, int b) {
+    return Math.abs(a - b) <= 2; // within 2px tolerance
+  }
+
+  private int getStatusBarHeightPx() {
+    int result = 0;
+    int resourceId = getContext()
+      .getResources()
+      .getIdentifier("status_bar_height", "dimen", "android");
+    if (resourceId > 0) {
+      result = getContext().getResources().getDimensionPixelSize(resourceId);
+    }
+    return result;
+  }
+
+  private int getNavigationBarHeightPx() {
+    int result = 0;
+    int resourceId = getContext()
+      .getResources()
+      .getIdentifier("navigation_bar_height", "dimen", "android");
+    if (resourceId > 0) {
+      result = getContext().getResources().getDimensionPixelSize(resourceId);
+    }
+    return result;
+  }
 }

package/dist/docs.json

@@ -684,6 +684,44 @@
           "PluginListenerHandle"
         ],
         "slug": "addlistenerscreenresize-"
+      },
+      {
+        "name": "deleteFile",
+        "signature": "(options: { path: string; }) => Promise<{ success: boolean; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ path: string; }"
+          }
+        ],
+        "returns": "Promise<{ success: boolean; }>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "8.2.0"
+          }
+        ],
+        "docs": "Deletes a file at the given absolute path on the device.\nUse this to quickly clean up temporary images created with `storeToFile`.\nOn web, this is not supported and will throw.",
+        "complexTypes": [],
+        "slug": "deletefile"
+      },
+      {
+        "name": "getSafeAreaInsets",
+        "signature": "() => Promise<SafeAreaInsets>",
+        "parameters": [],
+        "returns": "Promise<SafeAreaInsets>",
+        "tags": [
+          {
+            "name": "platform",
+            "text": "android"
+          }
+        ],
+        "docs": "Gets the safe area insets for Android devices.\nReturns the top and bottom insets in dp and the current orientation.",
+        "complexTypes": [
+          "SafeAreaInsets"
+        ],
+        "slug": "getsafeareainsets"
       }
     ],
     "properties": []
@@ -1406,6 +1444,36 @@
           "type": "() => Promise<void>"
         }
       ]
+    },
+    {
+      "name": "SafeAreaInsets",
+      "slug": "safeareainsets",
+      "docs": "Represents safe area insets on Android.\nValues are expressed in logical pixels (dp) to match JS layout units.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "orientation",
+          "tags": [],
+          "docs": "Current device orientation as reported by Android configuration.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "top",
+          "tags": [],
+          "docs": "Top inset (e.g., status bar or cutout) in dp.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "bottom",
+          "tags": [],
+          "docs": "Bottom inset (e.g., navigation bar) in dp.",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
     }
   ],
   "enums": [

package/dist/esm/definitions.d.ts

@@ -290,6 +290,18 @@ export interface CameraOpacityOptions {
      */
     opacity?: number;
 }
+/**
+ * Represents safe area insets on Android.
+ * Values are expressed in logical pixels (dp) to match JS layout units.
+ */
+export interface SafeAreaInsets {
+    /** Current device orientation as reported by Android configuration. */
+    orientation: number;
+    /** Top inset (e.g., status bar or cutout) in dp. */
+    top: number;
+    /** Bottom inset (e.g., navigation bar) in dp. */
+    bottom: number;
+}
 /**
  * The main interface for the CameraPreview plugin.
  */
@@ -587,4 +599,22 @@ export interface CameraPreviewPlugin {
         x: number;
         y: number;
     }) => void): Promise<PluginListenerHandle>;
+    /**
+     * Deletes a file at the given absolute path on the device.
+     * Use this to quickly clean up temporary images created with `storeToFile`.
+     * On web, this is not supported and will throw.
+     * @since 8.2.0
+     */
+    deleteFile(options: {
+        path: string;
+    }): Promise<{
+        success: boolean;
+    }>;
+    /**
+     * Gets the safe area insets for Android devices.
+     * Returns the top and bottom insets in dp and the current orientation.
+     *
+     * @platform android
+     */
+    getSafeAreaInsets(): Promise<SafeAreaInsets>;
 }

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAUA,MAAM,CAAN,IAAY,UAQX;AARD,WAAY,UAAU;IACpB,sCAAwB,CAAA;IACxB,sCAAwB,CAAA;IACxB,qCAAuB,CAAA;IACvB,sCAAwB,CAAA;IACxB,2BAAa,CAAA;IACb,oCAAsB,CAAA;IACtB,+BAAiB,CAAA;AACnB,CAAC,EARW,UAAU,KAAV,UAAU,QAQrB","sourcesContent":["import type { PluginListenerHandle } from \"@capacitor/core\";\n\nexport type CameraPosition = \"rear\" | \"front\";\n\nexport type FlashMode = CameraPreviewFlashMode;\n\nexport type GridMode = \"none\" | \"3x3\" | \"4x4\";\n\nexport type CameraPositioning = \"center\" | \"top\" | \"bottom\";\n\nexport enum DeviceType {\n  ULTRA_WIDE = \"ultraWide\",\n  WIDE_ANGLE = \"wideAngle\",\n  TELEPHOTO = \"telephoto\",\n  TRUE_DEPTH = \"trueDepth\",\n  DUAL = \"dual\",\n  DUAL_WIDE = \"dualWide\",\n  TRIPLE = \"triple\",\n}\n\n/**\n * Represents a single camera lens on a device. A {@link CameraDevice} can have multiple lenses.\n */\nexport interface CameraLens {\n  /** A human-readable name for the lens, e.g., \"Ultra-Wide\". */\n  label: string;\n  /** The type of the camera lens. */\n  deviceType: DeviceType;\n  /** The focal length of the lens in millimeters. */\n  focalLength: number;\n  /** The base zoom factor for this lens (e.g., 0.5 for ultra-wide, 1.0 for wide). */\n  baseZoomRatio: number;\n  /** The minimum zoom factor supported by this specific lens. */\n  minZoom: number;\n  /** The maximum zoom factor supported by this specific lens. */\n  maxZoom: number;\n}\n\n/**\n * Represents a physical camera on the device (e.g., the front-facing camera).\n */\nexport interface CameraDevice {\n  /** A unique identifier for the camera device. */\n  deviceId: string;\n  /** A human-readable name for the camera device. */\n  label: string;\n  /** The physical position of the camera on the device. */\n  position: CameraPosition;\n  /** A list of all available lenses for this camera device. */\n  lenses: CameraLens[];\n  /** The overall minimum zoom factor available across all lenses on this device. */\n  minZoom: number;\n  /** The overall maximum zoom factor available across all lenses on this device. */\n  maxZoom: number;\n  /** Identifies whether the device is a logical camera (composed of multiple physical lenses). */\n  isLogical: boolean;\n}\n\n/**\n * Represents the detailed information of the currently active lens.\n */\nexport interface LensInfo {\n  /** The focal length of the active lens in millimeters. */\n  focalLength: number;\n  /** The device type of the active lens. */\n  deviceType: DeviceType;\n  /** The base zoom ratio of the active lens (e.g., 0.5x, 1.0x). */\n  baseZoomRatio: number;\n  /** The current digital zoom factor applied on top of the base zoom. */\n  digitalZoom: number;\n}\n\n/**\n * Defines the configuration options for starting the camera preview.\n */\nexport interface CameraPreviewOptions {\n  /**\n   * The parent element to attach the video preview to.\n   * @platform web\n   */\n  parent?: string;\n  /**\n   * A CSS class name to add to the preview element.\n   * @platform web\n   */\n  className?: string;\n  /**\n   * The width of the preview in pixels. Defaults to the screen width.\n   * @platform android, ios, web\n   */\n  width?: number;\n  /**\n   * The height of the preview in pixels. Defaults to the screen height.\n   * @platform android, ios, web\n   */\n  height?: number;\n  /**\n   * The horizontal origin of the preview, in pixels.\n   * @platform android, ios\n   */\n  x?: number;\n  /**\n   * The vertical origin of the preview, in pixels.\n   * @platform android, ios\n   */\n  y?: number;\n  /**\n   * The aspect ratio of the camera preview, '4:3' or '16:9' or 'fill'.\n   * Cannot be set if width or height is provided, otherwise the call will be rejected.\n   * Use setPreviewSize to adjust size after starting.\n   *\n   * @since 2.0.0\n   */\n  aspectRatio?: \"4:3\" | \"16:9\";\n  /**\n   * The grid overlay to display on the camera preview.\n   * @default \"none\"\n   * @since 2.1.0\n   */\n  gridMode?: GridMode;\n  /**\n   * Adjusts the y-position to account for safe areas (e.g., notches).\n   * @platform ios\n   * @default false\n   */\n  includeSafeAreaInsets?: boolean;\n  /**\n   * If true, places the preview behind the webview.\n   * @platform android\n   * @default true\n   */\n  toBack?: boolean;\n  /**\n   * Bottom padding for the preview, in pixels.\n   * @platform android, ios\n   */\n  paddingBottom?: number;\n  /**\n   * Whether to rotate the preview when the device orientation changes.\n   * @platform ios\n   * @default true\n   */\n  rotateWhenOrientationChanged?: boolean;\n  /**\n   * The camera to use.\n   * @default \"rear\"\n   */\n  position?: CameraPosition | string;\n  /**\n   * If true, saves the captured image to a file and returns the file path.\n   * If false, returns a base64 encoded string.\n   * @default false\n   */\n  storeToFile?: boolean;\n  /**\n   * If true, prevents the plugin from rotating the image based on EXIF data.\n   * @platform android\n   * @default false\n   */\n  disableExifHeaderStripping?: boolean;\n  /**\n   * If true, disables the audio stream, preventing audio permission requests.\n   * @default true\n   */\n  disableAudio?: boolean;\n  /**\n   * If true, locks the device orientation while the camera is active.\n   * @platform android\n   * @default false\n   */\n  lockAndroidOrientation?: boolean;\n  /**\n   * If true, allows the camera preview's opacity to be changed.\n   * @platform android, web\n   * @default false\n   */\n  enableOpacity?: boolean;\n  /**\n   * If true, enables pinch-to-zoom functionality on the preview.\n   * @platform android\n   * @default false\n   */\n  enableZoom?: boolean;\n  /**\n   * If true, uses the video-optimized preset for the camera session.\n   * @platform ios\n   * @default false\n   */\n  enableVideoMode?: boolean;\n  /**\n   * The `deviceId` of the camera to use. If provided, `position` is ignored.\n   * @platform ios\n   */\n  deviceId?: string;\n  /**\n   * The initial zoom level when starting the camera preview.\n   * If the requested zoom level is not available, the native plugin will reject.\n   * @default 1.0\n   * @platform android, ios\n   * @since 2.2.0\n   */\n  initialZoomLevel?: number;\n  /**\n   * The vertical positioning of the camera preview.\n   * @default \"center\"\n   * @platform android, ios, web\n   * @since 2.3.0\n   */\n  positioning?: CameraPositioning;\n}\n\n/**\n * Defines the options for capturing a picture.\n */\nexport interface CameraPreviewPictureOptions {\n  /** @deprecated,\n   * The desired height of the picture in pixels.\n   * If not specified and no aspectRatio is provided, the captured image will match the preview's visible area.\n   */\n  height?: number;\n  /** @deprecated,\n   * The desired width of the picture in pixels.\n   * If not specified and no aspectRatio is provided, the captured image will match the preview's visible area.\n   */\n  width?: number;\n  /** @deprecated,\n   * The desired aspect ratio of the captured image (e.g., '4:3', '16:9').\n   * If not specified and no width/height is provided, the aspect ratio from the camera start will be used.\n   * If no aspect ratio was set at start, defaults to '4:3'.\n   * Cannot be used together with width or height - the capture will be rejected with an error.\n   * @since 7.7.0\n   */\n  aspectRatio?: string;\n  /**\n   * The quality of the captured image, from 0 to 100.\n   * Does not apply to `png` format.\n   * @default 85\n   */\n  quality?: number;\n  /**\n   * The format of the captured image.\n   * @default \"jpeg\"\n   */\n  format?: PictureFormat;\n  /**\n   * If true, the captured image will be saved to the user's gallery.\n   * @default false\n   * @since 7.5.0\n   */\n  saveToGallery?: boolean;\n  /**\n   * If true, the plugin will attempt to add GPS location data to the image's EXIF metadata.\n   * This may prompt the user for location permissions.\n   * @default false\n   * @since 7.6.0\n   */\n  withExifLocation?: boolean;\n}\n\n/** Represents EXIF data extracted from an image. */\nexport interface ExifData {\n  [key: string]: any;\n}\n\nexport type PictureFormat = \"jpeg\" | \"png\";\n\n/** Defines a standard picture size with width and height. */\nexport interface PictureSize {\n  /** The width of the picture in pixels. */\n  width: number;\n  /** The height of the picture in pixels. */\n  height: number;\n}\n\n/** Represents the supported picture sizes for a camera facing a certain direction. */\nexport interface SupportedPictureSizes {\n  /** The camera direction (\"front\" or \"rear\"). */\n  facing: string;\n  /** A list of supported picture sizes for this camera. */\n  supportedPictureSizes: PictureSize[];\n}\n\n/**\n * Defines the options for capturing a sample frame from the camera preview.\n */\nexport interface CameraSampleOptions {\n  /**\n   * The quality of the captured sample, from 0 to 100.\n   * @default 85\n   */\n  quality?: number;\n}\n\n/**\n * The available flash modes for the camera.\n * 'torch' is a continuous light mode.\n */\nexport type CameraPreviewFlashMode = \"off\" | \"on\" | \"auto\" | \"torch\";\n\n/**\n * Defines the options for setting the camera preview's opacity.\n */\nexport interface CameraOpacityOptions {\n  /**\n   * The opacity percentage, from 0.0 (fully transparent) to 1.0 (fully opaque).\n   * @default 1.0\n   */\n  opacity?: number;\n}\n\n/**\n * The main interface for the CameraPreview plugin.\n */\nexport interface CameraPreviewPlugin {\n  /**\n   * Starts the camera preview.\n   *\n   * @param {CameraPreviewOptions} options - The configuration for the camera preview.\n   * @returns {Promise<{ width: number; height: number; x: number; y: number }>} A promise that resolves with the preview dimensions.\n   * @since 0.0.1\n   */\n  start(options: CameraPreviewOptions): Promise<{\n    /** The width of the preview in pixels. */\n    width: number;\n    /** The height of the preview in pixels. */\n    height: number;\n    /** The horizontal origin of the preview, in pixels. */\n    x: number;\n    /** The vertical origin of the preview, in pixels. */\n    y: number;\n  }>;\n\n  /**\n   * Stops the camera preview.\n   *\n   * @returns {Promise<void>} A promise that resolves when the camera preview is stopped.\n   * @since 0.0.1\n   */\n  stop(): Promise<void>;\n\n  /**\n   * Captures a picture from the camera.\n   *\n   * @param {CameraPreviewPictureOptions} options - The options for capturing the picture.\n   * @returns {Promise<{ value: string }>} A promise that resolves with the captured image data.\n   * The `value` is a base64 encoded string unless `storeToFile` is true, in which case it's a file path.\n   * @since 0.0.1\n   */\n  capture(\n    options: CameraPreviewPictureOptions,\n  ): Promise<{ value: string; exif: ExifData }>;\n\n  /**\n   * Captures a single frame from the camera preview stream.\n   *\n   * @param {CameraSampleOptions} options - The options for capturing the sample.\n   * @returns {Promise<{ value: string }>} A promise that resolves with the sample image as a base64 encoded string.\n   * @since 0.0.1\n   */\n  captureSample(options: CameraSampleOptions): Promise<{ value: string }>;\n\n  /**\n   * Gets the flash modes supported by the active camera.\n   *\n   * @returns {Promise<{ result: CameraPreviewFlashMode[] }>} A promise that resolves with an array of supported flash modes.\n   * @since 0.0.1\n   */\n  getSupportedFlashModes(): Promise<{\n    result: CameraPreviewFlashMode[];\n  }>;\n\n  /**\n   * Set the aspect ratio of the camera preview.\n   *\n   * @param {{ aspectRatio: '4:3' | '16:9'; x?: number; y?: number }} options - The desired aspect ratio and optional position.\n   *   - aspectRatio: The desired aspect ratio ('4:3' or '16:9')\n   *   - x: Optional x coordinate for positioning. If not provided, view will be auto-centered horizontally.\n   *   - y: Optional y coordinate for positioning. If not provided, view will be auto-centered vertically.\n   * @returns {Promise<{ width: number; height: number; x: number; y: number }>} A promise that resolves with the actual preview dimensions and position.\n   * @since 7.4.0\n   */\n  setAspectRatio(options: {\n    aspectRatio: \"4:3\" | \"16:9\";\n    x?: number;\n    y?: number;\n  }): Promise<{\n    width: number;\n    height: number;\n    x: number;\n    y: number;\n  }>;\n\n  /**\n   * Gets the current aspect ratio of the camera preview.\n   *\n   * @returns {Promise<{ aspectRatio: '4:3' | '16:9' }>} A promise that resolves with the current aspect ratio.\n   * @since 7.4.0\n   */\n  getAspectRatio(): Promise<{ aspectRatio: \"4:3\" | \"16:9\" }>;\n\n  /**\n   * Sets the grid mode of the camera preview overlay.\n   *\n   * @param {{ gridMode: GridMode }} options - The desired grid mode ('none', '3x3', or '4x4').\n   * @returns {Promise<void>} A promise that resolves when the grid mode is set.\n   * @since 8.0.0\n   */\n  setGridMode(options: { gridMode: GridMode }): Promise<void>;\n\n  /**\n   * Gets the current grid mode of the camera preview overlay.\n   *\n   * @returns {Promise<{ gridMode: GridMode }>} A promise that resolves with the current grid mode.\n   * @since 8.0.0\n   */\n  getGridMode(): Promise<{ gridMode: GridMode }>;\n\n  /**\n   * Gets the horizontal field of view (FoV) for the active camera.\n   * Note: This can be an estimate on some devices.\n   *\n   * @returns {Promise<{ result: number }>} A promise that resolves with the horizontal field of view in degrees.\n   * @since 0.0.1\n   */\n  getHorizontalFov(): Promise<{\n    result: number;\n  }>;\n\n  /**\n   * Gets the supported picture sizes for all cameras.\n   *\n   * @returns {Promise<{ supportedPictureSizes: SupportedPictureSizes[] }>} A promise that resolves with the list of supported sizes.\n   * @since 7.4.0\n   */\n  getSupportedPictureSizes(): Promise<{\n    supportedPictureSizes: SupportedPictureSizes[];\n  }>;\n\n  /**\n   * Sets the flash mode for the active camera.\n   *\n   * @param {{ flashMode: CameraPreviewFlashMode | string }} options - The desired flash mode.\n   * @returns {Promise<void>} A promise that resolves when the flash mode is set.\n   * @since 0.0.1\n   */\n  setFlashMode(options: {\n    flashMode: CameraPreviewFlashMode | string;\n  }): Promise<void>;\n\n  /**\n   * Toggles between the front and rear cameras.\n   *\n   * @returns {Promise<void>} A promise that resolves when the camera is flipped.\n   * @since 0.0.1\n   */\n  flip(): Promise<void>;\n\n  /**\n   * Sets the opacity of the camera preview.\n   *\n   * @param {CameraOpacityOptions} options - The opacity options.\n   * @returns {Promise<void>} A promise that resolves when the opacity is set.\n   * @since 0.0.1\n   */\n  setOpacity(options: CameraOpacityOptions): Promise<void>;\n\n  /**\n   * Stops an ongoing video recording.\n   *\n   * @returns {Promise<{ videoFilePath: string }>} A promise that resolves with the path to the recorded video file.\n   * @since 0.0.1\n   */\n  stopRecordVideo(): Promise<{ videoFilePath: string }>;\n\n  /**\n   * Starts recording a video.\n   *\n   * @param {CameraPreviewOptions} options - The options for video recording.\n   * @returns {Promise<void>} A promise that resolves when video recording starts.\n   * @since 0.0.1\n   */\n  startRecordVideo(options: CameraPreviewOptions): Promise<void>;\n\n  /**\n   * Checks if the camera preview is currently running.\n   *\n   * @returns {Promise<{ isRunning: boolean }>} A promise that resolves with the running state.\n   * @since 7.4.0\n   */\n  isRunning(): Promise<{ isRunning: boolean }>;\n\n  /**\n   * Gets all available camera devices.\n   *\n   * @returns {Promise<{ devices: CameraDevice[] }>} A promise that resolves with the list of available camera devices.\n   * @since 7.4.0\n   */\n  getAvailableDevices(): Promise<{ devices: CameraDevice[] }>;\n\n  /**\n   * Gets the current zoom state, including min/max and current lens info.\n   *\n   * @returns {Promise<{ min: number; max: number; current: number; lens: LensInfo }>} A promise that resolves with the zoom state.\n   * @since 7.4.0\n   */\n  getZoom(): Promise<{\n    min: number;\n    max: number;\n    current: number;\n    lens: LensInfo;\n  }>;\n\n  /**\n   * Returns zoom button values for quick switching.\n   * - iOS/Android: includes 0.5 if ultra-wide available; 1 and 2 if wide available; 3 if telephoto available\n   * - Web: unsupported\n   */\n  getZoomButtonValues(): Promise<{ values: number[] }>;\n\n  /**\n   * Sets the zoom level of the camera.\n   *\n   * @param {{ level: number; ramp?: boolean; autoFocus?: boolean }} options - The desired zoom level. `ramp` is currently unused. `autoFocus` defaults to true.\n   * @returns {Promise<void>} A promise that resolves when the zoom level is set.\n   * @since 7.4.0\n   */\n  setZoom(options: {\n    level: number;\n    ramp?: boolean;\n    autoFocus?: boolean;\n  }): Promise<void>;\n\n  /**\n   * Gets the current flash mode.\n   *\n   * @returns {Promise<{ flashMode: FlashMode }>} A promise that resolves with the current flash mode.\n   * @since 7.4.0\n   */\n  getFlashMode(): Promise<{ flashMode: FlashMode }>;\n\n  /**\n   * Removes all registered listeners.\n   *\n   * @since 7.4.0\n   */\n  removeAllListeners(): Promise<void>;\n\n  /**\n   * Switches the active camera to the one with the specified `deviceId`.\n   *\n   * @param {{ deviceId: string }} options - The ID of the device to switch to.\n   * @returns {Promise<void>} A promise that resolves when the camera is switched.\n   * @since 7.4.0\n   */\n  setDeviceId(options: { deviceId: string }): Promise<void>;\n\n  /**\n   * Gets the ID of the currently active camera device.\n   *\n   * @returns {Promise<{ deviceId: string }>} A promise that resolves with the current device ID.\n   * @since 7.4.0\n   */\n  getDeviceId(): Promise<{ deviceId: string }>;\n\n  /**\n   * Gets the current preview size and position.\n   * @returns {Promise<{x: number, y: number, width: number, height: number}>}\n   */\n  getPreviewSize(): Promise<{\n    x: number;\n    y: number;\n    width: number;\n    height: number;\n  }>;\n  /**\n   * Sets the preview size and position.\n   * @param options The new position and dimensions.\n   * @returns {Promise<{ width: number; height: number; x: number; y: number }>} A promise that resolves with the actual preview dimensions and position.\n   */\n  setPreviewSize(options: {\n    x?: number;\n    y?: number;\n    width: number;\n    height: number;\n  }): Promise<{\n    width: number;\n    height: number;\n    x: number;\n    y: number;\n  }>;\n\n  /**\n   * Sets the camera focus to a specific point in the preview.\n   *\n   * @param {Object} options - The focus options.\n   * @param {number} options.x - The x coordinate in the preview view to focus on (0-1 normalized).\n   * @param {number} options.y - The y coordinate in the preview view to focus on (0-1 normalized).\n   * @returns {Promise<void>} A promise that resolves when the focus is set.\n   * @since 8.1.0\n   */\n  setFocus(options: { x: number; y: number }): Promise<void>;\n\n  addListener(\n    eventName: \"screenResize\",\n    listenerFunc: (data: {\n      width: number;\n      height: number;\n      x: number;\n      y: number;\n    }) => void,\n  ): Promise<PluginListenerHandle>;\n}\n"]}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAUA,MAAM,CAAN,IAAY,UAQX;AARD,WAAY,UAAU;IACpB,sCAAwB,CAAA;IACxB,sCAAwB,CAAA;IACxB,qCAAuB,CAAA;IACvB,sCAAwB,CAAA;IACxB,2BAAa,CAAA;IACb,oCAAsB,CAAA;IACtB,+BAAiB,CAAA;AACnB,CAAC,EARW,UAAU,KAAV,UAAU,QAQrB","sourcesContent":["import type { PluginListenerHandle } from \"@capacitor/core\";\n\nexport type CameraPosition = \"rear\" | \"front\";\n\nexport type FlashMode = CameraPreviewFlashMode;\n\nexport type GridMode = \"none\" | \"3x3\" | \"4x4\";\n\nexport type CameraPositioning = \"center\" | \"top\" | \"bottom\";\n\nexport enum DeviceType {\n  ULTRA_WIDE = \"ultraWide\",\n  WIDE_ANGLE = \"wideAngle\",\n  TELEPHOTO = \"telephoto\",\n  TRUE_DEPTH = \"trueDepth\",\n  DUAL = \"dual\",\n  DUAL_WIDE = \"dualWide\",\n  TRIPLE = \"triple\",\n}\n\n/**\n * Represents a single camera lens on a device. A {@link CameraDevice} can have multiple lenses.\n */\nexport interface CameraLens {\n  /** A human-readable name for the lens, e.g., \"Ultra-Wide\". */\n  label: string;\n  /** The type of the camera lens. */\n  deviceType: DeviceType;\n  /** The focal length of the lens in millimeters. */\n  focalLength: number;\n  /** The base zoom factor for this lens (e.g., 0.5 for ultra-wide, 1.0 for wide). */\n  baseZoomRatio: number;\n  /** The minimum zoom factor supported by this specific lens. */\n  minZoom: number;\n  /** The maximum zoom factor supported by this specific lens. */\n  maxZoom: number;\n}\n\n/**\n * Represents a physical camera on the device (e.g., the front-facing camera).\n */\nexport interface CameraDevice {\n  /** A unique identifier for the camera device. */\n  deviceId: string;\n  /** A human-readable name for the camera device. */\n  label: string;\n  /** The physical position of the camera on the device. */\n  position: CameraPosition;\n  /** A list of all available lenses for this camera device. */\n  lenses: CameraLens[];\n  /** The overall minimum zoom factor available across all lenses on this device. */\n  minZoom: number;\n  /** The overall maximum zoom factor available across all lenses on this device. */\n  maxZoom: number;\n  /** Identifies whether the device is a logical camera (composed of multiple physical lenses). */\n  isLogical: boolean;\n}\n\n/**\n * Represents the detailed information of the currently active lens.\n */\nexport interface LensInfo {\n  /** The focal length of the active lens in millimeters. */\n  focalLength: number;\n  /** The device type of the active lens. */\n  deviceType: DeviceType;\n  /** The base zoom ratio of the active lens (e.g., 0.5x, 1.0x). */\n  baseZoomRatio: number;\n  /** The current digital zoom factor applied on top of the base zoom. */\n  digitalZoom: number;\n}\n\n/**\n * Defines the configuration options for starting the camera preview.\n */\nexport interface CameraPreviewOptions {\n  /**\n   * The parent element to attach the video preview to.\n   * @platform web\n   */\n  parent?: string;\n  /**\n   * A CSS class name to add to the preview element.\n   * @platform web\n   */\n  className?: string;\n  /**\n   * The width of the preview in pixels. Defaults to the screen width.\n   * @platform android, ios, web\n   */\n  width?: number;\n  /**\n   * The height of the preview in pixels. Defaults to the screen height.\n   * @platform android, ios, web\n   */\n  height?: number;\n  /**\n   * The horizontal origin of the preview, in pixels.\n   * @platform android, ios\n   */\n  x?: number;\n  /**\n   * The vertical origin of the preview, in pixels.\n   * @platform android, ios\n   */\n  y?: number;\n  /**\n   * The aspect ratio of the camera preview, '4:3' or '16:9' or 'fill'.\n   * Cannot be set if width or height is provided, otherwise the call will be rejected.\n   * Use setPreviewSize to adjust size after starting.\n   *\n   * @since 2.0.0\n   */\n  aspectRatio?: \"4:3\" | \"16:9\";\n  /**\n   * The grid overlay to display on the camera preview.\n   * @default \"none\"\n   * @since 2.1.0\n   */\n  gridMode?: GridMode;\n  /**\n   * Adjusts the y-position to account for safe areas (e.g., notches).\n   * @platform ios\n   * @default false\n   */\n  includeSafeAreaInsets?: boolean;\n  /**\n   * If true, places the preview behind the webview.\n   * @platform android\n   * @default true\n   */\n  toBack?: boolean;\n  /**\n   * Bottom padding for the preview, in pixels.\n   * @platform android, ios\n   */\n  paddingBottom?: number;\n  /**\n   * Whether to rotate the preview when the device orientation changes.\n   * @platform ios\n   * @default true\n   */\n  rotateWhenOrientationChanged?: boolean;\n  /**\n   * The camera to use.\n   * @default \"rear\"\n   */\n  position?: CameraPosition | string;\n  /**\n   * If true, saves the captured image to a file and returns the file path.\n   * If false, returns a base64 encoded string.\n   * @default false\n   */\n  storeToFile?: boolean;\n  /**\n   * If true, prevents the plugin from rotating the image based on EXIF data.\n   * @platform android\n   * @default false\n   */\n  disableExifHeaderStripping?: boolean;\n  /**\n   * If true, disables the audio stream, preventing audio permission requests.\n   * @default true\n   */\n  disableAudio?: boolean;\n  /**\n   * If true, locks the device orientation while the camera is active.\n   * @platform android\n   * @default false\n   */\n  lockAndroidOrientation?: boolean;\n  /**\n   * If true, allows the camera preview's opacity to be changed.\n   * @platform android, web\n   * @default false\n   */\n  enableOpacity?: boolean;\n  /**\n   * If true, enables pinch-to-zoom functionality on the preview.\n   * @platform android\n   * @default false\n   */\n  enableZoom?: boolean;\n  /**\n   * If true, uses the video-optimized preset for the camera session.\n   * @platform ios\n   * @default false\n   */\n  enableVideoMode?: boolean;\n  /**\n   * The `deviceId` of the camera to use. If provided, `position` is ignored.\n   * @platform ios\n   */\n  deviceId?: string;\n  /**\n   * The initial zoom level when starting the camera preview.\n   * If the requested zoom level is not available, the native plugin will reject.\n   * @default 1.0\n   * @platform android, ios\n   * @since 2.2.0\n   */\n  initialZoomLevel?: number;\n  /**\n   * The vertical positioning of the camera preview.\n   * @default \"center\"\n   * @platform android, ios, web\n   * @since 2.3.0\n   */\n  positioning?: CameraPositioning;\n}\n\n/**\n * Defines the options for capturing a picture.\n */\nexport interface CameraPreviewPictureOptions {\n  /** @deprecated,\n   * The desired height of the picture in pixels.\n   * If not specified and no aspectRatio is provided, the captured image will match the preview's visible area.\n   */\n  height?: number;\n  /** @deprecated,\n   * The desired width of the picture in pixels.\n   * If not specified and no aspectRatio is provided, the captured image will match the preview's visible area.\n   */\n  width?: number;\n  /** @deprecated,\n   * The desired aspect ratio of the captured image (e.g., '4:3', '16:9').\n   * If not specified and no width/height is provided, the aspect ratio from the camera start will be used.\n   * If no aspect ratio was set at start, defaults to '4:3'.\n   * Cannot be used together with width or height - the capture will be rejected with an error.\n   * @since 7.7.0\n   */\n  aspectRatio?: string;\n  /**\n   * The quality of the captured image, from 0 to 100.\n   * Does not apply to `png` format.\n   * @default 85\n   */\n  quality?: number;\n  /**\n   * The format of the captured image.\n   * @default \"jpeg\"\n   */\n  format?: PictureFormat;\n  /**\n   * If true, the captured image will be saved to the user's gallery.\n   * @default false\n   * @since 7.5.0\n   */\n  saveToGallery?: boolean;\n  /**\n   * If true, the plugin will attempt to add GPS location data to the image's EXIF metadata.\n   * This may prompt the user for location permissions.\n   * @default false\n   * @since 7.6.0\n   */\n  withExifLocation?: boolean;\n}\n\n/** Represents EXIF data extracted from an image. */\nexport interface ExifData {\n  [key: string]: any;\n}\n\nexport type PictureFormat = \"jpeg\" | \"png\";\n\n/** Defines a standard picture size with width and height. */\nexport interface PictureSize {\n  /** The width of the picture in pixels. */\n  width: number;\n  /** The height of the picture in pixels. */\n  height: number;\n}\n\n/** Represents the supported picture sizes for a camera facing a certain direction. */\nexport interface SupportedPictureSizes {\n  /** The camera direction (\"front\" or \"rear\"). */\n  facing: string;\n  /** A list of supported picture sizes for this camera. */\n  supportedPictureSizes: PictureSize[];\n}\n\n/**\n * Defines the options for capturing a sample frame from the camera preview.\n */\nexport interface CameraSampleOptions {\n  /**\n   * The quality of the captured sample, from 0 to 100.\n   * @default 85\n   */\n  quality?: number;\n}\n\n/**\n * The available flash modes for the camera.\n * 'torch' is a continuous light mode.\n */\nexport type CameraPreviewFlashMode = \"off\" | \"on\" | \"auto\" | \"torch\";\n\n/**\n * Defines the options for setting the camera preview's opacity.\n */\nexport interface CameraOpacityOptions {\n  /**\n   * The opacity percentage, from 0.0 (fully transparent) to 1.0 (fully opaque).\n   * @default 1.0\n   */\n  opacity?: number;\n}\n\n/**\n * Represents safe area insets on Android.\n * Values are expressed in logical pixels (dp) to match JS layout units.\n */\nexport interface SafeAreaInsets {\n  /** Current device orientation as reported by Android configuration. */\n  orientation: number;\n  /** Top inset (e.g., status bar or cutout) in dp. */\n  top: number;\n  /** Bottom inset (e.g., navigation bar) in dp. */\n  bottom: number;\n}\n\n/**\n * The main interface for the CameraPreview plugin.\n */\nexport interface CameraPreviewPlugin {\n  /**\n   * Starts the camera preview.\n   *\n   * @param {CameraPreviewOptions} options - The configuration for the camera preview.\n   * @returns {Promise<{ width: number; height: number; x: number; y: number }>} A promise that resolves with the preview dimensions.\n   * @since 0.0.1\n   */\n  start(options: CameraPreviewOptions): Promise<{\n    /** The width of the preview in pixels. */\n    width: number;\n    /** The height of the preview in pixels. */\n    height: number;\n    /** The horizontal origin of the preview, in pixels. */\n    x: number;\n    /** The vertical origin of the preview, in pixels. */\n    y: number;\n  }>;\n\n  /**\n   * Stops the camera preview.\n   *\n   * @returns {Promise<void>} A promise that resolves when the camera preview is stopped.\n   * @since 0.0.1\n   */\n  stop(): Promise<void>;\n\n  /**\n   * Captures a picture from the camera.\n   *\n   * @param {CameraPreviewPictureOptions} options - The options for capturing the picture.\n   * @returns {Promise<{ value: string }>} A promise that resolves with the captured image data.\n   * The `value` is a base64 encoded string unless `storeToFile` is true, in which case it's a file path.\n   * @since 0.0.1\n   */\n  capture(\n    options: CameraPreviewPictureOptions,\n  ): Promise<{ value: string; exif: ExifData }>;\n\n  /**\n   * Captures a single frame from the camera preview stream.\n   *\n   * @param {CameraSampleOptions} options - The options for capturing the sample.\n   * @returns {Promise<{ value: string }>} A promise that resolves with the sample image as a base64 encoded string.\n   * @since 0.0.1\n   */\n  captureSample(options: CameraSampleOptions): Promise<{ value: string }>;\n\n  /**\n   * Gets the flash modes supported by the active camera.\n   *\n   * @returns {Promise<{ result: CameraPreviewFlashMode[] }>} A promise that resolves with an array of supported flash modes.\n   * @since 0.0.1\n   */\n  getSupportedFlashModes(): Promise<{\n    result: CameraPreviewFlashMode[];\n  }>;\n\n  /**\n   * Set the aspect ratio of the camera preview.\n   *\n   * @param {{ aspectRatio: '4:3' | '16:9'; x?: number; y?: number }} options - The desired aspect ratio and optional position.\n   *   - aspectRatio: The desired aspect ratio ('4:3' or '16:9')\n   *   - x: Optional x coordinate for positioning. If not provided, view will be auto-centered horizontally.\n   *   - y: Optional y coordinate for positioning. If not provided, view will be auto-centered vertically.\n   * @returns {Promise<{ width: number; height: number; x: number; y: number }>} A promise that resolves with the actual preview dimensions and position.\n   * @since 7.4.0\n   */\n  setAspectRatio(options: {\n    aspectRatio: \"4:3\" | \"16:9\";\n    x?: number;\n    y?: number;\n  }): Promise<{\n    width: number;\n    height: number;\n    x: number;\n    y: number;\n  }>;\n\n  /**\n   * Gets the current aspect ratio of the camera preview.\n   *\n   * @returns {Promise<{ aspectRatio: '4:3' | '16:9' }>} A promise that resolves with the current aspect ratio.\n   * @since 7.4.0\n   */\n  getAspectRatio(): Promise<{ aspectRatio: \"4:3\" | \"16:9\" }>;\n\n  /**\n   * Sets the grid mode of the camera preview overlay.\n   *\n   * @param {{ gridMode: GridMode }} options - The desired grid mode ('none', '3x3', or '4x4').\n   * @returns {Promise<void>} A promise that resolves when the grid mode is set.\n   * @since 8.0.0\n   */\n  setGridMode(options: { gridMode: GridMode }): Promise<void>;\n\n  /**\n   * Gets the current grid mode of the camera preview overlay.\n   *\n   * @returns {Promise<{ gridMode: GridMode }>} A promise that resolves with the current grid mode.\n   * @since 8.0.0\n   */\n  getGridMode(): Promise<{ gridMode: GridMode }>;\n\n  /**\n   * Gets the horizontal field of view (FoV) for the active camera.\n   * Note: This can be an estimate on some devices.\n   *\n   * @returns {Promise<{ result: number }>} A promise that resolves with the horizontal field of view in degrees.\n   * @since 0.0.1\n   */\n  getHorizontalFov(): Promise<{\n    result: number;\n  }>;\n\n  /**\n   * Gets the supported picture sizes for all cameras.\n   *\n   * @returns {Promise<{ supportedPictureSizes: SupportedPictureSizes[] }>} A promise that resolves with the list of supported sizes.\n   * @since 7.4.0\n   */\n  getSupportedPictureSizes(): Promise<{\n    supportedPictureSizes: SupportedPictureSizes[];\n  }>;\n\n  /**\n   * Sets the flash mode for the active camera.\n   *\n   * @param {{ flashMode: CameraPreviewFlashMode | string }} options - The desired flash mode.\n   * @returns {Promise<void>} A promise that resolves when the flash mode is set.\n   * @since 0.0.1\n   */\n  setFlashMode(options: {\n    flashMode: CameraPreviewFlashMode | string;\n  }): Promise<void>;\n\n  /**\n   * Toggles between the front and rear cameras.\n   *\n   * @returns {Promise<void>} A promise that resolves when the camera is flipped.\n   * @since 0.0.1\n   */\n  flip(): Promise<void>;\n\n  /**\n   * Sets the opacity of the camera preview.\n   *\n   * @param {CameraOpacityOptions} options - The opacity options.\n   * @returns {Promise<void>} A promise that resolves when the opacity is set.\n   * @since 0.0.1\n   */\n  setOpacity(options: CameraOpacityOptions): Promise<void>;\n\n  /**\n   * Stops an ongoing video recording.\n   *\n   * @returns {Promise<{ videoFilePath: string }>} A promise that resolves with the path to the recorded video file.\n   * @since 0.0.1\n   */\n  stopRecordVideo(): Promise<{ videoFilePath: string }>;\n\n  /**\n   * Starts recording a video.\n   *\n   * @param {CameraPreviewOptions} options - The options for video recording.\n   * @returns {Promise<void>} A promise that resolves when video recording starts.\n   * @since 0.0.1\n   */\n  startRecordVideo(options: CameraPreviewOptions): Promise<void>;\n\n  /**\n   * Checks if the camera preview is currently running.\n   *\n   * @returns {Promise<{ isRunning: boolean }>} A promise that resolves with the running state.\n   * @since 7.4.0\n   */\n  isRunning(): Promise<{ isRunning: boolean }>;\n\n  /**\n   * Gets all available camera devices.\n   *\n   * @returns {Promise<{ devices: CameraDevice[] }>} A promise that resolves with the list of available camera devices.\n   * @since 7.4.0\n   */\n  getAvailableDevices(): Promise<{ devices: CameraDevice[] }>;\n\n  /**\n   * Gets the current zoom state, including min/max and current lens info.\n   *\n   * @returns {Promise<{ min: number; max: number; current: number; lens: LensInfo }>} A promise that resolves with the zoom state.\n   * @since 7.4.0\n   */\n  getZoom(): Promise<{\n    min: number;\n    max: number;\n    current: number;\n    lens: LensInfo;\n  }>;\n\n  /**\n   * Returns zoom button values for quick switching.\n   * - iOS/Android: includes 0.5 if ultra-wide available; 1 and 2 if wide available; 3 if telephoto available\n   * - Web: unsupported\n   */\n  getZoomButtonValues(): Promise<{ values: number[] }>;\n\n  /**\n   * Sets the zoom level of the camera.\n   *\n   * @param {{ level: number; ramp?: boolean; autoFocus?: boolean }} options - The desired zoom level. `ramp` is currently unused. `autoFocus` defaults to true.\n   * @returns {Promise<void>} A promise that resolves when the zoom level is set.\n   * @since 7.4.0\n   */\n  setZoom(options: {\n    level: number;\n    ramp?: boolean;\n    autoFocus?: boolean;\n  }): Promise<void>;\n\n  /**\n   * Gets the current flash mode.\n   *\n   * @returns {Promise<{ flashMode: FlashMode }>} A promise that resolves with the current flash mode.\n   * @since 7.4.0\n   */\n  getFlashMode(): Promise<{ flashMode: FlashMode }>;\n\n  /**\n   * Removes all registered listeners.\n   *\n   * @since 7.4.0\n   */\n  removeAllListeners(): Promise<void>;\n\n  /**\n   * Switches the active camera to the one with the specified `deviceId`.\n   *\n   * @param {{ deviceId: string }} options - The ID of the device to switch to.\n   * @returns {Promise<void>} A promise that resolves when the camera is switched.\n   * @since 7.4.0\n   */\n  setDeviceId(options: { deviceId: string }): Promise<void>;\n\n  /**\n   * Gets the ID of the currently active camera device.\n   *\n   * @returns {Promise<{ deviceId: string }>} A promise that resolves with the current device ID.\n   * @since 7.4.0\n   */\n  getDeviceId(): Promise<{ deviceId: string }>;\n\n  /**\n   * Gets the current preview size and position.\n   * @returns {Promise<{x: number, y: number, width: number, height: number}>}\n   */\n  getPreviewSize(): Promise<{\n    x: number;\n    y: number;\n    width: number;\n    height: number;\n  }>;\n  /**\n   * Sets the preview size and position.\n   * @param options The new position and dimensions.\n   * @returns {Promise<{ width: number; height: number; x: number; y: number }>} A promise that resolves with the actual preview dimensions and position.\n   */\n  setPreviewSize(options: {\n    x?: number;\n    y?: number;\n    width: number;\n    height: number;\n  }): Promise<{\n    width: number;\n    height: number;\n    x: number;\n    y: number;\n  }>;\n\n  /**\n   * Sets the camera focus to a specific point in the preview.\n   *\n   * @param {Object} options - The focus options.\n   * @param {number} options.x - The x coordinate in the preview view to focus on (0-1 normalized).\n   * @param {number} options.y - The y coordinate in the preview view to focus on (0-1 normalized).\n   * @returns {Promise<void>} A promise that resolves when the focus is set.\n   * @since 8.1.0\n   */\n  setFocus(options: { x: number; y: number }): Promise<void>;\n\n  addListener(\n    eventName: \"screenResize\",\n    listenerFunc: (data: {\n      width: number;\n      height: number;\n      x: number;\n      y: number;\n    }) => void,\n  ): Promise<PluginListenerHandle>;\n  /**\n   * Deletes a file at the given absolute path on the device.\n   * Use this to quickly clean up temporary images created with `storeToFile`.\n   * On web, this is not supported and will throw.\n   * @since 8.2.0\n   */\n  deleteFile(options: { path: string }): Promise<{ success: boolean }>;\n\n  /**\n   * Gets the safe area insets for Android devices.\n   * Returns the top and bottom insets in dp and the current orientation.\n   *\n   * @platform android\n   */\n  getSafeAreaInsets(): Promise<SafeAreaInsets>;\n}\n"]}

package/dist/esm/web.d.ts

@@ -1,5 +1,5 @@
 import { WebPlugin } from "@capacitor/core";
-import type { CameraDevice, CameraOpacityOptions, CameraPreviewFlashMode, CameraPreviewOptions, CameraPreviewPictureOptions, CameraPreviewPlugin, CameraSampleOptions, GridMode, FlashMode, LensInfo } from "./definitions";
+import type { CameraDevice, CameraOpacityOptions, CameraPreviewFlashMode, CameraPreviewOptions, CameraPreviewPictureOptions, CameraPreviewPlugin, CameraSampleOptions, GridMode, FlashMode, LensInfo, SafeAreaInsets } from "./definitions";
 export declare class CameraPreviewWeb extends WebPlugin implements CameraPreviewPlugin {
     /**
      *  track which camera is used based on start options
@@ -10,6 +10,7 @@ export declare class CameraPreviewWeb extends WebPlugin implements CameraPreview
     private videoElement;
     private isStarted;
     constructor();
+    getSafeAreaInsets(): Promise<SafeAreaInsets>;
     getZoomButtonValues(): Promise<{
         values: number[];
     }>;

package/dist/esm/web.js

@@ -13,6 +13,9 @@ export class CameraPreviewWeb extends WebPlugin {
         this.videoElement = null;
         this.isStarted = false;
     }
+    getSafeAreaInsets() {
+        throw new Error("Method not implemented.");
+    }
     async getZoomButtonValues() {
         throw new Error("getZoomButtonValues not supported under the web platform");
     }