@cesdk/engine 1.16.1 → 1.17.0

package/index.d.ts

@@ -1859,21 +1859,6 @@ export declare class BlockAPI {
      * @param fill - The new fill.
      */
     setFill(id: DesignBlockId, fill: DesignBlockId): void;
-    /**
-     * Set the fill type of the given design block.
-     * @param id - The block whose fill type should be set.
-     * @param type - The fill type to set.
-     * @returns An empty result on success, an error otherwise.
-     * @deprecated Use `createFill`, e.g., with type 'color' and then apply the fill block with `setFill` to the block instead.  If the block has a fill, it should be removed with `getFill` and `destroy`.
-     */
-    setFillType(id: DesignBlockId, fillType: FillType): void;
-    /**
-     * Get the fill type of the given design block.
-     * @param id - The block whose fill type should be queried.
-     * @returns The block's fill type or an error.
-     * @deprecated Use `getEnum(id, 'fill/type')` instead.
-     */
-    getFillType(id: DesignBlockId): FillType;
     /**
      * Set the fill color of the given design block.
      * @param id - The block whose fill color should be set.
@@ -1890,100 +1875,6 @@ export declare class BlockAPI {
      * @returns A result holding the fill color or an error.
      */
     getFillSolidColor(id: DesignBlockId): RGBA;
-    /**
-     * Set the gradient type of the given design block.
-     * @param id - The block whose gradient type should be set.
-     * @param type - The gradient type.
-     * @returns An empty result on success, an error otherwise.
-     * @deprecated Use `createFill`, e.g., with '//ly.img.ubq/fill/gradient/linear' and then apply the fill block with `setFill` to the block instead. If the block has a fill, it should be removed with `getFill` and `destroy`.
-     */
-    setFillGradientType(id: DesignBlockId, gradientType: GradientType): void;
-    /**
-     * Get the gradient type of the given design block.
-     * @param id - The block whose gradient type should be queried.
-     * @returns The gradient type.
-     * @deprecated Use `getEnum(id, 'fill/gradient/type')` instead.
-     */
-    getFillGradientType(id: DesignBlockId): GradientType;
-    /**
-     * Add a gradient color stop on a design block.
-     * @param id - The block on which a gradient color stop should be added.
-     * @param stop - Where to add a color stop in the range 0 to 1.
-     * @param r - The red color component in the range of 0 to 1.
-     * @param g - The green color component in the range of 0 to 1.
-     * @param b - The blue color component in the range of 0 to 1.
-     * @param a - The alpha color component in the range of 0 to 1.
-     * @returns An empty result on success, an error otherwise.
-     * @deprecated Removed without a direct replacement. Use `block.setFloat(fill, keypath, value)` with key paths 'fill/gradient/linear/startPointX/Y', 'fill/gradient/radial/centerPointX/Y', and 'fill/gradient/conical/centerPointX/Y' to move the control points.
-     */
-    addFillGradientColorStop(id: DesignBlockId, stop: number, r: number, g: number, b: number, a?: number): void;
-    /**
-     * Remove a previously gradient color stop on a design block.
-     * @param id - The block from which to remove the gradient color stop.
-     * @param stop - The stop's position.
-     * @returns An empty result on success, an error otherwise.
-     * @deprecated Removed without a direct replacement. Use `block.setFloat(fill, keypath, value)` with key paths 'fill/gradient/linear/startPointX/Y', 'fill/gradient/radial/centerPointX/Y', and 'fill/gradient/conical/centerPointX/Y' to move the control points.
-     */
-    removeFillGradientColorStop(id: DesignBlockId, stop: number): void;
-    /**
-     * Get the gradient fill color stops of the given design block.
-     * @param id - The block whose gradient color stop should be queried.
-     * @returns All of the design block's gradient color stops.
-     * @deprecated Removed without a direct replacement. Use `block.getFloat(fill, keypath)` with key paths 'fill/gradient/linear/startPointX/Y', 'fill/gradient/radial/centerPointX/Y', and 'fill/gradient/conical/centerPointX/Y' instead.
-     */
-    getFillGradientColorStops(id: DesignBlockId): GradientstopRGBA[];
-    /**
-     * Set the gradient fill color stops of the given design block, overwriting previously set color stops.
-     * @param id - The block whose gradient color stop should be set.
-     * @param stops - The gradient color stops to set.
-     * @returns An empty result on success, an error otherwise.
-     * @deprecated Removed without a direct replacement. Use `block.setFloat(fill, keypath, value)` with key paths 'fill/gradient/linear/startPointX/Y', 'fill/gradient/radial/centerPointX/Y', and 'fill/gradient/conical/centerPointX/Y' to move the control points.
-     */
-    setFillGradientColorStops(id: DesignBlockId, stops: GradientstopRGBA[]): void;
-    /**
-     * Set the position of a gradient's control point.
-     * Note that Different gradient types of different control points.
-     * @param id - The block whose gradient control point should be set.
-     * @param gradientControlPointType - The type of control point.
-     * @param x - The horizontal component of the control point.
-     * @param y - The vertical component of the control point.
-     * @returns true if the control point was set, an error otherwise.
-     * @deprecated Use, e.g., `block.setFloat(fill, 'fill/gradient/linear/startPointX', value)` and `startPointY` instead.
-     */
-    setFillGradientControlPoint(id: DesignBlockId, gradientControlPointType: GradientControlPointType, x: number, y: number): boolean;
-    /**
-     * Get the horizontal component of a gradient's control point.
-     * @param id - The block whose gradient control point should be queried.
-     * @param gradientControlPointType - The type of control point.
-     * @returns The horizontal component of the control point, an error otherwise.
-     * @deprecated Use `block.getFloat(fill, keypath)` with key paths 'fill/gradient/linear/startPointX', 'fill/gradient/radial/centerPointX', and 'fill/gradient/conical/centerPointX' instead.
-     */
-    getFillGradientControlPointX(id: DesignBlockId, gradientControlPointType: GradientControlPointType): number;
-    /**
-     * Get the vertical component of a gradient's control point.
-     * @param id - The block whose gradient control point should be queried.
-     * @param gradientControlPointType - The type of control point.
-     * @returns The vertical component of the control point, an error otherwise.
-     * @deprecated Use `block.setFloat(fill, keypath, value)` with key paths 'fill/gradient/linear/startPointY', 'fill/gradient/radial/centerPointY', and 'fill/gradient/conical/centerPointY' instead.
-     */
-    getFillGradientControlPointY(id: DesignBlockId, gradientControlPointType: GradientControlPointType): number;
-    /**
-     * Set a gradient's radius.
-     * Note that Not all gradients have a radius.
-     * @param id - The block whose gradient radius should be set.
-     * @param radius - The gradient's radius.
-     * @returns true if the control point was set, an error otherwise.
-     * @deprecated Use, e.g., `block.setFloat(fill, 'fill/gradient/radial/radius', value)` instead.
-     */
-    setFillGradientRadius(id: DesignBlockId, radius: number): boolean;
-    /**
-     * Get a gradient's radius.
-     * Note that Not all gradients have a radius.
-     * @param id - The block whose gradient radius should be queried.
-     * @returns the gradient's radius, an error otherwise.
-     * @deprecated Use, e.g., `block.getFloat(fill, 'fill/gradient/radial/radius')` instead.
-     */
-    getFillGradientRadius(id: DesignBlockId): number;
     /**
      * Enable or disable the placeholder function for a block.
      * @param id - The block whose placeholder function should be enabled or disabled.
@@ -2337,6 +2228,12 @@ export declare class BlockAPI {
      * @deprecated Use `generateVideoThumbnailSequence` instead.
      */
     getPageThumbnailAtlas(id: DesignBlockId, numberOfColumns: number, numberOfRows: number, thumbnailHeight: number): Promise<Blob>;
+    /**
+     * Update the pixels of the given pixel stream fill block.
+     * @param id - The pixel stream fill block.
+     * @param buffer - Use pixel data from a canvas or a video element.
+     */
+    setNativePixelBuffer(id: number, buffer: HTMLCanvasElement | HTMLVideoElement): void;
 }
 
 /** @public */
@@ -2762,6 +2659,40 @@ declare class CreativeEngine {
 
 
 
+    /**
+     * Provide a callback that instantiates a web worker using the `@cesdk/engine`
+     * module as its source. How and where exactly you can find that module is
+     * highly depdendent on your particular setup. Web workers are used to perform
+     * certain expensive tasks, such as video export, in the background
+     *
+     * If no worker factory is provided, the engine will perform long-running
+     * tasks in the main thread.
+     *
+     * @example
+     * In a webpack environment, the implementation of the worker factory could
+     * look like this:
+     *
+     * ```ts
+     * engine._unstable_setWorkerFactory(
+     *   () => new Worker(new URL('@cesdk/engine', import.meta.url)))
+     * )
+     * ```
+     *
+     * For more information, consult the webpack documentation at
+     * https://webpack.js.org/guides/web-workers/
+     */
+    unstable_setWorkerFactory(workerFactory: null | (() => Worker)): void;
+    /**
+     * Some browsers exhibit a bug where support for certain video codecs is
+     * offered, but when attempting to decode or encode in these codecs, the
+     * request will simply never return.  We detect that situation using a
+     * timeout. To prevent this mechanism from triggering in situations where the
+     * export simply takes long because of a slow device, you can configure the
+     * timeout here.
+     *
+     * @param timeout - Timeout in milliseconds (default: 10 seconds)
+     */
+    unstable_setVideoExportInactivityTimeout(timeout: number): void;
 
     get element(): HTMLCreativeEngineCanvasElement | undefined;
     /**
@@ -2877,7 +2808,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",
+    Graphic = "//ly.img.ubq/graphic",
     Video = "//ly.img.ubq/video",
     VideoFill = "//ly.img.ubq/fill/video",
     ImageFill = "//ly.img.ubq/fill/image",
@@ -2891,7 +2822,11 @@ export declare enum DesignBlockType {
     PolygonShape = "//ly.img.ubq/shapes/polygon",
     EllipseShape = "//ly.img.ubq/shapes/ellipse",
     Group = "//ly.img.ubq/group",
-    Cutout = "//ly.img.ubq/cutout"
+    Cutout = "//ly.img.ubq/cutout",
+    ColorFill = "//ly.img.ubq/fill/color",
+    LinearGradientFill = "//ly.img.ubq/fill/gradient/linear",
+    RadialGradientFill = "//ly.img.ubq/fill/gradient/radial",
+    ConicalGradientFill = "//ly.img.ubq/fill/gradient/conical"
 }
 
 /**
@@ -3266,6 +3201,12 @@ export declare type ExportOptions = {
      * @defaultValue 0.9
      */
     jpegQuality?: number;
+    /**
+     * The WebP quality to use when encoding to WebP. Valid values are (0-1], higher means better quality.
+     * WebP uses a special lossless encoding that usually produces smaller file sizes than PNG.
+     * Ignored for other encodings. Defaults to 1.0.
+     */
+    webpQuality?: number;
     /**
      * An optional target width used in conjunction with target height.
      * If used, the block will be rendered large enough, that it fills the target
@@ -3289,6 +3230,7 @@ export declare type ExportOptions = {
 /** @public */
 declare interface ExportOptions_2 {
     jpegQuality: number;
+    webpQuality: number;
     pngCompressionLevel: number;
     useTargetSize: boolean;
     targetWidth: number;
@@ -3306,11 +3248,6 @@ declare interface ExportVideoOptions {
     targetHeight: number;
 }
 
-/**
- * @public
- */
-export declare type FillType = 'Solid' | 'Gradient' | 'Video' | 'Image';
-
 /** @public */
 declare interface FindAssetsQuery {
     perPage: number;
@@ -3342,11 +3279,6 @@ export declare interface GradientColorStop {
     stop: number;
 }
 
-/**
- * @public
- */
-export declare type GradientControlPointType = 'Start' | 'End' | 'Center';
-
 /**
  * @public
  */
@@ -3358,11 +3290,6 @@ b: number,
 a: number
 ];
 
-/**
- * @public
- */
-export declare type GradientType = 'Linear' | 'Radial' | 'Conical';
-
 /**
  * Will be called by a stream whenever a new value is available.
  * @public
@@ -3455,6 +3382,7 @@ export declare const LogLevel: {
 declare enum MimeType_2 {
     Png = "image/png",
     Jpeg = "image/jpeg",
+    WebP = "image/webp",
     Tga = "image/x-tga",
     Mp4 = "video/mp4",
     QuickTime = "video/quicktime",
@@ -3774,25 +3702,26 @@ export declare class SceneAPI {
      */
     isZoomAutoFitEnabled(blockOrScene: DesignBlockId): boolean;
     /**
-     * Continually ensures the camera position to be within the width and height of a block's axis-aligned bounding box.
+     * Continually ensures the camera position to be within the width and height of the blocks axis-aligned bounding box.
      * Without padding, this results in a tight clamp on the block. With padding, the padded part of the
-     * block is ensured to be visible. No more than one block per scene can have camera position clamping enabled.
+     * blocks is ensured to be visible.
      *
-     * @param id - The block for which the camera position is adjusted to, usually, the scene or a page.
+     * @param ids - The blocks to which the camera position is adjusted to, usually, the scene or a page.
      * @param paddingLeft - Optional padding in screen pixels to the left of the block.
      * @param paddingTop - Optional padding in screen pixels to the top of the block.
      * @param paddingRight - Optional padding in screen pixels to the right of the block.
      * @param paddingBottom - Optional padding in screen pixels to the bottom of the block.
-     * @param scaledPaddingLeft - Optional padding in pixels to the left of the block that scales with the zoom level.
-     * @param scaledPaddingTop - Optional padding in pixels to the top of the block that scales with the zoom level.
-     * @param scaledPaddingRight - Optional padding in pixels to the right of the block that scales with the zoom level.
-     * @param scaledPaddingBottom - Optional padding in pixels to the bottom of the block that scales with the zoom level.
+     * @param scaledPaddingLeft - Optional padding in screen pixels to the left of the block that scales with the zoom level until five times the initial value.
+     * @param scaledPaddingTop - Optional padding in screen pixels to the top of the block that scales with the zoom level until five times the initial value.
+     * @param scaledPaddingRight - Optional padding in screen pixels to the right of the block that scales with the zoom level until five times the initial value.
+     * @param scaledPaddingBottom - Optional padding in screen pixels to the bottom of the block that scales with the zoom level until five times the initial value.
      */
-    unstable_enableCameraPositionClamping(id: DesignBlockId, paddingLeft?: number, paddingTop?: number, paddingRight?: number, paddingBottom?: number, scaledPaddingLeft?: number, scaledPaddingTop?: number, scaledPaddingRight?: number, scaledPaddingBottom?: number): void;
+    unstable_enableCameraPositionClamping(ids: DesignBlockId[], paddingLeft?: number, paddingTop?: number, paddingRight?: number, paddingBottom?: number, scaledPaddingLeft?: number, scaledPaddingTop?: number, scaledPaddingRight?: number, scaledPaddingBottom?: number): void;
     /**
      *  Disables any previously set position clamping for the current scene.
+     * @param blockOrScene - Optionally, the scene or a block in the scene for which to query the position clamping.
      */
-    unstable_disableCameraPositionClamping(): void;
+    unstable_disableCameraPositionClamping(blockOrScene?: number | null): void;
     /**
      *  Queries whether position clamping is enabled.
      *
@@ -3804,7 +3733,7 @@ export declare class SceneAPI {
     /**
      * Continually ensures the zoom level of the camera in the active scene to be in the given range.
      *
-     * @param id - The block for which the camera zoom limits are adjusted to, usually, the scene or a page.
+     * @param ids - The blocks to which the camera zoom limits are adjusted to, usually, the scene or a page.
      * @param minZoomLimit - The minimum zoom level limit when zooming out, unlimited when negative.
      * @param maxZoomLimit - The maximum zoom level limit when zooming in, unlimited when negative.
      * @param paddingLeft - Optional padding in screen pixels to the left of the block. Only applied when the block is not a camera.
@@ -3813,11 +3742,12 @@ export declare class SceneAPI {
      * @param paddingBottom - Optional padding in screen pixels to the bottom of the block. Only applied when the block is not a camera.
      *
      */
-    unstable_enableCameraZoomClamping(id: DesignBlockId, minZoomLimit?: number, maxZoomLimit?: number, paddingLeft?: number, paddingTop?: number, paddingRight?: number, paddingBottom?: number): void;
+    unstable_enableCameraZoomClamping(ids: DesignBlockId[], minZoomLimit?: number, maxZoomLimit?: number, paddingLeft?: number, paddingTop?: number, paddingRight?: number, paddingBottom?: number): void;
     /**
      * Disables any previously set zoom clamping for the current scene.
+     * @param blockOrScene - Optionally, the scene or a block for which to query the zoom clamping.
      */
-    unstable_disableCameraZoomClamping(): void;
+    unstable_disableCameraZoomClamping(blockOrScene?: number | null): void;
     /**
      * Queries whether zoom clamping is enabled.
      *
@@ -4084,6 +4014,10 @@ export declare type VideoExportOptions = {
      * size entirely while maintaining its aspect ratio.
      */
     targetHeight?: number;
+    /**
+     * An abortsignal that can be used to cancel the export.
+     */
+    abortSignal?: AbortSignal;
 };
 
 /**