@cesdk/engine 1.30.0 → 1.31.0-rc.0

package/index.d.ts

@@ -1,3 +1,24 @@
+/**
+ * The block type IDs for the animation blocks. These are the IDs used to create new animations
+ * using `cesdk.engine.block.createAnimation(id)`.
+ * @public
+ */
+export declare type AnimationType = AnimationTypeShorthand | AnimationTypeLonghand;
+
+/**
+ * The longhand block type IDs for the animation blocks. These are the IDs used to create new animations
+ * using `cesdk.engine.block.createAnimation(id)`.
+ * @public
+ */
+export declare type AnimationTypeLonghand = `//ly.img.ubq/animation/${AnimationTypeShorthand}`;
+
+/**
+ * The shorthand block type IDs for the animation blocks. These are the IDs used to create new animations
+ * using `cesdk.engine.block.createAnimation(id)`.
+ * @public
+ */
+export declare type AnimationTypeShorthand = 'slide' | 'pan' | 'fade' | 'blur' | 'grow' | 'zoom' | 'pop' | 'wipe' | 'baseline' | 'crop_zoom' | 'spin' | 'spin_loop' | 'fade_loop' | 'blur_loop' | 'pulsating_loop' | 'breathing_loop' | 'jump_loop' | 'squeeze_loop' | 'sway_loop';
+
 /**
  * Generic asset information
  * @public
@@ -249,6 +270,16 @@ export declare interface AssetQueryData {
      * Together with `page` this can be used for pagination.
      */
     perPage: number;
+    /**
+     * The order to sort by if the asset source supports sorting.
+     * If set to None, the order is the same as the assets were added to the source.
+     */
+    sortingOrder?: SortingOrder;
+    /**
+     * The key that identifies the meta data value to sort by or 'id' to sort by the asset ID.
+     * If empty, the assets are sorted by the index.
+     */
+    sortKey?: string;
 }
 
 /**
@@ -676,8 +707,15 @@ export declare class BlockAPI {
      * 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.
+     * @deprecated Use supportsShape instead.
      */
     hasShape(id: DesignBlockId): boolean;
+    /**
+     * 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.
+     */
+    supportsShape(id: DesignBlockId): boolean;
     /**
      * Returns the block containing the shape properties of the given block.
      * @param id - The block whose shape block should be returned.
@@ -885,8 +923,15 @@ export declare class BlockAPI {
      * Query if the given block has a content fill mode.
      * @param id - The block to query.
      * @returns true, if the block has a content fill mode.
+     * @deprecated Use supportsContentFillMode instead.
      */
     hasContentFillMode(id: DesignBlockId): boolean;
+    /**
+     * Query if the given block has a content fill mode.
+     * @param id - The block to query.
+     * @returns true, if the block has a content fill mode.
+     */
+    supportsContentFillMode(id: DesignBlockId): boolean;
     /**
      * Query a block's width.
      * @param id - The block to query.
@@ -1323,6 +1368,14 @@ export declare class BlockAPI {
      * @param sourceSet - The block's new source set.
      */
     setSourceSet(id: DesignBlockId, property: string, sourceSet: Source[]): void;
+    /**
+     * Add a source to the `sourceSet` property of the given block.
+     * If there already exists in source set an image with the same width, that existing image will be replaced.
+     * @param id - The block to update.
+     * @param property - The name of the property to modify.
+     * @param uri - The source to add to the source set.
+     */
+    addImageFileURIToSourceSet(id: DesignBlockId, property: string, uri: string): Promise<void>;
     /**
      * Set an enum property of the given design block to the given value.
      * @param id - The block whose property should be set.
@@ -1341,8 +1394,15 @@ export declare class BlockAPI {
      * Query if the given block has crop properties.
      * @param id - The block to query.
      * @returns true, if the block has crop properties.
+     * @deprecated Use supportsCrop() instead.
      */
     hasCrop(id: DesignBlockId): boolean;
+    /**
+     * Query if the given block has crop properties.
+     * @param id - The block to query.
+     * @returns true, if the block has crop properties.
+     */
+    supportsCrop(id: DesignBlockId): boolean;
     /**
      * Set the crop scale in x direction of the given design block.
      * Required scope: 'layer/crop'
@@ -1450,8 +1510,15 @@ export declare class BlockAPI {
      * Query if the given block has an opacity.
      * @param id - The block to query.
      * @returns true, if the block has an opacity.
+     * @deprecated Use supportsOpacity() instead.
      */
     hasOpacity(id: DesignBlockId): boolean;
+    /**
+     * Query if the given block has an opacity.
+     * @param id - The block to query.
+     * @returns true, if the block has an opacity.
+     */
+    supportsOpacity(id: DesignBlockId): boolean;
     /**
      * Set the opacity of the given design block.
      * Required scope: 'layer/opacity'
@@ -1469,8 +1536,15 @@ export declare class BlockAPI {
      * Query if the given block has a blend mode.
      * @param id - The block to query.
      * @returns true, if the block has a blend mode.
+     * @deprecated Use supportsBlendMode() instead.
      */
     hasBlendMode(id: DesignBlockId): boolean;
+    /**
+     * Query if the given block has a blend mode.
+     * @param id - The block to query.
+     * @returns true, if the block has a blend mode.
+     */
+    supportsBlendMode(id: DesignBlockId): boolean;
     /**
      * Set the blend mode of the given design block.
      * Required scope: 'layer/blendMode'
@@ -1546,8 +1620,15 @@ export declare class BlockAPI {
      * Queries whether the block supports effects.
      * @param id - The block to query.
      * @returns True, if the block can render effects, false otherwise.
+     * @deprecated Use supportsEffects instead.
      */
     hasEffects(id: DesignBlockId): boolean;
+    /**
+     * Queries whether the block supports effects.
+     * @param id - The block to query.
+     * @returns True, if the block can render effects, false otherwise.
+     */
+    supportsEffects(id: DesignBlockId): boolean;
     /**
      * Get a list of all effects attached to this block
      * @param id - The block to query.
@@ -1582,6 +1663,7 @@ export declare class BlockAPI {
      * Checks whether an 'effect' block may be enabled and disabled.
      * @param effectId - The 'effect' block to query.
      * @returns True, if the block supports enabling and disabling, false otherwise.
+     * @deprecated Calls to this function can be removed. All effects can be enabled and disabled.
      */
     hasEffectEnabled(effectId: DesignBlockId): boolean;
     /**
@@ -1606,8 +1688,15 @@ export declare class BlockAPI {
      * Checks whether the block supports blur.
      * @param id - The block to query.
      * @returns True, if the block supports blur.
+     * @deprecated Use supportsBlur instead.
      */
     hasBlur(id: DesignBlockId): boolean;
+    /**
+     * Checks whether the block supports blur.
+     * @param id - The block to query.
+     * @returns True, if the block supports blur.
+     */
+    supportsBlur(id: DesignBlockId): boolean;
     /**
      * Connects `block`'s blur to the given `blur` block.
      * Required scope: 'appearance/blur'
@@ -1637,8 +1726,15 @@ export declare class BlockAPI {
      * Query if the given block has background color properties.
      * @param id - The block to query.
      * @returns true, if the block has background color properties.
+     * @deprecated Use supportsBackgroundColor() instead.
      */
     hasBackgroundColor(id: DesignBlockId): boolean;
+    /**
+     * Query if the given block has background color properties.
+     * @param id - The block to query.
+     * @returns true, if the block has background color properties.
+     */
+    supportsBackgroundColor(id: DesignBlockId): boolean;
     /**
      * Set the background color of the given design block.
      * Required scope: 'fill/change'
@@ -1675,8 +1771,15 @@ export declare class BlockAPI {
      * Query if the given block has a stroke property.
      * @param id - The block to query.
      * @returns True if the block has a stroke property.
+     * @deprecated Use supportsStroke() instead.
      */
     hasStroke(id: DesignBlockId): boolean;
+    /**
+     * Query if the given block has a stroke property.
+     * @param id - The block to query.
+     * @returns True if the block has a stroke property.
+     */
+    supportsStroke(id: DesignBlockId): boolean;
     /**
      * Enable or disable the stroke of the given design block.
      * Required scope: 'stroke/change'
@@ -1777,8 +1880,15 @@ export declare class BlockAPI {
      * Query if the given block has a drop shadow property.
      * @param id - The block to query.
      * @returns True if the block has a drop shadow property.
+     * @deprecated Use supportsDropShadow() instead.
      */
     hasDropShadow(id: DesignBlockId): boolean;
+    /**
+     * Query if the given block has a drop shadow property.
+     * @param id - The block to query.
+     * @returns True if the block has a drop shadow property.
+     */
+    supportsDropShadow(id: DesignBlockId): boolean;
     /**
      * Enable or disable the drop shadow of the given design block.
      * Required scope: 'appearance/shadow'
@@ -1814,7 +1924,7 @@ export declare class BlockAPI {
      * Get the  drop shadow color of the given design block.
      * @param id - The block whose drop shadow color should be queried.
      * @returns The drop shadow color.
-     * @deprecated Use getDropShadowColor() instead.
+     * @deprecated Use getDropShadowColor instead.
      */
     getDropShadowColorRGBA(id: DesignBlockId): RGBA;
     /**
@@ -2082,8 +2192,15 @@ export declare class BlockAPI {
      * Query if the given block has fill color properties.
      * @param id - The block to query.
      * @returns true, if the block has fill color properties, an error otherwise.
+     * @deprecated Use supportsFill instead.
      */
     hasFill(id: DesignBlockId): boolean;
+    /**
+     * Query if the given block has fill color properties.
+     * @param id - The block to query.
+     * @returns true, if the block has fill color properties, an error otherwise.
+     */
+    supportsFill(id: DesignBlockId): boolean;
     /**
      * Query if the fill of the given design block is enabled.
      * @param id - The block whose fill state should be queried.
@@ -2145,8 +2262,15 @@ export declare class BlockAPI {
      * Checks whether the block supports placeholder behavior.
      * @param block - The block to query.
      * @returns True, if the block supports placeholder behavior.
+     * @deprecated Use supportsPlaceholderBehavior instead.
      */
     hasPlaceholderBehavior(id: DesignBlockId): boolean;
+    /**
+     * Checks whether the block supports placeholder behavior.
+     * @param block - The block to query.
+     * @returns True, if the block supports placeholder behavior.
+     */
+    supportsPlaceholderBehavior(id: DesignBlockId): boolean;
     /**
      * Enable or disable the placeholder behavior for a block.
      * @param id - The block whose placeholder behavior should be enabled or disabled.
@@ -2163,8 +2287,15 @@ export declare class BlockAPI {
      * Checks whether the block supports placeholder controls.
      * @param block - The block to query.
      * @returns True, if the block supports placeholder controls.
+     * @deprecated Use supportsPlaceholderControls instead.
      */
     hasPlaceholderControls(id: DesignBlockId): boolean;
+    /**
+     * Checks whether the block supports placeholder controls.
+     * @param block - The block to query.
+     * @returns True, if the block supports placeholder controls.
+     */
+    supportsPlaceholderControls(id: DesignBlockId): boolean;
     /**
      * Enable or disable the visibility of the placeholder overlay pattern for a block.
      * @param block - The block whose placeholder overlay should be enabled or disabled.
@@ -2251,8 +2382,15 @@ export declare class BlockAPI {
      * Returns whether the block has a duration property.
      * @param id - The block to query.
      * @returns true if the block has a duration property.
+     * @deprecated Use supportsDuration instead.
      */
     hasDuration(id: DesignBlockId): boolean;
+    /**
+     * Returns whether the block has a duration property.
+     * @param id - The block to query.
+     * @returns true if the block has a duration property.
+     */
+    supportsDuration(id: DesignBlockId): boolean;
     /**
      * 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.
@@ -2271,8 +2409,15 @@ export declare class BlockAPI {
      * Returns whether the block has a time offset property.
      * @param id - The block to query.
      * @returns true, if the block has a time offset property.
+     * @deprecated Use supportsTimeOffset instead.
      */
     hasTimeOffset(id: DesignBlockId): boolean;
+    /**
+     * Returns whether the block has a time offset property.
+     * @param id - The block to query.
+     * @returns true, if the block has a time offset property.
+     */
+    supportsTimeOffset(id: DesignBlockId): boolean;
     /**
      * Set the time offset of the given block relative to its parent.
      * The time offset controls when the block is first active in the timeline.
@@ -2291,8 +2436,15 @@ export declare class BlockAPI {
      * Returns whether the block has trim properties.
      * @param id - The block to query.
      * @returns true, if the block has trim properties.
+     * @deprecated Use supportsTrim instead.
      */
     hasTrim(id: DesignBlockId): boolean;
+    /**
+     * Returns whether the block has trim properties.
+     * @param id - The block to query.
+     * @returns true, if the block has trim properties.
+     */
+    supportsTrim(id: DesignBlockId): boolean;
     /**
      * Set the trim offset of the given block or fill.
      * Sets the time in seconds within the fill at which playback of the audio or video clip should begin.
@@ -2347,8 +2499,15 @@ export declare class BlockAPI {
      * Returns whether the block has a playback time property.
      * @param id - The block to query.
      * @returns whether the block has a playback time property.
+     * @deprecated Use supportsPlaybackTime instead.
      */
     hasPlaybackTime(id: DesignBlockId): boolean;
+    /**
+     * Returns whether the block has a playback time property.
+     * @param id - The block to query.
+     * @returns whether the block has a playback time property.
+     */
+    supportsPlaybackTime(id: DesignBlockId): boolean;
     /**
      * Set the playback time of the given block.
      * @param id - The block whose playback time should be updated.
@@ -2387,8 +2546,15 @@ export declare class BlockAPI {
      * Returns whether the block supports a playback control.
      * @param block - The block to query.
      * @returns Whether the block has playback control.
+     * @deprecated Use supportsPlaybackControl instead
      */
     hasPlaybackControl(id: DesignBlockId): boolean;
+    /**
+     * Returns whether the block supports a playback control.
+     * @param block - The block to query.
+     * @returns Whether the block has playback control.
+     */
+    supportsPlaybackControl(id: DesignBlockId): boolean;
     /**
      * Set whether the block should restart from the beginning again or stop.
      * @param block - The block or video fill to update.
@@ -2508,6 +2674,54 @@ export declare class BlockAPI {
      * @deprecated Use `generateVideoThumbnailSequence` instead.
      */
     getPageThumbnailAtlas(id: DesignBlockId, numberOfColumns: number, numberOfRows: number, thumbnailHeight: number): Promise<Blob>;
+    /**
+     * Creates a new animation, fails if type is unknown.
+     * @param type - The type of animation to create.
+     * @returns The handle of the new animation instance.
+     */
+    createAnimation(type: AnimationType): DesignBlockId;
+    /**
+     * Returns whether the block supports animation.
+     * @param block - The block to query.
+     * @returns Whether the block supports animation.
+     */
+    supportsAnimation(id: DesignBlockId): boolean;
+    /**
+     * Set the "in" animation of the given block.
+     * @param id - The block whose "in" animation should be set.
+     * @param animation - The animation to set.
+     */
+    setInAnimation(id: DesignBlockId, animation: DesignBlockId): void;
+    /**
+     * Set the "loop" animation of the given block.
+     * @param id - The block whose "loop" animation should be set.
+     * @param animation - The animation to set.
+     */
+    setLoopAnimation(id: DesignBlockId, animation: DesignBlockId): void;
+    /**
+     * Set the "out" animation of the given block.
+     * @param id - The block whose "out" animation should be set.
+     * @param animation - The animation to set.
+     */
+    setOutAnimation(id: DesignBlockId, animation: DesignBlockId): void;
+    /**
+     * Get the "in" animation of the given block.
+     * @param id - The block whose "in" animation should be queried.
+     * @returns The "in" animation of the block.
+     */
+    getInAnimation(id: DesignBlockId): DesignBlockId;
+    /**
+     * Get the "loop" animation of the given block.
+     * @param id - The block whose "loop" animation should be queried.
+     * @returns The "loop" animation of the block.
+     */
+    getLoopAnimation(id: DesignBlockId): DesignBlockId;
+    /**
+     * Get the "out" animation of the given block.
+     * @param id - The block whose "out" animation should be queried.
+     * @returns The "out" animation of the block.
+     */
+    getOutAnimation(id: DesignBlockId): DesignBlockId;
     /**
      * Update the pixels of the given pixel stream fill block.
      * @param id - The pixel stream fill block.
@@ -3797,6 +4011,8 @@ declare interface FindAssetsQuery {
     groups: string[];
     excludeGroups: string[];
     locale: string;
+    sortingOrder: SortingOrder;
+    sortKey: string;
 }
 
 /** @public */
@@ -3953,14 +4169,14 @@ export declare type ObjectType = ObjectTypeShorthand | ObjectTypeLonghand;
  * engine when calling `cesdk.engine.block.getType(blockId)` for example.
  * @public
  */
-export declare type ObjectTypeLonghand = DesignBlockTypeLonghand | ShapeTypeLonghand | FillTypeLonghand | EffectTypeLonghand | BlurTypeLonghand;
+export declare type ObjectTypeLonghand = DesignBlockTypeLonghand | ShapeTypeLonghand | FillTypeLonghand | EffectTypeLonghand | BlurTypeLonghand | AnimationTypeLonghand;
 
 /**
  * The shorthand block type IDs for all blocks types in the Creative Engine. Those are the types that can be
  * passed to `cesdk.engine.block.findByType(type)` for example.
  * @public
  */
-export declare type ObjectTypeShorthand = DesignBlockTypeShorthand | `shape/${ShapeTypeShorthand}` | `fill/${FillTypeShorthand}` | `effect/${EffectTypeShorthand}` | `blur/${BlurTypeShorthand}`;
+export declare type ObjectTypeShorthand = DesignBlockTypeShorthand | `shape/${ShapeTypeShorthand}` | `fill/${FillTypeShorthand}` | `effect/${EffectTypeShorthand}` | `blur/${BlurTypeShorthand}` | `animation/${AnimationTypeShorthand}`;
 
 /**
  * A simplified placeholder type for `OffscreenCanvas`, to avoid a dependency on `@types/offscreencanvas`
@@ -4392,7 +4608,7 @@ export declare type SceneMode = 'Design' | 'Video';
 export declare type Scope = 'text/edit' | 'text/character' | 'fill/change' | 'fill/changeType' | 'stroke/change' | 'shape/change' | 'layer/move' | 'layer/resize' | 'layer/rotate' | 'layer/flip' | 'layer/crop' | 'layer/opacity' | 'layer/blendMode' | 'layer/visibility' | 'layer/clipping' | 'appearance/adjustments' | 'appearance/filter' | 'appearance/effect' | 'appearance/blur' | 'appearance/shadow' | 'lifecycle/destroy' | 'lifecycle/duplicate' | 'editor/add' | 'editor/select';
 
 /** @public */
-export declare type SettingsBool = 'controlGizmo/showCropHandles' | 'controlGizmo/showCropScaleHandles' | 'controlGizmo/showResizeHandles' | 'controlGizmo/showRotateHandles' | 'controlGizmo/showScaleHandles' | 'doubleClickToCropEnabled' | 'features/singlePageModeEnabled' | 'features/pageCarouselEnabled' | 'mouse/enableScroll' | 'mouse/enableZoom' | 'checkScopesInAPIs' | 'page/dimOutOfPageAreas' | 'page/title/appendPageName' | 'page/title/show' | 'page/title/showOnSinglePage' | 'page/title/showPageTitleTemplate' | 'placeholderControls/showButton' | 'placeholderControls/showOverlay' | 'showBuildVersion' | 'touch/dragStartCanSelect' | 'touch/singlePointPanning';
+export declare type SettingsBool = 'controlGizmo/showCropHandles' | 'controlGizmo/showCropScaleHandles' | 'controlGizmo/showResizeHandles' | 'controlGizmo/showRotateHandles' | 'controlGizmo/showScaleHandles' | 'doubleClickToCropEnabled' | 'features/singlePageModeEnabled' | 'features/pageCarouselEnabled' | 'mouse/enableScroll' | 'mouse/enableZoom' | 'checkScopesInAPIs' | 'page/dimOutOfPageAreas' | 'page/title/appendPageName' | 'page/title/show' | 'page/title/showOnSinglePage' | 'page/title/showPageTitleTemplate' | 'placeholderControls/showButton' | 'placeholderControls/showOverlay' | 'blockAnimations/enabled' | 'showBuildVersion' | 'touch/dragStartCanSelect' | 'touch/singlePointPanning';
 
 /** @public
  */
@@ -4456,6 +4672,13 @@ export declare interface Size2 {
  */
 export declare type SizeMode = 'Absolute' | 'Percent' | 'Auto';
 
+/**
+ * The order to sort by if the asset source supports sorting.
+ * If set to None, the order is the same as the assets were added to the source.
+ * @public
+ */
+export declare type SortingOrder = 'None' | 'Ascending' | 'Descending';
+
 /**
  * A single source width an intrinsic width & height.
  * @public