@cesdk/engine 1.22.0-rc.2 → 1.23.0-rc.0

package/index.d.ts

@@ -2280,6 +2280,19 @@ export declare class BlockAPI {
      * @returns A method that will cancel any thumbnail generation request in progress for this block.
      */
     generateVideoThumbnailSequence(id: DesignBlockId, thumbnailHeight: number, timeBegin: number, timeEnd: number, numberOfFrames: number, onFrame: (frameIndex: number, result: ImageData | Error) => void): () => void;
+    /**
+     * Generate a thumbnail sequence for the given audio block or video fill.
+     * A thumbnail in this case is a chunk of samples in the range of 0 to 1.
+     * In case stereo data is requested, the samples are interleaved, starting with the left channel.
+     * @param id - The audio block or video fill.
+     * @param samplesPerChunk - The number of samples per chunk. `onChunk` is called when this many samples are ready.
+     * @param timeBegin - The time in seconds at which the thumbnail sequence should start.
+     * @param timeEnd - The time in seconds at which the thumbnail sequence should end.
+     * @param numberOfSamples - The total number of samples to generate.
+     * @param numberOfChannels - The number of channels in the output. 1 for mono, 2 for stereo.
+     * @param onChunk - This gets passed an index and a chunk of samples whenever it's ready, or an error.
+     */
+    generateAudioThumbnailSequence(id: DesignBlockId, samplesPerChunk: number, timeBegin: number, timeEnd: number, numberOfSamples: number, numberOfChannels: number, onChunk: (chunkIndex: number, result: Float32Array | Error) => void): () => void;
     /**
      * Generate a thumbnail for the given video fill.
      * @param id - The video fill.
@@ -2776,8 +2789,8 @@ declare class CreativeEngine {
      * - `initialize` - Called once when the plugin is added to the engine
      * - `update` - Called every frame
      *
-     * PLEASE NOTE: Plugins not provded via URL will not be executed in the worker, e.g.
-     * during the video export the update method is not called.
+     * PLEASE NOTE: Only Plugins provded via URL will be executed in the worker, e.g.
+     * during the video export the update method will be called.
      *
      * Please be aware that this is experimental right now. This API can change or
      * be replaced or even removed completely in future versions.
@@ -2796,7 +2809,10 @@ declare class CreativeEngine {
      * @param timeout - Timeout in milliseconds (default: 10 seconds)
      */
     unstable_setVideoExportInactivityTimeout(timeout: number): void;
-
+    /**
+     * @returns An `unwrap` function that can be used to remove this wrapper from the list of wrappers
+     */
+    addPostUpdateCallback(callback: () => void): () => void;
     /**
      * Install the mousewheel event handler for the CreativeEngine on a different
      * element than the canvas.
@@ -2948,6 +2964,9 @@ export declare class EditorAPI {
 
 
 
+
+
+
     /**
      * Subscribe to changes to the editor state.
      * @param callback - This function is called at the end of the engine update, if the editor state has changed.
@@ -3325,7 +3344,7 @@ export declare type EffectTypeLonghand = `//ly.img.ubq/effect/${EffectTypeShorth
  * using `cesdk.engine.editor.createEffect(id)`.
  * @public
  */
-export declare type EffectTypeShorthand = 'adjustments' | 'cross_cut' | 'dot_pattern' | 'duotone_filter' | 'extrude_blur' | 'glow' | 'half_tone' | 'linocut' | 'liquid' | 'lut_filter' | 'mirror' | 'outliner' | 'pixelize' | 'posterize' | 'radial_pixel' | 'sharpie' | 'shifter' | 'tilt_shift' | 'tv_glitch' | 'vignette';
+export declare type EffectTypeShorthand = 'adjustments' | 'cross_cut' | 'dot_pattern' | 'duotone_filter' | 'extrude_blur' | 'glow' | 'green_screen' | 'half_tone' | 'linocut' | 'liquid' | 'lut_filter' | 'mirror' | 'outliner' | 'pixelize' | 'posterize' | 'radial_pixel' | 'recolor' | 'sharpie' | 'shifter' | 'tilt_shift' | 'tv_glitch' | 'vignette';
 
 /** @public */
 export declare interface EnginePlugin {
@@ -4314,6 +4333,11 @@ export declare type VideoExportOptions = {
     abortSignal?: AbortSignal;
 };
 
+/** Data needed for setting up the engine in the worker that is _not_ covered by the config */
+declare type WorkerOptions_2 = {
+    trackingMetadata?: TrackingMetadata;
+};
+
 /**
  * Describes a rectangle on the screen
  * - `x` and `y` indicate the position