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(source)

Burn text into the video.

The preview and the export lay the text out identically, so line breaks land on the same words in both.

Constructors

Link copied to clipboard
constructor(text: String, style: TextStyle = TextStyle.Default, anchor: Anchor = Anchor.BottomCenter, visibleDuring: TimeRange? = null, animation: OverlayAnimation? = null)

Properties

Link copied to clipboard

Where the text sits in the frame.

Link copied to clipboard
open override val animation: OverlayAnimation?

How the text is drawn at each frame of its run, or null to hold it still. It never re-lays the glyphs, so a scale resamples the block a line break already landed in.

Link copied to clipboard
Link copied to clipboard
open override val id: String
Link copied to clipboard
open val isInert: Boolean
Link copied to clipboard
Link copied to clipboard
open val scope: EffectScope
Link copied to clipboard
open override val stage: EffectStage
Link copied to clipboard

How the text is drawn.

Link copied to clipboard

The text to draw.

Link copied to clipboard
open override val visibleDuring: TimeRange?

When the text is visible, or null for the whole composition.

Functions

Link copied to clipboard

Resolves this text against the frame it is burned into.