deepar 5.1.1 → 5.2.0-chromeExtension

package/js/types/DeepAR.d.ts

@@ -265,7 +265,7 @@ export declare class DeepAR {
      *
      * Segmentation is usually lazy loaded on demand when filter loaded  with {@link switchEffect} requires it.
      * But this method will start loading the segmentation immediately.
-     * To start initializing foot tracking as soon as possible pass "segmentationInit" hint in the {@link initialize} function (see {@link DeepARParams}). <br><br>
+     * To start initializing segmentation as soon as possible pass "segmentationInit" hint in the {@link initialize} function (see {@link DeepARParams}). <br><br>
      *
      * If the segmentation is already initialized it will do nothing.
      * To check if segmentation is initialized call {@link isSegmentationInitialized} or wait {@link DeepARCallbacks.onSegmentationInitialized} callback.
@@ -275,6 +275,10 @@ export declare class DeepAR {
      * Check weather the segmentation is initialized.
      */
     isSegmentationInitialized(): boolean;
+    /**
+     * Check weather the wrist tracking is initialized.
+     */
+    isWristTrackingInitialized(): boolean;
     /**
      * Display profiling metrics on preview.
      * @param enabled
@@ -319,4 +323,10 @@ export declare class DeepAR {
      * @param enabled
      */
     showColliders(enabled: boolean): void;
+    /**
+     * Sets the preview zoom.
+     *
+     * @param zoomLevel Floating point number determining how much to zoom in. Value <= 1 will disable zoom. Example, value 2.0 puts 2x zoom.
+     */
+    setZoom(zoomLevel: number): void;
 }

package/js/types/callbacks.d.ts

@@ -1,5 +1,6 @@
 import { FaceData } from "./faceData";
 import { FootData } from "./footData";
+import { WristData } from "./wristData";
 /**
  * Callbacks from DeepAR notifying events.
  * Register callbacks with {@link DeepAR.callbacks}.
@@ -24,6 +25,12 @@ export interface DeepARCallbacks {
      * @param rightFootData Information about the right foot.
      */
     onFeetTracked?: (leftFootData: FootData, rightFootData: FootData) => void;
+    /**
+     * Passes the information about the detected wrist. If this callback is set, it will get called every frame.
+     * NOTE: This callback is only called when the SDK does wrist tracking. For example, you laded some effect that uses wrist tracking (watch-try-on effects). But if no effect is loaded this callback will not get called because the SDK is not performing wrist tracking.
+     * @param wristData Information about the wrist.
+     */
+    onWristTracked?: (wristData: WristData) => void;
     /**
      * Called when foot tracking is fully initialized.
      * Be sure to check {@link DeepAR.isFootTrackingInitialized} before setting this callback.
@@ -36,6 +43,12 @@ export interface DeepARCallbacks {
      * Because this callback is called only once. So if you set this callback after the segmentation is initialized, it will not be called again.
      */
     onSegmentationInitialized?: () => void;
+    /**
+     * Called when wrist tracking is fully initialized.
+     * Be sure to check {@link DeepAR.isWristTrackingInitialized} before setting this callback.
+     * Because this callback is called only once. So if you set this callback after the wrist tracking is initialized, it will not be called again.
+     */
+    onWristTrackingInitialized?: () => void;
     /**
      * Called when the animation player transitions to a new state.
      * @param newState Name of the new state that is being transitioned to.

package/js/types/initParams.d.ts

@@ -116,6 +116,39 @@ export interface DeepARParams {
              */
             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".
          */

package/js/types/version.d.ts

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

package/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;
+}

package/lib/README.md

@@ -0,0 +1,7 @@
+# DeepAR Web SDK
+
+Add 3D face masks, effects and more with better performance than Snapchat in a powerful SDK built for HTML5.
+
+## Documentation
+
+Visit official DeepAR docs for Web SDK here https://docs.deepar.ai/category/deepar-sdk-for-web.

package/lib/VERSION.txt

@@ -0,0 +1 @@
+DeepAR SDK version: v5.2.0-chromeExtension