@capgo/camera-preview 7.4.0-beta.2 → 7.4.0-beta.20

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

@@ -4,31 +4,32 @@ package com.ahm.capacitor.camera.preview.model;
  * Represents zoom factor information for a camera with current lens details.
  */
 public class ZoomFactors {
-    private final float min;
-    private final float max;
-    private final float current;
-    private final LensInfo lens;
 
-    public ZoomFactors(float min, float max, float current, LensInfo lens) {
-        this.min = min;
-        this.max = max;
-        this.current = current;
-        this.lens = lens;
-    }
+  private final float min;
+  private final float max;
+  private final float current;
+  private final LensInfo lens;
 
-    public float getMin() {
-        return min;
-    }
+  public ZoomFactors(float min, float max, float current, LensInfo lens) {
+    this.min = min;
+    this.max = max;
+    this.current = current;
+    this.lens = lens;
+  }
 
-    public float getMax() {
-        return max;
-    }
+  public float getMin() {
+    return min;
+  }
 
-    public float getCurrent() {
-        return current;
-    }
+  public float getMax() {
+    return max;
+  }
 
-    public LensInfo getLens() {
-        return lens;
-    }
-} 
+  public float getCurrent() {
+    return current;
+  }
+
+  public LensInfo getLens() {
+    return lens;
+  }
+}

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,106 @@
         ],
         "slug": "getsupportedflashmodes"
       },
+      {
+        "name": "setAspectRatio",
+        "signature": "(options: { aspectRatio: \"4:3\" | \"16:9\"; x?: number; y?: number; }) => Promise<{ width: number; height: number; x: number; y: number; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "- 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.",
+            "type": "{ aspectRatio: '4:3' | '16:9'; x?: number | undefined; y?: number | undefined; }"
+          }
+        ],
+        "returns": "Promise<{ width: number; height: number; x: number; y: number; }>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "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."
+          },
+          {
+            "name": "returns",
+            "text": "A promise that resolves with the actual preview dimensions and position."
+          },
+          {
+            "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\"; }>",
+        "parameters": [],
+        "returns": "Promise<{ aspectRatio: '4:3' | '16:9'; }>",
+        "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": "setGridMode",
+        "signature": "(options: { gridMode: GridMode; }) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "- The desired grid mode ('none', '3x3', or '4x4').",
+            "type": "{ gridMode: GridMode; }"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options - The desired grid mode ('none', '3x3', or '4x4')."
+          },
+          {
+            "name": "returns",
+            "text": "A promise that resolves when the grid mode is set."
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "Sets the grid mode of the camera preview overlay.",
+        "complexTypes": [
+          "GridMode"
+        ],
+        "slug": "setgridmode"
+      },
+      {
+        "name": "getGridMode",
+        "signature": "() => Promise<{ gridMode: GridMode; }>",
+        "parameters": [],
+        "returns": "Promise<{ gridMode: GridMode; }>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "A promise that resolves with the current grid mode."
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "Gets the current grid mode of the camera preview overlay.",
+        "complexTypes": [
+          "GridMode"
+        ],
+        "slug": "getgridmode"
+      },
       {
         "name": "getHorizontalFov",
         "signature": "() => Promise<{ result: number; }>",
@@ -373,19 +473,19 @@
       },
       {
         "name": "setZoom",
-        "signature": "(options: { level: number; ramp?: boolean; }) => Promise<void>",
+        "signature": "(options: { level: number; ramp?: boolean; autoFocus?: boolean; }) => Promise<void>",
         "parameters": [
           {
             "name": "options",
-            "docs": "- The desired zoom level. `ramp` is currently unused.",
-            "type": "{ level: number; ramp?: boolean | undefined; }"
+            "docs": "- The desired zoom level. `ramp` is currently unused. `autoFocus` defaults to true.",
+            "type": "{ level: number; ramp?: boolean | undefined; autoFocus?: boolean | undefined; }"
           }
         ],
         "returns": "Promise<void>",
         "tags": [
           {
             "name": "param",
-            "text": "options - The desired zoom level. `ramp` is currently unused."
+            "text": "options - The desired zoom level. `ramp` is currently unused. `autoFocus` defaults to true."
           },
           {
             "name": "returns",
@@ -396,7 +496,7 @@
             "text": "7.4.0"
           }
         ],
-        "docs": "Sets the camera's zoom level.",
+        "docs": "Sets the zoom level of the camera.",
         "complexTypes": [],
         "slug": "setzoom"
       },
@@ -483,6 +583,74 @@
         "docs": "Gets the ID of the currently active camera device.",
         "complexTypes": [],
         "slug": "getdeviceid"
+      },
+      {
+        "name": "getPreviewSize",
+        "signature": "() => Promise<{ x: number; y: number; width: number; height: number; }>",
+        "parameters": [],
+        "returns": "Promise<{ x: number; y: number; width: number; height: number; }>",
+        "tags": [
+          {
+            "name": "returns"
+          }
+        ],
+        "docs": "Gets the current preview size and position.",
+        "complexTypes": [],
+        "slug": "getpreviewsize"
+      },
+      {
+        "name": "setPreviewSize",
+        "signature": "(options: { x?: number; y?: number; width: number; height: number; }) => Promise<{ width: number; height: number; x: number; y: number; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "The new position and dimensions.",
+            "type": "{ x?: number | undefined; y?: number | undefined; width: number; height: number; }"
+          }
+        ],
+        "returns": "Promise<{ width: number; height: number; x: number; y: number; }>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options The new position and dimensions."
+          },
+          {
+            "name": "returns",
+            "text": "A promise that resolves with the actual preview dimensions and position."
+          }
+        ],
+        "docs": "Sets the preview size and position.",
+        "complexTypes": [],
+        "slug": "setpreviewsize"
+      },
+      {
+        "name": "setFocus",
+        "signature": "(options: { x: number; y: number; }) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "- The focus options.",
+            "type": "{ x: number; y: number; }"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options - The focus options."
+          },
+          {
+            "name": "returns",
+            "text": "A promise that resolves when the focus is set."
+          },
+          {
+            "name": "since",
+            "text": "8.1.0"
+          }
+        ],
+        "docs": "Sets the camera focus to a specific point in the preview.",
+        "complexTypes": [],
+        "slug": "setfocus"
       }
     ],
     "properties": []
@@ -567,6 +735,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' or 'fill'.\nCannot be set if width or height is provided, otherwise the call will be rejected.\nUse setPreviewSize to adjust size after starting.",
+          "complexTypes": [],
+          "type": "'4:3' | '16:9' | 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": [
@@ -669,27 +867,11 @@
           "complexTypes": [],
           "type": "boolean | undefined"
         },
-        {
-          "name": "enableHighResolution",
-          "tags": [
-            {
-              "text": "ios",
-              "name": "platform"
-            },
-            {
-              "text": "false",
-              "name": "default"
-            }
-          ],
-          "docs": "If true, enables high-resolution image capture.",
-          "complexTypes": [],
-          "type": "boolean | undefined"
-        },
         {
           "name": "disableAudio",
           "tags": [
             {
-              "text": "false",
+              "text": "true",
               "name": "default"
             }
           ],
@@ -772,6 +954,26 @@
           "docs": "The `deviceId` of the camera to use. If provided, `position` is ignored.",
           "complexTypes": [],
           "type": "string | undefined"
+        },
+        {
+          "name": "initialZoomLevel",
+          "tags": [
+            {
+              "text": "1.0",
+              "name": "default"
+            },
+            {
+              "text": "android, ios",
+              "name": "platform"
+            },
+            {
+              "text": "2.2.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The initial zoom level when starting the camera preview.\nIf the requested zoom level is not available, the native plugin will reject.",
+          "complexTypes": [],
+          "type": "number | undefined"
         }
       ]
     },
@@ -792,18 +994,44 @@
       "properties": [
         {
           "name": "height",
-          "tags": [],
-          "docs": "The desired height of the picture in pixels. If not provided, the device default is used.",
+          "tags": [
+            {
+              "text": ",\nThe desired height of the picture in pixels. \nIf not specified and no aspectRatio is provided, the captured image will match the preview's visible area.",
+              "name": "deprecated"
+            }
+          ],
+          "docs": "",
           "complexTypes": [],
           "type": "number | undefined"
         },
         {
           "name": "width",
-          "tags": [],
-          "docs": "The desired width of the picture in pixels. If not provided, the device default is used.",
+          "tags": [
+            {
+              "text": ",\nThe desired width of the picture in pixels. \nIf not specified and no aspectRatio is provided, the captured image will match the preview's visible area.",
+              "name": "deprecated"
+            }
+          ],
+          "docs": "",
           "complexTypes": [],
           "type": "number | undefined"
         },
+        {
+          "name": "aspectRatio",
+          "tags": [
+            {
+              "text": ",\nThe desired aspect ratio of the captured image (e.g., '4:3', '16:9').\nIf not specified and no width/height is provided, the aspect ratio from the camera start will be used.\nIf no aspect ratio was set at start, defaults to '4:3'.\nCannot be used together with width or height - the capture will be rejected with an error.",
+              "name": "deprecated"
+            },
+            {
+              "text": "7.7.0",
+              "name": "since"
+            }
+          ],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
         {
           "name": "quality",
           "tags": [
@@ -845,6 +1073,22 @@
           "docs": "If true, the captured image will be saved to the user's gallery.",
           "complexTypes": [],
           "type": "boolean | undefined"
+        },
+        {
+          "name": "withExifLocation",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            },
+            {
+              "text": "7.6.0",
+              "name": "since"
+            }
+          ],
+          "docs": "If true, the plugin will attempt to add GPS location data to the image's EXIF metadata.\nThis may prompt the user for location permissions.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
         }
       ]
     },
@@ -1144,6 +1388,25 @@
     }
   ],
   "typeAliases": [
+    {
+      "name": "GridMode",
+      "slug": "gridmode",
+      "docs": "",
+      "types": [
+        {
+          "text": "\"none\"",
+          "complexTypes": []
+        },
+        {
+          "text": "\"3x3\"",
+          "complexTypes": []
+        },
+        {
+          "text": "\"4x4\"",
+          "complexTypes": []
+        }
+      ]
+    },
     {
       "name": "CameraPosition",
       "slug": "cameraposition",