getCaptionsList()

Returns an array of objects based on available captions. Information for each object may vary depending on the caption types.

πŸ“˜

The event is only triggered when captions are present. The list is cleared on each .on('playlistItem') event.

Sideloaded Captions (VTT, SRT, DFXP)

ValueDescription
id stringThe URL of the sideloaded caption file
label stringThe label that is configured in the player setup.

Stream-Embedded Captions

ValueDescription
id numberThe index of the caption.
label stringThe label specified within the embedded captions