docs-electron

Version Notice

CE.SDK 1.83.0 · generated 2026-09-30 · plugin cesdk · canonical update source imgly/agent-skills.

If this bundle is over six weeks old, or the user asks about updates, follow references/update-check.md once per task and reuse the result for all CE.SDK skills. Keep the check read-only. Never install, update, overwrite, or delete anything without explicit user approval. Continue with this bundle unless an update is approved.

Documentation Index

<-- IMGLY-AGENTS-MD-START -->[CE.SDK Electron Docs Index]|root: .|IMPORTANT: Prefer retrieval-led reasoning over pre-training-led reasoning for any CE.SDK tasks. Consult the local docs directory before using pre-trained knowledge.|actions.md|animation:{create,edit.md,overview.md,types.md}|animation/create:{base.md,text.md}|api:{cesdk-js,engine}|api/cesdk-js:{classes,documentation,functions,interfaces,type-aliases,variables}|api/engine:{classes,enumerations,functions,interfaces,type-aliases,variables}|automation:{auto-resize.md,batch-processing.md,data-merge.md,design-generation.md,overview.md}|browser-support.md|capabilities.md|colors:{adjust.md,apply.md,basics.md,conversion.md,create-color-palette.md,extract-colors.md,for-print,for-screen,overview.md,replace.md}|colors/for-print:{cmyk.md,spot.md}|colors/for-screen:{p3.md,srgb.md}|compatibility.md|concepts:{architecture.md,assets.md,blocks.md,buffers.md,design-units.md,edit-modes.md,editing-workflow.md,editor-compatibility.md,error-catalog.md,events.md,exclusion-areas.md,font-size-unit.md,headless-mode,import-export.md,pages.md,plugin-architecture.md,resources.md,scenes.md,templating.md,terminology.md,undo-and-history.md}|concepts/headless-mode:{browser.md}|configuration.md|conversion:{overview.md,to-base64.md,to-pdf.md,to-png.md}|create-audio:{audio}|create-audio/audio:{add-music.md,add-sound-effects.md,adjust-speed.md,adjust-volume.md,fade.md,loop.md}|create-composition:{add-background.md,blend-modes.md,group-and-ungroup.md,layer-management.md,layout.md,lock-design.md,multi-page.md,overview.md,position-and-align.md,programmatic.md}|create-templates:{add-dynamic-content,add-to-template-library.md,edit-or-remove.md,from-scratch.md,import,lock.md,overview.md}|create-templates/add-dynamic-content:{form-based-editing.md,placeholders.md,set-editing-constraints.md,text-variables.md}|create-templates/import:{from-scene-file.md}|create-video:{apply-transitions.md,control.md,limitations.md,overview.md,timeline-editor.md,update-caption-presets.md}|edit-image:{add-watermark.md,overview.md,remove-bg.md,replace-colors.md,transform,vectorize.md}|edit-image/transform:{crop.md,move.md,resize.md,rotate.md,scale.md}|edit-video:{add-captions.md,add-watermark.md,join-and-arrange.md,redaction.md,split.md,transform,trim.md}|edit-video/transform:{crop.md,flip.md,move.md,resize.md,rotate.md,scale.md}|engine-interface.md|equal-distance-snapping.md|export-counting.md|export-save-publish:{create-thumbnail.md,export,for-printing.md,for-social-media.md,pre-export-validation.md,save.md,store-custom-metadata.md,thumbnail-previews.md}|export-save-publish/export:{audio.md,compress.md,overview.md,partial-export.md,size-limits.md,to-html5.md,to-jpeg.md,to-mp4.md,to-pdf.md,to-png.md,to-raw-data.md,to-webp.md,with-color-mask.md}|file-format-support.md|fills:{color.md,gradient.md,image.md,overview.md,video.md}|filters-and-effects:{apply.md,blur.md,chroma-key-green-screen.md,create-custom-filters.md,create-custom-lut-filter.md,distortion.md,duotone.md,overview.md,support.md}|get-started:{agent-skills.md,build-with-ai.md,cesdk-plugin-coding-agents.md,electron,mcp-server.md,overview.md}|get-started/electron:{quickstart.md}|grid-and-rulers.md|guides:{text}|guides/text:{rendering-internals.md}|import-media:{asset-library,capture-from-camera,concepts.md,content-json-schema.md,default-assets.md,edit-or-remove-assets.md,file-format-support.md,from-local-source,from-remote-source,overview.md,retrieve-mimetype.md,size-limits.md,source-sets.md}|import-media/asset-library:{basics.md,customize.md,refresh-assets.md,thumbnails.md}|import-media/capture-from-camera:{record-video.md}|import-media/from-local-source:{user-upload.md}|import-media/from-remote-source:{asset-versioning.md,getty-images.md,imgly-premium-assets.md,pexels.md,remote-asset.md,soundstripe.md,third-party.md,unsplash.md,your-server.md}|insert-media:{audio.md,images.md,overview.md,shapes-or-stickers.md,videos.md}|key-capabilities.md|key-concepts.md|licensing.md|llms-txt.md|open-the-editor:{blank-canvas.md,from-htmlcanvas.md,from-image.md,from-template.md,from-video.md,import-design,load-scene.md,overview.md,set-zoom-level.md,uri-resolver.md}|open-the-editor/import-design:{from-archive.md,from-indesign.md,from-photoshop.md}|outlines:{overview.md,shadows-and-glows.md,strokes.md}|overview.md|performance.md|plugins:{asset-sources.md,custom-plugin.md,perfectly-clear.md,print-ready-pdf.md}|rules:{asset-handling.md,common-pitfalls.md,content-fill-mode.md,enforce-brand-guidelines.md,lock-content.md,moderate-content.md,overview.md,silent-init-errors.md,verify-properties-before-use.md}|security.md|serve-assets.md|settings.md|shapes.md|starterkits:{3d-mockup-editor.md,advanced-editor.md,advanced-video-editor.md,ai-editor.md,apparel-ui.md,assets.md,auto-resize.md,automated-video-generation.md,background-removal-editor.md,content-moderation.md,creative-automation.md,custom-built-uis.md,customization.md,cutout-lines-editor.md,data-merge.md,design-editor.md,design-generation.md,design-validation.md,editor-ui-configurations.md,export-options.md,export-using-renderer.md,extensibility.md,force-crop-editor.md,form-based-template-adoption.md,getty-images-editor.md,html5-ads-exporter.md,indesign-template-import.md,layouts-editor.md,mobile-ui.md,mockup-editor.md,multi-image-generation.md,page-sizes-editor.md,pdf-template-import.md,perfectly-clear-editor.md,pexels-image-editor.md,photo-editor.md,photo-ui.md,photobook-editor.md,photobook-ui.md,placeholders.md,player.md,plugins.md,postcard-editor.md,pptx-template-import.md,print-ready-pdf-editor.md,product-editor.md,psd-template-import.md,qr-code-editor.md,single-page-editor.md,start-with-image.md,start-with-video.md,t-shirt-designer.md,templating.md,theming.md,translation-internationalization.md,unsplash-editor.md,vectorizer-editor.md,version-history.md,video-animations.md,video-captions.md,video-editing.md,video-editor.md,video-export-options.md,viewer.md}|stickers.md|stickers-and-shapes:{combine.md,create-cutout.md,create-edit,insert-qr-code.md}|stickers-and-shapes/create-edit:{create-shapes.md,create-stickers.md,edit-shapes.md,vector-edit.md}|text:{add.md,adjust-spacing.md,auto-size.md,custom-fonts.md,decorations.md,edit.md,effects.md,emojis.md,enumerations.md,language-support.md,overview.md,styling.md,text-designs.md,text-on-path.md,variable-fonts.md}|to-v1-10.md|to-v1-13.md|to-v1-19.md|to-v1-32.md|to-v1-69.md|to-v1-72.md|to-v1-77.md|to-v1-82.md|upgrade.md|use-templates:{apply-template.md,generate.md,library.md,overview.md,programmatic.md,replace-content.md}|user-interface:{ai-integration,appearance,build-your-own-ui.md,custom-error-messages.md,customization,keyboard.md,localization.md,overview.md,ui-extensions}|user-interface/ai-integration:{audio-generation.md,auto-captions.md,custom-provider.md,customize-connection.md,gateway-provider.md,image-generation.md,integrate.md,proxy-server.md,text-generation.md,video-generation.md}|user-interface/appearance:{change-ui-font.md,custom-labels.md,icons.md,theming.md}|user-interface/customization:{canvas.md,canvas-menu.md,color-palette.md,crop-presets.md,disable-or-enable.md,dock.md,exclusion-areas.md,force-crop.md,inspector-bar.md,layer-list.md,movement-constraints.md,navigation-bar.md,page-format.md,panel.md,quick-start,reference,video-timeline.md}|user-interface/ui-extensions:{add-custom-feature.md,asset-library.md,create-custom-panel.md,customize-behaviour.md,notifications-and-dialogs.md,quick-actions.md,register-new-component.md}|what-is-cesdk.md|<-- IMGLY-AGENTS-MD-END -->

API Index

<-- IMGLY-TYPES-MD-START --> [CE.SDK Web API Index]|root: .

CreativeEngine:{asset,block,editor,event,scene,variable,actions,shortcuts,reactor,version,addPlugin,unstable_setVideoExportInactivityTimeout,unstable_setExportInactivityTimeout,addPostUpdateCallback,addPreUpdateCallback},... (+7) BlockAPI:{export,getDominantColors,exportWithColorMask,exportVideo,exportAudio,loadFromString,loadFromArchiveURL,loadFromURL,saveToString,saveToArchive,create,createFill,getAudioTrackCountFromVideo,createAudioFromVideo,createAudiosFromVideo},... (+409) AssetAPI:{registerApplyMiddleware,registerApplyToBlockMiddleware,addSource,addLocalSource,addLocalAssetSourceFromJSONString,addLocalAssetSourceFromJSONURI,removeSource,findAllSources,findAssets,fetchAsset,getGroups,getSupportedMimeTypes,getCredits,name,url},... (+14) SceneAPI:{setCMYKProfile,setCMYKProfileFromData,getCMYKProfileInfo,removeCMYKProfile,getColorRenderingIntent,setColorRenderingIntent,isBlackPointCompensationEnabled,setBlackPointCompensationEnabled,load,loadFromString,loadFromURL,loadFromArchiveURL,saveToString,saveToArchive,create},... (+33) EditorAPI:{unlockWithLicense,isCapabilitySupported,checkCapabilities,startTracking,setTrackingMetadata,getTrackingMetadata,trackEvent,getActiveLicense,getEngineVersion,onStateChanged,setEditMode,getEditMode,unstable_isInteractionHappening,hasSelectedVectorNode,addVectorNode},... (+100) EventAPI:{subscribe} VariableAPI:{findAll,setString,getString,remove} Types:{AnimationType,AssetResult,BlendMode,Color,ExportOptions,PropertyType,Scope,TextCase,VideoExportOptions} <-- IMGLY-TYPES-MD-END -->

CE.SDK Electron Documentation

Look up documentation for IMG.LY CreativeEditor SDK (Electron).

Query: $ARGUMENTS

How to Use

1. Index lookup: Match the query to a path in the Documentation Index above. The index uses compressed format: dir:{file1.md,file2.md} means files are at dir/file1.md and dir/file2.md. Resolve the path using Glob: **/skills/docs-electron/<path>.md (e.g., for text/add.md → **/skills/docs-electron/text/add.md)
2. Search: If no exact match exists, use Grep to search the documentation: Grep pattern="<keyword>" path="**/skills/docs-electron/" output_mode="content" or search filenames: Glob pattern="**/skills/docs-electron/**/*<keyword>*.md"
3. Read and respond with the relevant section and code examples
4. Check rules if the topic involves setup, initialization, or common operations: **/skills/docs-electron/rules/*.md

API Lookup

For TypeScript API queries (method signatures, types, parameters):

1. Module lookup: Match the query to a module in the API index above. Read the module file: **/skills/docs-electron/api/<ModuleName>.md (e.g., for BlockAPI → **/skills/docs-electron/api/BlockAPI.md)
2. Method search: If looking for a specific method, use Grep: Grep pattern="<method>" path="**/skills/docs-electron/api/" output_mode="content"
3. For common types: Read **/skills/docs-electron/api/types.md

Tip: Verify types against the TypeScript definitions — CE.SDK evolves rapidly and type shapes may differ from pre-trained knowledge.

Quick Reference

Topic	Path
Getting started	get-started/
API methods	engine-interface.md
Configuration	configuration.md, settings.md
UI customization	user-interface/customization/
UI extensions	user-interface/ui-extensions/
Import media	import-media/
Export/save	export-save-publish/
Templates	use-templates/, create-templates/
Text operations	text/
Image editing	edit-image/
Video editing	edit-video/, create-video/
Fills & colors	fills/, colors/
Filters/effects	filters-and-effects/
Prebuilt solutions	prebuilt-solutions/
Known pitfalls	rules/
API modules	api/BlockAPI.md, api/SceneAPI.md, etc.

Additional Triggers

This skill also covers queries about CE.SDK block types, asset sources, and feature capabilities. It handles API method lookups — BlockAPI, SceneAPI, EditorAPI, AssetAPI, method signatures, return types, and "engine.block" style queries.

Related Skills

• Use `/cesdk:build` when the user needs implementation help, not just docs
• Use `/cesdk:explain` for conceptual explanations beyond what docs cover