@capgo/camera-preview 3.6.23 → 5.0.0

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

@@ -5,20 +5,20 @@ import android.view.MotionEvent;
 
 class TapGestureDetector extends GestureDetector.SimpleOnGestureListener {
 
-    private final String TAG = "TapGestureDetector";
+  private final String TAG = "TapGestureDetector";
 
-    @Override
-    public boolean onDown(MotionEvent e) {
-        return false;
-    }
+  @Override
+  public boolean onDown(MotionEvent e) {
+    return false;
+  }
 
-    @Override
-    public boolean onSingleTapUp(MotionEvent e) {
-        return true;
-    }
+  @Override
+  public boolean onSingleTapUp(MotionEvent e) {
+    return true;
+  }
 
-    @Override
-    public boolean onSingleTapConfirmed(MotionEvent e) {
-        return true;
-    }
+  @Override
+  public boolean onSingleTapConfirmed(MotionEvent e) {
+    return true;
+  }
 }

package/android/src/test/java/com/getcapacitor/ExampleUnitTest.java

@@ -11,8 +11,8 @@ import org.junit.Test;
  */
 public class ExampleUnitTest {
 
-    @Test
-    public void addition_isCorrect() throws Exception {
-        assertEquals(4, 2 + 2);
-    }
+  @Test
+  public void addition_isCorrect() throws Exception {
+    assertEquals(4, 2 + 2);
+  }
 }

package/dist/docs.json

@@ -11,13 +11,30 @@
         "parameters": [
           {
             "name": "options",
-            "docs": "",
+            "docs": "the options to start the camera preview with",
             "type": "CameraPreviewOptions"
           }
         ],
         "returns": "any",
-        "tags": [],
-        "docs": "",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options the options to start the camera preview with"
+          },
+          {
+            "name": "returns",
+            "text": "an Promise that resolves when the instance is started"
+          },
+          {
+            "name": "throws",
+            "text": "An error if the something went wrong"
+          },
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Start the camera preview instance.",
         "complexTypes": [
           "CameraPreviewOptions"
         ],
@@ -28,8 +45,21 @@
         "signature": "() => any",
         "parameters": [],
         "returns": "any",
-        "tags": [],
-        "docs": "",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "an Promise that resolves when the instance is stopped"
+          },
+          {
+            "name": "throws",
+            "text": "An error if the something went wrong"
+          },
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Stop the camera preview instance.",
         "complexTypes": [],
         "slug": "stop"
       },
@@ -39,13 +69,30 @@
         "parameters": [
           {
             "name": "options",
-            "docs": "",
+            "docs": "the options to switch the camera with",
             "type": "CameraPreviewPictureOptions"
           }
         ],
         "returns": "any",
-        "tags": [],
-        "docs": "",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options the options to switch the camera with"
+          },
+          {
+            "name": "returns",
+            "text": "an Promise that resolves when the camera is switched"
+          },
+          {
+            "name": "throws",
+            "text": "An error if the something went wrong"
+          },
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Switch camera.",
         "complexTypes": [
           "CameraPreviewPictureOptions"
         ],
@@ -57,13 +104,30 @@
         "parameters": [
           {
             "name": "options",
-            "docs": "",
+            "docs": "the options to capture the sample image with",
             "type": "CameraSampleOptions"
           }
         ],
         "returns": "any",
-        "tags": [],
-        "docs": "",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options the options to capture the sample image with"
+          },
+          {
+            "name": "returns",
+            "text": "an Promise that resolves with the sample image as a base64 encoded string"
+          },
+          {
+            "name": "throws",
+            "text": "An error if the something went wrong"
+          },
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Capture a sample image.",
         "complexTypes": [
           "CameraSampleOptions"
         ],
@@ -74,8 +138,21 @@
         "signature": "() => any",
         "parameters": [],
         "returns": "any",
-        "tags": [],
-        "docs": "",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "an Promise that resolves with the supported flash modes"
+          },
+          {
+            "name": "throws",
+            "text": "An error if the something went wrong"
+          },
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Get supported flash modes.",
         "complexTypes": [
           "CameraPreviewFlashMode"
         ],
@@ -86,8 +163,21 @@
         "signature": "() => any",
         "parameters": [],
         "returns": "any",
-        "tags": [],
-        "docs": "",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "an Promise that resolves with the horizontal field of view"
+          },
+          {
+            "name": "throws",
+            "text": "An error if the something went wrong"
+          },
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Get horizontal field of view.",
         "complexTypes": [],
         "slug": "gethorizontalfov"
       },
@@ -97,13 +187,30 @@
         "parameters": [
           {
             "name": "options",
-            "docs": "",
+            "docs": "the options to set the flash mode with",
             "type": "{ flashMode: string; }"
           }
         ],
         "returns": "any",
-        "tags": [],
-        "docs": "",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options the options to set the flash mode with"
+          },
+          {
+            "name": "returns",
+            "text": "an Promise that resolves when the flash mode is set"
+          },
+          {
+            "name": "throws",
+            "text": "An error if the something went wrong"
+          },
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Set flash mode.",
         "complexTypes": [
           "CameraPreviewFlashMode"
         ],
@@ -114,8 +221,21 @@
         "signature": "() => any",
         "parameters": [],
         "returns": "any",
-        "tags": [],
-        "docs": "",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "an Promise that resolves when the camera is flipped"
+          },
+          {
+            "name": "throws",
+            "text": "An error if the something went wrong"
+          },
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Flip camera.",
         "complexTypes": [],
         "slug": "flip"
       },
@@ -125,13 +245,30 @@
         "parameters": [
           {
             "name": "options",
-            "docs": "",
+            "docs": "the options to set the camera opacity with",
             "type": "CameraOpacityOptions"
           }
         ],
         "returns": "any",
-        "tags": [],
-        "docs": "",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options the options to set the camera opacity with"
+          },
+          {
+            "name": "returns",
+            "text": "an Promise that resolves when the camera color effect is set"
+          },
+          {
+            "name": "throws",
+            "text": "An error if the something went wrong"
+          },
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Set opacity.",
         "complexTypes": [
           "CameraOpacityOptions"
         ],
@@ -142,8 +279,25 @@
         "signature": "() => any",
         "parameters": [],
         "returns": "any",
-        "tags": [],
-        "docs": "",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options the options to stop recording video with"
+          },
+          {
+            "name": "returns",
+            "text": "an Promise that resolves when the camera zoom is set"
+          },
+          {
+            "name": "throws",
+            "text": "An error if the something went wrong"
+          },
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Stop recording video.",
         "complexTypes": [],
         "slug": "stoprecordvideo"
       },
@@ -153,13 +307,30 @@
         "parameters": [
           {
             "name": "options",
-            "docs": "",
+            "docs": "the options to start recording video with",
             "type": "CameraPreviewOptions"
           }
         ],
         "returns": "any",
-        "tags": [],
-        "docs": "",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options the options to start recording video with"
+          },
+          {
+            "name": "returns",
+            "text": "an Promise that resolves when the video recording is started"
+          },
+          {
+            "name": "throws",
+            "text": "An error if the something went wrong"
+          },
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Start recording video.",
         "complexTypes": [
           "CameraPreviewOptions"
         ],
@@ -379,11 +550,11 @@
       "docs": "",
       "types": [
         {
-          "text": "'rear'",
+          "text": "\"rear\"",
           "complexTypes": []
         },
         {
-          "text": "'front'",
+          "text": "\"front\"",
           "complexTypes": []
         }
       ]
@@ -394,11 +565,11 @@
       "docs": "",
       "types": [
         {
-          "text": "'jpeg'",
+          "text": "\"jpeg\"",
           "complexTypes": []
         },
         {
-          "text": "'png'",
+          "text": "\"png\"",
           "complexTypes": []
         }
       ]
@@ -409,23 +580,23 @@
       "docs": "",
       "types": [
         {
-          "text": "'off'",
+          "text": "\"off\"",
           "complexTypes": []
         },
         {
-          "text": "'on'",
+          "text": "\"on\"",
           "complexTypes": []
         },
         {
-          "text": "'auto'",
+          "text": "\"auto\"",
           "complexTypes": []
         },
         {
-          "text": "'red-eye'",
+          "text": "\"red-eye\"",
           "complexTypes": []
         },
         {
-          "text": "'torch'",
+          "text": "\"torch\"",
           "complexTypes": []
         }
       ]

package/dist/esm/definitions.d.ts

@@ -1,4 +1,4 @@
-export type CameraPosition = 'rear' | 'front';
+export type CameraPosition = "rear" | "front";
 export interface CameraPreviewOptions {
     /** Parent element to attach the video preview element to (applicable to the web platform only) */
     parent?: string;
@@ -47,36 +47,109 @@ export interface CameraPreviewPictureOptions {
      * quality has no effect on png */
     format?: PictureFormat;
 }
-export type PictureFormat = 'jpeg' | 'png';
+export type PictureFormat = "jpeg" | "png";
 export interface CameraSampleOptions {
     /** The picture quality, 0 - 100, default 85 */
     quality?: number;
 }
-export type CameraPreviewFlashMode = 'off' | 'on' | 'auto' | 'red-eye' | 'torch';
+export type CameraPreviewFlashMode = "off" | "on" | "auto" | "red-eye" | "torch";
 export interface CameraOpacityOptions {
     /** The percent opacity to set for camera view, default 1 */
     opacity?: number;
 }
 export interface CameraPreviewPlugin {
+    /**
+     * Start the camera preview instance.
+     * @param {CameraPreviewOptions} options the options to start the camera preview with
+     * @returns {Promise<void>} an Promise that resolves when the instance is started
+     * @throws An error if the something went wrong
+     * @since 0.0.1
+     */
     start(options: CameraPreviewOptions): Promise<void>;
+    /**
+     * Stop the camera preview instance.
+     * @returns {Promise<void>} an Promise that resolves when the instance is stopped
+     * @throws An error if the something went wrong
+     * @since 0.0.1
+     */
     stop(): Promise<void>;
+    /**
+     * Switch camera.
+     * @param {CameraPreviewOptions} options the options to switch the camera with
+     * @returns {Promise<void>} an Promise that resolves when the camera is switched
+     * @throws An error if the something went wrong
+     * @since 0.0.1
+     */
     capture(options: CameraPreviewPictureOptions): Promise<{
         value: string;
     }>;
+    /**
+     * Capture a sample image.
+     * @param {CameraSampleOptions} options the options to capture the sample image with
+     * @returns {Promise<string>} an Promise that resolves with the sample image as a base64 encoded string
+     * @throws An error if the something went wrong
+     * @since 0.0.1
+     */
     captureSample(options: CameraSampleOptions): Promise<{
         value: string;
     }>;
+    /**
+     * Get supported flash modes.
+     * @returns {Promise<CameraPreviewFlashMode[]>} an Promise that resolves with the supported flash modes
+     * @throws An error if the something went wrong
+     * @since 0.0.1
+     */
     getSupportedFlashModes(): Promise<{
         result: CameraPreviewFlashMode[];
     }>;
+    /**
+     * Get horizontal field of view.
+     * @returns {Promise<any>} an Promise that resolves with the horizontal field of view
+     * @throws An error if the something went wrong
+     * @since 0.0.1
+     */
     getHorizontalFov(): Promise<{
         result: any;
     }>;
+    /**
+     * Set flash mode.
+     * @param options the options to set the flash mode with
+     * @returns {Promise<void>} an Promise that resolves when the flash mode is set
+     * @throws An error if the something went wrong
+     * @since 0.0.1
+     */
     setFlashMode(options: {
         flashMode: CameraPreviewFlashMode | string;
     }): Promise<void>;
+    /**
+     * Flip camera.
+     * @returns {Promise<void>} an Promise that resolves when the camera is flipped
+     * @throws An error if the something went wrong
+     * @since 0.0.1
+     */
     flip(): Promise<void>;
+    /**
+     * Set opacity.
+     * @param {CameraOpacityOptions} options the options to set the camera opacity with
+     * @returns {Promise<void>} an Promise that resolves when the camera color effect is set
+     * @throws An error if the something went wrong
+     * @since 0.0.1
+     */
     setOpacity(options: CameraOpacityOptions): Promise<void>;
+    /**
+     * Stop recording video.
+     * @param {CameraPreviewOptions} options the options to stop recording video with
+     * @returns {Promise<void>} an Promise that resolves when the camera zoom is set
+     * @throws An error if the something went wrong
+     * @since 0.0.1
+     */
     stopRecordVideo(): Promise<void>;
+    /**
+     * Start recording video.
+     * @param {CameraPreviewOptions} options the options to start recording video with
+     * @returns {Promise<void>} an Promise that resolves when the video recording is started
+     * @throws An error if the something went wrong
+     * @since 0.0.1
+     */
     startRecordVideo(options: CameraPreviewOptions): Promise<void>;
 }

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/web.d.ts

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