filmstrip-core/dev.jordond.filmstrip.edit/CompositionBuilder

CompositionBuilder

clip appends to the primary track, which is the only track most edits have, so a single-track composition never names one. track adds a layer that plays alongside it.

Each lambda-taking method has a non-lambda counterpart, addClip, addTrack and addEffects, for callers that cannot use a receiver lambda.

Constructors

CompositionBuilder

constructor()

Functions

addClip

fun addClip(clip: Clip): CompositionBuilder

Appends an already-built clip to the primary track.

addEffects

fun addEffects(effects: List<EffectSpec>): CompositionBuilder

Adds already-built composition-level effects.

addTrack

fun addTrack(track: Track): CompositionBuilder

Adds an already-built track alongside the primary one.

audio

fun audio(spec: AudioSpec): CompositionBuilder

Sets what happens to the composition's audio once every track has been mixed.

build

fun build(): EditComposition

Freezes what has been described.

clip

fun clip(source: MediaSource, block: ClipBuilder.() -> Unit = {}): CompositionBuilder

Appends a clip to the primary track, reading from source and configured by block.

effects

fun effects(block: EffectsBuilder.() -> Unit): CompositionBuilder

Adds effects that apply to the composited output, after every track's own.

fill

fun fill(fill: Fill): CompositionBuilder

Sets what fills the frame where no clip's pixels land.

image

fun image(image: ImageSource, duration: Duration, block: ClipBuilder.() -> Unit = {}): CompositionBuilder

Appends a still image to the primary track, held for duration and configured by block.

track

fun track(content: TrackContent = TrackContent.AudioAndVideo, block: TrackBuilder.() -> Unit): CompositionBuilder

Adds a track that plays alongside the primary one, configured by block.