deepar 5.1.0 → 5.2.0-wristTracking-alpha-796

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.

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.0";
+declare const version = "5.2.0-wristTracking-alpha-796";
 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;
+}