@capgo/camera-preview 7.4.0-beta.8 → 7.4.0

package/dist/docs.json

@@ -141,7 +141,7 @@
       },
       {
         "name": "setAspectRatio",
-        "signature": "(options: { aspectRatio: '4:3' | '16:9'; x?: number; y?: number; }) => Promise<{ width: number; height: number; x: number; y: number; }>",
+        "signature": "(options: { aspectRatio: \"4:3\" | \"16:9\"; x?: number; y?: number; }) => Promise<{ width: number; height: number; x: number; y: number; }>",
         "parameters": [
           {
             "name": "options",
@@ -161,7 +161,11 @@
           },
           {
             "name": "since",
-            "text": "7.4.0"
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
           }
         ],
         "docs": "Set the aspect ratio of the camera preview.",
@@ -170,7 +174,7 @@
       },
       {
         "name": "getAspectRatio",
-        "signature": "() => Promise<{ aspectRatio: '4:3' | '16:9'; }>",
+        "signature": "() => Promise<{ aspectRatio: \"4:3\" | \"16:9\"; }>",
         "parameters": [],
         "returns": "Promise<{ aspectRatio: '4:3' | '16:9'; }>",
         "tags": [
@@ -180,7 +184,11 @@
           },
           {
             "name": "since",
-            "text": "7.4.0"
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
           }
         ],
         "docs": "Gets the current aspect ratio of the camera preview.",
@@ -422,7 +430,11 @@
           },
           {
             "name": "since",
-            "text": "7.4.0"
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
           }
         ],
         "docs": "Checks if the camera preview is currently running.",
@@ -441,7 +453,11 @@
           },
           {
             "name": "since",
-            "text": "7.4.0"
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
           }
         ],
         "docs": "Gets all available camera devices.",
@@ -462,7 +478,11 @@
           },
           {
             "name": "since",
-            "text": "7.4.0"
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
           }
         ],
         "docs": "Gets the current zoom state, including min/max and current lens info.",
@@ -471,21 +491,40 @@
         ],
         "slug": "getzoom"
       },
+      {
+        "name": "getZoomButtonValues",
+        "signature": "() => Promise<{ values: number[]; }>",
+        "parameters": [],
+        "returns": "Promise<{ values: number[]; }>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
+          }
+        ],
+        "docs": "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",
+        "complexTypes": [],
+        "slug": "getzoombuttonvalues"
+      },
       {
         "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",
@@ -493,10 +532,14 @@
           },
           {
             "name": "since",
-            "text": "7.4.0"
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
           }
         ],
-        "docs": "Sets the camera's zoom level.",
+        "docs": "Sets the zoom level of the camera.",
         "complexTypes": [],
         "slug": "setzoom"
       },
@@ -512,7 +555,11 @@
           },
           {
             "name": "since",
-            "text": "7.4.0"
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
           }
         ],
         "docs": "Gets the current flash mode.",
@@ -529,7 +576,11 @@
         "tags": [
           {
             "name": "since",
-            "text": "7.4.0"
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
           }
         ],
         "docs": "Removes all registered listeners.",
@@ -558,7 +609,11 @@
           },
           {
             "name": "since",
-            "text": "7.4.0"
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
           }
         ],
         "docs": "Switches the active camera to the one with the specified `deviceId`.",
@@ -577,7 +632,11 @@
           },
           {
             "name": "since",
-            "text": "7.4.0"
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
           }
         ],
         "docs": "Gets the ID of the currently active camera device.",
@@ -592,6 +651,14 @@
         "tags": [
           {
             "name": "returns"
+          },
+          {
+            "name": "since",
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
           }
         ],
         "docs": "Gets the current preview size and position.",
@@ -600,12 +667,12 @@
       },
       {
         "name": "setPreviewSize",
-        "signature": "(options: { x: number; y: number; width: number; height: number; }) => Promise<{ width: number; height: number; x: number; y: number; }>",
+        "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; y: number; width: number; height: number; }"
+            "type": "{ x?: number | undefined; y?: number | undefined; width: number; height: number; }"
           }
         ],
         "returns": "Promise<{ width: number; height: number; x: number; y: number; }>",
@@ -617,11 +684,204 @@
           {
             "name": "returns",
             "text": "A promise that resolves with the actual preview dimensions and position."
+          },
+          {
+            "name": "since",
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
           }
         ],
         "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": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
+          }
+        ],
+        "docs": "Sets the camera focus to a specific point in the preview.",
+        "complexTypes": [],
+        "slug": "setfocus"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: \"screenResize\", listenerFunc: (data: { width: number; height: number; x: number; y: number; }) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "- The event name to listen for.",
+            "type": "'screenResize'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "- The function to call when the event is triggered.",
+            "type": "(data: { width: number; height: number; x: number; y: number; }) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "eventName - The event name to listen for."
+          },
+          {
+            "name": "param",
+            "text": "listenerFunc - The function to call when the event is triggered."
+          },
+          {
+            "name": "returns",
+            "text": "A promise that resolves with a handle to the listener."
+          },
+          {
+            "name": "since",
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
+          }
+        ],
+        "docs": "Adds a listener for screen resize events.",
+        "complexTypes": [
+          "PluginListenerHandle"
+        ],
+        "slug": "addlistenerscreenresize-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: \"orientationChange\", listenerFunc: (data: { orientation: DeviceOrientation; }) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "- The event name to listen for.",
+            "type": "'orientationChange'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "- The function to call when the event is triggered.",
+            "type": "(data: { orientation: DeviceOrientation; }) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "eventName - The event name to listen for."
+          },
+          {
+            "name": "param",
+            "text": "listenerFunc - The function to call when the event is triggered."
+          },
+          {
+            "name": "returns",
+            "text": "A promise that resolves with a handle to the listener."
+          },
+          {
+            "name": "since",
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
+          }
+        ],
+        "docs": "Adds a listener for orientation change events.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "DeviceOrientation"
+        ],
+        "slug": "addlistenerorientationchange-"
+      },
+      {
+        "name": "deleteFile",
+        "signature": "(options: { path: string; }) => Promise<{ success: boolean; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ path: string; }"
+          }
+        ],
+        "returns": "Promise<{ success: boolean; }>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
+          }
+        ],
+        "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, ios"
+          }
+        ],
+        "docs": "Gets the safe area insets for devices.\nReturns the orientation-aware notch/camera cutout inset and the current orientation.\nIn portrait mode: returns top inset (notch at top).\nIn landscape mode: returns left inset (notch moved to side).\nThis specifically targets the cutout area (notch, punch hole, etc.) that all modern phones have.\n\nAndroid: Values returned in dp (logical pixels).\niOS: Values returned in physical pixels, excluding status bar (only pure notch/cutout size).",
+        "complexTypes": [
+          "SafeAreaInsets"
+        ],
+        "slug": "getsafeareainsets"
+      },
+      {
+        "name": "getOrientation",
+        "signature": "() => Promise<{ orientation: DeviceOrientation; }>",
+        "parameters": [],
+        "returns": "Promise<{ orientation: DeviceOrientation; }>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
+          }
+        ],
+        "docs": "Gets the current device orientation in a cross-platform format.",
+        "complexTypes": [
+          "DeviceOrientation"
+        ],
+        "slug": "getorientation"
       }
     ],
     "properties": []
@@ -716,7 +976,7 @@
           ],
           "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' | 'fill' | undefined"
+          "type": "'4:3' | '16:9' | undefined"
         },
         {
           "name": "gridMode",
@@ -838,22 +1098,6 @@
           "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": [
@@ -941,6 +1185,48 @@
           "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"
+        },
+        {
+          "name": "positioning",
+          "tags": [
+            {
+              "text": "\"center\"",
+              "name": "default"
+            },
+            {
+              "text": "android, ios, web",
+              "name": "platform"
+            },
+            {
+              "text": "2.3.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The vertical positioning of the camera preview.",
+          "complexTypes": [
+            "CameraPositioning"
+          ],
+          "type": "CameraPositioning"
         }
       ]
     },
@@ -961,18 +1247,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": [
@@ -1276,6 +1588,45 @@
           "type": "number"
         }
       ]
+    },
+    {
+      "name": "PluginListenerHandle",
+      "slug": "pluginlistenerhandle",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "remove",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "() => Promise<void>"
+        }
+      ]
+    },
+    {
+      "name": "SafeAreaInsets",
+      "slug": "safeareainsets",
+      "docs": "Represents safe area insets for devices.\nAndroid: Values are expressed in logical pixels (dp) to match JS layout units.\niOS: Values are expressed in physical pixels and exclude status bar.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "orientation",
+          "tags": [],
+          "docs": "Current device orientation (1 = portrait, 2 = landscape, 0 = unknown).",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "top",
+          "tags": [],
+          "docs": "Orientation-aware notch/camera cutout inset (excluding status bar).\nIn portrait mode: returns top inset (notch at top).\nIn landscape mode: returns left inset (notch at side).\nAndroid: Value in dp, iOS: Value in pixels (status bar excluded).",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
     }
   ],
   "enums": [
@@ -1363,6 +1714,25 @@
         }
       ]
     },
+    {
+      "name": "CameraPositioning",
+      "slug": "camerapositioning",
+      "docs": "",
+      "types": [
+        {
+          "text": "\"center\"",
+          "complexTypes": []
+        },
+        {
+          "text": "\"top\"",
+          "complexTypes": []
+        },
+        {
+          "text": "\"bottom\"",
+          "complexTypes": []
+        }
+      ]
+    },
     {
       "name": "PictureFormat",
       "slug": "pictureformat",
@@ -1413,6 +1783,37 @@
           ]
         }
       ]
+    },
+    {
+      "name": "DeviceOrientation",
+      "slug": "deviceorientation",
+      "docs": "Canonical device orientation values across platforms.",
+      "types": [
+        {
+          "text": "\"portrait\"",
+          "complexTypes": []
+        },
+        {
+          "text": "\"landscape\"",
+          "complexTypes": []
+        },
+        {
+          "text": "\"landscape-left\"",
+          "complexTypes": []
+        },
+        {
+          "text": "\"landscape-right\"",
+          "complexTypes": []
+        },
+        {
+          "text": "\"portrait-upside-down\"",
+          "complexTypes": []
+        },
+        {
+          "text": "\"unknown\"",
+          "complexTypes": []
+        }
+      ]
     }
   ],
   "pluginConfigs": []