This page is Ready to Use

Notice: The WebPlatform project, supported by various stewards between 2012 and 2015, has been discontinued. This site is now available on github.

snapToLines

Summary

Returns the text track cue snap-to-lines flag setting.

Property of apis/audio-video/TextTrackCueapis/audio-video/TextTrackCue

Syntax

var result = TextTrackCue.snapToLines;
TextTrackCue.snapToLines = value;

Return Value

Returns an object of type BooleanBoolean

Examples

//. . .
var myTrack = document.getElementById("entrack").track; // get text track from track element
var myCues = myTrack.cues;   // get list of cues
for (var i = 0; i < myCues.length; i++) {
// report each text track cue's snap-to-lines flag
alert("Cue " + i + " size: " + myCues[i].snapToLines);
}
//. . .

Related specifications

W3C HTML5 Specification
W3C Editor’s Draft

Attributions