@cesdk/node 1.12.1 → 1.13.0-rc.1

package/index.d.ts

@@ -1012,23 +1012,35 @@ export declare class BlockAPI {
      * @param property - The name of the property to set.
      * @param name - The name of the spot color.
      * @param tint - The tint factor in the range of 0 to 1.
-     * @returns An empty result on success, an error otherwise.
      */
     setColorSpot(id: DesignBlockId, property: string, name: string, tint?: number): void;
     /**
      * Get the spot color name of a color property of the given design block.
      * @param id - The block whose property should be queried.
      * @param property - The name of the property to query.
-     * @returns A result holding the name of the spot color or an error.
+     * @returns The name of the spot color.
      */
     getColorSpotName(id: DesignBlockId, property: string): string;
     /**
      * Get the spot color tint factor of a color property of the given design block.
      * @param id - The block whose property should be queried.
      * @param property - The name of the property to query.
-     * @returns A result holding the tint factor of the spot color or an error.
+     * @returns The tint factor of the spot color.
      */
     getColorSpotTint(id: DesignBlockId, property: string): number;
+    /**
+     * Set a gradient color stops property of the given design block.
+     * @param id - The block whose property should be set.
+     * @param property - The name of the property to set.
+     */
+    setGradientColorStops(id: DesignBlockId, property: string, colors: GradientColorStop[]): void;
+    /**
+     * Get the gradient color stops property of the given design block.
+     * @param id - The block whose property should be queried.
+     * @param property - The name of the property to query.
+     * @returns The gradient colors.
+     */
+    getGradientColorStops(id: DesignBlockId, property: string): GradientColorStop[];
     /**
      * Set an enum property of the given design block to the given value.
      * @param id - The block whose property should be set.
@@ -2004,17 +2016,17 @@ export declare class BlockAPI {
      */
     hasTimeOffset(id: DesignBlockId): boolean;
     /**
-     * Set the time offset of the given block in the scene.
-     * The time offset defines the point in time at which this block is first active in the scene.
-     * The time offset is not supported for page block or their children.
+     * Set the time offset of the given block relative to its parent.
+     * The time offset controls when the block is first active in the scene.
+     * The time offset is not supported by the page block.
      * @param id - The block whose time offset should be changed.
      * @param offset - The new time offset in seconds.
      */
     setTimeOffset(id: DesignBlockId, offset: number): void;
     /**
-     * Get the time offset of the given block in the scene.
+     * Get the time offset of the given block relative to its parent.
      * @param id - The block whose time offset should be queried.
-     * @returns the time offset of the block in the scene.
+     * @returns the time offset of the block.
      */
     getTimeOffset(id: DesignBlockId): number;
     /**
@@ -2471,11 +2483,6 @@ export declare interface Configuration {
      * If not configured the fallback value is 'auto'.
      */
     audioOutput?: 'auto' | 'none';
-    /**
-     * @deprecated This config key is not used anymore.
-     * You can configure a role via `setSettingEnum('role', role)` in the
-     * EditorAPI.
-     */
     role?: RoleString;
     /**
      * @deprecated This config key is not used anymore.
@@ -2631,6 +2638,7 @@ export declare enum DesignBlockType {
     Camera = "//ly.img.ubq/camera",
     Page = "//ly.img.ubq/page",
     Image = "//ly.img.ubq/image",
+    Design = "//ly.img.ubq/design",
     Video = "//ly.img.ubq/video",
     VideoFill = "//ly.img.ubq/fill/video",
     ImageFill = "//ly.img.ubq/fill/image",
@@ -3030,6 +3038,14 @@ export declare type FontStyle = 'normal' | 'italic';
 /** @public */
 export declare type FontWeight = 'thin' | 'extraLight' | 'Light' | 'normal' | 'medium' | 'semiBold' | 'bold' | 'extraBold' | 'heavy';
 
+/** @public */
+export declare interface GradientColorStop {
+    /** A color value within a gradient. */
+    color: RGBAColor | SpotColor;
+    /** The relative position of the color within the gradient in the range [0, 1]. */
+    stop: number;
+}
+
 /**
  * @public
  */