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

EditComposition

class EditComposition(val tracks: List<Track>, val effects: List<EffectSpec> = emptyList(), val audio: AudioSpec = AudioSpec.Keep, val fill: Fill = Fill.Black)(source)

A complete, immutable description of an edit: what to read, what to cut, what to apply.

Output format lives in dev.jordond.filmstrip.export.ExportSpec, so one composition can be previewed and then exported at several qualities. Pass the same value to preview() and to export().

Clips live on Tracks, which play at the same time as each other rather than one after another. Most edits have a single track and never name one. clips reads it and the composition builder fills it.

Constructors

EditComposition

constructor(tracks: List<Track>, effects: List<EffectSpec> = emptyList(), audio: AudioSpec = AudioSpec.Keep, fill: Fill = Fill.Black)

Properties

val audio: AudioSpec

What to do with the composition's audio once every track has been mixed.

val clips: List<Clip>

The primary track's clips, which for a single-track edit is every clip there is.

val duration: Duration?

Total duration after trimming and each clip's speed.

val effects: List<EffectSpec>

Effects applied to the composited output, after every track's own effects.

What fills the frame where no clip's pixels land.

val tracks: List<Track>

The layers to render, the first of which is the primary one.

Functions

fun withAudio(audio: AudioSpec): EditComposition

A copy with a different audio treatment.

fun withClips(clips: List<Clip>): EditComposition

A copy whose primary track holds different clips.

fun withEffects(effects: List<EffectSpec>): EditComposition

A copy with different composition-level effects.

fun withFill(fill: Fill): EditComposition

A copy with a different fill.

fun withTracks(tracks: List<Track>): EditComposition

A copy with different tracks.