Interface CreateVideoOptions

Options for creating a video background.

interface CreateVideoOptions {
    scale?: "cropCenter" | "inside" | "fit";
    alpha?: number | AnimatedVariable;
    dim?: number | AnimatedVariable;
    zIndex?: number;
    attach?: VideoAttach;
}

Index

Properties

scale? alpha? dim? zIndex? attach?

Properties

`Optional`scale

scale?: "cropCenter" | "inside" | "fit"

Scaling mode:

'cropCenter' (default) — fill screen, cropping edges.
'inside' — fit entire video inside screen.
'fit' — stretch to fill.

`Optional`alpha

alpha?: number | AnimatedVariable

Opacity, 0–1. Can be animated. Default: 1.

`Optional`dim

dim?: number | AnimatedVariable

Dimming amount, 0–1. Can be animated. Default: 0.3.

`Optional`zIndex

zIndex?: number

Z-order for the video layer.

`Optional`attach

attach?: VideoAttach

Attach the video to a judge line.