filmstrip-effects/dev.jordond.filmstrip.effects.overlay

Package-level declarations

Types

class CornerInset(val corner: Corner, val margin: Float)

A corner of the frame and how far in from it an overlay sits.

class ImageOverlay(val image: ImageSource, val corner: Corner, val margin: Float = DEFAULT_MARGIN, val scale: Float = DEFAULT_SCALE, val opacity: Float = 1.0f, val visibleDuring: TimeRange? = null, val animation: OverlayAnimation? = null) : OverlayEffect

Composite an image over the video.

OverlayAnimation

@Stable

fun interface OverlayAnimation

How an overlay is drawn at one instant.

OverlayEffect

interface OverlayEffect : EffectSpec

An effect drawn over the frame once geometry has settled.

OverlayFrame

@Immutable

class OverlayFrame(val opacity: Float = 1.0f, val offset: OverlayOffset = OverlayOffset.Zero, val scale: Float = 1.0f)

The three things an animation may change about one drawn frame.

OverlayOffset

@Immutable

class OverlayOffset(val x: Float, val y: Float)

A displacement from where an overlay would otherwise sit, as a fraction of the frame it is drawn on.

OverlayPlacement

@Immutable

class OverlayPlacement(val size: Size, val overlayAnchor: Anchor, val frameAnchor: Anchor)

Where a composited overlay lands, in real pixels of the frame it is drawn on.

OverlayTime

@Immutable

class OverlayTime(val elapsed: Duration, val remaining: Duration, val composition: Duration)

Where one frame sits inside the range an overlay is drawn over.

TextOverlay

class TextOverlay(val text: String, val style: TextStyle = TextStyle.Default, val anchor: Anchor = Anchor.BottomCenter, val visibleDuring: TimeRange? = null, val animation: OverlayAnimation? = null) : OverlayEffect

Burn text into the video.

Functions

fade

fun fade(inDuration: Duration = Duration.ZERO, outDuration: Duration = Duration.ZERO): OverlayAnimation

Fades the overlay in over inDuration and back out over outDuration.

imageOverlay

fun EffectsBuilder.imageOverlay(image: ImageSource, corner: Corner, margin: Float = ImageOverlay.DEFAULT_MARGIN, scale: Float = ImageOverlay.DEFAULT_SCALE, opacity: Float = 1.0f, visibleDuring: TimeRange? = null, animation: OverlayAnimation? = null): EffectsBuilder

Composite image into corner, sized and inset as fractions of the frame it is drawn on.

fun EffectsBuilder.imageOverlay(image: ImageSource, corner: Corner, at: ClosedRange<Duration>, margin: Float = ImageOverlay.DEFAULT_MARGIN, scale: Float = ImageOverlay.DEFAULT_SCALE, opacity: Float = 1.0f, animation: OverlayAnimation? = null): EffectsBuilder

Composite image into corner, visible only during at.

nearestCornerInset

fun Anchor.nearestCornerInset(frame: Size): CornerInset

The corner and margin that bring an image overlay's own corner to this point.

placedOn

fun TextOverlay.placedOn(text: Size): OverlayPlacement

Resolves this text against the frame it is burned into.

fun ImageOverlay.placedOn(frame: Size, image: Size): OverlayPlacement

Resolves this overlay against the frame it is composited onto.

plus

operator fun OverlayAnimation.plus(other: OverlayAnimation): OverlayAnimation

Runs both animations on every frame and merges what they answer.

rectOn

fun OverlayPlacement.rectOn(frame: Size): NormalizedRect

Where this placement puts the overlay on frame, as a fraction of it.

slideIn

fun slideIn(from: OverlayOffset, duration: Duration): OverlayAnimation

Slides the overlay from from to where it was authored over duration, counted from its first drawn frame.

slideOut

fun slideOut(to: OverlayOffset, duration: Duration): OverlayAnimation

Slides the overlay from where it was authored to to over duration, counted back from its last drawn frame.

textOverlay

fun EffectsBuilder.textOverlay(text: String, style: TextStyle = TextStyle.Default, anchor: Anchor = Anchor.BottomCenter, visibleDuring: TimeRange? = null, animation: OverlayAnimation? = null): EffectsBuilder

Burn text into the video at anchor.

fun EffectsBuilder.textOverlay(text: String, at: ClosedRange<Duration>, style: TextStyle = TextStyle.Default, anchor: Anchor = Anchor.BottomCenter, animation: OverlayAnimation? = null): EffectsBuilder

Burn text into the video, visible only during at.