VTTCue: snapToLines property

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since January 2020.

The snapToLines property of the VTTCue interface is a Boolean indicating if the VTTCue.line property is an integer number of lines, or a percentage of the video size.

Value

Examples

In the following example a new VTTCue is created, then the value of snapToLines is set to true. The value is then printed to the console.

js
let video = document.querySelector("video");
let track = video.addTextTrack("captions", "Captions", "en");
track.mode = "showing";

let cue1 = new VTTCue(0, 0.9, "Hildy!");
cue1.snapToLines = true;
console.log(cue1.snapToLines);

track.addCue(cue1);

Specifications

Specification
WebVTT: The Web Video Text Tracks Format
# dom-vttcue-snaptolines

Browser compatibility

BCD tables only load in the browser