Existing Project Setup

plugins {
    id 'com.android.application'
    id 'kotlin-android'
}

android {
    namespace "ly.img.editor.showcase"
    compileSdk 35

    defaultConfig {
        applicationId "ly.img.editor.showcase"
        minSdk 24
        targetSdk 35
        versionCode 1
        versionName "1.0"
        ndk {
            abiFilters "arm64-v8a", "armeabi-v7a", "x86_64", "x86"
        }
    }

    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }

    kotlinOptions {
        jvmTarget = '1.8'
    }
}

dependencies {
    implementation "ly.img:engine:1.51.0"
    implementation "androidx.appcompat:appcompat:1.6.0"
    implementation "org.jetbrains.kotlinx:kotlinx-coroutines-core:1.6.4"
}

Introduction

This guide will walk you through setting up CE.SDK editor in your existing Android app. By the end, you will have a powerful editor running in your app, capable of editing photos and videos.

CE.SDK editor running on an Android device

Pre-requisites

Existing Android project
Android Studio installed on your machine
CE.SDK license key. Get one here

Minimum Requirements

Android: 7.0 (Android SDK 24)
Kotlin 1.9.10
Jetpack Compose BOM version 2023.05.01 (1.4.3)
Supported ABIs: arm64-v8a, armeabi-v7a, x86_64 and x86

Add Dependencies & Setup

In your existing project, let’s add the required dependencies for the CE.SDK editor.

Add the IMG.LY repository to your settings.gradle:

dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        google()
        mavenCentral()
        maven {
            name "IMG.LY Artifactory"
            url "https://artifactory.img.ly/artifactory/maven"
            mavenContent {
                includeGroup("ly.img")
            }
        }
    }
}

Add the CE.SDK dependency to your app’s build.gradle.

implementation "ly.img:engine:1.51.0"

If not yet present, add Jetpack Compose libraries as well to your app’s build.gradle.

dependencies {
    implementation(platform('androidx.compose:compose-bom:2025.04.01'))
    implementation 'androidx.activity:activity-compose'

}

Also, make sure Compose features are enabled in your project in your app’s build.gradle file. If you are running kotlin version less than 2.0.0, also add the compose compiler version.

android {
  buildFeatures {
      compose true
  }

  // Only add this if you have Kotlin version lower than 2.0.0
  composeOptions {
      kotlinCompilerExtensionVersion = "1.5.15"
  }
  // ---------
}

Implementation

With the dependencies successfully added to the project and Jetpack Compose fully set up, you can now add the Editor to your app. Here, we will add the DesignEditor, but the process is similar for the other editors.

Create a new file where you will add a new Composable called EditorComposable.

import androidx.compose.runtime.Composable
import ly.img.editor.DesignEditor
import ly.img.editor.EngineConfiguration
import ly.img.editor.rememberForDesign

@Composable
fun EditorComposable() {
    val engineConfiguration = EngineConfiguration.rememberForDesign(
        license = "<your license here>",
        userId = "<your unique user id>",
    )

    DesignEditor(
        engineConfiguration = engineConfiguration,
        onClose = {
            // Close the editor here
            // If using a navigation library, call pop() here
        }
    )
}

Inside your new EditorComposable, you need to create engineConfiguration, that will then be passed into the DesignEditor. Within onClose, you can handle closing the editor appropriately.

You can now open the EditorComposable from any Compose function, or wrap inside setContent { } in any Activity or Fragment.

Common Errors

Here are some common errors you may encounter through this guide, and how to solve them.

Incompatible compose compiler

e: This version of the Compose Compiler requires Kotlin version x.x.xx but you appear to be using Kotlin version y.y.yy which is not known to be compatible.  Please fix your configuration (or `suppressKotlinVersionCompatibilityCheck` but don't say I didn't warn you!).

Solution -> Ensure you have the proper compose compiler version for your project. Check official mappings here

Dependency not found

> Could not resolve all files for configuration ':app:debugRuntimeClasspath'.
   > Could not find ly.img:editor:1.48.0.

Solution -> Make sure maven url is set up correctly in settings.gradle

Invalid License


Solution -> Check whether you have supplied a valid license

No Internet

No internet dialog

Solution -> Check your internet connection