@cesdk/engine 1.13.1 → 1.14.0

package/index.d.ts

@@ -74,6 +74,11 @@ export declare class AssetAPI {
      * @returns The asset groups.
      */
     getGroups(id: string): Promise<string[]>;
+    /**
+     * Queries the list of supported mime types of the specified asset source.
+     * An empty result means that all mime types are supported.
+     * @param sourceId - The ID of the asset source.
+     */
     getSupportedMimeTypes(sourceId: string): string[];
     /**
      * Queries the asset source's credits info.
@@ -441,6 +446,12 @@ export declare class BlockAPI {
      * @returns A method to unsubscribe.
      */
     onSelectionChanged(callback: () => void): () => void;
+    /**
+     * Subscribe to block click events.
+     * @param callback - This function is called at the end of the engine update if a block has been clicked.
+     * @returns A method to unsubscribe.
+     */
+    onClicked(callback: (id: DesignBlockId) => void): () => void;
     /**
      * Confirms that a given set of blocks can be grouped together.
      * @param ids - A non-empty array of block ids.
@@ -508,6 +519,32 @@ export declare class BlockAPI {
      * @returns A list of block ids.
      */
     findAllPlaceholders(): DesignBlockId[];
+    /**
+     * Create a new shape, fails if type is unknown.
+     * @param type - The type of the shape object that shall be created.
+     * @returns The created shape's handle.
+     */
+    createShape(type: string): DesignBlockId;
+    /**
+     * Query if the given block has a shape property.
+     * @param id - The block to query.
+     * @returns true, if the block has a shape property, an error otherwise.
+     */
+    hasShape(id: DesignBlockId): boolean;
+    /**
+     * Returns the block containing the shape properties of the given block.
+     * @param id - The block whose shape block should be returned.
+     * @returns The block that currently defines the given block's shape.
+     */
+    getShape(id: DesignBlockId): DesignBlockId;
+    /**
+     * Sets the block containing the shape properties of the given block.
+     * Note that the previous shape block is not destroyed automatically.
+     * The new shape is disconnected from its previously attached block.
+     * @param id - The block whose shape should be changed.
+     * @param fill - The new shape.
+     */
+    setShape(id: DesignBlockId, shape: DesignBlockId): void;
     /**
      * Query a block's visibility.
      * @param id - The block to query.
@@ -1087,6 +1124,8 @@ export declare class BlockAPI {
     setCropRotation(id: DesignBlockId, rotation: number): void;
     /**
      * Set the crop scale ratio of the given design block.
+     * This will uniformly scale the content up or down. The center of the
+     * scale operation is the center of the crop frame.
      * @param id - The block whose crop should be set.
      * @param scaleRatio - The crop scale ratio.
      */
@@ -1900,6 +1939,24 @@ export declare class BlockAPI {
      * @returns the enabled state of the placeholder function.
      */
     isPlaceholderEnabled(id: DesignBlockId): boolean;
+    /**
+     * Checks whether the block supports placeholder behavior.
+     * @param block - The block to query.
+     * @returns True, if the block supports placeholder behavior.
+     */
+    hasPlaceholderBehavior(id: DesignBlockId): boolean;
+    /**
+     * Enable or disable the placeholder behavior for a block.
+     * @param id - The block whose placeholder behavior should be enabled or disabled.
+     * @param enabled - Whether the placeholder behavior should be enabled or disabled.
+     */
+    setPlaceholderBehaviorEnabled(id: DesignBlockId, enabled: boolean): void;
+    /**
+     * Query whether the placeholder behavior for a block is enabled.
+     * @param id - The block whose placeholder behavior state should be queried.
+     * @returns the enabled state of the placeholder behavior.
+     */
+    isPlaceholderBehaviorEnabled(id: DesignBlockId): boolean;
     /**
      * Query if the given block shows placeholder content.
      * @param id - The block to query.
@@ -2178,11 +2235,36 @@ export declare class BlockAPI {
      * @returns The video or audio file duration
      */
     getAVResourceTotalDuration(id: DesignBlockId): number;
+    /**
+     * Get the video width in pixels of the video resource that is attached to the given block.
+     * @param block - The video fill.
+     * @returns The video width in pixels or an error.
+     */
+    getVideoWidth(id: DesignBlockId): number;
+    /**
+     * Get the video height in pixels of the video resource that is attached to the given block.
+     * @param block - The video fill.
+     * @returns The video height in pixels or an error.
+     */
+    getVideoHeight(id: DesignBlockId): number;
+    /**
+     * Generate a sequence of thumbnails for the given video fill or page.
+     * Note: there can only be one thumbnail generation request in progress for a given block.
+     * @param id - The video fill or page.
+     * @param thumbnailHeight - The height of a thumbnail. The width will be calculated from the video aspect ratio.
+     * @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 numberOfFrames - The number of frames to generate.
+     * @param onFrame - Gets passed the frame index and RGBA image data.
+     * @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 for the given video fill.
      * @param id - The video fill.
      * @param thumbnailHeight - The height of a thumbnail. The width will be calculated from the video aspect ratio.
      * @returns A thumbnail encoded as JPEG.
+     * @deprecated Use `generateVideoThumbnailSequence` instead.
      */
     getVideoFillThumbnail(id: DesignBlockId, thumbnailHeight: number): Promise<Blob>;
     /**
@@ -2192,6 +2274,7 @@ export declare class BlockAPI {
      * @param numberOfRows - The number of rows to generate.
      * @param thumbnailHeight - The height of a thumbnail. The width will be calculated from the video aspect ratio.
      * @returns A thumbnail atlas of the video as JPEG.
+     * @deprecated Use `generateVideoThumbnailSequence` instead.
      */
     getVideoFillThumbnailAtlas(id: DesignBlockId, numberOfColumns: number, numberOfRows: number, thumbnailHeight: number): Promise<Blob>;
     /**
@@ -2201,6 +2284,7 @@ export declare class BlockAPI {
      * @param numberOfRows - The number of rows to generate.
      * @param thumbnailHeight - The height of a thumbnail. The width will be calculated from the page aspect ratio.
      * @returns A thumbnail atlas of the composition as JPEG.
+     * @deprecated Use `generateVideoThumbnailSequence` instead.
      */
     getPageThumbnailAtlas(id: DesignBlockId, numberOfColumns: number, numberOfRows: number, thumbnailHeight: number): Promise<Blob>;
 }
@@ -2734,7 +2818,7 @@ export declare enum DesignBlockType {
 }
 
 /**
- * The scene layout determines how the layout stack should layout its pages.
+ * The unit type in which the page values (size, distances, etc.) are defined.
  * @public
  */
 export declare type DesignUnit = 'Pixel' | 'Millimeter' | 'Inch';
@@ -3175,7 +3259,10 @@ export declare type HistoryId = number;
  */
 export declare type HorizontalBlockAlignment = 'Left' | 'Right' | 'Center';
 
-/** @public */
+/**
+ * The horizontal text alignment options.
+ * @public
+ */
 export declare type HorizontalTextAlignment = 'Left' | 'Right' | 'Center';
 
 /**
@@ -3739,7 +3826,10 @@ export declare interface Vec4 {
  */
 export declare type VerticalBlockAlignment = 'Top' | 'Bottom' | 'Center';
 
-/** @public */
+/**
+ * The vertical text alignment options.
+ * @public
+ */
 export declare type VerticalTextAlignment = 'Top' | 'Bottom' | 'Center';
 
 /**
@@ -3800,7 +3890,10 @@ export declare type VideoExportOptions = {
  */
 export declare type XYWH = [x: number, y: number, w: number, h: number];
 
-/**  @public */
+/**
+ * The axis(es) for which to auto-fit.
+ * @public
+ */
 export declare type ZoomAutoFitAxis = 'Horizontal' | 'Vertical' | 'Both';
 
 export { }