Captions

Imperative controller that owns the Konva stage lifecycle for a single video element.

Constructors

new Captions(options): Captions;

Create a controller bound to the provided video element and preset.

Parameter	Type	Description
`options`	`CaptionsOptions`	Complete configuration for the controller.

Captions

captions(nextCaptions): void;

Replace the current caption track and repaint without reloading fonts.

Parameter	Type	Description
`nextCaptions`	`Caption`[] \| `null`	Timed words that should drive the overlay.

void

destroy(): void;

Alias for disable() to match typical imperative controller APIs.

void

disable(): void;

Tear down overlays, observers and animation loops to free resources.

void

enable(): void;

Mount caption overlays onto the configured video if they are not active yet.

void

getRenderCount(): number;

Number of times the scene has been rebuilt. Useful for diagnostics and tests — it stays flat while the video is paused.

number

isEnabled(): boolean;

Whether the Konva overlay is currently attached to the video element.

boolean

true when the overlay is mounted on top of the video.

preset(nextPreset): void;

Swap the active preset and re-render with updated typography/colors.

Parameter	Type	Description
`nextPreset`	`StylePreset`	Preset that becomes the new render baseline.

void