CaptionsSettings

Full styling + animation configuration for a single captions track.

Properties

Property	Type	Description
`animation`	\| `"scale"` \| `"none"` \| `"bounce"` \| `"underline"` \| `"box"` \| `"pop"` \| `"slide-left"` \| `"slide-up"` \| `"slide-down"` \| `"box-word"`	-
`lineSpacing?`	`number` \| `null`	-
`linesPerPage`	`number`	-
`position`	`"auto"` \| `"top"` \| `"middle"` \| `"bottom"`	-
`positionTopOffset?`	`number`	-
`style`	`object`	-
`style.aplifiedWordColor?`	`string`	Deprecated Misspelled original name of CaptionsSettings.style.highlightColor. Still read when `highlightColor` is not set; will be removed in 2.0.
`style.backgroundColor`	`string`	-
`style.font`	`object`	-
`style.font.fontCapitalize`	`boolean`	-
`style.font.fontColor`	`string`	-
`style.font.fontFamily`	`string`	-
`style.font.fontSize`	`number`	-
`style.font.fontStrokeColor`	`string`	-
`style.font.fontStrokeWidth`	`number`	-
`style.font.fontWeight`	`"thin"` \| `"light"` \| `"regular"` \| `"medium"` \| `"bold"` \| `"black"`	-
`style.font.italic`	`boolean`	-
`style.font.shadow?`	`object`	-
`style.font.shadow.fontShadowBlur`	`number`	-
`style.font.shadow.fontShadowColor`	`string`	-
`style.font.shadow.fontShadowOffsetX`	`number`	-
`style.font.shadow.fontShadowOffsetY`	`number`	-
`style.font.underline`	`boolean`	-
`style.highlightColor?`	`string`	Color of the active (spoken) word. A per-word `Caption.highlightColor` overrides it.
`style.name`	`string`	-
`style.verticalCoverImg?`	`string`	-