CaptionStyle

CaptionStyle

data class CaptionStyle(val foregroundColor: Int, val backgroundColor: Int, val windowColor: Int, val edgeType: Int, val edgeColor: Int, val typeface: Typeface?)

Styling options for subtitle and caption rendering.

This type mirrors CaptionStyleCompat and is used with SubtitleRendererView.setStyle.

Constructors

CaptionStyleconstructor(foregroundColor: Int, backgroundColor: Int, windowColor: Int, edgeType: Int, edgeColor: Int, typeface: Typeface?)

Properties

NameSummary
backgroundColorval backgroundColor: Int
Background color behind the rendered caption text as an Android ARGB color int.
edgeColorval edgeColor: Int
Color used for the configured edgeType as an Android ARGB color int.
edgeTypeval edgeType: Int
Edge style applied to caption text.
foregroundColorval foregroundColor: Int
Text color as an Android ARGB color int, for example a value from android.graphics.Color.
typefaceval typeface: Typeface?
Typeface used for caption text, or null to use the default typeface.
windowColorval windowColor: Int
Background color of the cue window as an Android ARGB color int.