deepar 5.6.3 → 5.6.4

package/js/types/DeepAR.d.ts

@@ -319,10 +319,12 @@ export declare class DeepAR {
      *
      * If the foot tracking is already initialized it will do nothing.
      * To check if foot tracking is initialized call {@link isFootTrackingInitialized} or wait {@link DeepARCallbacks.onFootTrackingInitialized} callback.
+     * @internal
      */
     initializeFootTracking(): void;
     /**
      * Check weather the foot tracking is initialized.
+     * @internal
      */
     isFootTrackingInitialized(): boolean;
     /**
@@ -342,6 +344,7 @@ export declare class DeepAR {
     isSegmentationInitialized(): boolean;
     /**
      * Check weather the wrist tracking is initialized.
+     * @internal
      */
     isWristTrackingInitialized(): boolean;
     /**

package/js/types/callbacks.d.ts

@@ -23,18 +23,21 @@ export interface DeepARCallbacks {
      * NOTE: This callback is only called when the SDK does foot tracking. For example, you laded some effect that uses foot tracking (shoe-try-on effects). But if no effect is loaded this callback will not get called because the SDK is not performing foot tracking.
      * @param leftFootData Information about the left foot.
      * @param rightFootData Information about the right foot.
+     * @internal
      */
     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.
+     * @internal
      */
     onWristTracked?: (wristData: WristData) => void;
     /**
      * Called when foot tracking is fully initialized.
      * Be sure to check {@link DeepAR.isFootTrackingInitialized} before setting this callback.
      * Because this callback is called only once. So if you set this callback after the foot tracking is initialized, it will not be called again.
+     * @internal
      */
     onFootTrackingInitialized?: () => void;
     /**
@@ -47,6 +50,7 @@ export interface DeepARCallbacks {
      * 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.
+     * @internal
      */
     onWristTrackingInitialized?: () => void;
     /**
@@ -60,5 +64,10 @@ export interface DeepARCallbacks {
      * @internal
      */
     __deeparRendered?: (canvas: HTMLCanvasElement) => void;
+    /**
+     * An internal callback called on every render() after __deeparRendered.
+     * @param canvas A canvas containing input camera image that DeepAR used for rendering/tracking.
+     * @internal
+     */
     __deeparRendered2?: (canvas: HTMLCanvasElement) => void;
 }

package/js/types/footData.d.ts

@@ -1,5 +1,6 @@
 /**
  * Information about the feet being tracked. FootData object is constructed and passed in the {@link DeepARCallbacks.onFeetTracked} callback.
+ * @internal
  */
 export interface FootData {
     /**

package/js/types/initParams.d.ts

@@ -95,11 +95,8 @@ export interface DeepARParams {
          * <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>faceInit</b> - Will initialize face tracking as soon as possible. Without this hint face tracking is lazy loaded when some face tracking 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>
-         *     <li><b>wristInit</b> - Will initialize wrist tracking as soon as possible. Without this hint wrist tracking is lazy loaded when some wrist tracking effect is loaded.</li>
          * </ul>
          */
         hint?: string | string[];
@@ -118,15 +115,15 @@ export interface DeepARParams {
              */
             poseEstimationWasmPath?: string;
             /**
-             * Path to the detector model, e.g. "/path/to/deepar/models/foot/foot-detector.bin".
+             * Path to the detector model, e.g. "/path/to/deepar/models/face-cnn/face-det.bin".
              */
             detectorPath?: string;
             /**
-             * Path to the tracker model, e.g. "/path/to/deepar/models/foot/foot-tracker.bin".
+             * Path to the tracker model, e.g. "/path/to/deepar/models/face-cnn/face-track-19-v2.bin".
              */
             trackerPath?: string;
             /**
-             * Path to the foot model object file, e.g. "/path/to/deepar/models/foot/foot-model.obj".
+             * Path to the face model object file, e.g. "/path/to/deepar/models/face/face-rigid.obj".
              */
             objPath?: string;
             /**
@@ -167,6 +164,7 @@ export interface DeepARParams {
         };
         /**
          * Foot tracking module paths and options.
+         * @internal
          */
         footTrackingConfig?: {
             /**
@@ -200,6 +198,7 @@ export interface DeepARParams {
         };
         /**
          * Foot tracking module paths and options.
+         * @internal
          */
         wristTrackingConfig?: {
             /**

package/js/types/version.d.ts

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

package/js/types/wristData.d.ts

@@ -1,5 +1,6 @@
 /**
  * Information about the wrist being tracked. WristData object is constructed and passed in the {@link DeepARCallbacks.onWristTracked} callback.
+ * @internal
  */
 export interface WristData {
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "deepar",
-  "version": "5.6.3",
+  "version": "5.6.4",
   "description": "The official DeepAR Web SDK",
   "main": "js/deepar.esm.js",
   "jsdelivr": "js/deepar.js",
@@ -14,7 +14,6 @@
     "bacground removal",
     "bacground replacement",
     "background blur",
-    "shoe try-on",
     "AR mini-games"
   ],
   "author": "deepar",