@capgo/camera-preview 7.4.0-beta.3 → 7.4.0-beta.4

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

@@ -0,0 +1,80 @@
+package com.ahm.capacitor.camera.preview;
+
+import android.content.Context;
+import android.graphics.Canvas;
+import android.graphics.Paint;
+import android.util.AttributeSet;
+import android.view.View;
+
+public class GridOverlayView extends View {
+    private Paint gridPaint;
+    private String gridMode = "none";
+
+    public GridOverlayView(Context context) {
+        super(context);
+        init();
+    }
+
+    public GridOverlayView(Context context, AttributeSet attrs) {
+        super(context, attrs);
+        init();
+    }
+
+    public GridOverlayView(Context context, AttributeSet attrs, int defStyleAttr) {
+        super(context, attrs, defStyleAttr);
+        init();
+    }
+
+    private void init() {
+        gridPaint = new Paint();
+        gridPaint.setColor(0x80FFFFFF); // Semi-transparent white
+        gridPaint.setStrokeWidth(2f);
+        gridPaint.setStyle(Paint.Style.STROKE);
+        gridPaint.setAntiAlias(true);
+    }
+
+    public void setGridMode(String mode) {
+        this.gridMode = mode != null ? mode : "none";
+        setVisibility("none".equals(this.gridMode) ? View.GONE : View.VISIBLE);
+        invalidate();
+    }
+
+    @Override
+    protected void onDraw(Canvas canvas) {
+        super.onDraw(canvas);
+
+        if ("none".equals(gridMode)) {
+            return;
+        }
+
+        int width = getWidth();
+        int height = getHeight();
+
+        if (width <= 0 || height <= 0) {
+            return;
+        }
+
+        if ("3x3".equals(gridMode)) {
+            drawGrid(canvas, width, height, 3);
+        } else if ("4x4".equals(gridMode)) {
+            drawGrid(canvas, width, height, 4);
+        }
+    }
+
+    private void drawGrid(Canvas canvas, int width, int height, int divisions) {
+        float stepX = (float) width / divisions;
+        float stepY = (float) height / divisions;
+
+        // Draw vertical lines
+        for (int i = 1; i < divisions; i++) {
+            float x = i * stepX;
+            canvas.drawLine(x, 0, x, height, gridPaint);
+        }
+
+        // Draw horizontal lines
+        for (int i = 1; i < divisions; i++) {
+            float y = i * stepY;
+            canvas.drawLine(0, y, width, y, gridPaint);
+        }
+    }
+}

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

@@ -18,12 +18,14 @@ public class CameraSessionConfiguration {
     private final boolean disableExifHeaderStripping;
     private final boolean disableAudio;
     private final float zoomFactor;
+    private final String aspectRatio;
+    private final String gridMode;
     private float targetZoom = 1.0f;
 
-    public CameraSessionConfiguration(String deviceId, String position, int x, int y, int width, int height, 
-                                    int paddingBottom, boolean toBack, boolean storeToFile, boolean enableOpacity, 
-                                    boolean enableZoom, boolean disableExifHeaderStripping, boolean disableAudio, 
-                                    float zoomFactor) {
+    public CameraSessionConfiguration(String deviceId, String position, int x, int y, int width, int height,
+                                    int paddingBottom, boolean toBack, boolean storeToFile, boolean enableOpacity,
+                                    boolean enableZoom, boolean disableExifHeaderStripping, boolean disableAudio,
+                                    float zoomFactor, String aspectRatio, String gridMode) {
         this.deviceId = deviceId;
         this.position = position;
         this.x = x;
@@ -38,6 +40,8 @@ public class CameraSessionConfiguration {
         this.disableExifHeaderStripping = disableExifHeaderStripping;
         this.disableAudio = disableAudio;
         this.zoomFactor = zoomFactor;
+        this.aspectRatio = aspectRatio;
+        this.gridMode = gridMode != null ? gridMode : "none";
     }
 
     public void setTargetZoom(float zoom) {
@@ -62,4 +66,14 @@ public class CameraSessionConfiguration {
     public boolean isDisableExifHeaderStripping() { return disableExifHeaderStripping; }
     public boolean isDisableAudio() { return disableAudio; }
     public float getZoomFactor() { return zoomFactor; }
-} 
+    public String getAspectRatio() { return aspectRatio; }
+    public String getGridMode() { return gridMode; }
+
+    // Additional getters with "get" prefix for compatibility
+    public boolean getToBack() { return toBack; }
+    public boolean getStoreToFile() { return storeToFile; }
+    public boolean getEnableOpacity() { return enableOpacity; }
+    public boolean getEnableZoom() { return enableZoom; }
+    public boolean getDisableExifHeaderStripping() { return disableExifHeaderStripping; }
+    public boolean getDisableAudio() { return disableAudio; }
+}

package/dist/docs.json

@@ -7,7 +7,7 @@
     "methods": [
       {
         "name": "start",
-        "signature": "(options: CameraPreviewOptions) => Promise<void>",
+        "signature": "(options: CameraPreviewOptions) => Promise<{ width: number; height: number; x: number; y: number; }>",
         "parameters": [
           {
             "name": "options",
@@ -15,7 +15,7 @@
             "type": "CameraPreviewOptions"
           }
         ],
-        "returns": "Promise<void>",
+        "returns": "Promise<{ width: number; height: number; x: number; y: number; }>",
         "tags": [
           {
             "name": "param",
@@ -23,7 +23,7 @@
           },
           {
             "name": "returns",
-            "text": "A promise that resolves when the camera preview is started."
+            "text": "A promise that resolves with the preview dimensions."
           },
           {
             "name": "since",
@@ -139,6 +139,54 @@
         ],
         "slug": "getsupportedflashmodes"
       },
+      {
+        "name": "setAspectRatio",
+        "signature": "(options: { aspectRatio: '4:3' | '16:9' | 'fill'; }) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "- The desired aspect ratio.",
+            "type": "{ aspectRatio: '4:3' | '16:9' | 'fill'; }"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options - The desired aspect ratio."
+          },
+          {
+            "name": "returns",
+            "text": "A promise that resolves when the aspect ratio is set."
+          },
+          {
+            "name": "since",
+            "text": "7.4.0"
+          }
+        ],
+        "docs": "Set the aspect ratio of the camera preview.",
+        "complexTypes": [],
+        "slug": "setaspectratio"
+      },
+      {
+        "name": "getAspectRatio",
+        "signature": "() => Promise<{ aspectRatio: '4:3' | '16:9' | 'fill'; }>",
+        "parameters": [],
+        "returns": "Promise<{ aspectRatio: '4:3' | '16:9' | 'fill'; }>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "A promise that resolves with the current aspect ratio."
+          },
+          {
+            "name": "since",
+            "text": "7.4.0"
+          }
+        ],
+        "docs": "Gets the current aspect ratio of the camera preview.",
+        "complexTypes": [],
+        "slug": "getaspectratio"
+      },
       {
         "name": "getHorizontalFov",
         "signature": "() => Promise<{ result: number; }>",
@@ -567,6 +615,36 @@
           "complexTypes": [],
           "type": "number | undefined"
         },
+        {
+          "name": "aspectRatio",
+          "tags": [
+            {
+              "text": "2.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The aspect ratio of the camera preview, '4:3' or '16:9'.\nIf not set, the camera will use the default aspect ratio.",
+          "complexTypes": [],
+          "type": "'4:3' | '16:9' | 'fill' | undefined"
+        },
+        {
+          "name": "gridMode",
+          "tags": [
+            {
+              "text": "\"none\"",
+              "name": "default"
+            },
+            {
+              "text": "2.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The grid overlay to display on the camera preview.",
+          "complexTypes": [
+            "GridMode"
+          ],
+          "type": "GridMode"
+        },
         {
           "name": "includeSafeAreaInsets",
           "tags": [
@@ -1160,6 +1238,25 @@
     }
   ],
   "typeAliases": [
+    {
+      "name": "GridMode",
+      "slug": "gridmode",
+      "docs": "",
+      "types": [
+        {
+          "text": "\"none\"",
+          "complexTypes": []
+        },
+        {
+          "text": "\"3x3\"",
+          "complexTypes": []
+        },
+        {
+          "text": "\"4x4\"",
+          "complexTypes": []
+        }
+      ]
+    },
     {
       "name": "CameraPosition",
       "slug": "cameraposition",

package/dist/esm/definitions.d.ts

@@ -1,5 +1,6 @@
 export type CameraPosition = "rear" | "front";
 export type FlashMode = CameraPreviewFlashMode;
+export type GridMode = "none" | "3x3" | "4x4";
 export declare enum DeviceType {
     ULTRA_WIDE = "ultraWide",
     WIDE_ANGLE = "wideAngle",
@@ -92,6 +93,19 @@ export interface CameraPreviewOptions {
      * @platform android, ios
      */
     y?: number;
+    /**
+     * The aspect ratio of the camera preview, '4:3' or '16:9'.
+     * If not set, the camera will use the default aspect ratio.
+     *
+     * @since 2.0.0
+     */
+    aspectRatio?: '4:3' | '16:9' | 'fill';
+    /**
+     * The grid overlay to display on the camera preview.
+     * @default "none"
+     * @since 2.1.0
+     */
+    gridMode?: GridMode;
     /**
      * Adjusts the y-position to account for safe areas (e.g., notches).
      * @platform ios
@@ -258,10 +272,19 @@ export interface CameraPreviewPlugin {
      * Starts the camera preview.
      *
      * @param {CameraPreviewOptions} options - The configuration for the camera preview.
-     * @returns {Promise<void>} A promise that resolves when the camera preview is started.
+     * @returns {Promise<{ width: number; height: number; x: number; y: number }>} A promise that resolves with the preview dimensions.
      * @since 0.0.1
      */
-    start(options: CameraPreviewOptions): Promise<void>;
+    start(options: CameraPreviewOptions): Promise<{
+        /** The width of the preview in pixels. */
+        width: number;
+        /** The height of the preview in pixels. */
+        height: number;
+        /** The horizontal origin of the preview, in pixels. */
+        x: number;
+        /** The vertical origin of the preview, in pixels. */
+        y: number;
+    }>;
     /**
      * Stops the camera preview.
      *
@@ -300,6 +323,25 @@ export interface CameraPreviewPlugin {
     getSupportedFlashModes(): Promise<{
         result: CameraPreviewFlashMode[];
     }>;
+    /**
+     * Set the aspect ratio of the camera preview.
+     *
+     * @param {{ aspectRatio: '4:3' | '16:9' | 'fill' }} options - The desired aspect ratio.
+     * @returns {Promise<void>} A promise that resolves when the aspect ratio is set.
+     * @since 7.4.0
+     */
+    setAspectRatio(options: {
+        aspectRatio: '4:3' | '16:9' | 'fill';
+    }): Promise<void>;
+    /**
+     * Gets the current aspect ratio of the camera preview.
+     *
+     * @returns {Promise<{ aspectRatio: '4:3' | '16:9' | 'fill' }>} A promise that resolves with the current aspect ratio.
+     * @since 7.4.0
+     */
+    getAspectRatio(): Promise<{
+        aspectRatio: '4:3' | '16:9' | 'fill';
+    }>;
     /**
      * Gets the horizontal field of view (FoV) for the active camera.
      * Note: This can be an estimate on some devices.

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAIA,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":["export type CameraPosition = \"rear\" | \"front\";\n\nexport type FlashMode = CameraPreviewFlashMode;\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   * 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, enables high-resolution image capture.\n   * @platform ios\n   * @default false\n   */\n  enableHighResolution?: 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\n/**\n * Defines the options for capturing a picture.\n */\nexport interface CameraPreviewPictureOptions {\n  /** The desired height of the picture in pixels. If not provided, the device default is used. */\n  height?: number;\n  /** The desired width of the picture in pixels. If not provided, the device default is used. */\n  width?: number;\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 =\n  | \"off\"\n  | \"on\"\n  | \"auto\"\n  | \"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<void>} A promise that resolves when the camera preview is started.\n   * @since 0.0.1\n   */\n  start(options: CameraPreviewOptions): Promise<void>;\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   * 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   * Sets the camera's zoom level.\n   *\n   * @param {{ level: number; ramp?: boolean }} options - The desired zoom level. `ramp` is currently unused.\n   * @returns {Promise<void>} A promise that resolves when the zoom level is set.\n   * @since 7.4.0\n   */\n  setZoom(options: { level: number; ramp?: boolean }): 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"]}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAMA,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":["export type CameraPosition = \"rear\" | \"front\";\n\nexport type FlashMode = CameraPreviewFlashMode;\n\nexport type GridMode = \"none\" | \"3x3\" | \"4x4\";\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'.\n   * If not set, the camera will use the default aspect ratio.\n   *\n   * @since 2.0.0\n   */\n  aspectRatio?: '4:3' | '16:9' | 'fill';\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, enables high-resolution image capture.\n   * @platform ios\n   * @default false\n   */\n  enableHighResolution?: 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\n/**\n * Defines the options for capturing a picture.\n */\nexport interface CameraPreviewPictureOptions {\n  /** The desired height of the picture in pixels. If not provided, the device default is used. */\n  height?: number;\n  /** The desired width of the picture in pixels. If not provided, the device default is used. */\n  width?: number;\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 =\n  | \"off\"\n  | \"on\"\n  | \"auto\"\n  | \"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' | 'fill' }} options - The desired aspect ratio.\n   * @returns {Promise<void>} A promise that resolves when the aspect ratio is set.\n   * @since 7.4.0\n   */\n  setAspectRatio(options: { aspectRatio: '4:3' | '16:9' | 'fill' }): Promise<void>;\n\n  /**\n   * Gets the current aspect ratio of the camera preview.\n   *\n   * @returns {Promise<{ aspectRatio: '4:3' | '16:9' | 'fill' }>} A promise that resolves with the current aspect ratio.\n   * @since 7.4.0\n   */\n  getAspectRatio(): Promise<{ aspectRatio: '4:3' | '16:9' | 'fill' }>;\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   * Sets the camera's zoom level.\n   *\n   * @param {{ level: number; ramp?: boolean }} options - The desired zoom level. `ramp` is currently unused.\n   * @returns {Promise<void>} A promise that resolves when the zoom level is set.\n   * @since 7.4.0\n   */\n  setZoom(options: { level: number; ramp?: boolean }): 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"]}

package/dist/esm/web.d.ts

@@ -7,11 +7,18 @@ export declare class CameraPreviewWeb extends WebPlugin implements CameraPreview
      */
     private isBackCamera;
     private currentDeviceId;
+    private videoElement;
+    private isStarted;
     constructor();
     getSupportedPictureSizes(): Promise<any>;
-    start(options: CameraPreviewOptions): Promise<void>;
+    start(options: CameraPreviewOptions): Promise<{
+        width: number;
+        height: number;
+        x: number;
+        y: number;
+    }>;
     private stopStream;
-    stop(): Promise<any>;
+    stop(): Promise<void>;
     capture(options: CameraPreviewPictureOptions): Promise<any>;
     captureSample(_options: CameraSampleOptions): Promise<any>;
     stopRecordVideo(): Promise<any>;
@@ -52,4 +59,11 @@ export declare class CameraPreviewWeb extends WebPlugin implements CameraPreview
     setDeviceId(options: {
         deviceId: string;
     }): Promise<void>;
+    getAspectRatio(): Promise<{
+        aspectRatio: '4:3' | '16:9' | 'fill';
+    }>;
+    setAspectRatio(options: {
+        aspectRatio: '4:3' | '16:9' | 'fill';
+    }): Promise<void>;
+    private createGridOverlay;
 }