@cesdk/engine 1.61.0-nightly.20250917 → 1.61.0-nightly.20250920

package/index.d.ts

@@ -943,12 +943,11 @@ export declare interface AssetResult extends Asset {
  * The `AssetResultCredits` interface provides a set of properties that describe the credits
  * for an asset result, including the name and URL of the credits.
  *
- * @categoryDescription AssetResultCredits
  * Methods for working with the credits of asset results.
  *
  * @public
  */
-declare interface AssetResultCredits {
+export declare interface _AssetResultCredits {
     name: string;
     url: string;
 }
@@ -959,12 +958,11 @@ declare interface AssetResultCredits {
  * The `AssetResultLicense` interface provides a set of properties that describe the license
  * for an asset result, including the name and URL of the license.
  *
- * @categoryDescription AssetResultLicense
  * Methods for working with the license of asset results.
  *
  * @public
  */
-declare interface AssetResultLicense {
+export declare interface _AssetResultLicense {
     name: string;
     url: string;
 }
@@ -4742,7 +4740,7 @@ export declare class BlockAPI {
      *
      * @category Block Video
      * @param id - The block whose trim should be updated.
-     * @param offset - The new trim offset in seconds.
+     * @param offset - The new trim offset, measured in timeline seconds (scaled by playback rate).
      */
     setTrimOffset(id: DesignBlockId, offset: number): void;
     /**
@@ -4945,6 +4943,23 @@ export declare class BlockAPI {
      * @returns The volume, ranging from 0.0 to 1.0.
      */
     getVolume(id: DesignBlockId): number;
+    /**
+     * Sets the playback speed multiplier of a block that supports playback control.
+     * Note: This also adjusts the trim and duration of the block.
+     *
+     * @category Block Video
+     * @param id - The block or video fill to update.
+     * @param speed - The desired playback speed multiplier with a range of [0.25, 3.0].
+     */
+    setPlaybackSpeed(id: DesignBlockId, speed: number): void;
+    /**
+     * Gets the playback speed multiplier of a block that supports playback control.
+     *
+     * @category Block Video
+     * @param id - The block to query.
+     * @returns The playback speed multiplier.
+     */
+    getPlaybackSpeed(id: DesignBlockId): number;
     /**
      * Forces the loading of a block's audio/video resource.
      *
@@ -6811,23 +6826,6 @@ export declare class EventAPI {
     subscribe: (blocks: DesignBlockId[], callback: (events: BlockEvent[]) => void) => (() => void);
 }
 
-/**
- * Specifies options for exporting audio design blocks to various formats.
- *
- * The `ExportAudioOptions` interface provides a set of properties that control the
- * behavior and quality of the exported audio content. These options include settings
- * for sample rate and number of channels.
- *
- * @categoryDescription Export Audio Options
- * Methods for configuring export settings for audio design blocks.
- *
- * @public
- */
-declare interface ExportAudioOptions {
-    sampleRate: number;
-    numberOfChannels: number;
-}
-
 /**
  * Represents the options for exporting a design block.
  *
@@ -6916,52 +6914,6 @@ export declare type ExportOptions = {
     abortSignal?: AbortSignal;
 };
 
-/**
- * Specifies options for exporting design blocks to various formats.
- *
- * The `ExportOptions` interface provides a set of properties that control the
- * behavior and quality of the exported content. These options include settings
- * for JPEG, WebP, PNG, and PDF exports, as well as options for resizing and
- * adding underlayers.
- *
- * @public
- */
-declare interface ExportOptions_2 {
-    jpegQuality: number;
-    webpQuality: number;
-    pngCompressionLevel: number;
-    useTargetSize: boolean;
-    targetWidth: number;
-    targetHeight: number;
-    exportPdfWithHighCompatibility: boolean;
-    exportPdfWithUnderlayer: boolean;
-    underlayerSpotColorName: string;
-    underlayerOffset: number;
-}
-
-/**
- * Specifies options for exporting video design blocks to various formats.
- *
- * The `ExportVideoOptions` interface provides a set of properties that control the
- * behavior and quality of the exported video content. These options include settings
- * for H.264 profile, level, framerate, video bitrate, audio bitrate, and resizing.
- *
- * @categoryDescription Export Video Options
- * Methods for configuring export settings for video design blocks.
- *
- * @public
- */
-declare interface ExportVideoOptions {
-    h264Profile: number;
-    h264Level: number;
-    framerate: number;
-    videoBitrate: number;
-    audioBitrate: number;
-    useTargetSize: boolean;
-    targetWidth: number;
-    targetHeight: number;
-}
-
 /**
  * The block type IDs for the fill blocks. These are the IDs used to create new fills
  * using `cesdk.engine.block.createFill(id)`.
@@ -6992,12 +6944,11 @@ export declare type FillTypeShorthand = 'color' | 'gradient/linear' | 'gradient/
  * the groups, the excluded groups, the locale, the sorting order, the sort key, and whether to
  * sort active assets first.
  *
- * @categoryDescription FindAssetsQuery
  * Methods for working with queries for finding assets.
  *
  * @public
  */
-declare interface FindAssetsQuery {
+export declare interface _FindAssetsQuery {
     perPage: number;
     page: number;
     query: string;
@@ -7016,12 +6967,11 @@ declare interface FindAssetsQuery {
  * The `Flip` interface provides a set of properties that indicate whether the design block
  * is flipped horizontally or vertically.
  *
- * @categoryDescription Flip
  * Methods for configuring the flip states of a design block.
  *
  * @public
  */
-declare interface Flip {
+export declare interface _Flip {
     horizontal: boolean;
     vertical: boolean;
 }
@@ -7216,7 +7166,7 @@ export declare function isSpotColor(color: Color): color is SpotColor;
  * e.g. `en`, `de`, etc.
  * @public
  */
-declare type Locale = string;
+export declare type Locale = string;
 
 /**
  * Represents a logger function.
@@ -8330,7 +8280,6 @@ export declare interface Settings {
  *
  * @deprecated Use keyof Settings or extract the boolean keys from Settings instead.
  * @public
- * @category Boolean Settings
  */
 export declare type SettingsBool = {
     [K in keyof Settings]: Settings[K] extends boolean ? K : never;
@@ -8341,7 +8290,6 @@ export declare type SettingsBool = {
  *
  * @deprecated Use keyof Settings or extract the color keys from Settings instead.
  * @public
- * @category Color Settings
  */
 export declare type SettingsColor = {
     [K in keyof Settings]: Settings[K] extends Color ? K : never;
@@ -8352,7 +8300,6 @@ export declare type SettingsColor = {
  *
  * @public
  * @deprecated Use SettingsColor instead.
- * @category Color Settings
  */
 export declare type SettingsColorRGBA = SettingsColor;
 
@@ -8361,7 +8308,6 @@ export declare type SettingsColorRGBA = SettingsColor;
  *
  * @deprecated Use keyof Settings or extract the enum keys from Settings instead.
  * @public
- * @category Enum Settings
  */
 export declare type SettingsEnum = Pick<Settings, 'doubleClickSelectionMode' | 'touch/pinchAction' | 'touch/rotateAction' | 'camera/clamping/overshootMode'>;
 
@@ -8370,7 +8316,6 @@ export declare type SettingsEnum = Pick<Settings, 'doubleClickSelectionMode' | '
  *
  * @deprecated Use keyof Settings or extract the float keys from Settings instead.
  * @public
- * @category Float Settings
  */
 export declare type SettingsFloat = Exclude<{
     [K in keyof Settings]: Settings[K] extends number ? K : never;
@@ -8380,7 +8325,6 @@ export declare type SettingsFloat = Exclude<{
  * Represents the integer settings available in the editor.
  *
  * @public
- * @category Integer Settings
  */
 export declare type SettingsInt = 'maxImageSize';
 
@@ -8389,7 +8333,6 @@ export declare type SettingsInt = 'maxImageSize';
  *
  * @deprecated Use keyof Settings or extract the string keys from Settings instead.
  * @public
- * @category String Settings
  */
 export declare type SettingsString = Exclude<{
     [K in keyof Settings]: Settings[K] extends string ? K : never;
@@ -8498,23 +8441,6 @@ export declare type SplitOptions = {
     selectNewBlock?: boolean;
 };
 
-/**
- * Specifies options for configuring block split operations.
- *
- * The `SplitOptions` interface provides a set of properties that control the
- * behavior of the block splitting operation.
- *
- * @categoryDescription Split Options
- * Methods for configuring block split operations.
- *
- * @public
- */
-declare interface SplitOptions_2 {
-    attachToParent: boolean;
-    createParentTrackIfNeeded: boolean;
-    selectNewBlock: boolean;
-}
-
 /**
  * Represents a spot color value.
  *
@@ -8583,7 +8509,7 @@ export declare type StrokeStyle = 'Dashed' | 'DashedRound' | 'Dotted' | 'LongDas
  *
  * @public
  */
-declare type Subscription = number;
+export declare type _Subscription = number;
 
 /**
  * Checks if the current browser supports necessary technologies to match our supported browsers
@@ -8694,6 +8620,83 @@ export declare type TypefaceDefinition = {
     }[];
 };
 
+/**
+ * Specifies options for exporting audio design blocks to various formats.
+ *
+ * The `UBQExportAudioOptions` interface provides a set of properties that control the
+ * behavior and quality of the exported audio content. These options include settings
+ * for sample rate and number of channels.
+ *
+ * Methods for configuring export settings for audio design blocks.
+ *
+ * @public
+ */
+export declare interface _UBQExportAudioOptions {
+    sampleRate: number;
+    numberOfChannels: number;
+}
+
+/**
+ * Specifies options for exporting design blocks to various formats.
+ *
+ * The `UBQExportOptions` interface provides a set of properties that control the
+ * behavior and quality of the exported content. These options include settings
+ * for JPEG, WebP, PNG, and PDF exports, as well as options for resizing and
+ * adding underlayers.
+ *
+ * @public
+ */
+export declare interface _UBQExportOptions {
+    jpegQuality: number;
+    webpQuality: number;
+    pngCompressionLevel: number;
+    useTargetSize: boolean;
+    targetWidth: number;
+    targetHeight: number;
+    exportPdfWithHighCompatibility: boolean;
+    exportPdfWithUnderlayer: boolean;
+    underlayerSpotColorName: string;
+    underlayerOffset: number;
+}
+
+/**
+ * Specifies options for exporting video design blocks to various formats.
+ *
+ * The `UBQExportVideoOptions` interface provides a set of properties that control the
+ * behavior and quality of the exported video content. These options include settings
+ * for H.264 profile, level, framerate, video bitrate, audio bitrate, and resizing.
+ *
+ * Methods for configuring export settings for video design blocks.
+ *
+ * @public
+ */
+export declare interface _UBQExportVideoOptions {
+    h264Profile: number;
+    h264Level: number;
+    framerate: number;
+    videoBitrate: number;
+    audioBitrate: number;
+    useTargetSize: boolean;
+    targetWidth: number;
+    targetHeight: number;
+}
+
+/**
+ * Specifies options for configuring block split operations.
+ *
+ * The `UBQSplitOptions` interface provides a set of properties that control the
+ * behavior of the block splitting operation.
+ *
+ * Methods for configuring block split operations.
+ *
+ * @public
+ */
+export declare interface _UBQSplitOptions {
+    attachToParent: boolean;
+    createParentTrackIfNeeded: boolean;
+    selectNewBlock: boolean;
+}
+
 /**
  * @public Manage text variables within design templates.
  *