@cesdk/engine 1.42.0 → 1.43.0-rc.0

package/index.d.ts

@@ -939,24 +939,28 @@ export declare class BlockAPI {
     /**
      * Updates the sorting order of this block and all of its manually created siblings
      * so that the given block has the highest sorting order.
+     * If the block is parented to a track, it is first moved up in the hierarchy.
      * @param id - The id of the block to be given the highest sorting order among its siblings.
      */
     bringToFront(id: DesignBlockId): void;
     /**
      * Updates the sorting order of this block and all of its manually created siblings
      * so that the given block has the lowest sorting order.
+     * If the block is parented to a track, it is first moved up in the hierarchy.
      * @param id - The id of the block to be given the lowest sorting order among its siblings.
      */
     sendToBack(id: DesignBlockId): void;
     /**
      * Updates the sorting order of this block and all of its superjacent siblings
      * so that the given block has a higher sorting order than the next superjacent sibling.
+     * If the block is parented to a track, it is first moved up in the hierarchy.
      * @param id - The id of the block to be given a higher sorting than the next superjacent sibling.
      */
     bringForward(id: DesignBlockId): void;
     /**
      * Updates the sorting order of this block and all of its manually created and subjacent siblings
      * so that the given block will have a lower sorting order than the next subjacent sibling.
+     * If the block is parented to a track, it is first moved up in the hierarchy.
      * @param id - The id of the block to be given a lower sorting order than the next subjacent sibling.
      */
     sendBackward(id: DesignBlockId): void;
@@ -2590,6 +2594,7 @@ export declare class BlockAPI {
     /**
      * Set the playback duration of the given block in seconds.
      * The duration defines for how long the block is active in the scene during playback.
+     * If a duration is set on the page block, it becomes the duration source block.
      * The duration is ignored when the scene is not in "Video" mode.
      * @param id - The block whose duration should be changed.
      * @param duration - The new duration in seconds.
@@ -2601,6 +2606,33 @@ export declare class BlockAPI {
      * @returns The block's duration.
      */
     getDuration(id: DesignBlockId): number;
+    /**
+     * Set an block as duration source so that the overall page duration is automatically determined by this.
+     * If no defining block is set, the page duration is calculated over all children.
+     * Only one block per page can be marked as duration source. Will automatically unmark the previously marked.
+     * Note: This is only supported for blocks that have a duration.
+     * @param page - The page block for which it should be enabled.
+     * @param id - The block that should be updated.
+     */
+    setPageDurationSource(page: DesignBlockId, id: DesignBlockId): void;
+    /**
+     * Query whether the block is a duration source block for the page.
+     * @param id - The block whose duration source property should be queried.
+     * @returns If the block is a duration source for a page.
+     */
+    isPageDurationSource(id: DesignBlockId): boolean;
+    /**
+     * Returns whether the block can be marked as the element that defines the duration of the given page.
+     * @param id - The block to query.
+     * @returns true, if the block can be marked as the element that defines the duration of the given page.
+     */
+    supportsPageDurationSource(page: DesignBlockId, id: DesignBlockId): boolean;
+    /**
+     * Remove the block as duration source block for the page.
+     * If a scene or page is given as block, it is deactivated for all blocks in the scene or page.
+     * @param id - The block whose duration source property should be removed.
+     */
+    removePageDurationSource(id: DesignBlockId): void;
     /**
      * Returns whether the block has a time offset property.
      * @param id - The block to query.
@@ -3156,6 +3188,7 @@ declare class CreativeEngine {
     scene: SceneAPI;
     variable: VariableAPI;
     reactor: Reactor;
+    version: string;
 
     /**
      * Adds and initializes a plugin to the engine.