@capgo/camera-preview 6.2.31 → 6.3.4

package/README.md

@@ -20,6 +20,40 @@ Use v5 for Capacitor 5 and below.
 
 -- [@riderx](https://github.com/riderx), current maintainers
 
+Remember to add the style below on your app's HTML or body element:
+
+```css
+:root {
+  --ion-background-color: transparent !important;
+}
+```
+
+Take into account that this will make transparent all ion-content on application, if you want to show camera preview only in one page, just add a custom class to your ion-content and make it transparent:
+
+```css
+.my-custom-camera-preview-content {
+  --background: transparent;
+}
+```
+
+If the camera preview is not displaying after applying the above styles, apply transparent background color to the root div element of the parent component
+Ex: VueJS >> App.vue component 
+```html
+<template>
+  <ion-app id="app">
+    <ion-router-outlet />
+  </ion-app>
+</template>
+
+<style>
+#app {
+  background-color: transparent !important;
+}
+<style>
+```
+
+If it don't work in dark mode here is issue who explain how to fix it: https://github.com/capacitor-community/camera-preview/issues/199
+
 <!-- # Features
 
 <ul>
@@ -99,7 +133,7 @@ Add `import '@capgo/camera-preview'` to you entry script in ionic on `app.module
 ### start(...)
 
 ```typescript
-start(options: CameraPreviewOptions) => any
+start(options: CameraPreviewOptions) => Promise<void>
 ```
 
 Start the camera preview instance.
@@ -108,8 +142,6 @@ Start the camera preview instance.
 | ------------- | --------------------------------------------------------------------- | -------------------------------------------- |
 | **`options`** | <code><a href="#camerapreviewoptions">CameraPreviewOptions</a></code> | the options to start the camera preview with |
 
-**Returns:** <code>any</code>
-
 **Since:** 0.0.1
 
 --------------------
@@ -118,13 +150,11 @@ Start the camera preview instance.
 ### stop()
 
 ```typescript
-stop() => any
+stop() => Promise<void>
 ```
 
 Stop the camera preview instance.
 
-**Returns:** <code>any</code>
-
 **Since:** 0.0.1
 
 --------------------
@@ -133,7 +163,7 @@ Stop the camera preview instance.
 ### capture(...)
 
 ```typescript
-capture(options: CameraPreviewPictureOptions) => any
+capture(options: CameraPreviewPictureOptions) => Promise<{ value: string; }>
 ```
 
 Switch camera.
@@ -142,7 +172,7 @@ Switch camera.
 | ------------- | ----------------------------------------------------------------------------------- | ------------------------------------- |
 | **`options`** | <code><a href="#camerapreviewpictureoptions">CameraPreviewPictureOptions</a></code> | the options to switch the camera with |
 
-**Returns:** <code>any</code>
+**Returns:** <code>Promise&lt;{ value: string; }&gt;</code>
 
 **Since:** 0.0.1
 
@@ -152,7 +182,7 @@ Switch camera.
 ### captureSample(...)
 
 ```typescript
-captureSample(options: CameraSampleOptions) => any
+captureSample(options: CameraSampleOptions) => Promise<{ value: string; }>
 ```
 
 Capture a sample image.
@@ -161,7 +191,7 @@ Capture a sample image.
 | ------------- | ------------------------------------------------------------------- | -------------------------------------------- |
 | **`options`** | <code><a href="#camerasampleoptions">CameraSampleOptions</a></code> | the options to capture the sample image with |
 
-**Returns:** <code>any</code>
+**Returns:** <code>Promise&lt;{ value: string; }&gt;</code>
 
 **Since:** 0.0.1
 
@@ -171,12 +201,12 @@ Capture a sample image.
 ### getSupportedFlashModes()
 
 ```typescript
-getSupportedFlashModes() => any
+getSupportedFlashModes() => Promise<{ result: CameraPreviewFlashMode[]; }>
 ```
 
 Get supported flash modes.
 
-**Returns:** <code>any</code>
+**Returns:** <code>Promise&lt;{ result: CameraPreviewFlashMode[]; }&gt;</code>
 
 **Since:** 0.0.1
 
@@ -186,12 +216,12 @@ Get supported flash modes.
 ### getHorizontalFov()
 
 ```typescript
-getHorizontalFov() => any
+getHorizontalFov() => Promise<{ result: any; }>
 ```
 
 Get horizontal field of view.
 
-**Returns:** <code>any</code>
+**Returns:** <code>Promise&lt;{ result: any; }&gt;</code>
 
 **Since:** 0.0.1
 
@@ -201,7 +231,7 @@ Get horizontal field of view.
 ### setFlashMode(...)
 
 ```typescript
-setFlashMode(options: { flashMode: CameraPreviewFlashMode | string; }) => any
+setFlashMode(options: { flashMode: CameraPreviewFlashMode | string; }) => Promise<void>
 ```
 
 Set flash mode.
@@ -210,8 +240,6 @@ Set flash mode.
 | ------------- | ----------------------------------- | -------------------------------------- |
 | **`options`** | <code>{ flashMode: string; }</code> | the options to set the flash mode with |
 
-**Returns:** <code>any</code>
-
 **Since:** 0.0.1
 
 --------------------
@@ -220,13 +248,11 @@ Set flash mode.
 ### flip()
 
 ```typescript
-flip() => any
+flip() => Promise<void>
 ```
 
 Flip camera.
 
-**Returns:** <code>any</code>
-
 **Since:** 0.0.1
 
 --------------------
@@ -235,7 +261,7 @@ Flip camera.
 ### setOpacity(...)
 
 ```typescript
-setOpacity(options: CameraOpacityOptions) => any
+setOpacity(options: CameraOpacityOptions) => Promise<void>
 ```
 
 Set opacity.
@@ -244,8 +270,6 @@ Set opacity.
 | ------------- | --------------------------------------------------------------------- | ------------------------------------------ |
 | **`options`** | <code><a href="#cameraopacityoptions">CameraOpacityOptions</a></code> | the options to set the camera opacity with |
 
-**Returns:** <code>any</code>
-
 **Since:** 0.0.1
 
 --------------------
@@ -254,12 +278,12 @@ Set opacity.
 ### stopRecordVideo()
 
 ```typescript
-stopRecordVideo() => any
+stopRecordVideo() => Promise<{ videoFilePath: string; }>
 ```
 
 Stop recording video.
 
-**Returns:** <code>any</code>
+**Returns:** <code>Promise&lt;{ videoFilePath: string; }&gt;</code>
 
 **Since:** 0.0.1
 
@@ -269,7 +293,7 @@ Stop recording video.
 ### startRecordVideo(...)
 
 ```typescript
-startRecordVideo(options: CameraPreviewOptions) => any
+startRecordVideo(options: CameraPreviewOptions) => Promise<void>
 ```
 
 Start recording video.
@@ -278,8 +302,6 @@ Start recording video.
 | ------------- | --------------------------------------------------------------------- | ----------------------------------------- |
 | **`options`** | <code><a href="#camerapreviewoptions">CameraPreviewOptions</a></code> | the options to start recording video with |
 
-**Returns:** <code>any</code>
-
 **Since:** 0.0.1
 
 --------------------

package/dist/docs.json

@@ -7,7 +7,7 @@
     "methods": [
       {
         "name": "start",
-        "signature": "(options: CameraPreviewOptions) => any",
+        "signature": "(options: CameraPreviewOptions) => Promise<void>",
         "parameters": [
           {
             "name": "options",
@@ -15,7 +15,7 @@
             "type": "CameraPreviewOptions"
           }
         ],
-        "returns": "any",
+        "returns": "Promise<void>",
         "tags": [
           {
             "name": "param",
@@ -42,9 +42,9 @@
       },
       {
         "name": "stop",
-        "signature": "() => any",
+        "signature": "() => Promise<void>",
         "parameters": [],
-        "returns": "any",
+        "returns": "Promise<void>",
         "tags": [
           {
             "name": "returns",
@@ -65,7 +65,7 @@
       },
       {
         "name": "capture",
-        "signature": "(options: CameraPreviewPictureOptions) => any",
+        "signature": "(options: CameraPreviewPictureOptions) => Promise<{ value: string; }>",
         "parameters": [
           {
             "name": "options",
@@ -73,7 +73,7 @@
             "type": "CameraPreviewPictureOptions"
           }
         ],
-        "returns": "any",
+        "returns": "Promise<{ value: string; }>",
         "tags": [
           {
             "name": "param",
@@ -100,7 +100,7 @@
       },
       {
         "name": "captureSample",
-        "signature": "(options: CameraSampleOptions) => any",
+        "signature": "(options: CameraSampleOptions) => Promise<{ value: string; }>",
         "parameters": [
           {
             "name": "options",
@@ -108,7 +108,7 @@
             "type": "CameraSampleOptions"
           }
         ],
-        "returns": "any",
+        "returns": "Promise<{ value: string; }>",
         "tags": [
           {
             "name": "param",
@@ -135,9 +135,9 @@
       },
       {
         "name": "getSupportedFlashModes",
-        "signature": "() => any",
+        "signature": "() => Promise<{ result: CameraPreviewFlashMode[]; }>",
         "parameters": [],
-        "returns": "any",
+        "returns": "Promise<{ result: CameraPreviewFlashMode[]; }>",
         "tags": [
           {
             "name": "returns",
@@ -160,9 +160,9 @@
       },
       {
         "name": "getHorizontalFov",
-        "signature": "() => any",
+        "signature": "() => Promise<{ result: any; }>",
         "parameters": [],
-        "returns": "any",
+        "returns": "Promise<{ result: any; }>",
         "tags": [
           {
             "name": "returns",
@@ -183,7 +183,7 @@
       },
       {
         "name": "setFlashMode",
-        "signature": "(options: { flashMode: CameraPreviewFlashMode | string; }) => any",
+        "signature": "(options: { flashMode: CameraPreviewFlashMode | string; }) => Promise<void>",
         "parameters": [
           {
             "name": "options",
@@ -191,7 +191,7 @@
             "type": "{ flashMode: string; }"
           }
         ],
-        "returns": "any",
+        "returns": "Promise<void>",
         "tags": [
           {
             "name": "param",
@@ -218,9 +218,9 @@
       },
       {
         "name": "flip",
-        "signature": "() => any",
+        "signature": "() => Promise<void>",
         "parameters": [],
-        "returns": "any",
+        "returns": "Promise<void>",
         "tags": [
           {
             "name": "returns",
@@ -241,7 +241,7 @@
       },
       {
         "name": "setOpacity",
-        "signature": "(options: CameraOpacityOptions) => any",
+        "signature": "(options: CameraOpacityOptions) => Promise<void>",
         "parameters": [
           {
             "name": "options",
@@ -249,7 +249,7 @@
             "type": "CameraOpacityOptions"
           }
         ],
-        "returns": "any",
+        "returns": "Promise<void>",
         "tags": [
           {
             "name": "param",
@@ -276,9 +276,9 @@
       },
       {
         "name": "stopRecordVideo",
-        "signature": "() => any",
+        "signature": "() => Promise<{ videoFilePath: string; }>",
         "parameters": [],
-        "returns": "any",
+        "returns": "Promise<{ videoFilePath: string; }>",
         "tags": [
           {
             "name": "param",
@@ -303,7 +303,7 @@
       },
       {
         "name": "startRecordVideo",
-        "signature": "(options: CameraPreviewOptions) => any",
+        "signature": "(options: CameraPreviewOptions) => Promise<void>",
         "parameters": [
           {
             "name": "options",
@@ -311,7 +311,7 @@
             "type": "CameraPreviewOptions"
           }
         ],
-        "returns": "any",
+        "returns": "Promise<void>",
         "tags": [
           {
             "name": "param",
@@ -352,63 +352,63 @@
           "tags": [],
           "docs": "Parent element to attach the video preview element to (applicable to the web platform only)",
           "complexTypes": [],
-          "type": "string"
+          "type": "string | undefined"
         },
         {
           "name": "className",
           "tags": [],
           "docs": "Class name to add to the video preview element (applicable to the web platform only)",
           "complexTypes": [],
-          "type": "string"
+          "type": "string | undefined"
         },
         {
           "name": "width",
           "tags": [],
           "docs": "The preview width in pixels, default window.screen.width",
           "complexTypes": [],
-          "type": "number"
+          "type": "number | undefined"
         },
         {
           "name": "height",
           "tags": [],
           "docs": "The preview height in pixels, default window.screen.height",
           "complexTypes": [],
-          "type": "number"
+          "type": "number | undefined"
         },
         {
           "name": "x",
           "tags": [],
           "docs": "The x origin, default 0 (applicable to the android and ios platforms only)",
           "complexTypes": [],
-          "type": "number"
+          "type": "number | undefined"
         },
         {
           "name": "y",
           "tags": [],
           "docs": "The y origin, default 0 (applicable to the android and ios platforms only)",
           "complexTypes": [],
-          "type": "number"
+          "type": "number | undefined"
         },
         {
           "name": "toBack",
           "tags": [],
           "docs": "Brings your html in front of your preview, default false (applicable to the android only)",
           "complexTypes": [],
-          "type": "boolean"
+          "type": "boolean | undefined"
         },
         {
           "name": "paddingBottom",
           "tags": [],
           "docs": "The preview bottom padding in pixes. Useful to keep the appropriate preview sizes when orientation changes (applicable to the android and ios platforms only)",
           "complexTypes": [],
-          "type": "number"
+          "type": "number | undefined"
         },
         {
           "name": "rotateWhenOrientationChanged",
           "tags": [],
           "docs": "Rotate preview when orientation changes (applicable to the ios platforms only; default value is true)",
           "complexTypes": [],
-          "type": "boolean"
+          "type": "boolean | undefined"
         },
         {
           "name": "position",
@@ -417,63 +417,63 @@
           "complexTypes": [
             "CameraPosition"
           ],
-          "type": "string"
+          "type": "string | undefined"
         },
         {
           "name": "storeToFile",
           "tags": [],
           "docs": "Defaults to false - Capture images to a file and return the file path instead of returning base64 encoded data",
           "complexTypes": [],
-          "type": "boolean"
+          "type": "boolean | undefined"
         },
         {
           "name": "disableExifHeaderStripping",
           "tags": [],
           "docs": "Defaults to false - Android Only - Disable automatic rotation of the image, and let the browser deal with it (keep reading on how to achieve it)",
           "complexTypes": [],
-          "type": "boolean"
+          "type": "boolean | undefined"
         },
         {
           "name": "enableHighResolution",
           "tags": [],
           "docs": "Defaults to false - iOS only - Activate high resolution image capture so that output images are from the highest resolution possible on the device *",
           "complexTypes": [],
-          "type": "boolean"
+          "type": "boolean | undefined"
         },
         {
           "name": "disableAudio",
           "tags": [],
           "docs": "Defaults to false - Web only - Disables audio stream to prevent permission requests and output switching",
           "complexTypes": [],
-          "type": "boolean"
+          "type": "boolean | undefined"
         },
         {
           "name": "lockAndroidOrientation",
           "tags": [],
           "docs": "Android Only - Locks device orientation when camera is showing.",
           "complexTypes": [],
-          "type": "boolean"
+          "type": "boolean | undefined"
         },
         {
           "name": "enableOpacity",
           "tags": [],
           "docs": "Defaults to false - Android and Web only.  Set if camera preview can change opacity.",
           "complexTypes": [],
-          "type": "boolean"
+          "type": "boolean | undefined"
         },
         {
           "name": "enableZoom",
           "tags": [],
           "docs": "Defaults to false - Android only.  Set if camera preview will support pinch to zoom.",
           "complexTypes": [],
-          "type": "boolean"
+          "type": "boolean | undefined"
         },
         {
           "name": "cameraMode",
           "tags": [],
           "docs": "default to false - IOS only. Set the CameraPreview to use the video mode preset",
           "complexTypes": [],
-          "type": "boolean"
+          "type": "boolean | undefined"
         }
       ]
     },
@@ -489,21 +489,21 @@
           "tags": [],
           "docs": "The picture height, optional, default 0 (Device default)",
           "complexTypes": [],
-          "type": "number"
+          "type": "number | undefined"
         },
         {
           "name": "width",
           "tags": [],
           "docs": "The picture width, optional, default 0 (Device default)",
           "complexTypes": [],
-          "type": "number"
+          "type": "number | undefined"
         },
         {
           "name": "quality",
           "tags": [],
           "docs": "The picture quality, 0 - 100, default 85",
           "complexTypes": [],
-          "type": "number"
+          "type": "number | undefined"
         },
         {
           "name": "format",
@@ -528,7 +528,7 @@
           "tags": [],
           "docs": "The picture quality, 0 - 100, default 85",
           "complexTypes": [],
-          "type": "number"
+          "type": "number | undefined"
         }
       ]
     },
@@ -544,7 +544,7 @@
           "tags": [],
           "docs": "The percent opacity to set for camera view, default 1",
           "complexTypes": [],
-          "type": "number"
+          "type": "number | undefined"
         }
       ]
     }

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["export type CameraPosition = \"rear\" | \"front\";\nexport interface CameraPreviewOptions {\n  /** Parent element to attach the video preview element to (applicable to the web platform only) */\n  parent?: string;\n  /** Class name to add to the video preview element (applicable to the web platform only) */\n  className?: string;\n  /** The preview width in pixels, default window.screen.width */\n  width?: number;\n  /** The preview height in pixels, default window.screen.height */\n  height?: number;\n  /** The x origin, default 0 (applicable to the android and ios platforms only) */\n  x?: number;\n  /** The y origin, default 0 (applicable to the android and ios platforms only) */\n  y?: number;\n  /**  Brings your html in front of your preview, default false (applicable to the android only) */\n  toBack?: boolean;\n  /** The preview bottom padding in pixes. Useful to keep the appropriate preview sizes when orientation changes (applicable to the android and ios platforms only) */\n  paddingBottom?: number;\n  /** Rotate preview when orientation changes (applicable to the ios platforms only; default value is true) */\n  rotateWhenOrientationChanged?: boolean;\n  /** Choose the camera to use 'front' or 'rear', default 'front' */\n  position?: CameraPosition | string;\n  /** Defaults to false - Capture images to a file and return the file path instead of returning base64 encoded data */\n  storeToFile?: boolean;\n  /** Defaults to false - Android Only - Disable automatic rotation of the image, and let the browser deal with it (keep reading on how to achieve it) */\n  disableExifHeaderStripping?: boolean;\n  /** Defaults to false - iOS only - Activate high resolution image capture so that output images are from the highest resolution possible on the device **/\n  enableHighResolution?: boolean;\n  /** Defaults to false - Web only - Disables audio stream to prevent permission requests and output switching */\n  disableAudio?: boolean;\n  /**  Android Only - Locks device orientation when camera is showing. */\n  lockAndroidOrientation?: boolean;\n  /** Defaults to false - Android and Web only.  Set if camera preview can change opacity. */\n  enableOpacity?: boolean;\n  /** Defaults to false - Android only.  Set if camera preview will support pinch to zoom. */\n  enableZoom?: boolean;\n  /** default to false - IOS only. Set the CameraPreview to use the video mode preset */\n  cameraMode?: boolean;\n}\n\nexport interface CameraPreviewPictureOptions {\n  /** The picture height, optional, default 0 (Device default) */\n  height?: number;\n  /** The picture width, optional, default 0 (Device default) */\n  width?: number;\n  /** The picture quality, 0 - 100, default 85 */\n  quality?: number;\n  /** The picture format, jpeg or png, default jpeg on `Web`.\n   *\n   * quality has no effect on png */\n  format?: PictureFormat;\n}\n\nexport type PictureFormat = \"jpeg\" | \"png\";\n\nexport interface CameraSampleOptions {\n  /** The picture quality, 0 - 100, default 85 */\n  quality?: number;\n}\n\nexport type CameraPreviewFlashMode =\n  | \"off\"\n  | \"on\"\n  | \"auto\"\n  | \"red-eye\"\n  | \"torch\";\n\nexport interface CameraOpacityOptions {\n  /** The percent opacity to set for camera view, default 1 */\n  opacity?: number;\n}\n\nexport interface CameraPreviewPlugin {\n  /**\n   * Start the camera preview instance.\n   * @param {CameraPreviewOptions} options the options to start the camera preview with\n   * @returns {Promise<void>} an Promise that resolves when the instance is started\n   * @throws An error if the something went wrong\n   * @since 0.0.1\n   */\n  start(options: CameraPreviewOptions): Promise<void>;\n  /**\n   * Stop the camera preview instance.\n   * @returns {Promise<void>} an Promise that resolves when the instance is stopped\n   * @throws An error if the something went wrong\n   * @since 0.0.1\n   */\n  stop(): Promise<void>;\n  /**\n   * Switch camera.\n   * @param {CameraPreviewOptions} options the options to switch the camera with\n   * @returns {Promise<void>} an Promise that resolves when the camera is switched\n   * @throws An error if the something went wrong\n   * @since 0.0.1\n   */\n  capture(options: CameraPreviewPictureOptions): Promise<{ value: string }>;\n  /**\n   * Capture a sample image.\n   * @param {CameraSampleOptions} options the options to capture the sample image with\n   * @returns {Promise<string>} an Promise that resolves with the sample image as a base64 encoded string\n   * @throws An error if the something went wrong\n   * @since 0.0.1\n   */\n  captureSample(options: CameraSampleOptions): Promise<{ value: string }>;\n  /**\n   * Get supported flash modes.\n   * @returns {Promise<CameraPreviewFlashMode[]>} an Promise that resolves with the supported flash modes\n   * @throws An error if the something went wrong\n   * @since 0.0.1\n   */\n  getSupportedFlashModes(): Promise<{\n    result: CameraPreviewFlashMode[];\n  }>;\n  /**\n   * Get horizontal field of view.\n   * @returns {Promise<any>} an Promise that resolves with the horizontal field of view\n   * @throws An error if the something went wrong\n   * @since 0.0.1\n   */\n  getHorizontalFov(): Promise<{\n    result: any;\n  }>;\n  /**\n   * Set flash mode.\n   * @param options the options to set the flash mode with\n   * @returns {Promise<void>} an Promise that resolves when the flash mode is set\n   * @throws An error if the something went wrong\n   * @since 0.0.1\n   */\n  setFlashMode(options: {\n    flashMode: CameraPreviewFlashMode | string;\n  }): Promise<void>;\n  /**\n   * Flip camera.\n   * @returns {Promise<void>} an Promise that resolves when the camera is flipped\n   * @throws An error if the something went wrong\n   * @since 0.0.1\n   */\n  flip(): Promise<void>;\n  /**\n   * Set opacity.\n   * @param {CameraOpacityOptions} options the options to set the camera opacity with\n   * @returns {Promise<void>} an Promise that resolves when the camera color effect is set\n   * @throws An error if the something went wrong\n   * @since 0.0.1\n   */\n  setOpacity(options: CameraOpacityOptions): Promise<void>;\n  /**\n   * Stop recording video.\n   * @param {CameraPreviewOptions} options the options to stop recording video with\n   * @returns {Promise<{videoFilePath: string}>} an Promise that resolves when the camera zoom is set\n   * @throws An error if the something went wrong\n   * @since 0.0.1\n   */\n  stopRecordVideo(): Promise<{videoFilePath: string}>;\n  /**\n   * Start recording video.\n   * @param {CameraPreviewOptions} options the options to start recording video with\n   * @returns {Promise<void>} an Promise that resolves when the video recording is started\n   * @throws An error if the something went wrong\n   * @since 0.0.1\n   */\n  startRecordVideo(options: CameraPreviewOptions): Promise<void>;\n}\n"]}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["export type CameraPosition = \"rear\" | \"front\";\nexport interface CameraPreviewOptions {\n  /** Parent element to attach the video preview element to (applicable to the web platform only) */\n  parent?: string;\n  /** Class name to add to the video preview element (applicable to the web platform only) */\n  className?: string;\n  /** The preview width in pixels, default window.screen.width */\n  width?: number;\n  /** The preview height in pixels, default window.screen.height */\n  height?: number;\n  /** The x origin, default 0 (applicable to the android and ios platforms only) */\n  x?: number;\n  /** The y origin, default 0 (applicable to the android and ios platforms only) */\n  y?: number;\n  /**  Brings your html in front of your preview, default false (applicable to the android only) */\n  toBack?: boolean;\n  /** The preview bottom padding in pixes. Useful to keep the appropriate preview sizes when orientation changes (applicable to the android and ios platforms only) */\n  paddingBottom?: number;\n  /** Rotate preview when orientation changes (applicable to the ios platforms only; default value is true) */\n  rotateWhenOrientationChanged?: boolean;\n  /** Choose the camera to use 'front' or 'rear', default 'front' */\n  position?: CameraPosition | string;\n  /** Defaults to false - Capture images to a file and return the file path instead of returning base64 encoded data */\n  storeToFile?: boolean;\n  /** Defaults to false - Android Only - Disable automatic rotation of the image, and let the browser deal with it (keep reading on how to achieve it) */\n  disableExifHeaderStripping?: boolean;\n  /** Defaults to false - iOS only - Activate high resolution image capture so that output images are from the highest resolution possible on the device **/\n  enableHighResolution?: boolean;\n  /** Defaults to false - Web only - Disables audio stream to prevent permission requests and output switching */\n  disableAudio?: boolean;\n  /**  Android Only - Locks device orientation when camera is showing. */\n  lockAndroidOrientation?: boolean;\n  /** Defaults to false - Android and Web only.  Set if camera preview can change opacity. */\n  enableOpacity?: boolean;\n  /** Defaults to false - Android only.  Set if camera preview will support pinch to zoom. */\n  enableZoom?: boolean;\n  /** default to false - IOS only. Set the CameraPreview to use the video mode preset */\n  cameraMode?: boolean;\n}\n\nexport interface CameraPreviewPictureOptions {\n  /** The picture height, optional, default 0 (Device default) */\n  height?: number;\n  /** The picture width, optional, default 0 (Device default) */\n  width?: number;\n  /** The picture quality, 0 - 100, default 85 */\n  quality?: number;\n  /** The picture format, jpeg or png, default jpeg on `Web`.\n   *\n   * quality has no effect on png */\n  format?: PictureFormat;\n}\n\nexport type PictureFormat = \"jpeg\" | \"png\";\n\nexport interface CameraSampleOptions {\n  /** The picture quality, 0 - 100, default 85 */\n  quality?: number;\n}\n\nexport type CameraPreviewFlashMode =\n  | \"off\"\n  | \"on\"\n  | \"auto\"\n  | \"red-eye\"\n  | \"torch\";\n\nexport interface CameraOpacityOptions {\n  /** The percent opacity to set for camera view, default 1 */\n  opacity?: number;\n}\n\nexport interface CameraPreviewPlugin {\n  /**\n   * Start the camera preview instance.\n   * @param {CameraPreviewOptions} options the options to start the camera preview with\n   * @returns {Promise<void>} an Promise that resolves when the instance is started\n   * @throws An error if the something went wrong\n   * @since 0.0.1\n   */\n  start(options: CameraPreviewOptions): Promise<void>;\n  /**\n   * Stop the camera preview instance.\n   * @returns {Promise<void>} an Promise that resolves when the instance is stopped\n   * @throws An error if the something went wrong\n   * @since 0.0.1\n   */\n  stop(): Promise<void>;\n  /**\n   * Switch camera.\n   * @param {CameraPreviewOptions} options the options to switch the camera with\n   * @returns {Promise<void>} an Promise that resolves when the camera is switched\n   * @throws An error if the something went wrong\n   * @since 0.0.1\n   */\n  capture(options: CameraPreviewPictureOptions): Promise<{ value: string }>;\n  /**\n   * Capture a sample image.\n   * @param {CameraSampleOptions} options the options to capture the sample image with\n   * @returns {Promise<string>} an Promise that resolves with the sample image as a base64 encoded string\n   * @throws An error if the something went wrong\n   * @since 0.0.1\n   */\n  captureSample(options: CameraSampleOptions): Promise<{ value: string }>;\n  /**\n   * Get supported flash modes.\n   * @returns {Promise<CameraPreviewFlashMode[]>} an Promise that resolves with the supported flash modes\n   * @throws An error if the something went wrong\n   * @since 0.0.1\n   */\n  getSupportedFlashModes(): Promise<{\n    result: CameraPreviewFlashMode[];\n  }>;\n  /**\n   * Get horizontal field of view.\n   * @returns {Promise<any>} an Promise that resolves with the horizontal field of view\n   * @throws An error if the something went wrong\n   * @since 0.0.1\n   */\n  getHorizontalFov(): Promise<{\n    result: any;\n  }>;\n  /**\n   * Set flash mode.\n   * @param options the options to set the flash mode with\n   * @returns {Promise<void>} an Promise that resolves when the flash mode is set\n   * @throws An error if the something went wrong\n   * @since 0.0.1\n   */\n  setFlashMode(options: {\n    flashMode: CameraPreviewFlashMode | string;\n  }): Promise<void>;\n  /**\n   * Flip camera.\n   * @returns {Promise<void>} an Promise that resolves when the camera is flipped\n   * @throws An error if the something went wrong\n   * @since 0.0.1\n   */\n  flip(): Promise<void>;\n  /**\n   * Set opacity.\n   * @param {CameraOpacityOptions} options the options to set the camera opacity with\n   * @returns {Promise<void>} an Promise that resolves when the camera color effect is set\n   * @throws An error if the something went wrong\n   * @since 0.0.1\n   */\n  setOpacity(options: CameraOpacityOptions): Promise<void>;\n  /**\n   * Stop recording video.\n   * @param {CameraPreviewOptions} options the options to stop recording video with\n   * @returns {Promise<{videoFilePath: string}>} an Promise that resolves when the camera zoom is set\n   * @throws An error if the something went wrong\n   * @since 0.0.1\n   */\n  stopRecordVideo(): Promise<{ videoFilePath: string }>;\n  /**\n   * Start recording video.\n   * @param {CameraPreviewOptions} options the options to start recording video with\n   * @returns {Promise<void>} an Promise that resolves when the video recording is started\n   * @throws An error if the something went wrong\n   * @since 0.0.1\n   */\n  startRecordVideo(options: CameraPreviewOptions): Promise<void>;\n}\n"]}

package/dist/esm/index.d.ts

@@ -1,4 +1,4 @@
-import type { CameraPreviewPlugin } from './definitions';
+import type { CameraPreviewPlugin } from "./definitions";
 declare const CameraPreview: CameraPreviewPlugin;
-export * from './definitions';
+export * from "./definitions";
 export { CameraPreview };

package/dist/esm/index.js

@@ -1,7 +1,7 @@
-import { registerPlugin } from '@capacitor/core';
-const CameraPreview = registerPlugin('CameraPreview', {
-    web: () => import('./web').then(m => new m.CameraPreviewWeb()),
+import { registerPlugin } from "@capacitor/core";
+const CameraPreview = registerPlugin("CameraPreview", {
+    web: () => import("./web").then((m) => new m.CameraPreviewWeb()),
 });
-export * from './definitions';
+export * from "./definitions";
 export { CameraPreview };
 //# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAA;AAIhD,MAAM,aAAa,GAAG,cAAc,CAAsB,eAAe,EAAE;IACzE,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,gBAAgB,EAAE,CAAC;CAC/D,CAAC,CAAA;AAEF,cAAc,eAAe,CAAA;AAC7B,OAAO,EAAE,aAAa,EAAE,CAAA","sourcesContent":["import { registerPlugin } from '@capacitor/core'\n\nimport type { CameraPreviewPlugin } from './definitions'\n\nconst CameraPreview = registerPlugin<CameraPreviewPlugin>('CameraPreview', {\n  web: () => import('./web').then(m => new m.CameraPreviewWeb()),\n})\n\nexport * from './definitions'\nexport { CameraPreview }\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAIjD,MAAM,aAAa,GAAG,cAAc,CAAsB,eAAe,EAAE;IACzE,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,gBAAgB,EAAE,CAAC;CACjE,CAAC,CAAC;AAEH,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,aAAa,EAAE,CAAC","sourcesContent":["import { registerPlugin } from \"@capacitor/core\";\n\nimport type { CameraPreviewPlugin } from \"./definitions\";\n\nconst CameraPreview = registerPlugin<CameraPreviewPlugin>(\"CameraPreview\", {\n  web: () => import(\"./web\").then((m) => new m.CameraPreviewWeb()),\n});\n\nexport * from \"./definitions\";\nexport { CameraPreview };\n"]}

package/dist/esm/web.d.ts

@@ -1,5 +1,5 @@
-import { WebPlugin } from '@capacitor/core';
-import type { CameraOpacityOptions, CameraPreviewFlashMode, CameraPreviewOptions, CameraPreviewPictureOptions, CameraPreviewPlugin, CameraSampleOptions } from './definitions';
+import { WebPlugin } from "@capacitor/core";
+import type { CameraOpacityOptions, CameraPreviewFlashMode, CameraPreviewOptions, CameraPreviewPictureOptions, CameraPreviewPlugin, CameraSampleOptions } from "./definitions";
 export declare class CameraPreviewWeb extends WebPlugin implements CameraPreviewPlugin {
     /**
      *  track which camera is used based on start options