Background features

Video Background Element Parameters (nightly build only)

Supported media files:

• Containers: WebM (.webm) and Matroska (.mkv) only
• Video codecs: VP8 and VP9
• Audio codecs: Opus and Vorbis

type (required, string)

Specifies that this background element is a video. Must be set to:

type = video

path (required, string)

Path to the video media file. Defaults to video directory.

volume (optional, int)

Audio playback volume (0–100). Defaults to 100.

scale (optional, string)

Defines how the video is scaled to fit the window. Defaults to none. Available options:

• none – No scaling. Video is shown at its original size.
• fit – Uniformly scales so the entire video fits inside the window; pads if necessary.
• fitwidth – Scales to match window width. If taller than the window, vertically center-crops; otherwise pads.
• fitheight – Scales to match window height. If wider than the window, horizontally center-crops; otherwise pads.
• zoomfill – Uniformly scales until the video fully covers the window; center-crops any overflow.
• stretch – Stretches to fill the window exactly (may distort aspect ratio).
• center – No scaling; centers the video. Crops if larger than the window, pads if smaller.

filter (optional, string)

Specifies the scaling filter algorithm. Defaults to fastbilinear. Available options:

• lanczos
• fastbilinear
• bilinear
• bicubic
• experimental
• neighbor
• area
• bicublin
• gauss
• sinc
• spline