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)
Value | Description |
---|---|
id string | The URL of the sideloaded caption file |
label string | The label that is configured in the player setup. |
Stream-Embedded Captions
Value | Description |
---|---|
id number | The index of the caption. |
label string | The label specified within the embedded captions |