deepar 5.4.2 → 5.4.3-chromeExtension

package/lib/js/types/initParams.d.ts

@@ -0,0 +1,236 @@
+/**
+ * Parameters for the initialization of {@link DeepAR} object.
+ */
+export interface DeepARParams {
+    /**
+     * License key created on <a href="https://developer.deepar.ai/">DeepAR developer portal</a> for your web app.
+     */
+    licenseKey: string;
+    /**
+     * HTML element where AR preview will be presented.
+     *
+     * This is usually a <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div">div</a> element which
+     * is used solely for AR preview. AR preview will fully occupy the previewElement's space.
+     * Therefore, position and size your previewElement according to your preferred AR preview dimensions.
+     *
+     * > NOTE: AR preview will adjust to the size of the previewElement if it changes.
+     *
+     * The canvas element will be appended as child to the previewElement. If you wish to work with the canvas element directly
+     * and position and size it yourself then use {@link canvas} parameter instead.
+     *
+     * > ⚠️ You must specify {@link previewElement} or {@link canvas}.
+     */
+    previewElement?: HTMLElement;
+    /**
+     *  The URL of a DeepAR effect file. This effect will be applied when DeepAR is initialized.
+     *  This parameter is optional. You can always later switch to a different effect with {@link DeepAR.switchEffect}.
+     */
+    effect?: string;
+    /**
+     * Path to the root directory of the DeepAR SDK. This path will be used to locate and download all the additional needed files like ML models and wasm files.
+     * By default, this points to the JsDelivr CDN. For example "https://cdn.jsdelivr.net/npm/deepar@5.0.0/".<br>
+     *
+     * If you want to host the DeepAR SDK yourself set the path to it here. It is recommended to host DeepAR SDK on your own since then you can use compressions like gzip and brotli on the files.
+     *
+     * > ⚠️ <b>Be sure that the version of DeepAR js file and the root SDK path match!</b>
+     *
+     * DeepAR SDK can be hosted on any other server, but be sure not to change the directory and file structure of DeepAR SDK when hosing it.<br>
+     *
+     * To configure usage of non-default ML models, define them in the {@link additionalOptions}.
+     */
+    rootPath?: string;
+    /**
+     * Canvas element where DeepAR will render the AR preview.
+     *
+     * > ⚠️ You must specify {@link previewElement} or {@link canvas}.
+     *
+     * The preferred way is by using the {@link previewElement} parameter.
+     * In that case, the DeepAR will take care of correctly sizing the canvas.
+     *
+     * @example
+     * ```javascript
+     * const canvas = document.createElement('canvas')
+     * canvas.style.display = 'block'
+     *
+     * // We want to fill the whole screen.
+     * const width = window.innerWidth
+     * const height = window.innerHeight
+     * const dpr = window.devicePixelRatio || 1
+     * canvas.width = width * dpr
+     * canvas.height = height * dpr
+     * canvas.style.width = `${width}px`
+     * canvas.style.height = `${height}px`
+     * ```
+     */
+    canvas?: HTMLCanvasElement;
+    /**
+     * Additional DeepAR options.
+     */
+    additionalOptions?: {
+        /**
+         * Camera options. DeepAR will use the camera by default.
+         */
+        cameraConfig?: {
+            /**
+             * If true, DeepAR will not use camera preview by default and all the other options here are ignored in that case. You can use your own camera/video by calling {@link DeepAR.setVideoElement} or start the camera at any time by calling {@link DeepAR.startCamera}
+             */
+            disableDefaultCamera?: boolean;
+            /**
+             * Can be "user" or "environment". User will be a front facing camera on mobile devices, while environment will be the back facing camera. Default is "user".
+             */
+            facingMode?: string;
+            /**
+             * Called when the camera permission is asked.
+             */
+            cameraPermissionAsked?: () => void;
+            /**
+             * Called when the camera permission is granted.
+             */
+            cameraPermissionGranted?: () => void;
+        };
+        /**
+         * Provide a hint or hints to DeepAR to optimize the SDK in some scenarios. <br><br>
+         * Available hints:
+         * <ul>
+         *     <li><b>faceModelsPredownload</b> - Will download the face models as soon as possible.</li>
+         *     <li><b>segmentationModelsPredownload</b> - Will download the segmentation models as soon as possible. Note - it will not try to initialize segmentation. Segmentation will be lazy loaded when needed.</li>
+         *     <li><b>footModelsPredownload</b> - Will download the foot models as soon as possible. Note - it will not try to initialize foot tracking. Foot tracking will be lazy loaded when needed.</li>
+         *     <li><b>segmentationInit</b> - Will initialize segmentation as soon as possible. Without this hint segmentation is lazy loaded when some segmentation effect is loaded.</li>
+         *     <li><b>footInit</b> - Will initialize foot tracking as soon as possible. Without this hint foot tracking is lazy loaded when some foot tracking effect is loaded.</li>
+         * </ul>
+         */
+        hint?: string | string[];
+        /**
+         * Face tracking module path and options.
+         */
+        faceTrackingConfig?: {
+            /**
+             * Path to the face tracking model. Something like "path/to/deepar/models/face/models-68-extreme.bin".
+             */
+            modelPath: string;
+        };
+        rigidFaceTrackingConfig?: {
+            /**
+             * Path to the pose libPoseEstimation.wasm file, e.g. "/path/to/deepar/wasm/libPoseEstimation.wasm".
+             */
+            poseEstimationWasmPath?: string;
+            /**
+             * Path to the detector model, e.g. "/path/to/deepar/models/foot/foot-detector.bin".
+             */
+            detectorPath?: string;
+            /**
+             * Path to the tracker model, e.g. "/path/to/deepar/models/foot/foot-tracker.bin".
+             */
+            trackerPath?: string;
+            /**
+             * Path to the foot model object file, e.g. "/path/to/deepar/models/foot/foot-model.obj".
+             */
+            objPath?: string;
+            /**
+             * Path to tfjs-backend-wasm.wasm file, e.g. "path/to/deepar/wasm/tfjs-backend-wasm.wasm"
+             */
+            tfjsBackendWasmPath?: string;
+            /**
+             * Path to tfjs-backend-wasm-simd.wasm file, e.g. "path/to/deepar/wasm/tfjs-backend-wasm-simd.wasm"
+             */
+            tfjsBackendWasmSimdPath?: string;
+            /**
+             * Path to tfjs-backend-wasm-threaded-simd.wasm file, e.g. "path/to/deepar/wasm/tfjs-backend-wasm-threaded-simd.wasm"
+             */
+            tfjsBackendWasmThreadedSimdPath?: string;
+        };
+        /**
+         * Segmentation module path and options.
+         */
+        segmentationConfig?: {
+            /**
+             * Path to the base segmentation model. Something like "path/to/deepar/models/segmentation/segmentation-192x192.bin".
+             * Thi is not used by default.
+             */
+            modelPath?: string;
+            /**
+             * MediaPipe segmentation config.
+             */
+            mediaPipeConfig?: {
+                /**
+                 * Base path to wasm fileset. Something like "path/to/deepar/mediaPipe/segmentation/wasm".
+                 */
+                wasmBasePath?: string;
+                /**
+                 * Media Pipe selfie segmenter model to be used. Something like "path/to/deepar/mediaPipe/segmentation/model/selfie_segmenter.tflite"
+                 */
+                modelPath?: string;
+            };
+        };
+        /**
+         * Foot tracking module paths and options.
+         */
+        footTrackingConfig?: {
+            /**
+             * Path to the pose libPoseEstimation.wasm file, e.g. "/path/to/deepar/wasm/libPoseEstimation.wasm".
+             */
+            poseEstimationWasmPath?: string;
+            /**
+             * Path to the detector model, e.g. "/path/to/deepar/models/foot/foot-detector.bin".
+             */
+            detectorPath?: string;
+            /**
+             * Path to the tracker model, e.g. "/path/to/deepar/models/foot/foot-tracker.bin".
+             */
+            trackerPath?: string;
+            /**
+             * Path to the foot model object file, e.g. "/path/to/deepar/models/foot/foot-model.obj".
+             */
+            objPath?: string;
+            /**
+             * Path to tfjs-backend-wasm.wasm file, e.g. "path/to/deepar/wasm/tfjs-backend-wasm.wasm"
+             */
+            tfjsBackendWasmPath?: string;
+            /**
+             * Path to tfjs-backend-wasm-simd.wasm file, e.g. "path/to/deepar/wasm/tfjs-backend-wasm-simd.wasm"
+             */
+            tfjsBackendWasmSimdPath?: string;
+            /**
+             * Path to tfjs-backend-wasm-threaded-simd.wasm file, e.g. "path/to/deepar/wasm/tfjs-backend-wasm-threaded-simd.wasm"
+             */
+            tfjsBackendWasmThreadedSimdPath?: string;
+        };
+        /**
+         * Foot tracking module paths and options.
+         */
+        wristTrackingConfig?: {
+            /**
+             * Path to the pose libPoseEstimation.wasm file, e.g. "/path/to/deepar/wasm/libPoseEstimation.wasm".
+             */
+            poseEstimationWasmPath?: string;
+            /**
+             * Path to the detector model, e.g. "/path/to/deepar/models/foot/foot-detector.bin".
+             */
+            detectorPath?: string;
+            /**
+             * Path to the tracker model, e.g. "/path/to/deepar/models/foot/foot-tracker.bin".
+             */
+            trackerPath?: string;
+            /**
+             * Path to the foot model object file, e.g. "/path/to/deepar/models/foot/foot-model.obj".
+             */
+            objPath?: string;
+            /**
+             * Path to tfjs-backend-wasm.wasm file, e.g. "path/to/deepar/wasm/tfjs-backend-wasm.wasm"
+             */
+            tfjsBackendWasmPath?: string;
+            /**
+             * Path to tfjs-backend-wasm-simd.wasm file, e.g. "path/to/deepar/wasm/tfjs-backend-wasm-simd.wasm"
+             */
+            tfjsBackendWasmSimdPath?: string;
+            /**
+             * Path to tfjs-backend-wasm-threaded-simd.wasm file, e.g. "path/to/deepar/wasm/tfjs-backend-wasm-threaded-simd.wasm"
+             */
+            tfjsBackendWasmThreadedSimdPath?: string;
+        };
+        /**
+         * Path to deepar.wasm file. Something like "/path/to/deepar/wasm/deepar.wasm".
+         */
+        deeparWasmPath?: string;
+    };
+}

package/lib/js/types/logType.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @internal
+ * Enum that defines possible types of logging messages.
+ */
+export declare enum LogType {
+    /**
+     * Information logging message.
+     */
+    INFO = 1,
+    /**
+     * Warning logging message.
+     */
+    WARNING = 2,
+    /**
+     * Error logging message.
+     */
+    ERROR = 3
+}

package/lib/js/types/mediaRecorderVideoRecording.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="dom-mediacapture-transform" />
+export declare function startMediaRecorderVideoRecording(canvas: HTMLCanvasElement, options: {
+    audioTrack?: MediaStreamAudioTrack;
+    audioBitRate?: number;
+    audioSampleRate: number;
+    videoBitRate: number;
+    videoFrameRate: number;
+    mimeType: string;
+}): void;
+export declare function finishMediaRecorderVideoRecording(): Promise<Blob>;

package/lib/js/types/scriptingApi.d.ts

@@ -0,0 +1,107 @@
+/**
+ * DeepAR Scripting API interop variable types.
+ */
+export declare enum VarType {
+    Bool = 0,
+    Int = 1,
+    Double = 2,
+    String = 3
+}
+/**
+ * A DeepAR Scripting API interop namespace.
+ */
+export declare class ScriptingAPI {
+    private module;
+    /**
+     * @internal
+     * @param module DeepAR emscripten module.
+     */
+    constructor(module: any);
+    /**
+     * Check if variable with the given name is already created.
+     * @param name The variable name.
+     * @param slot The slot of the effect in which to search the variable. If it is not given, variable will be searched for in all the effects.
+     * @return boolean True if the variable is already created, false otherwise.
+     */
+    hasVar(name: string, slot?: string): boolean;
+    /**
+     * Get the type of the variable with the given name.
+     * @param name The variable name.
+     * @param slot The slot of the effect in which to search the variable. If it is not given, variable will be searched for in all the effects.
+     * @return VarType The variable type.
+     */
+    getVarType(name: string, slot?: string): VarType;
+    /**
+     * Get boolean variable with the given name.
+     * @param name The variable name.
+     * @param slot The slot of the effect in which to search the variable. If it is not given, variable will be searched for in all the effects.
+     * @return boolean Value of the variable with the specified name.
+     */
+    getBoolVar(name: string, slot?: string): boolean;
+    /**
+     * Get int variable with the given name.
+     * @param name The variable name.
+     * @param slot The slot of the effect in which to search the variable. If it is not given, variable will be searched for in all the effects.
+     * @return int Value of the variable with the specified name.
+     */
+    getIntVar(name: string, slot?: string): number;
+    /**
+     * Get the double variable with the given name.
+     * @param name The variable name.
+     * @param slot The slot of the effect in which to search the variable. If it is not given, variable will be searched for in all the effects.
+     * @return double Value of the variable with the specified name.
+     */
+    getDoubleVar(name: string, slot?: string): number;
+    /**
+     * Get the string variable with the given name.
+     * @param name The variable name.
+     * @param slot The slot of the effect in which to search the variable. If it is not given, variable will be searched for in all the effects.
+     * @return string Value of the variable with the specified name.
+     */
+    getStringVar(name: string, slot?: number): string;
+    /**
+     * Set the boolean variable with the given name.
+     * @param name The variable name.
+     * @param value Value to be set.
+     * @param slot The slot of the effect in which to search the variable. If it is not given, variable will be searched for in all the effects.
+     * @return True if the variable is created, false if the variable already exists and the new value is set.
+     */
+    setBoolVar(name: string, value: boolean, slot?: string): boolean;
+    /**
+     * Set the int variable with the given name.
+     * @param name The variable name.
+     * @param value Value to be set.
+     * @param slot The slot of the effect in which to search the variable. If it is not given, variable will be searched for in all the effects.
+     * @return True if the variable is created, false if the variable already exists and the new value is set.
+     */
+    setIntVar(name: string, value: number, slot?: string): boolean;
+    /**
+     * Set the double variable with the given name.
+     * @param name The variable name.
+     * @param value Value to be set.
+     * @param slot The slot of the effect in which to search the variable. If it is not given, variable will be searched for in all the effects.
+     * @return True if the variable is created, false if the variable already exists and the new value is set.
+     */
+    setDoubleVar(name: string, value: number, slot?: string): boolean;
+    /**
+     * Set the string variable with the given name.
+     * @param name The variable name.
+     * @param value Value to be set.
+     * @param slot The slot of the effect in which to search the variable. If it is not given, variable will be searched for in all the effects.
+     * @return True if the variable is created, false if the variable already exists and the new value is set.
+     */
+    setStringVar(name: string, value: string, slot?: string): boolean;
+    /**
+     * Delete variable with the given name.
+     * @param name The variable name.
+     * @param slot The slot of the effect in which to search the variable. If it is not given, variable will be searched for in all the effects.
+     * @return boolean True if the variable is deleted, false otherwise.
+     */
+    deleteVar(name: string, slot?: string): boolean;
+    /**
+     * Clear all variables or variables from the specified effect.
+     * @param slot The slot of the effect in which to search the variable. If it is not given, variable will be searched for in all the effects.
+     * @return boolean True if one or more variables are deleted, false otherwise.
+     */
+    clearVars(slot?: string): boolean;
+}

package/lib/js/types/touchType.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Describes the touch/click type.
+ */
+export declare enum ARTouchType {
+    /**
+     * Touch started.
+     */
+    Start = 0,
+    /**
+     * Touch is pressed and is being moved.
+     */
+    Move = 1,
+    /**
+     * Touch ended.
+     */
+    End = 2
+}
+/**
+ * Information about the touch. Used by {@link DeepAR.touchOccurred}.
+ */
+export interface ARTouchInfo {
+    /**
+     * X coordinate.
+     */
+    x: number;
+    /**
+     * Y coordinate
+     */
+    y: number;
+    /**
+     * Touch type.
+     */
+    touchType: ARTouchType;
+}

package/lib/js/types/version.d.ts

@@ -0,0 +1,5 @@
+/**
+ * DeepAR Web SDK version.
+ */
+declare const version = "5.4.3-chromeExtension";
+export { version };

package/lib/js/types/webCodecsVideoRecording.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="dom-mediacapture-transform" />
+import { DeepARCallbacks } from './callbacks';
+export declare function startWebCodecVideoRecording(canvas: HTMLCanvasElement, callbacks: DeepARCallbacks, options: {
+    audioTrack?: MediaStreamAudioTrack;
+    audioBitRate?: number;
+    audioSampleRate: number;
+    videoBitRate: number;
+    videoFrameRate: number;
+    mimeType: string;
+}): Promise<void>;
+export declare function finishWebCodecVideoRecording(callbacks: DeepARCallbacks): Promise<Blob>;

package/lib/js/types/wristData.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Information about the wrist being tracked. WristData object is constructed and passed in the {@link DeepARCallbacks.onWristTracked} callback.
+ */
+export interface WristData {
+    /**
+     * True if the wrist is detected, false otherwise.
+     */
+    detected: boolean;
+    /**
+     * True if the detected wrist is of the left hande. False if the detected wrist is of the right hand.
+     */
+    isLeft: boolean;
+}