captions.js

---

Interface: CaptionsSettings

Defined in: entities/captions/captions.types.ts:6

Full styling + animation configuration for a single captions track.

Properties

animation

animation: "none" | "bounce" | "underline" | "box" | "pop" | "scale" | "slide-left" | "slide-up" | "slide-down" | "box-word"

Defined in: entities/captions/captions.types.ts:34

---

lineSpacing?

optional lineSpacing: number | null

Defined in: entities/captions/captions.types.ts:31

---

linesPerPage

linesPerPage: number

Defined in: entities/captions/captions.types.ts:30

---

position

position: "auto" | "top" | "middle" | "bottom"

Defined in: entities/captions/captions.types.ts:32

---

positionTopOffset?

optional positionTopOffset: number

Defined in: entities/captions/captions.types.ts:33

---

style

style: object

Defined in: entities/captions/captions.types.ts:7

aplifiedWordColor

aplifiedWordColor: string

backgroundColor

backgroundColor: string

font

font: object

font.fontCapitalize

fontCapitalize: boolean

font.fontColor

fontColor: string

font.fontFamily

fontFamily: string

font.fontSize

fontSize: number

font.fontStrokeColor

fontStrokeColor: string

font.fontStrokeWidth

fontStrokeWidth: number

font.fontWeight

fontWeight: "thin" | "light" | "regular" | "medium" | "bold" | "black"

font.italic

italic: boolean

font.shadow?

optional shadow: object

font.shadow.fontShadowBlur

fontShadowBlur: number

font.shadow.fontShadowColor

fontShadowColor: string

font.shadow.fontShadowOffsetX

fontShadowOffsetX: number

font.shadow.fontShadowOffsetY

fontShadowOffsetY: number

font.underline

underline: boolean

name

name: string

verticalCoverImg?

optional verticalCoverImg: string