filmstrip-core/dev.jordond.filmstrip.edit

Package-level declarations

Types

AudioLevel

sealed interface AudioLevel

What to do with one clip's or one track's audio.

AudioSpec

sealed interface AudioSpec

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

Clip

class Clip(val source: MediaSource, val trim: TimeRange? = null, val effects: List<EffectSpec> = emptyList(), val audio: AudioLevel = AudioLevel.Inherit, val snapWithin: Duration = Duration.ZERO, val fadeIn: Duration = Duration.ZERO, val fadeOut: Duration = Duration.ZERO, val speed: Double = 1.0)

One source contributing a time range to a track.

ClipBuilder

class ClipBuilder(source: MediaSource)

Builds one Clip.

CompositionBuilder

class CompositionBuilder

Builds an EditComposition.

EditComposition

@Immutable

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

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

EffectsBuilder

class EffectsBuilder

Collects effect declarations.

EnvelopeAnchor

enum EnvelopeAnchor : Enum<EnvelopeAnchor>

Which edge of a clip or track an EnvelopePoint is measured from.

EnvelopePoint

class EnvelopePoint(val at: Duration, val gain: Float, val from: EnvelopeAnchor = EnvelopeAnchor.Start)

One pinned gain in an AudioLevel.Envelope.

FilmstripDsl

@DslMarker

annotation class FilmstripDsl

Scopes filmstrip's builder receivers, so an inner block cannot silently call an outer one's members.

TimeRange

@Immutable

class TimeRange(val start: Duration, val endExclusive: Duration? = null)

A half-open range of media time, [start, endExclusive).

Track

class Track(val clips: List<Clip>, val content: TrackContent = TrackContent.AudioAndVideo, val effects: List<EffectSpec> = emptyList(), val audio: AudioLevel = AudioLevel.Inherit, val start: Duration = Duration.ZERO, val looping: Boolean = false, val fadeIn: Duration = Duration.ZERO, val fadeOut: Duration = Duration.ZERO)

One layer of a composition: clips laid end to end, playing alongside the other tracks.

TrackBuilder

class TrackBuilder(content: TrackContent = TrackContent.AudioAndVideo)

Builds one Track.

TrackContent

enum TrackContent : Enum<TrackContent>

Which media streams a track contributes to the output.

Properties

CLIP_SPEED_RANGE

val CLIP_SPEED_RANGE: ClosedFloatingPointRange<Double>

The speeds a clip can play at, from 32 times slower to 32 times faster.

Functions

compositionOf

fun compositionOf(block: CompositionBuilder.() -> Unit): EditComposition

Describes an edit.

TimeRange

fun TimeRange(range: ClosedRange<Duration>): TimeRange

A range covering range, with its end treated as exclusive.