deepar 4.0.2 → 4.0.3-alpha-test

package/README.md

@@ -1,6 +1,6 @@
 # deepar
 
-DeepAR SDK for Web is an augmented reality SDK that allows users to integrate advanced, Snapchat-like face lenses in the browser environment. It supports face masks, effects, multiple face tracking, natural image tracking. The hair segmentation and emotion tracking are **not** supported.
+DeepAR SDK for Web is an augmented reality SDK that allows users to integrate advanced, Snapchat-like face lenses in the browser environment. It supports face masks, effects, multiple face tracking, natural image tracking.
 The SDK requires an internet connection.
 
 ## Documentation
@@ -10,6 +10,8 @@ See the official example here: https://github.com/DeepARSDK/quickstart-web-js-np
 
 ## Prerequisites
 
+> ⚠️ Note that these steps are only needed when deploying to production (non-localhost) domain.
+
 In order to use the DeepAR Web SDK you need to set up a license key for your web app on [developer.deepar.ai](https://developer.deepar.ai).
 1. Create an account: https://developer.deepar.ai/signup.
 2. Create a project: https://developer.deepar.ai/projects.

package/js/deepar.d.ts

@@ -86,6 +86,10 @@ export interface DeepARCallbacks {
      * @param faceDataArray Information about all the tracked faces.
      */
     onFaceTracked?: (faceDataArray: FaceData[]) => void;
+    /**
+     * Called when one or both feet are tracked.
+     */
+    onFeetTracked?: () => void;
     /**
      * Called when any DeepAR related event happens
      * @param errorType Type of message.
@@ -284,6 +288,11 @@ export declare class DeepAR {
      * @param callback Callback to be called when the download is complete.
      */
     downloadFaceTrackingModel(path: string, callback?: () => void): void;
+    /**
+     * Downloads the foot tracking models defined when creating DeepAR and sets them up. When it's done, the callback is invoked.
+     * @param callback Callback to be called when the download is complete.
+     */
+    initializeFootTracking(callback?: () => void): void;
     /**
      * Sets the face tracking model data.
      * @param byteArray Face tracking model data.

package/js/deepar.esm.d.ts

@@ -86,6 +86,10 @@ export interface DeepARCallbacks {
      * @param faceDataArray Information about all the tracked faces.
      */
     onFaceTracked?: (faceDataArray: FaceData[]) => void;
+    /**
+     * Called when one or both feet are tracked.
+     */
+    onFeetTracked?: () => void;
     /**
      * Called when any DeepAR related event happens
      * @param errorType Type of message.
@@ -284,6 +288,11 @@ export declare class DeepAR {
      * @param callback Callback to be called when the download is complete.
      */
     downloadFaceTrackingModel(path: string, callback?: () => void): void;
+    /**
+     * Downloads the foot tracking models defined when creating DeepAR and sets them up. When it's done, the callback is invoked.
+     * @param callback Callback to be called when the download is complete.
+     */
+    initializeFootTracking(callback?: () => void): void;
     /**
      * Sets the face tracking model data.
      * @param byteArray Face tracking model data.