@cesdk/cesdk-js 1.9.0 → 1.9.2

package/index.d.ts

@@ -496,6 +496,11 @@ declare interface AssetsQueryResult_2 {
     total: number;
 }
 
+/** @public */
+declare interface AudioElement extends _AssetElement {
+    duration: number;
+}
+
 /**
  * Bleed margin configuration options for a single design unit type.
  * @public
@@ -544,7 +549,20 @@ export declare class BlockAPI {
      * @returns A promise that resolves with an array of the exported image and mask or is rejected with an error.
      */
     exportWithColorMask(handle: DesignBlockId, mimeType: MimeType_2 | undefined, maskColorR: number, maskColorG: number, maskColorB: number, options?: EngineExportOptions): Promise<Blob[]>;
-
+    /**
+     * Exports a design block as a video file of the given mime type.
+     * Note: The export will run across multiple iterations of the update loop. In each iteration a frame is scheduled for encoding.
+     * @param block - The design block to export.
+     * @param timeOffset - The time offset in seconds of the scene's timeline from which the video will start.
+     * @param duration - The duration in seconds of the final video.
+     * @param mimeType - The mime type of the output video file.
+     * @param resolutionWidth - The target video width in pixel.
+     * @param resolutionHeight - The target video height in pixel.
+     * @param framerate - The target framerate in Hz.
+     * @param progressCallback - A callback which reports on the progress of the export. It informs the receiver of the current frame index, which currently gets exported and the total frame count.
+     * @returns A promise that resolves with video blob or is rejected with an error.
+     */
+    exportVideo(handle: DesignBlockId, timeOffset: number, duration: number, mimeType: MimeType_2 | undefined, resolutionWidth: number, resolutionHeight: number, framerate: number, progressCallback: (numberOfRenderedFrames: number, numberOfEncodedFrames: number, totalNumberOfFrames: number) => void): Promise<Blob>;
     /**
      * Loads existing blocks from the given string.
      * The blocks are not attached by default and won't be visible until attached to a page or the scene.
@@ -2580,6 +2598,13 @@ export declare interface _EngineConfiguration {
      * and always create a webgl1 context.
      */
     forceWebGL1?: boolean;
+    /**
+     * Whether the engine should automatically choose an audio output device or
+     * should not output audio at all.
+     *
+     * If not configured the fallback value is 'auto'.
+     */
+    audioOutput?: 'auto' | 'none';
 }
 
 /**
@@ -3442,6 +3467,15 @@ declare interface Vec3 {
     z: number;
 }
 
+/** @public */
+declare interface VideoElement extends _AssetElement {
+    duration: number;
+    size: {
+        width: number;
+        height: number;
+    };
+}
+
 /** @public */
 declare enum ViewStyle {
     Advanced = "advanced",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cesdk/cesdk-js",
-  "version": "1.9.0",
+  "version": "1.9.2",
   "main": "./cesdk.umd.js",
   "types": "./index.d.ts",
   "homepage": "https://www.img.ly",