@cesdk/engine 1.8.0-alpha.5 → 1.9.0-preview.0

package/index.d.ts

@@ -367,6 +367,13 @@ export declare type BlendMode = 'PassThrough' | 'Normal' | 'Darken' | 'Multiply'
  */
 export declare class Block extends Entity {
     effects: ReadWriteChannelSync<number[]>;
+    soloPlaybackEnabled: ReadWriteChannelSync<boolean>;
+    trimOffset: ReadWriteChannelSync<number>;
+    trimLength: ReadWriteChannelSync<number>;
+    playing: ReadWriteChannelSync<boolean>;
+    playbackTime: ReadWriteChannelSync<number>;
+    selection: ReadWriteChannelSync<boolean>;
+    videoMode: ReadWriteChannelSync<boolean>;
 
 }
 
@@ -1708,23 +1715,26 @@ export declare class BlockAPI {
     hasTrim(id: DesignBlockId): boolean;
     /**
      * Set the trim offset of the given block or fill.
-     * Sets the relative time within the fill at which playback of the audio or video clip should begin.
-     * This is a percentage value in the range [0, 1].
+     * Sets the time in seconds within the fill at which playback of the audio or video clip should begin.
+     * This requires the video or audio clip to be loaded.
      * @param id - The block whose trim should be updated.
      * @param offset - The new trim offset.
      */
     setTrimOffset(id: DesignBlockId, offset: number): void;
     /**
      * Get the trim offset of this block.
+     * * This requires the video or audio clip to be loaded.
      * @param id - The block whose trim offset should be queried.
-     * @returns the trim offset.
+     * @returns the trim offset in seconds.
      */
     getTrimOffset(id: DesignBlockId): number;
     /**
      * Set the trim length of the given block or fill.
-     * The trim length is the percentage of the audio or video clip that should be used for playback.
+     * The trim length is the duration of the audio or video clip that should be used for playback.
+     * After reaching this value during playback, the trim region will loop.
+     * This requires the video or audio clip to be loaded.
      * @param id - The object whose trim length should be updated.
-     * @param length - The new trim length as a percentage of the clip duration in the range [0, 1].
+     * @param length - The new trim length in seconds.
      */
     setTrimLength(id: DesignBlockId, length: number): void;
     /**
@@ -1786,6 +1796,30 @@ export declare class BlockAPI {
      * @returns Whether solo playback is enabled for this block.
      */
     isSoloPlaybackEnabled(id: DesignBlockId): boolean;
+    /**
+     * Begins loading the required audio and video resource for the given video fill or audio block.
+     * @param id - The video fill or audio block whose resource should be loaded.
+     * @returns A Promise that resolves once the resource has finished loading.
+     */
+    forceLoadAVResource(id: DesignBlockId): Promise<void>;
+    /**
+     * Get the duration in seconds of the video or audio resource that is attached to the given block.
+     * @param id - The video fill or audio block.
+     * @returns The video or audio file duration
+     */
+    getAVResourceTotalDuration(id: DesignBlockId): number;
+    /**
+     * Generate a thumbnail for the given video fill.
+     * @param id - The video fill.
+     * @returns A thumbnail encoded as PNG with a height of 128px.
+     */
+    getVideoFillThumbnail(id: DesignBlockId): Promise<Blob>;
+    /**
+     * Generate an 8x8 thumbnail atlas for the given video fill.
+     * @param id - The video fill.
+     * @returns A thumbnail atlas of the video as PNG.
+     */
+    getVideoFillThumbnailAtlas(id: DesignBlockId): Promise<Blob>;
 }
 
 /**
@@ -2420,11 +2454,7 @@ declare type HexColorString = string;
  *
  * @public
  */
-export declare class HTMLCreativeEngineCanvasElement extends HTMLElement {
-    #private;
-    constructor();
-    connectedCallback(): void;
-    disconnectedCallback(): void;
+export declare interface HTMLCreativeEngineCanvasElement extends HTMLElement {
 
 
 }
@@ -2674,10 +2704,15 @@ export declare class SceneAPI {
      */
     saveToArchive(): Promise<Blob>;
     /**
-     * Create a new scene, along with its own camera.
-     * @returns The scenes handle.
+     * Create a new design scene, along with its own camera.
+     * @returns The scene's handle.
      */
     create(): DesignBlockId;
+    /**
+     * Create a new scene in video mode, along with its own camera and page stack.
+     * @returns The scene's handle.
+     */
+    createVideo(): DesignBlockId;
     /**
      * Loads the given image and creates a scene with a single page showing the image.
      * Fetching the image may take an arbitrary amount of time, so the scene isn't immediately
@@ -2793,6 +2828,18 @@ export declare type StrokeStyle = 'Dashed' | 'DashedRound' | 'Dotted' | 'LongDas
 /** @public */
 declare type Subscription = number;
 
+/**
+ * Checks if the current browser supports video editing
+ * @public
+ */
+export declare function supportsVideo(): boolean;
+
+/**
+ * Checks if the current browser supports web assembly
+ * @public
+ */
+export declare function supportsWasm(): boolean;
+
 /** @public */
 declare type TemplateDefinition = Preset & {
     label: string;