kiteplayer-core/io.github.yuroyami.kiteplayer.subtitle/CueLayout

CueLayout

data class CueLayout(val alignment: CueAlignment = CueAlignment.BottomCenter, val marginLeft: Float = 0.05f, val marginRight: Float = 0.05f, val marginVertical: Float = 0.05f, val positionX: Float? = null, val positionY: Float? = null, val authoredHeight: Int? = null, val wrap: CueWrap = CueWrap.Balanced, val stacking: CueStacking = CueStacking.FirstAtBottom, val fadeInMicros: Long = 0, val fadeOutMicros: Long = 0, val scriptColorMatrix: ScriptColorMatrix? = null)

Where a cue goes.

Constructors

CueLayout

constructor(alignment: CueAlignment = CueAlignment.BottomCenter, marginLeft: Float = 0.05f, marginRight: Float = 0.05f, marginVertical: Float = 0.05f, positionX: Float? = null, positionY: Float? = null, authoredHeight: Int? = null, wrap: CueWrap = CueWrap.Balanced, stacking: CueStacking = CueStacking.FirstAtBottom, fadeInMicros: Long = 0, fadeOutMicros: Long = 0, scriptColorMatrix: ScriptColorMatrix? = null)

Properties

alignment

val alignment: CueAlignment

authoredHeight

val authoredHeight: Int?

The video height the cue's pixel sizes were authored against, when the format declares one. Layout scales by the ratio of the current viewport to this, so a subtitle authored for 720p looks the same on a 4K display.

fadeInMicros

val fadeInMicros: Long

Linear fade lengths from an ASS \fad tag, in microseconds from the cue's edges. Renderers that cannot animate ignore them; the cue still shows and hides on time.

fadeOutMicros

val fadeOutMicros: Long

marginLeft

val marginLeft: Float

Fraction of the video width to keep clear on the left.

marginRight

val marginRight: Float

marginVertical

val marginVertical: Float

Fraction of the video height to keep clear at the bottom, or top for top alignments.

positionX

val positionX: Float?

Explicit position as a fraction of the video size, from an ASS \pos tag or a WebVTT setting. Overrides alignment when set.

positionY

val positionY: Float?

scriptColorMatrix

val scriptColorMatrix: ScriptColorMatrix?

The colour matrix an ASS script's YCbCr Matrix header names, which the player matches the cue's colours to the video through (#499). The engine converts the colours of the cues it publishes, so a cue arriving at a rasterizer is already matched. Null for every other format, which names none.

stacking

val stacking: CueStacking

Which cue sits at the bottom when several show at once. See CueStacking.

wrap

val wrap: CueWrap

How lines break. All three built-in rasterizers honour it.