Skip to main content

SubtitlesStyle

Style options for subtitles. Overwrite styles defined in the subtitle content.

Properties​

autoFlow?​

optional autoFlow: boolean

Enable auto flow.

If true, will ignore all subtitle positioning and text flow defined in the content, and simply fit all text together at the bottom-middle of the screen. This is useful especially when you adjust the font size scaling

  • Not available on Web

backgroundColor?​

optional backgroundColor: Color

The text background color.

extendSystemStyle?​

optional extendSystemStyle: boolean

Whether to extend the system's default subtitle style.

fontFamily?​

optional fontFamily: FontFamily

The font family.

fontScale?​

optional fontScale: number

The font size scaling.

This is a number holding a percentage of the size of the calculated default font size. A value of 1.2 indicates 20% larger than the default font size. A value of 0.8 indicates 80% of the default font size. The value 1.0 indicates no size difference and is the default.

foregroundColor?​

optional foregroundColor: Color

The text foreground color.

textEdgeColor?​

optional textEdgeColor: Color

The text edge color.

textEdgeType?​

optional textEdgeType: TextEdgeType

The text edge type.

windowColor?​

optional windowColor: Color

The box background color.