TextTrack: kind property

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 kind read-only property of the TextTrack interface returns the kind of text track this object represents. This decides how the track will be handled by a user agent.

Value

A string. One of:

"subtitles"

The cues are overlaid on the video. Positioning of the cues is controlled using the properties of an object that inherits from TextTrackCue, for example VTTCue.

"captions"

The cues are overlaid on the video. Positioning of the cues is controlled using the properties of an object that inherits from TextTrackCue, for example VTTCue.

"descriptions"

The cues are made available in a non-visual fashion.

"chapters"

The user agent will make available a mechanism to navigate by selecting a cue.

"metadata"

Additional data related to the media data, which could be used for interactive views.

Examples

In the following example the value of kind is printed to the console.

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

Specifications

Specification
HTML
# dom-texttrack-kind-dev

Browser compatibility

Report problems with this compatibility data on GitHub
desktopmobile
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
kind

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support