@microblink/camera-manager 7.2.1 → 7.2.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microblink/camera-manager",
-  "version": "7.2.1",
+  "version": "7.2.3",
   "author": "Microblink",
   "type": "module",
   "main": "./dist/camera-manager.js",

package/types/core/Camera.d.ts

@@ -4,6 +4,9 @@
 export type FacingMode = "front" | "back" | undefined;
 /**
  * Available video resolutions for the camera stream.
+ *
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackConstraints/width for width details.
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackConstraints/height for height details.
  */
 export declare const videoResolutions: {
     readonly "720p": {
@@ -19,20 +22,61 @@ export declare const videoResolutions: {
         readonly height: 2160;
     };
 };
+/**
+ * Represents a video resolution.
+ *
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackConstraints/width for width details.
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackConstraints/height for height details.
+ */
 export type Resolution = {
     width: number;
     height: number;
 };
+/**
+ * Represents a video resolution name.
+ *
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackConstraints/width for width details.
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackConstraints/height for height details.
+ */
 export type VideoResolutionName = keyof typeof videoResolutions;
+/**
+ * Returns the longer side of a resolution.
+ *
+ * @param resolution - The resolution to get the longer side of.
+ * @returns The longer side of the resolution.
+ */
 export declare function returnLongerSide(resolution: Resolution): number;
+/**
+ * Normalizes a resolution to the longer side.
+ *
+ * @param resolution - The resolution to normalize.
+ * @returns The normalized resolution.
+ */
 export declare function getNormalizedResolution(resolution: Resolution): Resolution;
+/**
+ * Matches the closest resolution to the given resolution.
+ *
+ * @param resolution - The resolution to match.
+ * @returns The closest resolution.
+ */
 export declare function matchClosestResolution(resolution: Resolution): VideoResolutionName;
+/**
+ * Finds the closest resolution key to the given resolution.
+ *
+ * @param videoTrackResolution - The resolution to find the closest key for.
+ * @returns The closest resolution key.
+ */
 export declare function findResolutionKey(videoTrackResolution: Resolution): VideoResolutionName;
 /**
  * Represents a camera device and its active stream.
+ *
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamTrack/getCapabilities for more details.
  */
 export declare class Camera {
     #private;
+    /**
+     * The device info.
+     */
     deviceInfo: InputDeviceInfo;
     /**
      * Stream capabilities as reported by the stream.
@@ -56,19 +100,48 @@ export declare class Camera {
     original: this;
     notify: (reason?: unknown) => void;
     notifyStateChange?: (camera: Camera, reason?: unknown) => void;
+    /**
+     * Creates a new Camera instance.
+     *
+     * @param deviceInfo - The device info.
+     */
     constructor(deviceInfo: InputDeviceInfo);
+    /**
+     * Starts a stream with the specified resolution.
+     *
+     * @param resolution - The resolution to start the stream with.
+     * @returns The stream.
+     */
     startStream(resolution: VideoResolutionName): Promise<MediaStream>;
     /**
      * Acquires a camera stream with the specified resolution.
      * If acquisition fails, it tries a lower resolution as fallback.
+     *
+     * @param resolution - The resolution to acquire the stream with.
+     * @returns The stream.
      */
     private acquireStreamWithFallback;
     /**
      * Populates the camera instance with capabilities from the stream.
+     *
+     * @param stream - The stream to populate the capabilities from.
      */
     private populateCapabilities;
+    /**
+     * Toggles the torch on the camera.
+     *
+     * @returns The torch status.
+     */
     toggleTorch(): Promise<boolean>;
+    /**
+     * Stops the stream on the camera.
+     */
     stopStream(): void;
+    /**
+     * Gets the video track on the camera.
+     *
+     * @returns The video track.
+     */
     getVideoTrack(): MediaStreamTrack | undefined;
 }
 //# sourceMappingURL=Camera.d.ts.map

package/types/core/Camera.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Camera.d.ts","sourceRoot":"","sources":["../../src/core/Camera.ts"],"names":[],"mappings":"AAAA;;GAEG;AAKH,MAAM,MAAM,UAAU,GAAG,OAAO,GAAG,MAAM,GAAG,SAAS,CAAC;AAEtD;;GAEG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;CAIkB,CAAC;AAEhD,MAAM,MAAM,UAAU,GAAG;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,MAAM,OAAO,gBAAgB,CAAC;AAEhE,wBAAgB,gBAAgB,CAAC,UAAU,EAAE,UAAU,GAAG,MAAM,CAE/D;AAED,wBAAgB,uBAAuB,CAAC,UAAU,EAAE,UAAU,GAAG,UAAU,CAiB1E;AAED,wBAAgB,sBAAsB,CACpC,UAAU,EAAE,UAAU,GACrB,mBAAmB,CASrB;AAED,wBAAgB,iBAAiB,CAC/B,oBAAoB,EAAE,UAAU,GAC/B,mBAAmB,CA0BrB;AAED;;GAEG;AACH,qBAAa,MAAM;;IACjB,UAAU,EAAE,eAAe,CAAC;IAC5B;;;;;;;OAOG;IACH,kBAAkB,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,CAAC,CAAC;IACrE,YAAY,EAAE,WAAW,GAAG,SAAS,CAAC;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,UAAU,CAAC;IACvB,cAAc,UAAS;IACvB,YAAY,UAAS;IACrB,mBAAmB,UAAS;IAC5B,sBAAsB,CAAC,EAAE,mBAAmB,CAAC;IAE7C;;OAEG;IACH,QAAQ,OAAQ;IAEhB,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;IACnC,iBAAiB,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;gBAanD,UAAU,EAAE,eAAe;IAmDjC,WAAW,CAAC,UAAU,EAAE,mBAAmB,GAAG,OAAO,CAAC,WAAW,CAAC;IA6BxE;;;OAGG;YACW,yBAAyB;IAoCvC;;OAEG;IACH,OAAO,CAAC,oBAAoB;IA+DtB,WAAW;IA+BjB,UAAU;IAUV,aAAa;CAQd"}
+{"version":3,"file":"Camera.d.ts","sourceRoot":"","sources":["../../src/core/Camera.ts"],"names":[],"mappings":"AAAA;;GAEG;AAKH,MAAM,MAAM,UAAU,GAAG,OAAO,GAAG,MAAM,GAAG,SAAS,CAAC;AAEtD;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;CAIkB,CAAC;AAEhD;;;;;GAKG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,OAAO,gBAAgB,CAAC;AAEhE;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,UAAU,EAAE,UAAU,GAAG,MAAM,CAE/D;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,UAAU,EAAE,UAAU,GAAG,UAAU,CAiB1E;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CACpC,UAAU,EAAE,UAAU,GACrB,mBAAmB,CASrB;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAC/B,oBAAoB,EAAE,UAAU,GAC/B,mBAAmB,CA0BrB;AAED;;;;GAIG;AACH,qBAAa,MAAM;;IACjB;;OAEG;IACH,UAAU,EAAE,eAAe,CAAC;IAE5B;;;;;;;OAOG;IACH,kBAAkB,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,CAAC,CAAC;IACrE,YAAY,EAAE,WAAW,GAAG,SAAS,CAAC;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,UAAU,CAAC;IACvB,cAAc,UAAS;IACvB,YAAY,UAAS;IACrB,mBAAmB,UAAS;IAC5B,sBAAsB,CAAC,EAAE,mBAAmB,CAAC;IAE7C;;OAEG;IACH,QAAQ,OAAQ;IAEhB,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;IACnC,iBAAiB,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;IAa/D;;;;OAIG;gBACS,UAAU,EAAE,eAAe;IAmDvC;;;;;OAKG;IACG,WAAW,CAAC,UAAU,EAAE,mBAAmB,GAAG,OAAO,CAAC,WAAW,CAAC;IA6BxE;;;;;;OAMG;YACW,yBAAyB;IAoCvC;;;;OAIG;IACH,OAAO,CAAC,oBAAoB;IA+D5B;;;;OAIG;IACG,WAAW;IA+BjB;;OAEG;IACH,UAAU;IAUV;;;;OAIG;IACH,aAAa;CAQd"}

package/types/core/CameraManager.d.ts

@@ -5,8 +5,26 @@ import { Camera, FacingMode, VideoResolutionName } from "./Camera";
 import { cameraManagerStore as store } from "./cameraManagerStore";
 import { Promisable } from "type-fest";
 import { ExtractionArea, VideoFrameProcessorInitOptions } from "./VideoFrameProcessor";
+/**
+ * A callback that will be triggered on each frame when the playback state is
+ * "capturing".
+ *
+ * @param frame - The frame to capture.
+ * @returns The frame.
+ */
 export type FrameCaptureCallback = (frame: ImageData) => Promisable<ArrayBufferLike | void>;
+/**
+ * A camera getter.
+ *
+ * @param cameras - The cameras to get.
+ * @returns The camera.
+ */
 type CameraGetter = (cameras: Camera[]) => Camera | undefined;
+/**
+ * A camera preference.
+ *
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackConstraints/facingMode for facing mode details.
+ */
 export type CameraPreference = {
     preferredCamera: Camera | undefined;
     preferredFacing?: undefined;
@@ -20,61 +38,112 @@ export type CameraPreference = {
     preferredCamera?: undefined;
     preferredFacing?: undefined;
 };
+/**
+ * Options for starting a camera stream.
+ *
+ * @param autoplay - If true, the camera stream will be started automatically.
+ * @param preferredCamera - The camera to start the stream with.
+ * @param preferredFacing - The facing mode to start the stream with.
+ */
 export type StartCameraStreamOptions = {
     autoplay?: boolean;
 } & CameraPreference;
+/**
+ * Options for the CameraManager.
+ *
+ * @param mirrorFrontCameras - If true, front-facing cameras will be mirrored horizontally when started.
+ */
 export type CameraManagerOptions = {
     /** If true, the camera stream will be mirrored horizontally when started. */
     mirrorFrontCameras: boolean;
 };
+/**
+ * Default options for the CameraManager.
+ */
 export declare const defaultCameraManagerOptions: CameraManagerOptions;
+/**
+ * The CameraManager class.
+ *
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamTrack/getCapabilities for more details.
+ */
 export declare class CameraManager {
     #private;
+    /**
+     * If true, the user has initiated an abort. This will prevent the
+     * CameraManager from throwing errors when the user interrupts the process.
+     */
     get userInitiatedAbort(): boolean;
     set userInitiatedAbort(value: boolean);
     /**
      * Sets the area of the video frame that will be extracted.
+     *
      * @param extractionArea The area of the video frame that will be extracted.
      */
     setExtractionArea(extractionArea: ExtractionArea): void;
+    /**
+     * Creates a new CameraManager instance.
+     *
+     * @param options - The options for the CameraManager.
+     * @param videoFrameProcessorOptions - The options for the VideoFrameProcessor.
+     */
     constructor(options?: Partial<CameraManagerOptions>, videoFrameProcessorOptions?: VideoFrameProcessorInitOptions);
     /**
-     * Sets the resolution of the camera stream
+     * Sets the resolution of the camera stream.
+     *
+     * @param resolution - The resolution to set.
      */
     setResolution: (resolution: VideoResolutionName) => Promise<void>;
+    /**
+     * The resolution of the camera stream.
+     */
     get resolution(): "720p" | "1080p" | "4k";
     /**
      * True if there is a video playing or capturing
-     * TODO: see if we can simplify this, by observing the video playback state
+     *
+     * @see https://developer.mozilla.org/en-US/docs/Web/API/MediaSession/playbackState for more details.
      */
     get isActive(): boolean;
+    /**
+     * Sets the facing filter.
+     *
+     * @param facingFilter - The facing filter.
+     */
     setFacingFilter(facingFilter: FacingMode[]): void;
     /**
      * Returns the cameras that are available to the user, filtered by the facing mode.
      * If no facing mode is set, all cameras are returned.
+     *
+     * @returns The cameras that are available to the user, filtered by the facing mode.
      */
     getCameraDevices(): Promise<Camera[]>;
     /**
      * Initializes the CameraManager with a video element.
+     *
+     * @param videoElement - The video element to initialize.
      */
     initVideoElement(videoElement: HTMLVideoElement): void;
     /**
      * Adds a callback that will be triggered on each frame when the playback state
      * is "capturing".
      *
-     * @param frameCaptureCallback
+     * @param frameCaptureCallback - The callback to add.
      * @returns a cleanup function to remove the callback
      */
     addFrameCaptureCallback(frameCaptureCallback: FrameCaptureCallback): () => boolean;
+    /**
+     * Cleans up the video element, and stops the stream.
+     */
     releaseVideoElement(): void;
     /**
      * Select a camera device from available ones.
      *
-     * TODO: might become a private method in the future as an implementation detail of `startStream`
+     * @param camera - The camera to select.
      */
     selectCamera(camera: Camera): Promise<void>;
     /**
      * Refreshes available devices on the system and updates the state.
+     *
+     * @returns resolves when the camera devices are refreshed
      */
     refreshCameraDevices(): Promise<void>;
     /**
@@ -85,15 +154,20 @@ export declare class CameraManager {
     startPlayback(): Promise<void>;
     /**
      * Starts capturing frames from the video element.
+     *
+     * @returns resolves when frame capture starts
      */
     startFrameCapture: () => Promise<void>;
     /**
      * Starts a best-effort camera stream. Will pick a camera automatically if
      * none is selected.
+     *
+     * @param params - The parameters for the camera stream.
+     * @returns resolves when the camera stream starts
      */
     startCameraStream(params?: StartCameraStreamOptions): Promise<void>;
     /**
-     * Pauses capturing frames without pausing playback.
+     * Pauses capturing frames, without stopping playback.
      */
     stopFrameCapture(): void;
     /**
@@ -106,20 +180,26 @@ export declare class CameraManager {
     pausePlayback(): void;
     /**
      * If true, the video and captured frames will be mirrored horizontally.
+     *
+     * @param mirrorX - If true, the video and captured frames will be mirrored horizontally.
      */
     setCameraMirrorX(mirrorX: boolean): void;
     /**
      * Allows the user to subscribe to state changes inside the Camera Manager.
      * Implemented using Zustand. For usage information, see
-     * {@link https://github.com/pmndrs/zustand#using-subscribe-with-selector}
+     * @see https://github.com/pmndrs/zustand#using-subscribe-with-selector for more details.
+     *
+     * @returns a cleanup function to remove the subscription
      */
     subscribe: typeof store.subscribe;
     /**
      * Gets the current internal state of the CameraManager.
+     *
+     * @returns the current state of the CameraManager
      */
     getState: typeof store.getState;
     /**
-     * Resets the CameraManager and stop all streams
+     * Resets the CameraManager and stops all streams.
      */
     reset(): void;
 }

package/types/core/CameraManager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CameraManager.d.ts","sourceRoot":"","sources":["../../src/core/CameraManager.ts"],"names":[],"mappings":"AAAA;;GAEG;AAKH,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAQnE,OAAO,EAGL,kBAAkB,IAAI,KAAK,EAC5B,MAAM,sBAAsB,CAAC;AAG9B,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAEvC,OAAO,EACL,cAAc,EAGd,8BAA8B,EAC/B,MAAM,uBAAuB,CAAC;AAE/B,MAAM,MAAM,oBAAoB,GAAG,CACjC,KAAK,EAAE,SAAS,KACb,UAAU,CAAC,eAAe,GAAG,IAAI,CAAC,CAAC;AAExC,KAAK,YAAY,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,MAAM,GAAG,SAAS,CAAC;AAE9D,MAAM,MAAM,gBAAgB,GACxB;IAEE,eAAe,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,eAAe,CAAC,EAAE,SAAS,CAAC;CAC7B,GACD;IAEE,eAAe,EAAE,YAAY,GAAG,SAAS,CAAC;IAC1C,eAAe,CAAC,EAAE,SAAS,CAAC;CAC7B,GACD;IAEE,eAAe,EAAE,UAAU,CAAC;IAC5B,eAAe,CAAC,EAAE,SAAS,CAAC;CAC7B,GACD;IAEE,eAAe,CAAC,EAAE,SAAS,CAAC;IAC5B,eAAe,CAAC,EAAE,SAAS,CAAC;CAC7B,CAAC;AAEN,MAAM,MAAM,wBAAwB,GAAG;IACrC,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,GAAG,gBAAgB,CAAC;AAErB,MAAM,MAAM,oBAAoB,GAAG;IACjC,6EAA6E;IAC7E,kBAAkB,EAAE,OAAO,CAAC;CAC7B,CAAC;AAEF,eAAO,MAAM,2BAA2B,EAAE,oBAEhC,CAAC;AAEX,qBAAa,aAAa;;IAmBxB,IAAI,kBAAkB,IAIQ,OAAO,CAFpC;IAED,IAAI,kBAAkB,CAAC,KAAK,EAAE,OAAO,EAEpC;IAED;;;OAGG;IACH,iBAAiB,CAAC,cAAc,EAAE,cAAc;gBAW9C,OAAO,GAAE,OAAO,CAAC,oBAAoB,CAAM,EAC3C,0BAA0B,CAAC,EAAE,8BAA8B;IAa7D;;OAEG;IACH,aAAa,GAAU,YAAY,mBAAmB,mBAUpD;IAEF,IAAI,UAAU,4BAEb;IAED;;;OAGG;IACH,IAAI,QAAQ,YAEX;IAED,eAAe,CAAC,YAAY,EAAE,UAAU,EAAE;IAM1C;;;OAGG;IACG,gBAAgB;IAsHtB;;OAEG;IACH,gBAAgB,CAAC,YAAY,EAAE,gBAAgB;IAY/C;;;;;;OAMG;IACH,uBAAuB,CAAC,oBAAoB,EAAE,oBAAoB;IAKlE,mBAAmB;IAQnB;;;;OAIG;IACG,YAAY,CAAC,MAAM,EAAE,MAAM;IA0DjC;;OAEG;IACG,oBAAoB;IAuE1B;;;;OAIG;IACG,aAAa;IAqFnB;;OAEG;IACH,iBAAiB,sBAUf;IA4GF;;;OAGG;IACG,iBAAiB,CAAC,MAAM,GAAE,wBAA6B;IAqB7D;;OAEG;IACH,gBAAgB;IAMhB;;OAEG;IACH,UAAU;IAYV;;OAEG;IACH,aAAa;IAmIb;;OAEG;IACH,gBAAgB,CAAC,OAAO,EAAE,OAAO;IAyBjC;;;;OAIG;IACH,SAAS,EAAE,OAAO,KAAK,CAAC,SAAS,CAAmB;IAEpD;;OAEG;IACH,QAAQ,EAAE,OAAO,KAAK,CAAC,QAAQ,CAAkB;IAEjD;;OAEG;IACH,KAAK;CAMN"}
+{"version":3,"file":"CameraManager.d.ts","sourceRoot":"","sources":["../../src/core/CameraManager.ts"],"names":[],"mappings":"AAAA;;GAEG;AAKH,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAQnE,OAAO,EAGL,kBAAkB,IAAI,KAAK,EAC5B,MAAM,sBAAsB,CAAC;AAG9B,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAEvC,OAAO,EACL,cAAc,EAGd,8BAA8B,EAC/B,MAAM,uBAAuB,CAAC;AAE/B;;;;;;GAMG;AACH,MAAM,MAAM,oBAAoB,GAAG,CACjC,KAAK,EAAE,SAAS,KACb,UAAU,CAAC,eAAe,GAAG,IAAI,CAAC,CAAC;AAExC;;;;;GAKG;AACH,KAAK,YAAY,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,MAAM,GAAG,SAAS,CAAC;AAE9D;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GACxB;IAEE,eAAe,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,eAAe,CAAC,EAAE,SAAS,CAAC;CAC7B,GACD;IAEE,eAAe,EAAE,YAAY,GAAG,SAAS,CAAC;IAC1C,eAAe,CAAC,EAAE,SAAS,CAAC;CAC7B,GACD;IAEE,eAAe,EAAE,UAAU,CAAC;IAC5B,eAAe,CAAC,EAAE,SAAS,CAAC;CAC7B,GACD;IAEE,eAAe,CAAC,EAAE,SAAS,CAAC;IAC5B,eAAe,CAAC,EAAE,SAAS,CAAC;CAC7B,CAAC;AAEN;;;;;;GAMG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,GAAG,gBAAgB,CAAC;AAErB;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,6EAA6E;IAC7E,kBAAkB,EAAE,OAAO,CAAC;CAC7B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,2BAA2B,EAAE,oBAEhC,CAAC;AAEX;;;;GAIG;AACH,qBAAa,aAAa;;IAmBxB;;;OAGG;IACH,IAAI,kBAAkB,IAIQ,OAAO,CAFpC;IAED,IAAI,kBAAkB,CAAC,KAAK,EAAE,OAAO,EAEpC;IAED;;;;OAIG;IACH,iBAAiB,CAAC,cAAc,EAAE,cAAc;IAUhD;;;;;OAKG;gBAED,OAAO,GAAE,OAAO,CAAC,oBAAoB,CAAM,EAC3C,0BAA0B,CAAC,EAAE,8BAA8B;IAa7D;;;;OAIG;IACH,aAAa,GAAU,YAAY,mBAAmB,mBAUpD;IAEF;;OAEG;IACH,IAAI,UAAU,4BAEb;IAED;;;;OAIG;IACH,IAAI,QAAQ,YAGX;IAED;;;;OAIG;IACH,eAAe,CAAC,YAAY,EAAE,UAAU,EAAE;IAM1C;;;;;OAKG;IACG,gBAAgB;IAwHtB;;;;OAIG;IACH,gBAAgB,CAAC,YAAY,EAAE,gBAAgB;IAY/C;;;;;;OAMG;IACH,uBAAuB,CAAC,oBAAoB,EAAE,oBAAoB;IAKlE;;OAEG;IACH,mBAAmB;IASnB;;;;OAIG;IACG,YAAY,CAAC,MAAM,EAAE,MAAM;IA0DjC;;;;OAIG;IACG,oBAAoB;IAuE1B;;;;OAIG;IACG,aAAa;IAuFnB;;;;OAIG;IACH,iBAAiB,sBAUf;IAkHF;;;;;;OAMG;IACG,iBAAiB,CAAC,MAAM,GAAE,wBAA6B;IA0B7D;;OAEG;IACH,gBAAgB;IAMhB;;OAEG;IACH,UAAU;IAYV;;OAEG;IACH,aAAa;IAmIb;;;;OAIG;IACH,gBAAgB,CAAC,OAAO,EAAE,OAAO;IAyBjC;;;;;;OAMG;IACH,SAAS,EAAE,OAAO,KAAK,CAAC,SAAS,CAAmB;IAEpD;;;;OAIG;IACH,QAAQ,EAAE,OAAO,KAAK,CAAC,QAAQ,CAAkB;IAEjD;;OAEG;IACH,KAAK;CAMN"}

package/types/core/VideoFrameProcessor.d.ts

@@ -3,6 +3,9 @@
  */
 export type CanvasRenderingMode = "2d" | "webgl2";
 export type ImageSource = HTMLVideoElement | HTMLCanvasElement | ImageBitmap;
+/**
+ * Options for the VideoFrameProcessor.
+ */
 export type VideoFrameProcessorInitOptions = {
     canvasRenderingMode?: CanvasRenderingMode;
     fallbackWebGlTo2d?: boolean;
@@ -13,6 +16,9 @@ export type VideoFrameProcessorInitOptions = {
  * @returns true if the buffer is detached, false otherwise
  */
 export declare function isBufferDetached(buffer: ArrayBuffer): boolean;
+/**
+ * The extraction area.
+ */
 export type ExtractionArea = {
     x: number;
     y: number;
@@ -24,36 +30,52 @@ export type ExtractionArea = {
  */
 export declare class VideoFrameProcessor {
     #private;
+    /**
+     * Creates a new VideoFrameProcessor.
+     *
+     * @param options - The options for the VideoFrameProcessor.
+     */
     constructor(options?: VideoFrameProcessorInitOptions);
     /**
-     * Returns ownership of an ArrayBuffer to the processor for reuse
-     * This should only be called with ArrayBuffers that were originally from this processor
-     * Typically used after transferring the buffer to/from a worker
+     * Returns ownership of an ArrayBuffer to the processor for reuse.
+     *
+     * This should only be called with ArrayBuffers that were originally from this processor.
+     * Typically used after transferring the buffer to/from a worker.
+     *
+     * @param arrayBuffer - The array buffer to reattach.
      */
     reattachArrayBuffer(arrayBuffer: ArrayBufferLike): void;
     /**
-     * Used to check if the processor owns the buffer
+     * Used to check if the processor owns the buffer.
+     *
+     * @returns true if the processor owns the buffer, false otherwise.
      */
     isBufferDetached(): boolean;
     /**
-     * Extracts image data from a source element
+     * Extracts image data from a source element.
+     *
+     * @param source - The source element to extract image data from.
+     * @param area - The extraction area.
+     * @returns The image data.
      */
     getImageData(source: ImageSource, area?: ExtractionArea): ImageData;
     /**
      * Used to get the current ImageData object with the current buffer. Useful
      * when you need to get the same `ImageData` object multiple times after the
      * original `ImageData` buffer has been detached
+     *
      * @returns ImageData object with the current buffer
      */
     getCurrentImageData(): ImageData;
     /**
-     * Clean up resources
+     * Clean up resources.
      */
     dispose(): void;
 }
 /**
  * Converts a view to a buffer, since both match the type signature of
  * `ArrayBufferLike`.
+ *
  * @param buffer - The buffer or view to convert
  * @returns The actual underlying buffer
  */

package/types/core/VideoFrameProcessor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"VideoFrameProcessor.d.ts","sourceRoot":"","sources":["../../src/core/VideoFrameProcessor.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,MAAM,mBAAmB,GAAG,IAAI,GAAG,QAAQ,CAAC;AAClD,MAAM,MAAM,WAAW,GAAG,gBAAgB,GAAG,iBAAiB,GAAG,WAAW,CAAC;AAE7E,MAAM,MAAM,8BAA8B,GAAG;IAC3C,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IAC1C,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,WAAW,GAAG,OAAO,CAe7D;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;GAEG;AACH,qBAAa,mBAAmB;;gBAYlB,OAAO,GAAE,8BAAmC;IAyFxD;;;;OAIG;IACH,mBAAmB,CAAC,WAAW,EAAE,eAAe,GAAG,IAAI;IAoBvD;;OAEG;IACH,gBAAgB,IAAI,OAAO;IAO3B;;OAEG;IACH,YAAY,CAAC,MAAM,EAAE,WAAW,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,SAAS;IAMnE;;;;;OAKG;IACH,mBAAmB,IAAI,SAAS;IA0HhC;;OAEG;IACH,OAAO,IAAI,IAAI;CAehB;AACD;;;;;GAKG;AAEH,eAAO,MAAM,SAAS,GAAI,QAAQ,eAAe,oBAOhD,CAAC"}
+{"version":3,"file":"VideoFrameProcessor.d.ts","sourceRoot":"","sources":["../../src/core/VideoFrameProcessor.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,MAAM,mBAAmB,GAAG,IAAI,GAAG,QAAQ,CAAC;AAClD,MAAM,MAAM,WAAW,GAAG,gBAAgB,GAAG,iBAAiB,GAAG,WAAW,CAAC;AAE7E;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG;IAC3C,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IAC1C,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,WAAW,GAAG,OAAO,CAe7D;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;GAEG;AACH,qBAAa,mBAAmB;;IAY9B;;;;OAIG;gBACS,OAAO,GAAE,8BAAmC;IAyFxD;;;;;;;OAOG;IACH,mBAAmB,CAAC,WAAW,EAAE,eAAe,GAAG,IAAI;IAoBvD;;;;OAIG;IACH,gBAAgB,IAAI,OAAO;IAO3B;;;;;;OAMG;IACH,YAAY,CAAC,MAAM,EAAE,WAAW,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,SAAS;IAMnE;;;;;;OAMG;IACH,mBAAmB,IAAI,SAAS;IAqIhC;;OAEG;IACH,OAAO,IAAI,IAAI;CAehB;AAED;;;;;;GAMG;AACH,eAAO,MAAM,SAAS,GAAI,QAAQ,eAAe,oBAOhD,CAAC"}

package/types/core/cameraError.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Copyright (c) 2025 Microblink Ltd. All rights reserved.
+ */
+/**
+ * A camera error code.
+ */
+export type CameraErrorCode = "PERMISSION_DENIED" | (string & {});
+/**
+ * A camera error.
+ */
+export declare class CameraError extends Error {
+    code: CameraErrorCode;
+    /**
+     * Creates a new camera error.
+     *
+     * @param message - The error message.
+     * @param code - The error code.
+     * @param cause - The cause of the error.
+     */
+    constructor(message: string, code: CameraErrorCode, cause?: Error);
+}
+//# sourceMappingURL=cameraError.d.ts.map

package/types/core/cameraError.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cameraError.d.ts","sourceRoot":"","sources":["../../src/core/cameraError.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;GAEG;AAEH,MAAM,MAAM,eAAe,GAAG,mBAAmB,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;AAElE;;GAEG;AACH,qBAAa,WAAY,SAAQ,KAAK;IACpC,IAAI,EAAE,eAAe,CAAC;IAEtB;;;;;;OAMG;gBACS,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,eAAe,EAAE,KAAK,CAAC,EAAE,KAAK;CAKlE"}

package/types/core/cameraManagerStore.d.ts

@@ -2,8 +2,14 @@
  * Copyright (c) 2025 Microblink Ltd. All rights reserved.
  */
 import { Camera, FacingMode } from "./Camera";
-import { CameraError } from "./cameraUtils";
+import { CameraError } from "./cameraError";
+/**
+ * The playback state of the camera manager.
+ */
 export type PlaybackState = "idle" | "playback" | "capturing";
+/**
+ * The camera manager store.
+ */
 export type CameraManagerStore = {
     /**
      * The video element that will display the camera stream.
@@ -23,7 +29,7 @@ export type CameraManagerStore = {
      */
     selectedCamera?: Camera;
     /**
-     * Capturing / playing / idle
+     * Capturing / playing / idle.
      */
     playbackState: PlaybackState;
     /**
@@ -53,7 +59,7 @@ export type CameraManagerStore = {
  *
  * Prefer using subscriptions if you require observable state.
  *
- * {@link https://github.com/pmndrs/zustand}
+ * @see https://github.com/pmndrs/zustand for more details.
  */
 export declare const cameraManagerStore: Omit<import("zustand/vanilla").StoreApi<CameraManagerStore>, "subscribe"> & {
     subscribe: {
@@ -66,6 +72,7 @@ export declare const cameraManagerStore: Omit<import("zustand/vanilla").StoreApi
 };
 /**
  * Resets the store to its initial state.
+ *
  * Stops all camera streams as a side effect.
  */
 export declare const resetCameraManagerStore: () => void;

package/types/core/cameraManagerStore.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cameraManagerStore.d.ts","sourceRoot":"","sources":["../../src/core/cameraManagerStore.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAC9C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,UAAU,GAAG,WAAW,CAAC;AAE9D,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAEhC;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAC;IAElB;;;OAGG;IACH,YAAY,CAAC,EAAE,UAAU,EAAE,CAAC;IAE5B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,aAAa,EAAE,aAAa,CAAC;IAE7B;;OAEG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,iBAAiB,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,GAAG,WAAW,CAAC;CAClC,CAAC;AAeF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;CAG9B,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,uBAAuB,YAOnC,CAAC"}
+{"version":3,"file":"cameraManagerStore.d.ts","sourceRoot":"","sources":["../../src/core/cameraManagerStore.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAC9C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,UAAU,GAAG,WAAW,CAAC;AAE9D;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAEhC;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAC;IAElB;;;OAGG;IACH,YAAY,CAAC,EAAE,UAAU,EAAE,CAAC;IAE5B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,aAAa,EAAE,aAAa,CAAC;IAE7B;;OAEG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,iBAAiB,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,GAAG,WAAW,CAAC;CAClC,CAAC;AAmBF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;CAG9B,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,YAOnC,CAAC"}

package/types/core/cameraNames.d.ts

@@ -2,25 +2,41 @@
  * Copyright (c) 2025 Microblink Ltd. All rights reserved.
  */
 /**
- * Generic keywords for back camera
+ * Generic keywords for back camera.
  */
 export declare const backCameraKeywords: ["back", "rear", "rück", "arrière", "trasera", "trás", "traseira", "posteriore", "achterzijde", "baksidan", "bagside", "bak", "takakamera", "πίσω", "darrere", "задней", "tylny", "spate", "hátsó", "zadní", "zadná", "задня", "stražnja", "الخلفية", "אחורית", "arka", "后面", "后置", "後面", "後置", "背面", "背置", "후", "背面", "หลัง", "belakang", "बैक", "posterior"];
 /**
- * Generic keywords for front camera
+ * Generic keywords for front camera.
  */
 export declare const frontCameraKeywords: ["front", "vorder", "avant", "frontal", "frente", "frontale", "voorzijde", "framsidan", "forside", "front", "etukamera", "μπροστά", "davant", "передняя", "przedni", "față", "elülső", "přední", "predná", "передня", "prednja", "الأمامية", "קדמית", "ön", "前面", "前置", "前面", "前置", "전면", "前面", "หน้า", "depan", "फ्रंट", "frontal"];
 /**
- * Localizations for iOS back camera
+ * Localizations for iOS back camera.
  */
 export declare const backCameraLocalizations: ["후면 카메라", "後置相機", "Задна камера", "後置鏡頭", "Camera mặt sau", "Hátoldali kamera", "Cámara trasera", "Back Camera", "Kamera på baksidan", "Πίσω κάμερα", "Bagsidekamera", "Zadná kamera", "Fotocamera (posteriore)", "Câmara traseira", "מצלמה אחורית", "Takakamera", "Rückkamera", "Caméra arrière", "Zadní fotoaparát", "Артқы камера", "Tylny aparat", "बैक कैमरा", "Hátsó kamera", "Camera aan achterzijde", "Kamera Belakang", "Câmera Traseira", "Stražnja kamera", "الكاميرا الخلفية", "Càmera posterior", "Fotocamera posteriore", "Càmera del darrere", "กล้องด้านหลัง", "Cameră spate", "Kamera, bagside", "背面カメラ", "Задня камера", "Arka Kamera", "后置相机", "Камера на задней панели", "后置镜头", "Kamera bak", "Задняя камера", "Aparat tylny", "Kamera på baksiden", "Câmera de Trás"];
 /**
- * Localizations for iOS back dual wide camera
+ * Localizations for iOS back dual wide camera.
  */
 export declare const backDualWideCameraLocalizations: ["Cameră dublă cu obiectiv superangular spate", "מצלמה כפולה רחבה אחורית", "Артқы қос кең бұрышты камера", "Câmara grande angular dupla traseira", "Πίσω διπλή ευρεία κάμερα", "後置雙廣角鏡頭相機", "Задна двойна широкоъгълна камера", "Càmera dual posterior amb gran angular", "Zadná duálna širokouhlá kamera", "كاميرا خلفية مزدوجة عريضة", "Задняя двойная широкоугольная камера", "Задня здвоєна ширококутна камера", "Cámara amplia posterior doble", "Dwikamera Lebar Belakang", "Tylny dwuobiektywowy aparat szerokokątny", "Dubbel vidvinkelkamera på baksidan", "Back Dual Wide Camera", "Hátsó, kettős, széles látószögű kamera", "후면 듀얼 와이드 카메라", "Double caméra grand angle arrière", "Fotocamera doppia con grandangolo (posteriore)", "Double appareil photo grand angle arrière", "Zadní duální širokoúhlý fotoaparát", "Çift Geniş Kamera Arka Yüzü", "Laajakulmainen kaksoistakakamera", "Rückseitige Dual-Weitwinkelkamera", "बैक ड्युअल वाइड कैमरा", "后置双广角镜头", "Câmera Dupla Grande-Angular Traseira", "後置雙廣角相機", "กล้องคู่ด้านหลังมุมกว้าง", "Kamera Lebar Belakang Ganda", "Dobbelt vidvinkelkamera bak", "Camera kép rộng mặt sau", "Cámara trasera dual con gran angular", "背面デュアル広角カメラ", "Stražnja dvostruka široka kamera"];
 /**
- * Check if a string contains any of the keywords
+ * Check if a string contains any of the keywords.
+ *
+ * @param string - The string to check.
+ * @param keywords - The keywords to check.
+ * @returns true if the string contains any of the keywords.
  */
 export declare const containsKeyword: (string: string, keywords: string[]) => boolean;
+/**
+ * Checks if a string is a back camera name.
+ *
+ * @param string - The string to check.
+ * @returns true if the string is a back camera name.
+ */
 export declare const isBackCameraName: (string: string) => boolean;
+/**
+ * Checks if a string is a front camera name.
+ *
+ * @param string - The string to check.
+ * @returns true if the string is a front camera name.
+ */
 export declare const isFrontCameraName: (string: string) => boolean;
 //# sourceMappingURL=cameraNames.d.ts.map

package/types/core/cameraNames.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cameraNames.d.ts","sourceRoot":"","sources":["../../src/core/cameraNames.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;GAEG;AACH,eAAO,MAAM,kBAAkB,gWAuEF,CAAC;AAE9B;;GAEG;AACH,eAAO,MAAM,mBAAmB,sUAmEH,CAAC;AAE9B;;GAEG;AACH,eAAO,MAAM,uBAAuB,8vBA8CP,CAAC;AAE9B;;GAEG;AACH,eAAO,MAAM,+BAA+B,krCAsCf,CAAC;AAE9B;;GAEG;AACH,eAAO,MAAM,eAAe,GAAI,QAAQ,MAAM,EAAE,UAAU,MAAM,EAAE,YAEjE,CAAC;AAEF,eAAO,MAAM,gBAAgB,GAAI,QAAQ,MAAM,YACF,CAAC;AAE9C,eAAO,MAAM,iBAAiB,GAAI,QAAQ,MAAM,YACF,CAAC"}
+{"version":3,"file":"cameraNames.d.ts","sourceRoot":"","sources":["../../src/core/cameraNames.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;GAEG;AACH,eAAO,MAAM,kBAAkB,gWAuEF,CAAC;AAE9B;;GAEG;AACH,eAAO,MAAM,mBAAmB,sUAmEH,CAAC;AAE9B;;GAEG;AACH,eAAO,MAAM,uBAAuB,8vBA8CP,CAAC;AAE9B;;GAEG;AACH,eAAO,MAAM,+BAA+B,krCAsCf,CAAC;AAE9B;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,GAAI,QAAQ,MAAM,EAAE,UAAU,MAAM,EAAE,YAEjE,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,GAAI,QAAQ,MAAM,YACF,CAAC;AAE9C;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,GAAI,QAAQ,MAAM,YACF,CAAC"}

package/types/core/cameraUtils.d.ts

@@ -2,46 +2,67 @@
  * Copyright (c) 2025 Microblink Ltd. All rights reserved.
  */
 import { Camera, FacingMode, VideoResolutionName } from "./Camera";
-type CameraErrorCode = "PERMISSION_DENIED" | (string & {});
-export declare class CameraError extends Error {
-    code: CameraErrorCode;
-    constructor(message: string, code: CameraErrorCode, cause?: Error);
-}
 /**
  * Trigger camera permission dialog.
+ *
+ * @returns resolves when the camera permission is granted
  */
 export declare const askForCameraPermission: () => Promise<void>;
 /**
  * Returns available camera devices on the user's device.
- * @returns An array of {@linkcode InputDeviceInfo} objects representing the available camera devices.
+ *
+ * @returns An array of `InputDeviceInfo` objects representing the available camera devices.
+ *
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/InputDeviceInfo for more details.
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/enumerateDevices for more details.
  */
 export declare const obtainVideoInputDevices: () => Promise<InputDeviceInfo[]>;
+/**
+ * Closes all tracks on a media stream.
+ *
+ * @param stream - The media stream to close.
+ */
 export declare const closeStreamTracks: (stream: MediaStream) => void;
+/**
+ * Creates a media stream constraints object.
+ *
+ * @param resolution - The resolution to create constraints for.
+ * @param facing - The facing mode to create constraints for.
+ * @param id - The device ID to create constraints for.
+ */
 export declare const createConstraints: (resolution: VideoResolutionName, facing?: FacingMode, id?: Camera["deviceInfo"]["deviceId"]) => MediaStreamConstraints;
 /**
  * Scores a camera based on its capabilities.
  * Higher score means better camera.
+ *
+ * @param camera - The camera to score.
+ * @returns The score of the camera.
  */
 export declare function scoreCameraCapabilities(camera: Camera): number;
 /**
  * Filters cameras based on facing mode.
+ *
+ * @param cameras - The cameras to filter.
+ * @param requestedFacing - The facing mode to filter by.
+ * @returns The filtered cameras.
  */
 export declare function filterCamerasByFacing(cameras: Camera[], requestedFacing: FacingMode): Camera[];
 /**
  * Finds the ideal camera based on the provided constraints.
  *
- * @param cameras Available {@linkcode Camera}s on the device
- * @param resolution Ideal resolution for the camera stream, will fall back to the closest available resolution.
- * @param requestedFacing Ideal facing mode for the camera stream. If not provided, will default to back camera.
+ * @param cameras - Available `Camera`s on the device.
+ * @param resolution - Ideal resolution for the camera stream, will fall back to the closest available resolution.
+ * @param requestedFacing - Ideal facing mode for the camera stream. If not provided, will default to back camera.
  * If no facing mode is available, will return a best effort match.
  *
- * @returns A {@linkcode Camera} instance that matches the provided constraints, with an active stream.
+ * @returns A `Camera` instance that matches the provided constraints, with an active stream.
  */
 export declare const findIdealCamera: (cameras: Camera[], resolution?: VideoResolutionName, requestedFacing?: FacingMode) => Promise<Camera>;
 /**
- * Creates an array of {@linkcode Camera} instances with stream from native
- * `deviceInfo` objects.
+ * Creates an array of `Camera` instances with stream from native `deviceInfo` objects.
+ *
+ * @param cameras - The input device info to create cameras from.
+ * @returns The created cameras.
  */
 export declare function createCameras(cameras: InputDeviceInfo[]): Camera[];
-export {};
 //# sourceMappingURL=cameraUtils.d.ts.map

package/types/core/cameraUtils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cameraUtils.d.ts","sourceRoot":"","sources":["../../src/core/cameraUtils.ts"],"names":[],"mappings":"AAAA;;GAEG;AAKH,OAAO,EACL,MAAM,EACN,UAAU,EACV,mBAAmB,EAEpB,MAAM,UAAU,CAAC;AAMlB,KAAK,eAAe,GAAG,mBAAmB,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;AAE3D,qBAAa,WAAY,SAAQ,KAAK;IACpC,IAAI,EAAE,eAAe,CAAC;gBAEV,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,eAAe,EAAE,KAAK,CAAC,EAAE,KAAK;CAKlE;AAED;;GAEG;AACH,eAAO,MAAM,sBAAsB,qBAkBlC,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,uBAAuB,kCAkBnC,CAAC;AAEF,eAAO,MAAM,iBAAiB,GAAI,QAAQ,WAAW,SAKpD,CAAC;AAEF,eAAO,MAAM,iBAAiB,GAC5B,YAAY,mBAAmB,EAC/B,SAAS,UAAU,EACnB,KAAK,MAAM,CAAC,YAAY,CAAC,CAAC,UAAU,CAAC,2BAuBtC,CAAC;AAEF;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAK9D;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CACnC,OAAO,EAAE,MAAM,EAAE,EACjB,eAAe,EAAE,UAAU,GAC1B,MAAM,EAAE,CAQV;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,eAAe,GAC1B,SAAS,MAAM,EAAE,EACjB,aAAY,mBAA0B,EACtC,kBAAiB,UAAmB,KACnC,OAAO,CAAC,MAAM,CAoGhB,CAAC;AAEF;;;GAGG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,eAAe,EAAE,YAWvD"}
+{"version":3,"file":"cameraUtils.d.ts","sourceRoot":"","sources":["../../src/core/cameraUtils.ts"],"names":[],"mappings":"AAAA;;GAEG;AAKH,OAAO,EACL,MAAM,EACN,UAAU,EACV,mBAAmB,EAEpB,MAAM,UAAU,CAAC;AAMlB;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,qBAkBlC,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,uBAAuB,kCAkBnC,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,GAAI,QAAQ,WAAW,SAKpD,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,GAC5B,YAAY,mBAAmB,EAC/B,SAAS,UAAU,EACnB,KAAK,MAAM,CAAC,YAAY,CAAC,CAAC,UAAU,CAAC,2BAuBtC,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAK9D;AAED;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CACnC,OAAO,EAAE,MAAM,EAAE,EACjB,eAAe,EAAE,UAAU,GAC1B,MAAM,EAAE,CAQV;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,eAAe,GAC1B,SAAS,MAAM,EAAE,EACjB,aAAY,mBAA0B,EACtC,kBAAiB,UAAmB,KACnC,OAAO,CAAC,MAAM,CAoGhB,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,eAAe,EAAE,YAWvD"}