Changelog

Breaking Changes

• Engine/Swift: Updated the default value of Engine.assetBaseURL for Engine.addDefaultAssetSources to https://cdn.img.ly/assets/v4.
• Editor/iOS: Updated DefaultAssetLibrary.shapes and DefaultAssetLibrary.stickers with new sections from v4 assets.
• Engine/Android: Updated the default value of baseUri in Engine.addDefaultAssetSources to https://cdn.img.ly/assets/v4.
• Editor/Android: Updated LibraryContent.Shapes and LibraryContent.Stickers with new sections from v4 assets.

Non Breaking Changes

• Editor/iOS: Allow Kingfisher 7 and 8 dependency.
• Engine: From now on addAssetToSource does not allow adding multiple assets with the same ID in case of local asset sources.
• Engine/Android: Improved memory usage when saving scene to archive.
• Engine/Swift: Improved memory usage when saving scene to archive.
• Editor/Web: Fix caption dock button visible after disabling caption feature via feature API
• Engine/Swift: Fixed invalid blend mode values and added new blend modes (linearBurn, darkenColor, linearDodge, lightenColor, vividLight, linearLight, pinLight, hardMix, subtract, divide).
• Camera/iOS: Close the camera if there is an issue loading the reaction video.
• Engine: Fixed that min and max automatic font size were not scaled the same way as the font size. Could lead to auto-sized text being too small or too large after a change in design unit or DPI, e.g., during applyTemplateFromString if the current scene has a different design unit or DPI setting.
• Engine: Add asset.addFromJSONString endpoint to streamline asset source creation.
• Editor/Web: Introduced a new builder.Component component that allows rendering custom components that were registered using the cesdk.ui.registerComponent.
• Editor/Web: Order UI APIs now support nested orders, allowing for the customization of nested components within the order. This pattern is currently only supported by ly.img.actions.navigationBar component with other components to follow soon.
• Editor/Web: Added new order manipulation APIs for all UI areas:
  • Dock: updateDockOrderComponent, removeDockOrderComponent, insertDockOrderComponent
  • Inspector Bar: updateInspectorBarOrderComponent, removeInspectorBarOrderComponent, insertInspectorBarOrderComponent
  • Canvas Menu: updateCanvasMenuOrderComponent, removeCanvasMenuOrderComponent, insertCanvasMenuOrderComponent
  • Navigation Bar: updateNavigationBarOrderComponent, removeNavigationBarOrderComponent, insertNavigationBarOrderComponent
  • Canvas Bar: updateCanvasBarOrderComponent, removeCanvasBarOrderComponent, insertCanvasBarOrderComponent

Breaking Changes

• Editor/Web: Updated the ly.img.vectorpath asset library with new shapes. Those can be accessed by calling cesdk.addDefaultAssetSources().
• Engine: Added fetchAsset method to the AssetSource interface, allowing fetching of specific assets by ID. This is a breaking change for custom asset source implementations, which must now implement or handle the new fetchAsset method.
• Engine: Added findAssetSourceAssets to the UBQ interface, allowing fetching of specific assets by ID.
• Engine/Android: added fetchAsset method to the AssetAPI interface. AssetSource now includes an optional fetchAsset method.
• Engine/Swift: added fetchAsset method to the AssetAPI interface. AssetSource protocol now includes an optional fetchAsset method. The getAsset method is removed.
• Engine/Web: added fetchAsset method to the AssetAPI interface. AssetSource protocol now includes an optional fetchAsset method.
• Editor/Android: Changed localization keys to a common structure prefixed with ly_img_editor_ for easy customizations and added German translations.
• Camera/Android: Changed localization keys to a common structure prefixed with ly_img_camera_ for easy customizations and added German translations.
• Editor/iOS: Changed AssetLibrarySource, AssetLibraryGroup, AssetLibraryTab, AssetLibraryTabView, NavigationLabel, SheetType.libraryAdd, and .libraryReplace initializers to accept a LocalizedStringResource as title instead of a String.
• Editor/iOS: Changed localization keys to a common structure prefixed with ly_img_editor_ for easy customizations and added German translations.
• Camera/iOS: Changed localization keys to a common structure prefixed with ly_img_camera_ for easy customizations and added German translations.
• Editor/Web: Introduce a new set of sticker assets that can be added by calling addDefaultAssetSources
• Editor/Web: Moved the default assets path from https://cdn.img.ly/assets/v3 to https://cdn.img.ly/assets/v4
• Editor/Swift: Packages for Apple platforms are now built with Xcode 16.4, which is the new minimum requirement for using them.
• Engine/Swift: Packages for Apple platforms are now built with Xcode 16.4, which is the new minimum requirement for using them.

Non Breaking Changes

• Editor/Web: Introduced a new scale slider for captions, allowing users to adjust the size of the captions directly from the preset panel.
• Editor/Web: Add feature API ids for crop related inputs
• Editor/Android: Added new onLoaded callback to EngineConfiguration that is invoked when the editor is loaded and ready to be used. It is best to register callbacks, collect flows returned by the engine and apply editor settings in this callback.
• Editor/Web: Adding force crop feature via applyForceCrop API
• Editor/iOS: Added configurable onClose and onError callbacks.
• Editor/iOS: Added a default confirmation alert when closing the editor.
• Editor/React Native: Fixed unexpected behavior when opening camera inside the editor that caused the editor to close.
• Editor/Flutter: Fixed unexpected behavior when opening camera inside the editor that caused the editor to close.
• Editor/Web: Adjustments, effects, filters and blurs are now only enabled for images and videos by default. This can be easily changed by using the cesdk.feature.enable API.
• Editor: When selecting a child with all arrangement scopes disabled, the group’s rotation and resize gizmos now appear instead — allowing to move, resize, and rotate the group directly (provided the group itself has the necessary arrangement scopes).
• Editor/Web: The canvas menu will now be hidden by default during playback. If you wish to show it, you can use the feature predicate ly.img.canvasMenu to control its visibility.
• Engine: Fixed potential crash during export if the device runs out of memory.
• Editor/Web: Fixed an issue where the AnimationSubInspector was not positioned correctly.
• Engine: Removed crop component from blocks when switching to a non-croppable fill.
• Editor/Web: Fixed an issue where certain panels did not respond correctly to API calls.
• Editor/RN: Fixed compatibility issues with RN 0.77.0+/Expo 53+ during compilation due to signature mismatch.
• Engine/Android: Fixed not released GPU memory on repeated export, which could result in the device running out of memory.
• Editor/iOS: Fixed incorrect scope check when determining if a block can be moved. Previously, the “editor/add” scope was checked instead of the correct “layer/move” scope when evaluating whether a block can be moved forward or backward.
• Editor/Android: Fixed incorrect scope check when determining if a block can be moved. Previously, the “editor/add” scope was checked instead of the correct “layer/move” scope when evaluating whether a block can be moved forward or backward.
• Engine: Enable all scopes for the current user role when loading blocks from serialized resources in defaultApplyAsset.
• Engine/iOS: Fixed crashes during text editing.
• Engine: fixed an issue where toggling mute while in “Playback” mode would set the edit mode to “Transform”.

Breaking Changes

Non Breaking Changes

• Engine/iOS: Fixed crashes during text editing.

Breaking Changes

Non Breaking Changes

• Engine/Android: Fix native crash due to incorrect Proguard configuration.

Breaking Changes

• Engine/Android: Fixed DesignUnit raw values are not aligned with the C++ enum, resulting in incorrect mapping for engine.scene.getDesignUnit() and engine.scene.setDesignUnit().

Non Breaking Changes

• Engine: Added ten new blend modes: Linear Burn, Linear Dodge, Lighten Color, Darken Color, Vivid Light, Linear Light, Pin Light, Hard Mix, Subtract and Divide.
• Editor/Web: Updated FeatureAPI.enable() to automatically use default guards when no predicate is provided.
• Editor/Web: Introduce a new ly.img.dock feature key to allow controlling the dock.
• Editor/Web: Introduce a new ly.img.inspectorBar feature key to allow controlling the inspector bar.
• Editor/Web: Introduce a new ly.img.videoTimeline feature key to allow controlling the video timeline.
• Editor/Web: Introduce a new ly.img.navigationBar feature key to allow controlling the navigation bar.
• Editor/Web: Introduce a new ly.img.navigate.undoRedo feature key to allow controlling the navigation bar undo and redo.
• Editor/Web: Introduce a new ly.img.navigate.zoom feature key to allow controlling the navigation bar zoom.
• Editor/Web: Introduce a new ly.img.navigate.actions feature key to allow controlling the navigation bar actions.
• Editor: Added improved loading animations
• Engine: Added new editor APIs to enable/disable and check the state of a block’s highlight: setHighlightingEnabled and hasHighlightingEnabled
• Editor/iOS: Fixed incorrect icon order for content fill mode in the crop sheet.
• Engine: Fixed legacy handling in the loadFromString API which could cause a legacy scene to be corrupted, e.g., vector paths getting deleted. Only occurs if a legacy scene is a loaded while loadFromString is called.
• Engine: Trim length and trim offset now have the expected behavior when using GIFs.
• Engine: Fixed crash when using compositing keyboards.
• Editor/Web: Improved the video playback performance.
• Engine: Improved the video playback performance.
• Editor/Web: Adding documentation on how to update and manage video caption presets
• Engine: Added video captions support, see documentation. Introduced two new block types: caption and captionTrack. Introduced a new API for creating captions from a file: createCaptionsFromURI.
• Editor/Web: Added support for video captions in the editor, enabling the creation and management of captions for video projects. This feature includes functionalities for manually adding, editing, and removing captions, as well as importing captions from SRT and VTT files. Additionally, it supports managing various caption style assets.
• Editor/Android: Added predefined crop presets to the crop sheet.
• Editor/Android: Introduced multiple SheetType.Crop.Mode options that enable a combined crop and page resize sheet, supporting both manual adjustments and predefined size presets. Custom modes are configurable to define custom behavior.
• Editor/Web: Fix editor crash when OPFS is not available in certain browser environments e.g. Firefox private mode.
• Engine: Fixed that events on edit state changes were not being delivered if and only if they were issued within an event callback, e.g., by setting the playing state to false within a callback from another event.
• Engine/Swift: Fixed crash when closing the editor while a text block is being edited.
• Editor/iOS: Fixed zoom insets being wrong in the crop and resize sheet when resizing the page.
• Engine/Swift: Fixed tone-mapping for certain HDR videos.
• Editor/Web: Introduce a new ly.img.canvasBar feature key to allow controlling the canvas bar.
• Editor/Web: Introduce a new ly.img.canvasMenu feature key to allow controlling the canvas menu.
• Editor/Web: Introduce a new ly.img.inspector feature key to allow controlling the advanced inspector.
• Engine: Add background gradient for text blocks when the block is in pending state.
• Engine: Fix issue where the loading indicator overlay wasn’t clipped to the outline of the block in case of rounded corners.
• Engine: Allow thumbnail generation during playback to fix issue with voiceover graph not displaying.
• Engine: Added automatic switching to transform mode when users modify components during video playback to improve UI reactivity.

Breaking Changes

Non Breaking Changes

• Editor/iOS: Fixed zoom insets being wrong in the crop and resize sheet when resizing the page.
• Engine/Swift: Fixed crash when closing the editor while a text block is being edited.

Breaking Changes

• Editor/Web: Removed the “more” options menu from the inspector bar.
• Editor/Web: Removed the ly.img.options feature key that was used to enable the “more” options menu in the inspector bar.
• Engine/Swift: Fixed DesignUnit raw values not being aligned with the C++ enum.
• Engine/Swift: Updated default asset sources configuration to include new crop and size preset sources. The sources ly.img.crop.presets and ly.img.page.presets are now part of the default assets served through the CDN. You must update your CDN configuration to include these new sources.

Non Breaking Changes

• Engine: Added new getTextVisibleLineContent API to retrieve the text content of the visible lines in text blocks.
• Editor/Android: Added “Select Group” button in canvas menu for design blocks that are in a group design block.
• Engine: Skia is now used to parse SVG data instead of NanoSVG
• Editor/Web: Introduced new feature keys to configure the transform controls via the feature API.
• Editor/Web: Introduced the following UX improvements:
  • Centered the controls in the inspector bar.
  • Moved the stroke settings into a dropdown in the inspector bar.
  • Introduced the text style dropdown in the inspector bar.
  • Introduced the advanced text controls in the inspector bar.
  • Introduced a new dropdown in the canvas bar that contains the following actions:
    • Copy
    • Paste
    • Flip Horizontally
    • Flip Vertically
  • Moved the inspector toggle into the top level inspector.
• Camera/Android: Fixed an issue where the permission request flow could break under certain conditions when the same permission was being requested elsewhere in the app.
• Engine: The dashed outline of groups are now independent of zoom level.
• Engine/Web: Deprecated the old export API signatures in favor of a new improved signatures to follow better API design practices. The following changes were made:
  • Simplified the exportVideo, export and exportWithColorMask APIs by making all parameters optional except for the page handle
  • Moved all optional parameters (including mimeType) into a single options object, which removes the requirement to pass undefined or empty objects for unused parameters
  • Removed enum usage for mime types in favor of string literals to align with the rest of our type definitions
  • These changes make the APIs more intuitive and easier to use, especially when only specific options need to be configured

  // Before
  engine.block.export(page, MimeType.Jpeg, {
    jpegQuality: 0.8,
    targetWidth: 1080,
    targetHeight: 1080
  });
  engine.block.export(page, undefined, {
    targetWidth: 1080,
    targetHeight: 1080
  });
  
  // After
  engine.block.export(page, {
    mimeType: 'image/jpeg',
    jpegQuality: 0.8,
    targetWidth: 1080,
    targetHeight: 1080
  });
  engine.block.export(page, {
    targetWidth: 1080,
    targetHeight: 1080
  });
  
  // Before
  engine.block.exportWithColorMask(page, MimeType.Png, 0.5, 0, 0, {
    pngCompressionLevel: 6
  });
  engine.block.exportWithColorMask(page, undefined, 0.5, 0, 0);
  
  // After
  engine.block.exportWithColorMask(page, 0.5, 0, 0, {
    mimeType: 'image/png',
    pngCompressionLevel: 6
  });
  engine.block.exportWithColorMask(page, 0.5, 0, 0);
  
  // Before
  engine.block.exportVideo(
    page,
    MimeType.Mp4,
    (
      numberOfRenderedFrames,
      numberOfEncodedFrames,
      totalNumberOfFrames: number
    ) => {
      console.log(
        `Rendered ${numberOfRenderedFrames} frames, encoded ${numberOfEncodedFrames} frames out of ${totalNumberOfFrames}`
      );
    },
    {
      targetWidth: 1080,
      targetHeight: 1080
    }
  );
  engine.block.exportVideo(page, undefined, undefined, {
    targetWidth: 1080,
    targetHeight: 1080
  });
  
  // After
  engine.block.exportVideo(page, {
    mimeType: 'video/mp4',
    onProgress: (
      numberOfRenderedFrames,
      numberOfEncodedFrames,
      totalNumberOfFrames: number
    ) => {
      console.log(
        `Rendered ${numberOfRenderedFrames} frames, encoded ${numberOfEncodedFrames} frames out of ${totalNumberOfFrames}`
      );
    },
    targetWidth: 1080,
    targetHeight: 1080
  });
  engine.block.exportVideo(page, {
    targetWidth: 1080,
    targetHeight: 1080
  });

• Engine/iOS: Fixed export not continuing after app was returned from the background.
• Engine: Use magic bytes primarily for determining the MIME type of a file during import.
• Editor/iOS: Added a new dock button to open the page resize sheet, supporting both manual adjustments and predefined size presets.
• Editor/iOS: Added predefined crop presets to the crop sheet.
• Editor/iOS: Changed default of SheetType.crop.style to SheetStyle/only(detent:).
• Editor/iOS: Fixed OS system photo camera permission handling to prevent black screen.
• Editor/iOS: Fixed sheet dismissal behavior to ensure the sheet closes correctly when the event is triggered.

Breaking Changes

Non Breaking Changes

• Editor/Web: Added new pagePresetLibraries configuration that enables defining asset sources with transform presets. In addition,pagePresetLibraries configuration replaces pageFormats. Finally, format selection is now shown in its own panel instead of the document inspector.
• Editor/Web: Added new cropPresetLibraries configuration that enables defining asset sources with transform presets. These presets will be shown inside the crop panel.
• Engine: The duplicate API now has an additional parameter that allows choosing if the new block will be attached to the same parent as the original (defaults to true).
• Editor/iOS: Added new SwiftUI view modifiers: .imgly.canvasMenuItems and .imgly.modifyCanvasMenuItems, which allow customization of the canvas menu (a list of buttons that appears next to the selected design block).
• Editor/iOS: Added and updated custom SF Symbols in the iOS editor.
• Engine: new transform presets assets can be applied to graphics blocks and pages with defaultApplyAssetToBlock. These presets can set dimensions, enforce an aspect ratio or allow free resizing.
• Engine/Android: Fixed AssetSource references not being released when the engine is stopped. This allows AssetSource instances to be garbage collected.
• Engine: Fixed a potential crash in unstable_enableCameraZoomClamping if the setting pageCarouselEnabled is used.
• Engine: Remove PageDurationSourceTag from page when using the createSceneFromVideo API. This fixes the issue of the timeline duration not updating correctly.
• Editor/Android: Fixed the default value of demo asset sources baseUri.
• Editor/iOS: Added spacing between dock and inspector bar items.
• Editor/iOS: Configured dock and inspector bar items to have dynamic width, enforcing a minimum width.
• Engine/iOS: Render cursor while text field is not tapped.
• Editor/RN: Fix Compose Compiler plugin not getting applied correctly for Kotlin 2.0.0+.
• Engine: Enable setWidth and setHeight on groups. Setting a dimension on a group will modify the other dimension as well according to the aspect ratio of the group.
• Editor/Web: Fixed an issue where toggling fonts bold was buggy. You had to click the bold button twice to turn a font family bold after selecting a new font family.
• Engine: The property image/fill/imageFileURI is now undeprecated.
• Engine: Improved HDR color information detection on HEVC videos.
• Editor/Web: For registered components, pass payload from order to all components not just Dock & NavigationBar
• Editor/Web: Render the text content of a text clip instead of the thumbnail.
• Engine/Swift: Fix issue when the audio did not stop when the app went to the background.
• Editor/iOS: Fixed potential memory leaks after closing a sheet, e.g., when dismissing the asset library.
• Editor/Android: Fixed an issue where internal debug dependencies were unintentionally included in release artifacts.
• Editor/Web: Updated video timeline thumbnail display.
• Editor/Web: Fix an issue where the onUnsupportedBrowser callback was not being triggered when the video editor is opened in an unsupported browser.
• Editor/Web: Introduce a new ly.img.page.resize feature key to allow controlling the page resize feature in the editor.
• Engine: Fixed an issue with the setTypeface block API where italic and bold toggling would only work in the second try after switching the typeface. Occurred when switching from a typeface with active bold or italic to one that does not support it and then back.
• Editor/Android: Added translation keys for known subfamilies from ly.img.typeface.

Breaking Changes

Non Breaking Changes

• Editor/Android: Fixed an issue where the crop reset button remained disabled even when it should have been enabled.
• Engine/Web: Fixed that asset labels were not passed to a custom addAsset function in custom asset sources.
• Engine: supportsBlendMode returns false for the following block types: Stack, Audio, Metrics, Track, CaptionTrack
• Editor/RN: Added proper handling for export errors on Android.
• Editor/Flutter: Added proper handling for export errors on Android.
• Editor/iOS: Fixed attribution sheet presentation looping when opening the bottom most images.
• Engine: Changed the block.setTextColor API to also update the fill color if the color is changed on the whole text and not only the text run. This prevents the fill color from being different than expected.
• Engine: Changed the block.setTextFontSize API to also update the font size property if the font size is changed on the whole text and not only the text run. This prevents the font size property from being different than expected.
• Editor/Android: For scenes without a stack, the toggle pages button is no longer visible by default in the DesignEditor.
• Editor/Web: Fixed an issue where the upload button on the panel would get squished when an image with small height is uploaded and the size gets very longer when a bigger image is uploaded.
• Editor/Web: Export the types FeaturePredicate and FeaturePredicateContext used by the Feature API
• Editor/iOS: For scenes without a stack, the toggle pages button is no longer visible by default in the design editor.
• Editor/Web: Fix an issue where the background color inspector is not visible in some cases.

Breaking Changes

• Editor/iOS: Added new SwiftUI view modifiers: .imgly.navigationBarItems and .imgly.modifyNavigationBarItems, which allow customization of the navigation bar (a list of items shown at the top of the editor). With this change, the button used to dismiss the editor should now always be managed through these new APIs, rather than being injected externally via a regular .toolbar modifier. The BackButtonHiddenKey preference key, previously used to control the visibility of the back button, has been marked as unavailable in favor of the new NavigationBar.Buttons.closeEditor button.
• Editor: Add new ‘Font Combinations’ asset source to our demo assets. It’s enabled by default in our static design editors. To disable, exclude ly.img.textComponents from addDemoAssetSources. Font combinations make use of groups and have limited editing experiences in our video-based editors for now and are therefore disabled there by default. When using these combinations, be aware that the resulting blocks reference font resources in our CDN. These will be replaced with archives in a future release to further decouple resources.
• Editor/iOS: Fixed scene mode not being available in AssetLibrary by removing @Environment(\.imglyAssetLibrarySceneMode) from the public API. Use AssetLibrarySceneModeReader instead.

Non Breaking Changes

• Engine/Android: Added new asset API AssetApi.applyAssetSourceProperty that applies AssetProperty to the Asset.
• Editor/Android: Added new inspector bar button InspectorBar.Button.rememberAnimations that opens the animations sheet in the video editor.
• Editor/Android: Added support for animations in the video editor.
• Editor/Android: Added new Background option to the inspector bar that controls the background of text design blocks.
• Engine: Fixed the playback control APIs to check if the given block is valid.
• Engine: When setting the none animation, and undo set is now added.
• Camera/Android: Enable video and preview stabilization if supported.
• Editor/Web: Fix an issue where the active card background was not visible on hover.
• Engine: When saving block hierarchies to archives, all referenced resources are now added to the archive.
• Editor/Web: Fixed an issue where setting the css custom property ‘—ubq-typography-font_family’ did not work when set under ‘.ubq-public’ class
• Editor/iOS: Fixed the initial scroll position in the timeline on iOS 18.
• Editor/iOS: Fixed scrollbar behavior in the timeline on iOS 18.
• Editor/iOS: Fixed the initial scroll position in the voiceover sheet on iOS 18.
• Editor/iOS: Fix loading error in the Design Editor for scenes without a stack.
• Editor: Allow resizing and moving of elements with mouse or gestures that have a percent unit in x-position, y-position, width, or height.
• Editor/Web: Improved the naming of the animation direction values of block animations in the video editor.
• Engine: When loading individual blocks while no scene is present, design unit information will now be retained and used when saving those blocks again.
• Engine: When loading blocks, design unit conversion is now applied to the entire loaded hierarchy, not just its roots.
• Editor/Web: Fix an issue where disabling the text color feature via configuration will also affect the fill of other block types.
• Editor/Android: Resolved an issue in the Photo Editor where the inspector bar briefly remained visible and interactive after closing the crop sheet. The inspector bar now hides immediately with the crop sheet.
• Editor/iOS: Fixed text alignment options to not depend on layer/resize scope.
• Editor/iOS: Fixed an issue where scrolling the asset library inadvertently tapped an asset on iOS 18.1+.