@cesdk/cesdk-js 1.68.0-rc.1 → 1.69.0-nightly.20260129

package/index.d.ts

@@ -1126,8 +1126,6 @@ export declare interface BuiltinTranslations {
     'component.contentFill.options.description': string;
     'component.contentFill.video': string;
     'component.cutout': string;
-    'component.dnd.description': string;
-    'component.dnd.prompt': string;
     'component.dockIconSizeSelect': string;
     'component.dockIconSizeSelect.large': string;
     'component.dockIconSizeSelect.large.description': string;
@@ -3069,6 +3067,7 @@ export { DesignUnit }
 export declare interface Dialog {
     type?: DialogType;
     size?: DialogSize;
+    backdrop?: DialogBackdrop;
     content: DialogContent;
     progress?: DialogProgress;
     actions?: DialogAction | DialogAction[];
@@ -3095,6 +3094,17 @@ export declare type DialogAction = {
     }) => void;
 };
 
+/**
+ * Represents the backdrop style for the dialog.
+ *
+ * The DialogBackdrop type defines how the background overlay is rendered when a dialog is shown.
+ * - 'transparent': A semi-transparent overlay that allows content behind to be partially visible (default behavior)
+ * - 'opaque': A fully opaque overlay that completely blocks the view of content behind the dialog
+ *
+ * @public
+ */
+export declare type DialogBackdrop = 'transparent' | 'opaque';
+
 /**
  * Represents the content of the dialog.
  *
@@ -4753,6 +4763,13 @@ export declare interface RegisteredActions {
     copy: CopyAction;
     /** Action for pasting blocks from the clipboard */
     paste: PasteAction;
+    /**
+     * Video support check actions
+     */
+    /** Action for checking video decoding/playback support */
+    'video.decode.checkSupport': VideoDecodeCheckSupportAction;
+    /** Action for checking video encoding/export support */
+    'video.encode.checkSupport': VideoEncodeCheckSupportAction;
 }
 
 /**
@@ -7050,16 +7067,108 @@ export declare class UtilsAPI {
         paddingX: number;
         paddingY: number;
     };
+    /**
+     * Checks if the current browser supports video decoding/playback.
+     *
+     * Video decoding requires the WebCodecs API (VideoFrame, VideoDecoder, VideoEncoder,
+     * AudioDecoder, AudioEncoder). These APIs are not available on all platforms.
+     *
+     * **Supported platforms**: Chrome and Edge on Windows and macOS.
+     * **Unsupported platforms**: All browsers on Linux, Firefox on any OS.
+     *
+     * @returns true if the browser supports video decoding, false otherwise
+     *
+     * @example
+     * ```typescript
+     * if (cesdk.utils.supportsVideoDecode()) {
+     *   // Video features are available
+     *   await cesdk.engine.scene.loadFromURL('video-scene.scene');
+     * } else {
+     *   // Show fallback UI or message
+     *   console.log('Video features not available in this browser');
+     * }
+     * ```
+     * @public
+     */
+    supportsVideoDecode(): boolean;
+    /**
+     * Checks if the current browser supports video encoding/export.
+     *
+     * Video encoding requires the WebCodecs API with H.264 (AVC) video encoding
+     * and AAC audio encoding support. These codecs are patent-encumbered and not
+     * included in open-source browser builds.
+     *
+     * **Supported platforms**: Chrome and Edge on Windows and macOS.
+     * **Unsupported platforms**: All browsers on Linux, Firefox on any OS.
+     *
+     * For server-side video rendering that works on all platforms, see CE.SDK Renderer:
+     * https://img.ly/docs/cesdk/renderer/cesdk-renderer-overview-7f3e9a/
+     *
+     * @returns A promise that resolves to true if the browser supports video encoding, false otherwise
+     *
+     * @example
+     * ```typescript
+     * if (await cesdk.utils.supportsVideoEncode()) {
+     *   // Video export is available
+     *   const blob = await cesdk.engine.block.exportVideo(page);
+     * } else {
+     *   // Show fallback UI or suggest server-side rendering
+     *   console.log('Video export not available - consider using CE.SDK Renderer');
+     * }
+     * ```
+     * @public
+     */
+    supportsVideoEncode(): Promise<boolean>;
 }
 
 export { VariableAPI }
 
 export { VerticalBlockAlignment }
 
+/**
+ * Action function for checking video decoding/playback support.
+ * Returns true if WebCodecs APIs are available for video decoding and playback.
+ * Shows a blocking error dialog if not supported (unless dialog is disabled).
+ *
+ * @param options - Options for configuring the action behavior
+ *                - dialog: false to disable the dialog, true for default, or VideoSupportDialogOptions for fine control
+ * @returns true if video decoding is supported, false otherwise
+ * @public
+ */
+export declare type VideoDecodeCheckSupportAction = (options?: {
+    dialog?: boolean | VideoSupportDialogOptions;
+}) => boolean;
+
+/**
+ * Action function for checking video encoding/export support.
+ * Returns true if H.264 video encoding and AAC audio encoding are supported.
+ * Shows a warning dialog if not supported (unless dialog is disabled).
+ *
+ * @param options - Options for configuring the action behavior
+ *                - dialog: false to disable the dialog, true for default, or VideoSupportDialogOptions for fine control
+ * @returns A promise that resolves to true if video encoding is supported, false otherwise
+ * @public
+ */
+export declare type VideoEncodeCheckSupportAction = (options?: {
+    dialog?: boolean | VideoSupportDialogOptions;
+}) => Promise<boolean>;
+
 export { VideoExportOptions }
 
 export { VideoMimeType }
 
+/**
+ * Dialog display options for video support check actions.
+ * Allows configuring whether and how the dialog is displayed.
+ * @public
+ */
+export declare type VideoSupportDialogOptions = {
+    /** Whether to show the dialog */
+    show: boolean;
+    /** Backdrop style for the dialog - 'transparent' allows interaction with the page, 'opaque' blocks it */
+    backdrop?: 'transparent' | 'opaque';
+};
+
 /**
  * Represents the view style options in the Creative Editor SDK.
  * This type defines the possible view styles, which are 'advanced' and 'default'.