@cesdk/engine 1.9.0 → 1.9.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/index.d.ts CHANGED
@@ -462,7 +462,20 @@ export declare class BlockAPI {
462
462
  * @returns A promise that resolves with an array of the exported image and mask or is rejected with an error.
463
463
  */
464
464
  exportWithColorMask(handle: DesignBlockId, mimeType: MimeType_2 | undefined, maskColorR: number, maskColorG: number, maskColorB: number, options?: ExportOptions): Promise<Blob[]>;
465
-
465
+ /**
466
+ * Exports a design block as a video file of the given mime type.
467
+ * Note: The export will run across multiple iterations of the update loop. In each iteration a frame is scheduled for encoding.
468
+ * @param block - The design block to export.
469
+ * @param timeOffset - The time offset in seconds of the scene's timeline from which the video will start.
470
+ * @param duration - The duration in seconds of the final video.
471
+ * @param mimeType - The mime type of the output video file.
472
+ * @param resolutionWidth - The target video width in pixel.
473
+ * @param resolutionHeight - The target video height in pixel.
474
+ * @param framerate - The target framerate in Hz.
475
+ * @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.
476
+ * @returns A promise that resolves with video blob or is rejected with an error.
477
+ */
478
+ 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>;
466
479
  /**
467
480
  * Loads existing blocks from the given string.
468
481
  * The blocks are not attached by default and won't be visible until attached to a page or the scene.
@@ -2080,6 +2093,13 @@ export declare interface Configuration {
2080
2093
  * and always create a webgl1 context.
2081
2094
  */
2082
2095
  forceWebGL1?: boolean;
2096
+ /**
2097
+ * Whether the engine should automatically choose an audio output device or
2098
+ * should not output audio at all.
2099
+ *
2100
+ * If not configured the fallback value is 'auto'.
2101
+ */
2102
+ audioOutput?: 'auto' | 'none';
2083
2103
  }
2084
2104
 
2085
2105
  /**