Classes#
| Class | Description |
|---|---|
| AssetAPI | Manage asset sources and apply assets to scenes. |
| BlockAPI | Create, manipulate, and query the building blocks of your design. |
| CreativeEngine | The CreativeEngine is the core processing unit of CE.SDK and handles state management, rendering, input handling, and much more. It provides APIs to directly interact with assets, blocks, scenes, and variables. These APIs can be used in a headless environment to build and manipulate designs programmatically, or in a browser to create interactive applications. |
| EditorAPI | Control the design editor’s behavior and settings. |
| EventAPI | Subscribe to block lifecycle events in the design engine. |
| SceneAPI | Create, load, save, and manipulate scenes. |
| VariableAPI | Manage text variables within design templates. |
Functions#
| Function | Description |
|---|---|
| checkVideoExportSupport | Throws an error if the current browser does not support video exporting. |
| checkVideoSupport | Throws an error if the current browser does not support video editing. |
| defaultLogger | - |
| isCMYKColor | Type guard for CMYKColor. |
| isRGBAColor | Type guard for RGBAColor. |
| isSpotColor | Type guard for SpotColor. |
| supportsBrowser | Checks if the current browser supports necessary technologies to match our supported browsers |
| supportsVideo | Checks if the current browser supports video editing. |
| supportsVideoExport | Checks if the current browser supports video exporting. |
| supportsWasm | Checks if the current browser supports web assembly |
Type Aliases#
| Type Alias | Description |
|---|---|
| AddImageOptions | Options for adding images to the scene. |
| AnimationEasing | The easing options for the camera animation. |
| AnimationEntry | Configuration options for animations. |
| AnimationOptions | Options for configuring animations (in, loop, out animations). |
| AnimationType | The block type IDs for the animation blocks. These are the IDs used to create new animations using cesdk.engine.block.createAnimation(id). Refer to AnimationTypeShorthand and AnimationTypeLonghand for more details. |
| AnimationTypeLonghand | The longhand block type IDs for the animation blocks. These are the IDs used to create new animations using cesdk.engine.block.createAnimation(id). |
| AnimationTypeShorthand | The shorthand block type IDs for the animation blocks. These are the IDs used to create new animations using cesdk.engine.block.createAnimation(id). |
| ApplicationMimeType | Represents the application MIME types used in the editor. |
| AssetColor | Asset Color payload |
| AssetGroups | An asset can be member of multiple groups. Groups have a semantic meaning used to build and group UIs exploring the assets, e.g.sections in the content library, or for things like topics in Unsplash for instance. |
| AssetMetaData | Generic asset information |
| AssetProperty | Asset property for payload |
| AssetTransformPreset | Transform preset payload |
| AudioExportOptions | Represents the options for exporting audio. |
| AudioMimeType | Represents the audio MIME types used in the editor. |
| BlendMode | Represents the blend mode of a layer or effect. |
| BlockState | Represents the state of a design block. |
| BlurType | The block type IDs for the blur blocks. These are the IDs used to create new blurs using cesdk.engine.block.createBlur(id). Refer to BlurTypeShorthand and BlurTypeLonghand for more details. |
| BlurTypeLonghand | The longhand block type IDs for the blur blocks. These are the IDs used to create new blurs using cesdk.engine.block.createBlur(id). |
| BlurTypeShorthand | The shorthand block type IDs for the blur blocks. These are the IDs used to create new blurs using cesdk.engine.block.createBlur(id). |
| BooleanOperation | Represents the names of boolean operations. |
| Canvas | An HTML Canvas or an Offscreen Canvas |
| CMYK | Represents a color in the CMYK color space. |
| Color | Represents all color types supported by the engine. |
| ColorSpace | Represents the color space used in the editor. |
| ContentFillMode | Represents the mode for filling content within a block. |
| CreateSceneOptions | Options for creating a video scene. |
| CutoutOperation | Represents the operation performed on a cutout. |
| CutoutType | Represents the type of a cutout. |
| DefaultAssetSourceId | Represents the default asset source IDs used in the editor. |
| DemoAssetSourceId | Represents the default demo asset source IDs used in the editor. |
| DesignBlockId | A numerical identifier for a design block |
| DesignBlockType | The block type IDs for the top-level design blocks. These are the IDs used to create new blocks using cesdk.engine.block.create(id). Refer to DesignBlockTypeShorthand and DesignBlockTypeLonghand for more details. |
| DesignBlockTypeLonghand | The longhand block type IDs for the top-level design blocks. These are the IDs used to create new blocks using cesdk.engine.block.create(id). |
| DesignBlockTypeShorthand | The shorthand block type IDs for the top-level design blocks. These are the IDs used to create new blocks using cesdk.engine.block.create(id). |
| DesignUnit | The unit type in which the page values (size, distances, etc.) are defined. |
| DropShadowOptions | Options for configuring drop shadow effects on blocks. |
| EditMode | Represents the current edit mode of the editor. |
| EffectType | The block type IDs for the effect blocks. These are the IDs used to create new effects using cesdk.engine.block.createEffect(id). Refer to EffectTypeShorthand and EffectTypeLonghand for more details. |
| EffectTypeLonghand | The longhand block type IDs for the effect blocks. These are the IDs used to create new effects using cesdk.engine.block.createEffect(id). |
| EffectTypeShorthand | The shorthand block type IDs for the effect blocks. These are the IDs used to create new effects using cesdk.engine.block.createEffect(id). |
| EnginePluginContext | Represents the context for an engine plugin. |
| ExportOptions | Represents the options for exporting a design block. |
| FillType | The block type IDs for the fill blocks. These are the IDs used to create new fills using cesdk.engine.block.createFill(id). Refer to FillTypeShorthand and FillTypeLonghand for more details. |
| FillTypeLonghand | The longhand block type IDs for the fill blocks. These are the IDs used to create new fills using cesdk.engine.block.createFill(id). |
| FillTypeShorthand | The shorthand block type IDs for the fill blocks. These are the IDs used to create new fills using cesdk.engine.block.createFill(id). |
| FontStyle | Represents the style of a font. |
| FontWeight | Represents the weight of a font. |
| GradientstopRGBA | Represents a gradient stop in the RGBA color space. |
| HexColorString | Represents a hexadecimal color value (RGB or RGBA) that starts with a ’#’. |
| HistoryId | A numerical identifier for a history stack |
| HorizontalBlockAlignment | Represents the horizontal alignment of blocks. |
| HorizontalTextAlignment | The horizontal text alignment options. |
| ImageMimeType | Represents the image MIME types used in the editor. |
| LogLevel | Provides logging functionality for the Creative Editor SDK. |
| MimeType | Represents the MIME types used in the editor. |
| ObjectType | The block type IDs for all blocks types in the Creative Engine. Those are the types that can be passed to cesdk.engine.block.findByType(type) for example. Refer to ObjectTypeShorthand and ObjectTypeLonghand for more details. |
| ObjectTypeLonghand | The longhand block type IDs for all blocks types in the Creative Engine. Those are the Types returned by the engine when calling cesdk.engine.block.getType(blockId) for example. |
| ObjectTypeShorthand | The shorthand block type IDs for all blocks types in the Creative Engine. Those are the types that can be passed to cesdk.engine.block.findByType(type) for example. |
| OffscreenCanvas | A simplified placeholder type for OffscreenCanvas, to avoid a dependency on @types/offscreencanvas |
| PaletteColor | Represents a color definition for the custom color palette. |
| PositionMode | Represents the mode for positioning blocks. |
| PropertyType | Represents the various types of properties that can be associated with design blocks. Each type corresponds to a different kind of data that can be used to define the properties of a design block within the system. |
| RGBA | Represents a color in the RGBA color space. |
| RoleString | Represents a role string. |
| SceneLayout | The scene layout determines how the layout stack should layout its pages. |
| SceneMode | The mode of the scene defines how the editor and playback should behave. |
| Scope | Represents the various scopes that define the capabilities and permissions within the Creative Editor SDK. Each scope corresponds to a specific functionality or action that can be performed within the editor. |
| SettingsBool | Represents the boolean settings available in the editor. |
| SettingsColor | Represents the color settings available in the editor. |
| Represents the color settings available in the editor. | |
| SettingsEnum | Represents the enum settings available in the editor. |
| SettingsFloat | Represents the float settings available in the editor. |
| SettingsString | Represents the string settings available in the editor. |
| SettingType | Represents the type of a setting. |
| ShapeType | The block type IDs for the shape blocks. These are the IDs used to create new shapes using cesdk.engine.block.createShape(id). Refer to ShapeTypeShorthand and ShapeTypeLonghand for more details. |
| ShapeTypeLonghand | The longhand block type IDs for the blocks. These are the IDs used to create new shapes using cesdk.engine.block.createShape(id). |
| ShapeTypeShorthand | The shorthand block type IDs for the shape blocks. These are the IDs used to create new shapes using cesdk.engine.block.createShape(id). |
| SizeMode | Represents the mode for sizing blocks. |
| SortingOrder | The order to sort by if the asset source supports sorting. If set to None, the order is the same as the assets were added to the source. |
| StrokeCornerGeometry | Represents the corner geometry of a stroke. |
| StrokePosition | Represents the position of a stroke relative to the shape’s boundary. |
| StrokeStyle | Represents the style of a stroke. |
| TextCase | Represents the text case of a text block. |
| Represents a typeface definition used in the editor. | |
| VerticalBlockAlignment | Represents the vertical alignment of blocks. |
| VerticalTextAlignment | The vertical text alignment options. |
| VideoExportOptions | Represents the options for exporting a video. |
| VideoMimeType | Represents the video MIME types used in the editor. |
| XYWH | Describes a rectangle on the screen. |
| ZoomAutoFitAxis | The axis(es) for which to auto-fit. |
| ZoomOptions | Options for zooming to a block with optional animation. |
Interfaces#
| Interface | Description |
|---|---|
| AddVideoOptions | Options for adding videos to the scene. |
| Asset | Generic asset information |
| AssetBooleanProperty | Asset boolean property definition |
| AssetCMYKColor | Asset Color payload CMYK representation |
| AssetColorProperty | Asset color property definition |
| AssetDefinition | Definition of an asset used if an asset is added to an asset source. |
| AssetEnumProperty | Asset enum property definition |
| AssetFixedAspectRatio | Asset transform preset payload fixed aspect ratio |
| AssetFixedSize | Asset transform preset payload fixed size |
| AssetFreeAspectRatio | Asset transform preset payload free aspect ratio |
| AssetNumberProperty | Asset number property definition |
| AssetPayload | Asset payload |
| AssetQueryData | Defines a request for querying assets |
| AssetResult | Single asset result of a query from the engine. |
| AssetRGBColor | Asset Color payload RGB representation |
| AssetSource | A source of assets |
| AssetSpotColor | Asset Color payload SpotColor representation |
| AssetsQueryResult | Return type of a findAssets query. |
| AssetStringProperty | Asset string property definition |
| AudioTrackInfo | Information about a single audio track from a video. This interface provides comprehensive metadata about audio tracks, including codec information, technical specifications, and track details. |
| BlockEvent | Represents an event related to a design block. |
| BlockStateError | Represents an error state for a design block. |
| BlockStatePending | Represents a pending state for a design block. |
| BlockStateReady | Represents a ready state for a design block. |
| BlurEvent | Dispatched on the engine canvas when the text input has been blurred. Call preventDefault() to disallow this and refocus the engine text input. |
| Buffer | Represents a buffer of data. |
| CMYKColor | Represents a CMYK color value. |
| CompleteAssetResult | Asset results that are returned from the engine. |
| Configuration | Specifies the configuration for the Creative Editor SDK. |
| CursorEvent | Dispatched on the engine canvas when the text input has been blurred. Call preventDefault() to disallow this and refocus the engine text input. |
| EnginePlugin | Represents an engine plugin. |
| Font | Represents a font. |
| GradientColorStop | Represents a gradient color stop. |
| HTMLCreativeEngineCanvasElement | A wrapper around a plain canvas |
| Logger | Represents a logger function. |
| PageDuration | - |
| Range | An open range. |
| Reaction | Reactions track read calls and provide a way to react if they change. |
| Reactor | The reactor coordinates the update of registered Reactions. |
| RefocusEvent | Dispatched on the engine canvas right before the engine will refocus its text input after a blur. Call preventDefault() to prevent the refocusing. |
| RGBAColor | Represents an RGBA color value. |
| RGBColor | Represents an RGB color value. |
| Size2 | - |
| Source | A single source width an intrinsic width & height. |
| SpotColor | Represents a spot color value. |
| TransientResource | Represents a transient resource. |
| Typeface | Represents a typeface. |
| Vec2 | - |
| Vec3 | - |
Variables#
| Variable | Description |
|---|---|
| Provides a set of predefined log levels for the Creative Editor SDK. | |
| Represents the MIME types used in the editor. |