player-core/com.bitmovin.player/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

CaptionStyle

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

Properties

backgroundColor

val backgroundColor: Int

Background color behind the rendered caption text as an Android ARGB color int.

edgeColor

val edgeColor: Int

Color used for the configured edgeType as an Android ARGB color int.

edgeType

val edgeType: Int

Edge style applied to caption text.

foregroundColor

val foregroundColor: Int

Text color as an Android ARGB color int, for example a value from android.graphics.Color.

typeface

val typeface: Typeface?

Typeface used for caption text, or null to use the default typeface.

windowColor

val windowColor: Int

Background color of the cue window as an Android ARGB color int.