docs

CE.SDK Swift Documentation

Version Notice

CE.SDK 1.83.0 · generated 2026-09-30 · plugin cesdk-swift · 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.

Platform and Module Scope

Determine the target from the request, active Xcode destination, Package.swift, or project settings. If the answer materially changes and the target remains unclear, ask whether it is iOS, macOS, or Mac Catalyst.

Module surface	iOS	macOS	Mac Catalyst
`IMGLYEngine`	Yes	Yes	Yes
`IMGLYCore`, `IMGLYCoreUI`, `IMGLYCamera`, `IMGLYEditor`	Yes	No	No
Prebuilt editor products and SwiftUI starter kits	Yes	No	No

For macOS or Mac Catalyst editor-UI requests, explain that the prebuilt editor UI is unavailable and offer an IMGLYEngine-backed custom UI instead.

Source Priority

Prefer live Xcode symbol or documentation lookup, when available, for exact installed-SDK signatures, generic constraints, availability, and deprecations.
Use bundled API digests for discovery, planning, and portable lookup.
Use bundled guides for integration recipes.
Use pretrained knowledge only when the installed SDK and bundle do not answer.

If live Xcode symbols disagree with a bundled API digest, follow the installed SDK and call out the version difference.

Lookup Workflow

Resolve the target platform and module surface.
Search the relevant guide index below and read files under guides/<platform>/.
For API lookup, use the module-qualified index and read api/<Module>/<Type>.md, for example api/IMGLYEngine/AssetAPI.md.
Cross-check exact callable signatures in live Xcode documentation when available.

Guide Indexes

iOS (Swift)

<-- IMGLY-AGENTS-MD-START -->[CE.SDK iOS (Swift) Docs Index]|root: ./guides/ios|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.|animation:{create,edit.md,overview.md,types.md}|animation/create:{base.md,text.md}|automation:{auto-resize.md,batch-processing.md,data-merge.md,design-generation.md,multi-image-generation.md,overview.md,product-variations.md}|bundle-size.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-139ef9.md|compatibility-fef719.md|concepts:{architecture.md,assets.md,blocks.md,buffers.md,design-units.md,edit-modes.md,editing-workflow.md,error-catalog.md,events.md,exclusion-areas.md,font-size-unit.md,import-export.md,pages.md,plugin-architecture.md,resources.md,scenes.md,templating.md,terminology.md,undo-and-history.md}|configuration.md|conversion:{overview.md,to-base64.md,to-blob.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,record-voiceover.md}|create-composition:{add-background.md,blend-modes.md,collage.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-prebuilt-xcframework.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,lock-design.md,overview.md,programmatic.md,record-reaction.md,timeline-editor.md,update-caption-presets.md}|edit-image:{add-watermark.md,annotation.md,overview.md,remove-bg.md,replace-colors.md,transform}|edit-image/transform:{crop.md,flip.md,move.md,resize.md,rotate.md,scale.md}|edit-video:{add-captions.md,add-watermark.md,annotation.md,force-trim.md,join-and-arrange.md,programmatic.md,redaction.md,split.md,transform,trim.md}|edit-video/transform:{crop.md,flip.md,move.md,overview.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-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,ios,mcp-server.md,overview.md}|get-started/ios:{existing-project,new-project,quickstart.md}|get-started/ios/existing-project:{swiftui.md,uikit.md}|get-started/ios/new-project:{swiftui.md,uikit.md}|guides.md|import-media:{asset-library,capture-from-camera,concepts.md,content-json-schema.md,create-custom-importer.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:{camera-configuration.md,dual-camera.md,integrate.md,photos.md,record-reaction.md,record-video.md,recordings.md,take-photo.md,zoom.md}|import-media/from-local-source:{local-asset.md,photo-roll.md,user-upload.md}|import-media/from-remote-source:{asset-versioning.md,getty-images.md,imgly-premium-assets.md,pexels.md,remote-asset.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-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:{ai-image-generation.md,custom-plugin.md}|prebuilt-solutions.md|rules:{enforce-brand-guidelines.md,lock-content.md,moderate-content.md,overview.md}|security.md|serve-assets.md|settings.md|shapes.md|starterkits:{custom-built-uis.md,design-editor.md,photo-editor.md,postcard-editor.md,t-shirt-designer.md,video-editor.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,edit-stickers.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-19.md|to-v1-73.md|to-v1-77.md|to-v1-83.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,events.md,localization.md,overview.md,ui-extensions}|user-interface/ai-integration:{auto-captions.md}|user-interface/appearance:{change-ui-font.md,custom-labels.md,icons.md,theming.md}|user-interface/customization:{canvas-menu.md,color-palette.md,crop-presets.md,disable-or-enable.md,dock.md,force-crop.md,hide-elements.md,inspector-bar.md,movement-constraints.md,navigation-bar.md,page-format.md,panel.md,rearrange-buttons.md,video-timeline.md}|user-interface/ui-extensions:{add-new-button.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 -->

macOS (Swift)

<-- IMGLY-AGENTS-MD-START -->[CE.SDK macOS (Swift) Docs Index]|root: ./guides/macos|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.|animation:{create,edit.md,overview.md,types.md}|animation/create:{base.md,text.md}|automation:{auto-resize.md,batch-processing.md,data-merge.md,design-generation.md,multi-image-generation.md,overview.md,product-variations.md}|capabilities.md|colors:{adjust.md,apply.md,basics.md,conversion.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-139ef9.md|compatibility-fef719.md|concepts:{architecture.md,assets.md,blocks.md,buffers.md,design-units.md,edit-modes.md,editing-workflow.md,error-catalog.md,events.md,exclusion-areas.md,font-size-unit.md,import-export.md,pages.md,resources.md,scenes.md,templating.md,terminology.md,undo-and-history.md}|conversion:{overview.md,to-base64.md,to-blob.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,collage.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-prebuilt-xcframework.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,lock-design.md,overview.md,programmatic.md,timeline-editor.md,update-caption-presets.md}|edit-image:{add-watermark.md,annotation.md,replace-colors.md,transform}|edit-image/transform:{crop.md,flip.md,move.md,resize.md,rotate.md,scale.md}|edit-video:{add-captions.md,add-watermark.md,annotation.md,force-trim.md,join-and-arrange.md,programmatic.md,redaction.md,split.md,transform,trim.md}|edit-video/transform:{crop.md,flip.md,move.md,overview.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-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,macos,mcp-server.md,overview.md}|get-started/macos:{quickstart.md}|guides.md|import-media:{asset-library,concepts.md,content-json-schema.md,create-custom-importer.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:{thumbnails.md}|import-media/from-local-source:{local-asset.md}|import-media/from-remote-source:{asset-versioning.md,getty-images.md,imgly-premium-assets.md,pexels.md,remote-asset.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-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|prebuilt-solutions.md|rules:{enforce-brand-guidelines.md,lock-content.md,moderate-content.md,overview.md}|security.md|serve-assets.md|settings.md|shapes.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,edit-stickers.md}|text:{add.md,adjust-spacing.md,auto-size.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}|to-v1-19.md|upgrade.md|use-templates:{apply-template.md,generate.md,library.md,overview.md,programmatic.md,replace-content.md}|user-interface:{build-your-own-ui.md,customization}|user-interface/customization:{movement-constraints.md}|what-is-cesdk.md|<-- IMGLY-AGENTS-MD-END -->

Mac Catalyst

<-- IMGLY-AGENTS-MD-START -->[CE.SDK Mac Catalyst Docs Index]|root: ./guides/mac-catalyst|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.|animation:{create,edit.md,overview.md,types.md}|animation/create:{base.md,text.md}|automation:{auto-resize.md,batch-processing.md,data-merge.md,design-generation.md,multi-image-generation.md,overview.md,product-variations.md}|capabilities.md|colors:{adjust.md,apply.md,basics.md,conversion.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-139ef9.md|compatibility-fef719.md|concepts:{architecture.md,assets.md,blocks.md,buffers.md,design-units.md,edit-modes.md,editing-workflow.md,error-catalog.md,events.md,exclusion-areas.md,font-size-unit.md,import-export.md,pages.md,resources.md,scenes.md,templating.md,terminology.md,undo-and-history.md}|conversion:{overview.md,to-base64.md,to-blob.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,collage.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-prebuilt-xcframework.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,lock-design.md,overview.md,programmatic.md,timeline-editor.md,update-caption-presets.md}|edit-image:{add-watermark.md,annotation.md,replace-colors.md,transform}|edit-image/transform:{crop.md,flip.md,move.md,resize.md,rotate.md,scale.md}|edit-video:{add-captions.md,add-watermark.md,annotation.md,force-trim.md,join-and-arrange.md,programmatic.md,redaction.md,split.md,transform,trim.md}|edit-video/transform:{crop.md,flip.md,move.md,overview.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-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,mac-catalyst,mcp-server.md,overview.md}|get-started/mac-catalyst:{quickstart.md}|guides.md|import-media:{asset-library,concepts.md,content-json-schema.md,create-custom-importer.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:{thumbnails.md}|import-media/from-local-source:{local-asset.md}|import-media/from-remote-source:{asset-versioning.md,getty-images.md,imgly-premium-assets.md,pexels.md,remote-asset.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-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|prebuilt-solutions.md|rules:{enforce-brand-guidelines.md,lock-content.md,moderate-content.md,overview.md}|security.md|serve-assets.md|settings.md|shapes.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,edit-stickers.md}|text:{add.md,adjust-spacing.md,auto-size.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}|to-v1-19.md|upgrade.md|use-templates:{apply-template.md,generate.md,library.md,overview.md,programmatic.md,replace-content.md}|user-interface:{build-your-own-ui.md,customization}|user-interface/customization:{movement-constraints.md}|what-is-cesdk.md|<-- IMGLY-AGENTS-MD-END -->

API Index

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

IMGLYCamera:{Camera,CameraConfiguration,CameraError,CameraLayoutMode,CameraMode,CameraResult,Capture,CaptureCount,CaptureType,IMGLYEngine,Photo,Recording,Swift}|platforms:{ios} IMGLYCore:{EngineSettings,Foundation,IMGLY,IMGLYCompatible,PhotoRollAssetSource,PhotoRollAssetSourceMode,PhotoRollMediaType,TextAssetSource[deprecated]}|platforms:{ios} IMGLYCoreUI:{AssetLibrary,AssetLibraryBuilder,AssetLibraryCategory,AssetLibraryContent,AssetLibraryGroup,AssetLibraryModifierError,AssetLibraryMoreTab,AssetLibrarySection,AssetLibrarySource,AssetLibraryTab,AssetLibraryTabView,AssetLibraryView,AssetLoader,AssetPreview,AudioGrid,AudioList,AudioPreview,AudioUploadButton,AudioUploadGrid,CategoryModifier,DefaultAssetLibrary[deprecated],ImageGrid,IMGLYCore,IMGLYEngine,MediaType,Message,nonNil(_:file:function:line:),PhotoRollAccessory,PhotoRollDestination,PhotoRollPreview,SectionModifier,ShapeGrid,StickerGrid,SwiftUICore,TextComponentGrid,TextGrid,TextList,TextPresetsGrid,TextPreview,UploadButton,UploadGrid}|platforms:{ios} IMGLYEditor:{AdaptiveIconOnlyLabelStyle,ArrayBuilder,ArrayModifier,AssetLibraryButtonStyle,AssetLibraryConfiguration,BackgroundColorIcon,BottomPanel,CanvasMenu,CanvasMenuLabelStyle,CategoryModifications,DefaultTimelineComponent[deprecated],Dock,Editor,EditorComponent,EditorComponentID,EditorComponents,EditorConfiguration,EditorContext,EditorError,EditorEvent,EditorEventHandler,EditorEvents,EditorState,EditorViewMode,ExportProgress,FillStrokeIcon,ForceCropMode,ForceCropPreset,IMGLYCore,InspectorBar,NamedColor,NavigationBar,NavigationLabel,None,OnChanged,OnClose,OnCreate,OnError,OnExport,OnLoaded,OnUpload,SheetStyle,SheetType,SheetTypes,SwiftUI,Timeline,transitionIncomingClip(engine:outgoing:)}|platforms:{ios} IMGLYEngine:{AnimationEasing,AnimationType,Asset,AssetAPI,AssetColor,AssetContext,AssetCredits,AssetDefinition,AssetFacetPath,AssetFacetValue,AssetFilter,AssetLicense,AssetPayload,AssetPlacement,AssetProperty,AssetQueryData,AssetQueryResult,AssetResult,AssetSource,AssetSpotColorRepresentation,AssetTransformPreset,AssetUTM,AudioExport,AudioExportOptions,AudioFromVideoOptions,AudioThumbnail,AudioTrackInfo,BlendMode,Blob,BlockAPI,BlockEvent,BlockEventType,BlockState,BlockStateError,BlurType,BooleanOperation,Canvas,char8_t,CharacterInkBox,CMYK,CMYKProfileInfo,Color,ColorRenderingIntent,ColorSpace,CompressionFormat,CompressionLevel,CompressionOptions,ContentFillMode,CursorType,CutoutOperation,CutoutType,DesignBlockID,DesignBlockType,DesignUnit,DominantColor,DominantColorsOptions,EditMode,EditorAPI,EffectType,Engine,EngineError,EngineErrorCode,EngineErrorDomain,EventAPI,ExportOptions,FetchAssetOptions,FillRule,FillType,Font,FontMetrics,FontStyle,FontUnit,FontWeight,GlobalScope,GradientColorStop,GradientType,Groups,H264Profile,HandleVisibility,History,HistoryUpdate,HorizontalBlockAlignment,HorizontalContentFillAlignment,HorizontalTextAlignment,LicenseError,ListStyle,Locale,MIMEType,MovementConstraintRule,MovementConstraintScope,ObjectType,PositionMode,PropertyType,ResolvedMovementConstraint,RGBA,SaveToArchiveOptions,SaveToStringOptions,SceneAPI,SceneLayout,SceneMode,SelectionBox,ShapeType,SizeMode,SortingOrder,SortKey,Source,SplitOptions,StrokeCap,StrokeCornerGeometry,StrokePosition,StrokeStyle,Subscription,TextCase,TextDecorationConfig,TextDecorationLine,TextDecorationStyle,TextRunInfo,TransitionType,Typeface,UBQ,VariableAPI,VerticalBlockAlignment,VerticalContentFillAlignment,VideoBitrate,VideoExport,VideoExportOptions,VideoThumbnail,ZoomAutoFitAxis}|platforms:{ios,macos,mac-catalyst} <-- IMGLY-TYPES-MD-END -->

Related Skills

Use the sibling build skill to implement or scaffold Swift code.
Use the sibling explain skill for a conceptual walkthrough.