This options block configures the styling of closed captions in the player for desktop browsers.
On iOS and Android, a system settings menu provides exactly the same settings, as these are mandated by the FCC.
If you want to control if captions are rendered using the renderer of the browser or the player, set the renderCaptionsNatively property at the global level of
setup().
| Property | Description |
|---|---|
| backgroundColor string | Hex color of the caption characters background
Default: #000000
|
| backgroundOpacity number | Alpha percentage of the caption characters background
Default: 75
|
| color string | Hex color of the captions text
Default: #ffffff
|
| edgeStyle string | Method by which the captions characters are separated from their background
Default: none
|
| fontFamily string | Font Family of the captions text
Default: sans
|
| fontOpacity number | Alpha percentage of the captions text
Default: 100
|
| fontSize number | Size of the captions text (Will not affect text size when rendering captions via browser)
Default: 15
|
| windowColor string | Hex color of the background of the entire captions area
Default: #000000
|
| windowOpacity number | Alpha percentage of the background of the entire captions area
Default: 0
|
When setting caption styles, color must be specified as a hex value.