ly.img:engine/ly.img.engine

Package-level declarations

Types

enum AnimationEasingType : Enum<AnimationEasingType>

data class Asset(val id: String, val context: AssetContext?, val label: String? = null, val locale: String? = null, val tags: List<String>? = null, val groups: List<String>? = null, val active: Boolean = false, val meta: Map<String, String>? = null, val payload: AssetPayload = AssetPayload(), val credits: AssetCredits? = null, val license: AssetLicense? = null, val utm: AssetUTM? = null)

Single asset result of a findAssets query.

AssetApi

interface AssetApi

AssetBooleanProperty

data class AssetBooleanProperty(val property: String, val value: Boolean, val defaultValue: Boolean) : AssetProperty

A class that represents a boolean asset property.

AssetColor

interface AssetColor

AssetColorProperty

data class AssetColorProperty(val property: String, val value: Color, val defaultValue: Color) : AssetProperty

A class that represents a color asset property.

AssetContext

data class AssetContext(val sourceId: String)

Context on how an asset was added and shall be used.

AssetCredits

data class AssetCredits(val name: String, val uri: Uri?)

Credits for the creator of the asset.

AssetDefinition

data class AssetDefinition(val id: String, val label: Map<String, String>? = null, val tags: Map<String, List<String>>? = null, val groups: List<String>? = null, val meta: Map<String, String>? = null, val payload: AssetPayload = AssetPayload(), val credits: AssetCredits? = null, val license: AssetLicense? = null, val utm: AssetUTM? = null)

AssetDoubleProperty

data class AssetDoubleProperty(val property: String, val value: Double, val defaultValue: Double, val min: Double, val max: Double, val step: Double) : AssetProperty

A class that represents a double asset property.

AssetEnumProperty

data class AssetEnumProperty(val property: String, val value: String, val defaultValue: String, val options: List<String>) : AssetProperty

A class that represents an enum asset property.

AssetFloatProperty

data class AssetFloatProperty(val property: String, val value: Float, val defaultValue: Float, val min: Float, val max: Float, val step: Float) : AssetProperty

A class that represents a float asset property.

AssetIntProperty

data class AssetIntProperty(val property: String, val value: Int, val defaultValue: Int, val min: Int, val max: Int, val step: Int) : AssetProperty

A class that represents an int asset property.

AssetLicense

data class AssetLicense(val name: String, val uri: Uri?)

License for the asset. Overrides the asset source license if present.

AssetPayload

data class AssetPayload(val color: AssetColor? = null, val sourceSet: List<Source>? = null, val typeface: Typeface? = null, val transformPreset: AssetTransformPreset? = null, val properties: List<AssetProperty>? = null, val stylePreset: String? = null)

Structured information about the contained asset.

AssetProperty

interface AssetProperty

A class that represents an asset property.

AssetSource

abstract class AssetSource(val sourceId: String)

AssetStringProperty

data class AssetStringProperty(val property: String, val value: String, val defaultValue: String) : AssetProperty

A class that represents a string asset property.

AssetTransformPreset

interface AssetTransformPreset

A sealed interface that represents a transform preset.

AssetUTM

data class AssetUTM(val source: String?, val medium: String?)

UTM parameters for the links inside the credits.

AudioContext

enum AudioContext : Enum<AudioContext>

AudioFromVideoOptions

data class AudioFromVideoOptions(val keepTrimSettings: Boolean = true, val muteOriginalVideo: Boolean = false)

AudioThumbnailResult

class AudioThumbnailResult(val chunkIndex: Int, val samples: List<Float>)

AudioTrackInfo

data class AudioTrackInfo(val audioCodec: String, val channels: Int, val sampleRate: Int, val audioDuration: Double, val numAudioPackets: Int, val numAudioFrames: Long, val trackName: String, val trackIndex: Int, val language: String)

Information about a single audio track from a video. This data class provides comprehensive metadata about audio tracks, including codec information, technical specifications, and track details.

BlendMode

enum BlendMode : Enum<BlendMode>

BlockApi

interface BlockApi

BlockState

interface BlockState

BlurType

sealed class BlurType : ObjectType

BooleanOperation

enum BooleanOperation : Enum<BooleanOperation>

CharacterInkBox

data class CharacterInkBox(val x: Float, val y: Float, val width: Float, val height: Float, val baselineY: Float)

Tight ink-paint bounding box of a single grapheme, in global scene coordinates.

CMYKColor

data class CMYKColor : Color

Color

interface Color

ColorSpace

enum ColorSpace : Enum<ColorSpace>

CompressionFormat

enum CompressionFormat : Enum<CompressionFormat>

CompressionLevel

enum CompressionLevel : Enum<CompressionLevel>

CompressionOptions

data class CompressionOptions(val format: CompressionFormat = CompressionFormat.ZSTD, val level: CompressionLevel = CompressionLevel.DEFAULT)

Compression options for scene serialization.

ContentFillMode

enum ContentFillMode : Enum<ContentFillMode>

CutoutOperation

enum CutoutOperation : Enum<CutoutOperation>

CutoutType

enum CutoutType : Enum<CutoutType>

DefaultAssetSource

enum ~~DefaultAssetSource~~ : Enum<DefaultAssetSource>

DemoAssetSource

enum ~~DemoAssetSource~~ : Enum<DemoAssetSource>

DesignBlock

typealias DesignBlock = Int

DesignBlockEvent

data class DesignBlockEvent(val block: DesignBlock, val type: DesignBlockEvent.Type)

DesignBlockType

sealed class DesignBlockType : ObjectType

DesignUnit

enum DesignUnit : Enum<DesignUnit>

DominantColor

data class DominantColor(val r: Float, val g: Float, val b: Float, val weight: Float)

A single color extracted from the rendered appearance of a block.

DominantColorsOptions

data class DominantColorsOptions(val count: Int = 5, val ignoreWhite: Boolean = false)

Options for BlockApi.getDominantColors.

EditorApi

interface EditorApi

EffectType

sealed class EffectType : ObjectType

Engine

class Engine : SavedStateRegistry.SavedStateProvider

EngineErrorCode

object EngineErrorCode

Every stable catalog error code as a typed constant. Branch on EngineException.code against these instead of bare strings:

EngineException

open class EngineException(message: String, val code: String = "", val category: String = "", val hint: String = "", docs: String = "", val args: Map<String, Any> = emptyMap(), val silent: Boolean = false) : RuntimeException

Structured engine error surfaced from the native side.

EventApi

interface EventApi

ExportOptions

data class ExportOptions(val pngCompressionLevel: Int = 5, val jpegQuality: Float = 0.9f, val webpQuality: Float = 1.0f, val targetWidth: Float? = null, val targetHeight: Float? = null, val exportPdfWithHighCompatibility: Boolean = true, val exportPdfWithUnderlayer: Boolean = false, val underlayerSpotColorName: String = "", val underlayerOffset: Float = 0.0f, val underlayerRenderRatio: Float = 1.0f, val underlayerMaxError: Float = 2.0f, val allowTextOverhang: Boolean = false)

The export options.

ExportVideoOptions

data class ExportVideoOptions(val h264Profile: Int = 77, val h264Level: Int = 52, val videoBitrate: Int = 0, val audioBitrate: Int = 0, val frameRate: Float = 30.0f, val targetWidth: Float? = null, val targetHeight: Float? = null, val allowTextOverhang: Boolean = false)

ExportVideoProgress

data class ExportVideoProgress(val renderedFrames: Int, val encodedFrames: Int, val totalFrames: Int)

FetchAssetOptions

data class FetchAssetOptions(val locale: String? = null)

Options for fetching an asset.

FillRule

enum FillRule : Enum<FillRule>

Fill rule for resolving self-intersecting or overlapping subpaths of a vector path shape. Use with the shape/vector_path/fillRule enum property.

FillType

sealed class FillType : ObjectType

FindAssetsQuery

data class FindAssetsQuery(val perPage: Int, val page: Int, val query: String? = null, val locale: String? = null, val sortingOrder: SortingOrder = SortingOrder.NONE, val sortKey: String? = null, val sortActiveFirst: Boolean = false, val tags: List<String>? = null, val groups: List<String>? = null, val excludeGroups: List<String>? = null)

Search parameters for find asset query.

FindAssetsResult

data class FindAssetsResult(val assets: List<Asset>, val currentPage: Int, val nextPage: Int = -1, val total: Int)

Return type of a findAssets query.

Font

data class Font(val uri: Uri, val subFamily: String, val weight: FontWeight, val style: FontStyle)

FontMetrics

data class FontMetrics(val ascender: Float, val descender: Float, val unitsPerEm: Float, val lineGap: Float, val capHeight: Float, val xHeight: Float, val underlineOffset: Float, val underlineSize: Float, val strikeoutOffset: Float, val strikeoutSize: Float)

Font metrics extracted from a font file. Values are in the font's design units coordinate space.

FontStyle

enum FontStyle : Enum<FontStyle>

FontUnit

enum FontUnit : Enum<FontUnit>

FontWeight

enum FontWeight : Enum<FontWeight>

GlobalScope

enum GlobalScope : Enum<GlobalScope>

GradientColorStop

data class GradientColorStop(@FloatRange(from = 0.0, to = 1.0) val stop: Float, val color: Color)

HandleVisibility

enum HandleVisibility : Enum<HandleVisibility>

When a transform handle is shown: by the default rules, always (including while editing text), or never. always does not apply in crop edit mode, which has its own handles.

History

typealias History = Int

HistoryUpdate

enum HistoryUpdate : Enum<HistoryUpdate>

Describes the kind of update that triggered an EditorApi.onHistoryUpdatedWithKind event.

HorizontalAlignment

enum HorizontalAlignment : Enum<HorizontalAlignment>

HorizontalBlockAlignment

enum HorizontalBlockAlignment : Enum<HorizontalBlockAlignment>

HorizontalContentFillAlignment

enum HorizontalContentFillAlignment : Enum<HorizontalContentFillAlignment>

Horizontal alignment of the content fill inside the block.

HorizontalTextAlignment

typealias ~~HorizontalTextAlignment~~ = HorizontalAlignment

LicenseValidationException

class LicenseValidationException(message: String) : EngineException

ListStyle

enum ListStyle : Enum<ListStyle>

MimeType

enum MimeType : Enum<MimeType>

MovementConstraintRule

data class MovementConstraintRule(val overshoot: Float, val scope: MovementConstraintScope = MovementConstraintScope.Scene)

A movement constraint rule. The scope determines which blocks the rule applies to; overshoot is a non-negative fraction of the moved block's own size.

MovementConstraintScope

sealed class MovementConstraintScope

Identifies which blocks a movement constraint rule applies to.

ObjectType

sealed class ObjectType

PositionMode

enum PositionMode : Enum<PositionMode>

PropertyType

enum PropertyType : Enum<PropertyType>

ResolvedMovementConstraint

data class ResolvedMovementConstraint(val overshoot: Float)

The effective movement constraint for a block, returned by EditorApi.getMovementConstraint. null is returned when the block is unconstrained.

RGBAColor

data class RGBAColor : Color

SaveToStringOptions

data class SaveToStringOptions(val allowedResourceSchemes: List<String> = listOf("blob", "bundle", "file", "http", "https"), val compression: CompressionOptions? = null)

Options for saving a scene to string.

SceneApi

interface SceneApi

SceneLayout

enum SceneLayout : Enum<SceneLayout>

SceneMode

enum ~~SceneMode~~ : Enum<SceneMode>

Setting

interface Setting

ShapeType

sealed class ShapeType : ObjectType

SizeMode

enum SizeMode : Enum<SizeMode>

SortingOrder

enum SortingOrder : Enum<SortingOrder>

The order to sort by if the asset source supports sorting. If set to None, the order is the same as the assets were added to the source.

Source

data class Source(val uri: Uri, val width: Int, val height: Int)

SplitOptions

data class SplitOptions(val attachToParent: Boolean = true, val createParentTrackIfNeeded: Boolean = false, val selectNewBlock: Boolean = true)

SpotColor

data class SpotColor : Color

StrokeCap

enum StrokeCap : Enum<StrokeCap>

Controls how the ends of open stroked paths (such as line shapes) are rendered.

StrokeCornerGeometry

enum StrokeCornerGeometry : Enum<StrokeCornerGeometry>

StrokePosition

enum StrokePosition : Enum<StrokePosition>

StrokeStyle

enum StrokeStyle : Enum<StrokeStyle>

Subscription

typealias Subscription = Int

TextCase

enum TextCase : Enum<TextCase>

TextDecorationConfig

data class TextDecorationConfig(val lines: Set<TextDecorationLine> = setOf(TextDecorationLine.NONE), val style: TextDecorationStyle = TextDecorationStyle.SOLID, val underlineColor: Color? = null, val underlineThickness: Float = 1.0f, val underlineOffset: Float = 0.0f, val skipInk: Boolean = true)

Configuration for text decorations on a text range.

TextDecorationLine

enum TextDecorationLine : Enum<TextDecorationLine>

Represents a type of text decoration line.

TextDecorationStyle

enum TextDecorationStyle : Enum<TextDecorationStyle>

Represents the visual style of a text decoration line.

TextRunInfo

data class TextRunInfo(val from: Int, val to: Int, val text: String, val color: Color, val fontWeight: FontWeight, val fontStyle: FontStyle, val fontSize: Float, val textCase: TextCase, val typeface: Typeface, val resolvedFontFileUri: String, val textDecoration: TextDecorationConfig, val kerning: Float)

Represents a single contiguous text run with uniform formatting.

Typeface

data class Typeface(val name: String, val fonts: List<Font>)

UnstableEngineApi

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY])

annotation class UnstableEngineApi

UriResolverAsync

class UriResolverAsync(resolver: suspend (Uri) -> Uri)

Internal helper class used by EditorApi.setUriResolverAsync.

VariableApi

interface VariableApi

VerticalBlockAlignment

enum VerticalBlockAlignment : Enum<VerticalBlockAlignment>

VerticalContentFillAlignment

enum VerticalContentFillAlignment : Enum<VerticalContentFillAlignment>

Vertical alignment of the content fill inside the block.

VideoThumbnailResult

class VideoThumbnailResult(val frameIndex: Int, val width: Int, val height: Int, val imageData: ByteBuffer)

ZoomAutoFitAxis

enum ZoomAutoFitAxis : Enum<ZoomAutoFitAxis>

Properties

assetBaseUri

val Engine.Companion.~~assetBaseUri~~: Uri

The default base URI for loading CE.SDK asset definitions from the IMG.LY CDN.

defaultAssetSourcesBaseUri

val Engine.~~defaultAssetSourcesBaseUri~~: Uri?

Returns the base uri of the default asset sources that was previously passed to addDefaultAssetSources.

Functions

addDefaultAssetSources

suspend fun Engine.~~addDefaultAssetSources~~(baseUri: Uri = Engine.assetBaseUri, exclude: Set<DefaultAssetSource> = emptySet()): Job

Convenience function that registers a set of asset sources containing our example assets. Note: See DefaultAssetSource enum for available values. Note: By default, these assets are parsed from the IMG.LY CDN at https://cdn.img.ly/packages/imgly/cesdk-android/<version>/assets/<id>/content.json.

addDemoAssetSources

suspend fun Engine.~~addDemoAssetSources~~(exclude: Set<DemoAssetSource> = emptySet(), withUploadAssetSources: Boolean = false, baseUri: Uri = Engine.assetBaseUri)

Convenience function that registers a set of demo asset sources containing our example assets. Note: See DemoAssetSource enum for available values. Note: By default, these assets are parsed from the IMG.LY CDN at https://cdn.img.ly/packages/imgly/cesdk-android/<version>/assets/<id>/content.json.

exportSettings

fun Engine.exportSettings(): List<Setting>

Returns all the keypath-value setting pairs of the Engine. Useful when copying settings between Engine instances (see importSettings).

getMoveHandleVisibility

fun EditorApi.getMoveHandleVisibility(): HandleVisibility

Get when the standalone move handle is shown for the selected block.

getResizeHandlesVisibility

fun EditorApi.getResizeHandlesVisibility(): HandleVisibility

Get when the edge (resize) handles are shown for the selected block.

getRotateHandlesVisibility

fun EditorApi.getRotateHandlesVisibility(): HandleVisibility

Get when the rotation handle is shown for the selected block.

getScaleHandlesVisibility

fun EditorApi.getScaleHandlesVisibility(): HandleVisibility

Get when the corner (scale) handles are shown for the selected block.

importSettings

fun Engine.importSettings(settings: List<Setting>)

Sets all the keypath-value setting pairs to the Engine. Useful when copying settings between Engine instances (see exportSettings).

populateAssetSource

suspend fun Engine.~~populateAssetSource~~(id: String, jsonUri: Uri, replaceBaseUri: Uri? = null)

Creates and adds a new local asset source with id. A describing content json file is fetched from jsonUri and containing assets are added to the local asset source. Note: Check "https://cdn.img.ly/packages/imgly/cesdk-android/1.78.0/assets/ly.img.sticker/content.json" for the structure of the json file.

setMoveHandleVisibility

fun EditorApi.setMoveHandleVisibility(value: HandleVisibility)

Set when the standalone move handle is shown for the selected block.

setResizeHandlesVisibility

fun EditorApi.setResizeHandlesVisibility(value: HandleVisibility)

Set when the edge (resize) handles are shown for the selected block.

setRotateHandlesVisibility

fun EditorApi.setRotateHandlesVisibility(value: HandleVisibility)

Set when the rotation handle is shown for the selected block.

setScaleHandlesVisibility

fun EditorApi.setScaleHandlesVisibility(value: HandleVisibility)

Set when the corner (scale) handles are shown for the selected block.