@cesdk/engine 1.8.0-alpha.4 → 1.8.0

package/index.d.ts

@@ -93,6 +93,7 @@ export declare class AssetAPI {
      * @param assetResult - A single assetResult of a `findAssets` query.
      */
     defaultApplyAsset(assetResult: AssetResult): Promise<void>;
+
 }
 
 /**
@@ -366,6 +367,12 @@ 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>;
 
 }
 
@@ -1003,6 +1010,16 @@ export declare class BlockAPI {
      * @param minScaleRatio - The minimal crop scale ratio to go down to.
      */
     adjustCropToFillFrame(id: DesignBlockId, minScaleRatio: number): number;
+    /**
+     * Adjusts the crop in order to flip the content along its own horizontal axis.
+     * @param block - The block whose crop should be updated.
+     */
+    flipCropHorizontal(id: DesignBlockId): void;
+    /**
+     * Adjusts the crop in order to flip the content along its own vertical axis.
+     * @param block - The block whose crop should be updated.
+     */
+    flipCropVertical(id: DesignBlockId): void;
     /**
      * Query if the given block has an opacity.
      * @param id - The block to query.
@@ -1614,6 +1631,13 @@ export declare class BlockAPI {
      * @returns whether the key exists.
      */
     hasMetadata(id: DesignBlockId, key: string): boolean;
+    /**
+     * Query all metadata keys that exist on this block.
+     * @param id - The block whose metadata will be accessed.
+     * @returns A list of all metadata keys on this block or an error,
+     * if the block is invalid.
+     */
+    findAllMetadata(id: DesignBlockId): string[];
     /**
      * Remove metadata associated with the key from the given block.
      * If the key does not exist, this method will fail.
@@ -1690,23 +1714,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;
     /**
@@ -1768,6 +1795,24 @@ 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>;
 }
 
 /**
@@ -2402,11 +2447,8 @@ declare type HexColorString = string;
  *
  * @public
  */
-export declare class HTMLCreativeEngineCanvasElement extends HTMLElement {
-    #private;
-    constructor();
-    connectedCallback(): void;
-    disconnectedCallback(): void;
+export declare interface HTMLCreativeEngineCanvasElement extends HTMLElement {
+
 
 }
 
@@ -2774,6 +2816,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;