@cesdk/engine 1.20.0 → 1.21.0-rc.0

package/index.d.ts

@@ -425,7 +425,7 @@ export declare class BlockAPI {
     /**
      * Exports a design block as a video file of the given mime type.
      * Note: The export will run across multiple iterations of the update loop. In each iteration a frame is scheduled for encoding.
-     * @param handle - The design block element to export. Currently, only the scene block is supported.
+     * @param handle - The design block element to export. Currently, only page blocks are supported.
      * @param mimeType - The mime type of the output video file.
      * @param progressCallback - A callback which reports on the progress of the export. It informs the receiver of the current frame index, which currently gets exported and the total frame count.
      * @param options - The options for exporting the video
@@ -2088,7 +2088,7 @@ export declare class BlockAPI {
     hasTimeOffset(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 scene.
+     * The time offset controls when the block is first active in the timeline.
      * 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.
@@ -2141,6 +2141,7 @@ export declare class BlockAPI {
      * The duration is defined by all blocks in the scene.
      * @param scene - The scene whose duration is being queried.
      * @returns the total scene duration.
+     * @deprecated Use `getDuration` and pass a page block.
      */
     getTotalSceneDuration(scene: DesignBlockId): number;
     /**
@@ -2173,6 +2174,12 @@ export declare class BlockAPI {
      * @returns the playback time of the block in seconds.
      */
     getPlaybackTime(id: DesignBlockId): number;
+    /**
+     * Returns whether the block should be visible on the canvas at the current playback time.
+     * @param id - The block to query.
+     * @returns Whether the block should be visible on the canvas at the current playback time.
+     */
+    isVisibleAtCurrentPlaybackTime(id: DesignBlockId): boolean;
     /**
      * Set whether the given block or fill should play
      * its contents while the rest of the scene remains paused.
@@ -2237,10 +2244,16 @@ export declare class BlockAPI {
      * @returns A Promise that resolves once the resource has finished loading.
      */
     forceLoadAVResource(id: DesignBlockId): Promise<void>;
+    /**
+     * Returns whether the audio and video resource for the given video fill or audio block is loaded.
+     * @param id - The video fill or audio block.
+     * @returns The loading state of the resource.
+     */
+    unstable_isAVResourceLoaded(id: DesignBlockId): boolean;
     /**
      * Get the duration in seconds of the video or audio resource that is attached to the given block.
      * @param id - The video fill or audio block.
-     * @returns The video or audio file duration
+     * @returns The video or audio file duration.
      */
     getAVResourceTotalDuration(id: DesignBlockId): number;
     /**
@@ -2256,12 +2269,12 @@ export declare class BlockAPI {
      */
     getVideoHeight(id: DesignBlockId): number;
     /**
-     * Generate a sequence of thumbnails for the given video fill or page.
+     * Generate a sequence of thumbnails for the given video fill or design block.
      * Note: there can only be one thumbnail generation request in progress for a given block.
-     * @param id - The video fill or page.
+     * @param id - The video fill or design block.
      * @param thumbnailHeight - The height of a thumbnail. The width will be calculated from the video aspect ratio.
-     * @param timeBegin - The time in seconds at which the thumbnail sequence should start.
-     * @param timeEnd - The time in seconds at which the thumbnail sequence should end.
+     * @param timeBegin - The time in seconds relative to the time offset of the design block at which the thumbnail sequence should start.
+     * @param timeEnd - The time in seconds relative to the time offset of the design block  at which the thumbnail sequence should end.
      * @param numberOfFrames - The number of frames to generate.
      * @param onFrame - Gets passed the frame index and RGBA image data.
      * @returns A method that will cancel any thumbnail generation request in progress for this block.
@@ -2919,7 +2932,7 @@ export declare type DesignBlockTypeLonghand = `//ly.img.ubq/${DesignBlockTypeSho
  * using `cesdk.engine.editor.cerate(id)`.
  * @public
  */
-export declare type DesignBlockTypeShorthand = 'scene' | 'stack' | 'camera' | 'page' | 'graphic' | 'audio' | 'text' | 'group' | 'cutout';
+export declare type DesignBlockTypeShorthand = 'scene' | 'stack' | 'camera' | 'page' | 'graphic' | 'audio' | 'text' | 'group' | 'cutout' | 'track';
 
 /**
  * The unit type in which the page values (size, distances, etc.) are defined.
@@ -2945,15 +2958,15 @@ export declare class EditorAPI {
      * Set the edit mode of the editor.
      * An edit mode defines what type of content can currently be edited by the user.
      * Hint: the initial edit mode is "Transform".
-     * @param mode - "Transform", "Crop", "Text", or a custom value.
+     * @param mode - "Transform", "Crop", "Text", "Playback", or a custom value.
      */
-    setEditMode(mode: 'Transform' | 'Crop' | 'Text' | string): void;
+    setEditMode(mode: 'Transform' | 'Crop' | 'Text' | 'Playback' | string): void;
     /**
      * Get the current edit mode of the editor.
      * An edit mode defines what type of content can currently be edited by the user.
-     * @returns "Transform", "Crop", "Text", or a custom value.
+     * @returns "Transform", "Crop", "Text", "Playback", or a custom value.
      */
-    getEditMode(): 'Transform' | 'Crop' | 'Text' | string;
+    getEditMode(): 'Transform' | 'Crop' | 'Text' | 'Playback' | string;
     /**
      * Get the type of cursor that should be displayed by the application.
      * @returns The cursor type.
@@ -3179,6 +3192,15 @@ export declare class EditorAPI {
      * @returns The current memory usage in bytes.
      */
     getUsedMemory(): number;
+    /**
+     * Get the export size limit in pixels on the current device. An export is
+     * only possible when both the width and height of the output are below or
+     * equal this limit. However, this is only an upper limit as the export might
+     * also not be possible due to other reasons, e.g., memory constraints.
+     * @returns The upper export size limit in pixels or an unlimited size, i.e,
+     * the maximum signed 32-bit integer value, if the limit is unknown.
+     */
+    getMaxExportSize(): number;
     /**
      * Sets a custom URI resolver.
      * This function can be called more than once. Subsequent calls will overwrite previous calls.
@@ -3372,6 +3394,20 @@ export declare type ExportOptions = {
      * setting instead of embedding them directly.
      */
     exportPdfWithHighCompatibility?: boolean;
+    /**
+     * Export the PDF document with an underlayer.
+     * An underlayer is generated by adding a graphics block behind the existing elements of the shape of the elements on
+     * the page.
+     */
+    exportPdfWithUnderlayer?: boolean;
+    /**
+     * The name of the spot color to be used for the underlayer's fill.
+     */
+    underlayerSpotColorName?: string;
+    /**
+     * The adjustment in size of the shape of the underlayer.
+     */
+    underlayerOffset?: number;
 };
 
 /** @public */
@@ -3383,6 +3419,9 @@ declare interface ExportOptions_2 {
     targetWidth: number;
     targetHeight: number;
     exportPdfWithHighCompatibility: boolean;
+    exportPdfWithUnderlayer: boolean;
+    underlayerSpotColorName: string;
+    underlayerOffset: number;
 }
 
 /** @public */
@@ -3766,7 +3805,7 @@ export declare class SceneAPI {
      */
     create(sceneLayout?: SceneLayout): DesignBlockId;
     /**
-     * Create a new scene in video mode, along with its own camera and page stack.
+     * Create a new scene in video mode, along with its own camera.
      * @returns The scene's handle.
      */
     createVideo(): DesignBlockId;
@@ -4015,6 +4054,7 @@ export declare type SettingsEnum = {
     doubleClickSelectionMode: 'Direct' | 'Hierarchical';
     'touch/pinchAction': 'None' | 'Zoom' | 'Scale';
     'touch/rotateAction': 'None' | 'Rotate';
+    'camera/clamping/overshootMode': 'Center' | 'Reverse';
 };
 
 /** @public */