captions.js

CaptionsOptions

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

type CaptionsOptions = object;

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

Properties

autoEnable?

optional autoEnable?: boolean;

When false, caller must invoke Captions.enable manually.


captions?

optional captions?: Caption[] | null;

Initial caption track.


container?

optional container?: HTMLDivElement;

Optional custom container to host the Konva stage.


debug?

optional debug?: boolean;

Show debug bounding boxes around lines/blocks.


preset

preset: StylePreset;

Initial preset controlling font, colors, animations.


video

video: HTMLVideoElement;

Video element that should receive overlays.

For AI agents and LLMs: this page as Markdown · llms.txt · all docs in one file