android-ui-common/com.theoplayer.android.ui/TextTrackStyleState

TextTrackStyleState

class TextTrackStyleState(source)

State holder for the style of subtitles, such as TextTrackStyleMenu.

Create an instance with rememberTextTrackStyleState.

Properties

backgroundColor

var backgroundColor: Color

The color of the background directly behind the subtitle text, including its opacity.

backgroundOpacity

val backgroundOpacity: Int

The opacity of the background directly behind the subtitle text, as a percentage.

edgeColor

var edgeColor: Color

The color of the edge of the subtitle text, including its opacity.

edgeType

var edgeType: TextTrackStyle.EdgeType

The edge style of the subtitle text.

fontColor

var fontColor: Color

The color of the subtitle text, including its opacity.

fontFamily

var fontFamily: TextTrackFontFamily?

The font family of the subtitles.

fontOpacity

val fontOpacity: Int

The opacity of the subtitle text, as a percentage.

fontSize

var fontSize: Int

The font size of the subtitles, as a percentage of the default font size.

isFontFamilySupported

val isFontFamilySupported: Boolean

Whether the font family can be changed.

windowColor

var windowColor: Color

The color of the window behind the subtitle text, including its opacity.

windowOpacity

val windowOpacity: Int

The opacity of the window behind the subtitle text, as a percentage.

Functions

reset

fun reset()

Resets the style to the built-in defaults.

selectBackgroundColor

fun selectBackgroundColor(color: Color)

Selects the color of the background directly behind the subtitle text, keeping the current background opacity.

selectBackgroundOpacity

fun selectBackgroundOpacity(opacity: Int)

Selects the opacity of the background directly behind the subtitle text, keeping the current background color.

selectEdgeColor

fun selectEdgeColor(color: Color)

Selects the color of the edge of the subtitle text, keeping its current opacity.

selectEdgeType

fun selectEdgeType(edgeType: TextTrackStyle.EdgeType)

Selects the edge style of the subtitle text.

selectFontColor

fun selectFontColor(color: Color)

Selects the color of the subtitle text, keeping the current font opacity.

selectFontFamily

fun selectFontFamily(fontFamily: TextTrackFontFamily)

Selects the font family of the subtitles.

selectFontOpacity

fun selectFontOpacity(opacity: Int)

Selects the opacity of the subtitle text, keeping the current font color.

selectFontSize

fun selectFontSize(fontSize: Int)

Selects the font size of the subtitles, as a percentage of the default font size.

selectWindowColor

fun selectWindowColor(color: Color)

Selects the color of the window behind the subtitle text, keeping the current window opacity.

selectWindowOpacity

fun selectWindowOpacity(opacity: Int)

Selects the opacity of the window behind the subtitle text, keeping the current window color.