SubtitleCue

sealed interface SubtitleCue

One subtitle event with a time window.

Text subtitles and bitmap subtitles are genuinely different things. A text cue carries words and styling and must be laid out for the current viewport. A bitmap cue carries pixels that were authored for a fixed video size and must be placed and scaled. Unifying them at this level, and not inside a renderer, is what keeps a plain SRT file from needing a font engine.

Inheritors

Types

Link copied to clipboard
data class Bitmap(val startMicros: Long, val endMicros: Long, val regions: List<BitmapRegion>, val layer: Int = 0) : SubtitleCue
Link copied to clipboard
object Companion
Link copied to clipboard
data class Text(val startMicros: Long, val endMicros: Long, val spans: List<StyledSpan>, val layout: CueLayout = CueLayout(), val layer: Int = 0) : SubtitleCue

Properties

Link copied to clipboard
abstract val endMicros: Long

When the cue stops being visible. The cue shows from startMicros up to, but not including, this time.

Link copied to clipboard
abstract val layer: Int

Ordering hint from the source. Higher values are drawn on top.

Link copied to clipboard
abstract val startMicros: Long

When the cue becomes visible, in microseconds on the media timeline.