captions.js

---

Type Alias: CaptionsOptions

CaptionsOptions = object

Defined in: captions/Captions.ts:13

Configuration passed to the captions runtime when binding to a video element.

Properties

autoEnable?

optional autoEnable: boolean

Defined in: captions/Captions.ts:23

When false, caller must invoke Captions.enable manually.

---

captions?

optional captions: Caption[] | null

Defined in: captions/Captions.ts:21

Initial caption track.

---

container?

optional container: HTMLDivElement

Defined in: captions/Captions.ts:17

Optional custom container to host the Konva stage.

---

debug?

optional debug: boolean

Defined in: captions/Captions.ts:25

Show debug bounding boxes around lines/blocks.

---

preset

preset: StylePreset

Defined in: captions/Captions.ts:19

Initial preset controlling font, colors, animations.

---

video

video: HTMLVideoElement

Defined in: captions/Captions.ts:15

Video element that should receive overlays.