@cesdk/engine 1.57.0-nightly.20250721 → 1.57.0-nightly.20250722

package/index.d.ts

@@ -1092,6 +1092,8 @@ export declare type BlendMode = 'PassThrough' | 'Normal' | 'Darken' | 'Multiply'
  * Manage permissions and capabilities per block.
  * @categoryDescription Block Animations
  * Create and manage animations and timeline-based effects.
+ * @categoryDescription Helper
+ * Convenient high-level functions that combine multiple operations into single, easy-to-use methods for common tasks like adding media, applying effects, and positioning blocks.
  */
 export declare class BlockAPI {
     #private;
@@ -1985,6 +1987,8 @@ export declare class BlockAPI {
     getHeightMode(id: DesignBlockId): SizeMode;
     /**
      * Update a block's size.
+     *
+     * @category Helper
      * @param id - The block to update.
      * @param width - The new width of the block.
      * @param height - The new height of the block.
@@ -1998,6 +2002,8 @@ export declare class BlockAPI {
     }): void;
     /**
      * Update a block's position.
+     *
+     * @category Helper
      * @param id - The block to update.
      * @param x - The new x position of the block.
      * @param y - The new y position of the block.
@@ -4847,6 +4853,7 @@ export declare class BlockAPI {
      * Adds an image to the current page. The image will be automatically loaded
      * and sized appropriately. In Video mode, timeline and animation options can be applied.
      *
+     * @category Helper
      * @param url - URL or path to the image file
      * @param options - Configuration options for the image
      * @returns Promise that resolves to the ID of the created image block
@@ -4858,6 +4865,7 @@ export declare class BlockAPI {
      * according to the provided parameters. Timeline and animation effects can be applied.
      * Only works in Video mode, not in Design mode.
      *
+     * @category Helper
      * @param url - URL or path to the video file
      * @param width - Width of the video in scene design units
      * @param height - Height of the video in scene design units
@@ -4869,6 +4877,7 @@ export declare class BlockAPI {
     /**
      * Applies an animation to a block.
      *
+     * @category Helper
      * @param block - The ID of the block to apply the animation to
      * @param animation - The animation configuration options
      */
@@ -4876,6 +4885,7 @@ export declare class BlockAPI {
     /**
      * Applies a drop shadow effect to any block.
      *
+     * @category Helper
      * @param block - The ID of the block to apply the shadow to
      * @param options - Shadow configuration options. If not provided, enables shadow with default settings
      */
@@ -4884,6 +4894,7 @@ export declare class BlockAPI {
      * Generates a thumbnail image of the scene at a specific time.
      * Only works in Video mode, not in Design mode.
      *
+     * @category Helper
      * @param height - Height of the thumbnail in scene design units (maximum 512)
      * @param time - Time position in seconds to capture the thumbnail
      * @returns Promise that resolves to a Blob containing the PNG thumbnail image
@@ -4895,6 +4906,7 @@ export declare class BlockAPI {
      * The background track is the track that determines the page duration.
      * Only works in Video mode, not in Design mode.
      *
+     * @category Helper
      * @returns The ID of the background track, or null if none exists
      * @throws Error if called in Design mode
      */
@@ -4905,6 +4917,7 @@ export declare class BlockAPI {
      * certain elements to be part of the background layer.
      * The background track is the track that determines the page duration.
      *
+     * @category Helper
      * @param block - The ID of the block to move to the background track
      * @throws Error if no background track is found
      */