Skip to content

Configuration

In this example, we will show you how to make basic configurations for the mobile editor. The example is based on the Design Editor, however, it is exactly the same for all the other solutions.

Configuration

All the basic configuration settings are part of the EngineConfiguration.

  • license - the license to activate the Engine with.
license = "<your license here>",
  • userId - an optional unique ID tied to your application’s user. This helps us accurately calculate monthly active users (MAU). Especially useful when one person uses the app on multiple devices with a sign-in feature, ensuring they’re counted once. Providing this aids in better data accuracy. The default value is null.
userId = "<your unique user id>",
  • baseUri - is used to initialize the engine’s basePath setting before the editor’s onCreate callback is run. It is the foundational URI for constructing absolute paths from relative ones. For example, setting it to the Android assets directory allows loading resources directly from there: file:///android_asset/. This URI enables the loading of specific scenes or assets using their relative paths. The default value is pointing at the versioned IMG.LY CDN but it should be changed in production environments.
baseUri = Uri.parse("file:///android_asset/"),
  • sceneUri - the scene URI to load content within the editor. Note that this configuration is only available in EngineConfiguration.rememberFor{solution-name} helper functions. This URI is used to load the scene in EdiorConfiguration.onCreate, therefore, you can configure the scene you load without helper functions too: simply invoke EditorDefaults.onCreate(engine, sceneUri, eventHandler) in EdiorConfiguration.onCreate. By default, helper functions load the scenes that are available at EdiorConfiguration.default{solution-name}Scene. Normally, you should not modify the sceneUri, however, you may want to save/restore the editing progress for your customers. If that is the case, you should save the scene in one of the callbacks, then provide the URI of the newly saved scene when your customer opens the editor next time.
sceneUri = EngineConfiguration.defaultDesignSceneUri,
  • renderTarget - the target which should be used by the Engine to render. The engine is able to render on both SurfaceView and TextureView. The default value is EngineRenderTarget.SURFACE_VIEW.
renderTarget = EngineRenderTarget.SURFACE_VIEW,

Full Code

Here’s the full code:

import android.net.Uri
import androidx.compose.runtime.Composable
import androidx.navigation.NavHostController
import ly.img.editor.DesignEditor
import ly.img.editor.EngineConfiguration
import ly.img.editor.core.engine.EngineRenderTarget
import ly.img.editor.rememberForDesign


// Add this composable to your NavHost
@Composable
fun BasicEditorSolution(navController: NavHostController) {
    val engineConfiguration = EngineConfiguration.rememberForDesign(
        license = "<your license here>",
        userId = "<your unique user id>",
        baseUri = Uri.parse("file:///android_asset/"),
        sceneUri = EngineConfiguration.defaultDesignSceneUri,
        renderTarget = EngineRenderTarget.SURFACE_VIEW,
    )
    DesignEditor(engineConfiguration = engineConfiguration) {
        // You can set result here
        navController.popBackStack()
    }
}