deepar 5.0.0-alpha-2 → 5.0.0-alpha-4

package/js/types/DeepAR.d.ts

@@ -49,7 +49,7 @@ export declare class DeepAR {
      *
      * @param effect A path (URL) to the AR effect file or an ArrayBuffer object of an already fetched AR effect file.
      * @param effectOptions Effect options.
-     * @param effectOptions.slot Default value is "mask" if slot is not given. Slot is a container for a given AR effect. When replacing the already loaded AR effect, call switchEffect with that same slot. To remove AR effect entirely, call {@link clearEffect} with the same slot.
+     * @param effectOptions.slot Default value is "DEFAULT_SLOT" if slot is not given. Slot is a container for a given AR effect. When replacing the already loaded AR effect, call switchEffect with that same slot. To remove AR effect entirely, call {@link clearEffect} with the same slot.
      * @param effectOptions.face If AR effect is face filter, select to which face to attach it to. The value should be between 0 and 3. Default value is 0.
      *
      *
@@ -77,7 +77,7 @@ export declare class DeepAR {
     }): Promise<void>;
     /**
      * Clears the given slot of any loaded effects.
-     * @param slot The effect slot name.
+     * @param slot The effect slot name. Default is "DEFAULT_SLOT".
      */
     clearEffect(slot?: string): void;
     /**
@@ -160,7 +160,7 @@ export declare class DeepAR {
      * Pauses the DeepAR processing and rendering on canvas.
      * @param isPause If true, DeepAR will pause. Otherwise, it will resume processing and rendering.
      */
-    pause(isPause: boolean): void;
+    setPaused(isPause: boolean): void;
     /**
      * Changes a node or component bool parameter of the currently loaded effect. For more details about changeParameter API read our docs <a href="https://docs.deepar.ai/guides-and-tutorials/changing-filter-parameters-from-code">here</a>.
      * @param gameObject The name of the node from DeepAR Studio. If multiple nodes share the same name, only the first one will be affected.

package/js/types/callbacks.d.ts

@@ -39,4 +39,10 @@ export interface DeepARCallbacks {
      * @param newState Name of the new state that is being transitioned to.
      */
     onAnimationTransitionedToState?: (newState: string) => void;
+    /**
+     * An internal callback called on every render().
+     * @param canvas A canvas containing input camera image that DeepAR used for rendering/tracking.
+     * @internal
+     */
+    __deeparRendered?: (canvas: HTMLCanvasElement) => void;
 }

package/js/types/version.d.ts

@@ -1,5 +1,5 @@
 /**
  * DeepAR Web SDK version.
  */
-declare const version = "5.0.0-alpha-2";
+declare const version = "5.0.0-alpha-4";
 export { version };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "deepar",
-  "version": "5.0.0-alpha-2",
+  "version": "5.0.0-alpha-4",
   "description": "The official DeepAR Web SDK",
   "main": "js/deepar.esm.js",
   "jsdelivr": "js/deepar.js",