VTTCue: getCueAsHTML() method

Baseline Widely available

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

The getCueAsHTML() method of the VTTCue interface returns a DocumentFragment containing the cue content.

Syntax

js
getCueAsHTML()

Parameters

None.

Return value

A DocumentFragment.

Examples

In the following example a new VTTCue is created. The value as a document fragment 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!");
console.log(cue1.getCueAsHTML());

track.addCue(cue1);

Specifications

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

Browser compatibility

BCD tables only load in the browser