Configuration

import android.util.Log
import androidx.compose.runtime.Composable
import androidx.core.net.toUri
import ly.img.editor.Editor
import ly.img.editor.EditorUiMode
import ly.img.editor.core.configuration.EditorConfiguration
import ly.img.editor.core.configuration.remember
import ly.img.editor.core.engine.EngineRenderTarget

// Call this composable from your app's navigation layer.
@Composable
fun BasicEditorSolution(
    license: String,
    signedInUserId: String?,
    onClose: (Throwable?) -> Unit,
) {
    Editor(
        license = license,
        userId = signedInUserId,
        baseUri = "file:///android_asset/assets/".toUri(),
        engineRenderTarget = EngineRenderTarget.SURFACE_VIEW,
        uiMode = EditorUiMode.SYSTEM,
        configuration = {
            EditorConfiguration.remember {
                onLoaded = {
                    val editor = editorContext.engine.editor
                    editor.setRole("Creator")
                    Log.i("ConfigurationGuide", "Current role: ${editor.getRole()}")

                    editor.setSettingBoolean(
                        keypath = "doubleClickToCropEnabled",
                        value = false,
                    )
                    val doubleClickToCropEnabled = editor.getSettingBoolean(
                        keypath = "doubleClickToCropEnabled",
                    )
                    Log.i(
                        "ConfigurationGuide",
                        "Double-click crop enabled: $doubleClickToCropEnabled",
                    )
                }
            }
        },
        onClose = onClose,
    )
}

The Android Editor composable owns Engine startup for the CE.SDK editor UI. Pass startup values directly to Editor, then use EditorConfiguration for callbacks, component customization, and runtime Engine settings through the existing editorContext.engine.

Required Configuration#

License Key#

Production apps should pass a CE.SDK license key. Passing null or an empty value starts evaluation mode, which keeps export watermarks active.

Get a free trial license at https://img.ly/forms/free-trial.

license = license,

Optional Configuration#

These Editor parameters configure startup values, editor lifecycle hooks, and close handling. Values such as userId, baseUri, host, engineRenderTarget, and uiMode apply when the editor starts, while configuration and onClose cover callbacks and behavior throughout the editor lifecycle.

Android routes editor and engine messages through Logcat. There is no initialization-time custom logger configuration option.

Configuration Properties#

User ID#

Set userId when your app has signed-in users. Pass the current user’s stable application ID instead of a shared hard-coded value, or omit it for anonymous sessions. CE.SDK also uses the Android device ID for tracking accuracy, so include that collection in your Play Store Data safety form.

userId = signedInUserId,

Asset Base URI#

baseUri is the base path for relative editor and Engine asset paths. If omitted, Editor uses the top-level defaultBaseUri from ly.img.editor, a versioned IMG.LY CDN URL defined by the Android SDK. For production apps, bundle the CE.SDK Android assets with your app or host them yourself, then point baseUri at that location instead of relying on the IMG.LY CDN.

For the local URI shown below, download the versioned CE.SDK Android asset bundle from the IMG.LY CDN and extract it. The archive contains a top-level assets/ directory; copy that directory into your app module’s src/main/assets/ folder so file:///android_asset/assets/ points directly at the asset files. If you host the same asset folder, pass its HTTPS base URL as baseUri instead; the Serve Assets From Your Server guide covers that setup.

baseUri = "file:///android_asset/assets/".toUri(),

Rendering and UI Mode#

Use engineRenderTarget to choose the underlying Android render view:

• EngineRenderTarget.SURFACE_VIEW renders through SurfaceView.
• EngineRenderTarget.TEXTURE_VIEW renders through TextureView.

Use uiMode for the editor color scheme:

• EditorUiMode.SYSTEM follows the operating system setting.
• EditorUiMode.LIGHT displays the editor in light mode.
• EditorUiMode.DARK displays the editor in dark mode.

Advanced theme customization belongs in the Theming guide.

engineRenderTarget = EngineRenderTarget.SURFACE_VIEW,
uiMode = EditorUiMode.SYSTEM,

Runtime Configuration#

Use EditorConfiguration.remember for callbacks that run inside the editor lifecycle. The default editor creation flow creates the initial scene for you, so this guide keeps that default and uses onLoaded to apply the role and settings after the editor is ready. If you override onCreate, create or load a scene before the callback completes.

Use EditorConfiguration.remember and then to chain additional configuration blocks and IMG.LY plugins onto an existing editor configuration.

configuration = {
    EditorConfiguration.remember {
        onLoaded = {
            val editor = editorContext.engine.editor
            editor.setRole("Creator")
            Log.i("ConfigurationGuide", "Current role: ${editor.getRole()}")

            editor.setSettingBoolean(
                keypath = "doubleClickToCropEnabled",
                value = false,
            )
            val doubleClickToCropEnabled = editor.getSettingBoolean(
                keypath = "doubleClickToCropEnabled",
            )
            Log.i(
                "ConfigurationGuide",
                "Double-click crop enabled: $doubleClickToCropEnabled",
            )
        }
    }
},

setRole() changes the active editing role and applies role-dependent defaults. The CE.SDK editor UI applies Adopter before onLoaded; the sample sets Creator so the callback demonstrates a role change in the editor flow. Supported roles are Creator, Adopter, Viewer, and Presenter. On Android, read and write the role with setRole() and getRole() rather than a settings keypath.

Settings such as doubleClickToCropEnabled are available through the typed setting methods on engine.editor. The sample disables double-click crop so the readback logs a non-default value. Use the Boolean, Int, Float, String, Color, and Enum setter/getter pairs for known settings, and use findAllSettings() or getSettingType() when you need to inspect available settings dynamically.

Troubleshooting#

API Reference#

Next Steps#

• Theming - Customize the editor’s visual appearance
• Localization - Configure languages and translations
• Asset Library - Configure asset sources and libraries
• Editing Workflow - Control editing capabilities with roles and scopes
• Headless Mode - Use CE.SDK without the UI