deepar 4.0.0 → 4.0.2

package/js/deepar.d.ts

@@ -205,6 +205,20 @@ declare enum LogType {
      */
     ERROR = 3
 }
+/**
+ * Parameters that specify the format of recorded videos. Used by {@link DeepAR.startVideoRecording}.
+ */
+export interface VideoRecordingOptions {
+    /**
+     * A MIME type specyfing the format for the resulting video, such as `video/webm` or `video/mp4`.
+     * Corresponds to the MIME type used by <a href="https://developer.mozilla.org/en-US/docs/Web/API/Blob">Blob</a>
+     * objects and <a href="https://developer.mozilla.org/en-US/docs/Web/API/MediaRecorder">MediaRecorder</a>
+     * from the MediaStream Recording API.
+     *
+     * Note that `video/mp4` may not be supported in all browsers.
+     */
+    mimeType?: string;
+}
 /**
  * Main class for interacting with DeepAR SDK.
  */
@@ -375,8 +389,9 @@ export declare class DeepAR {
     touchOccurred(touchInfo: ARTouchInfo): void;
     /**
      * Starts video recording of the canvas.
+     * @param options Video recording options.
      */
-    startVideoRecording(): void;
+    startVideoRecording(options?: VideoRecordingOptions): void;
     /**
      * Stops the video recording and returns a video blob via callback.
      * @param callback A callback function with single argument that will be a blob of video/mp4 file.
@@ -414,6 +429,11 @@ export declare class DeepAR {
      * @param enable True - DeepAR will use its internal timer for the rendering loop. Rendering will work even when tab is not focused. False - DeepAR will use requestAnimationFrame() for the rendering loop.
      */
     setOffscreenRenderingEnabled(enable: boolean): void;
+    /**
+     * @internal
+     * @param enable
+     */
+    enableAutoframing(enable: boolean): void;
     /**
      * Used to initialize the DeepAR SDK.<br><br>
      * <strong><u>IMPORTANT</u></strong>: Note that this is now called with the <b>new</b> keyword. In previous versions of SDK this was just a plain function called without new keyword

package/js/deepar.esm.d.ts

@@ -205,6 +205,20 @@ declare enum LogType {
      */
     ERROR = 3
 }
+/**
+ * Parameters that specify the format of recorded videos. Used by {@link DeepAR.startVideoRecording}.
+ */
+export interface VideoRecordingOptions {
+    /**
+     * A MIME type specyfing the format for the resulting video, such as `video/webm` or `video/mp4`.
+     * Corresponds to the MIME type used by <a href="https://developer.mozilla.org/en-US/docs/Web/API/Blob">Blob</a>
+     * objects and <a href="https://developer.mozilla.org/en-US/docs/Web/API/MediaRecorder">MediaRecorder</a>
+     * from the MediaStream Recording API.
+     *
+     * Note that `video/mp4` may not be supported in all browsers.
+     */
+    mimeType?: string;
+}
 /**
  * Main class for interacting with DeepAR SDK.
  */
@@ -375,8 +389,9 @@ export declare class DeepAR {
     touchOccurred(touchInfo: ARTouchInfo): void;
     /**
      * Starts video recording of the canvas.
+     * @param options Video recording options.
      */
-    startVideoRecording(): void;
+    startVideoRecording(options?: VideoRecordingOptions): void;
     /**
      * Stops the video recording and returns a video blob via callback.
      * @param callback A callback function with single argument that will be a blob of video/mp4 file.
@@ -414,6 +429,11 @@ export declare class DeepAR {
      * @param enable True - DeepAR will use its internal timer for the rendering loop. Rendering will work even when tab is not focused. False - DeepAR will use requestAnimationFrame() for the rendering loop.
      */
     setOffscreenRenderingEnabled(enable: boolean): void;
+    /**
+     * @internal
+     * @param enable
+     */
+    enableAutoframing(enable: boolean): void;
     /**
      * Used to initialize the DeepAR SDK.<br><br>
      * <strong><u>IMPORTANT</u></strong>: Note that this is now called with the <b>new</b> keyword. In previous versions of SDK this was just a plain function called without new keyword