W3cubDocs

/Web APIs

TextTrack: inBandMetadataTrackDispatchType property

The inBandMetadataTrackDispatchType read-only property of the TextTrack interface returns the text track's in-band metadata dispatch type of the text track represented by the TextTrack object.

An in-band metadata dispatch type is a string extracted from a media resource specifically for in-band metadata tracks. An example of a media resource that might have such tracks is a TV station streaming a broadcast on the web. Text Tracks may be used to include metadata for ad targeting, additional information such as recipe data during a cooking show, or trivia game data during a game show.

The value of this attribute could be used to attach these tracks to dedicated script modules as they are loaded.

Value

A string containing the inBandMetadataTrackDispatchType, or an empty string.

Examples

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

js

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

Specifications

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
inBandMetadataTrackDispatchType 23 12 31 10 ≤12.1 6 4.4 25 31 ≤12.1 7 1.5

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/TextTrack/inBandMetadataTrackDispatchType