Text Track Hooks

The vtt module, @react-av/vtt, provides two hooks for consuming text tracks in React AV. More hooks are to come to provide additional functionality.

useMediaTextTrack(id)

Access the cues of a text track, given its ID. It returns a tuple of all the cues and the active cues (cues that are currently being displayed). These values are reactive and will update when the cues change.

Parameters: id: string

Returns: [VTTCue[], VTTCue[]] where the first element is all the cues and the second element is the active cues.

useMediaTextTrackList()

Access the list of text tracks for the current media element. This hook returns a list of TextTrack objects. These values are reactive and will update when the text tracks change.

Returns: TextTrack[] the list of text tracks for the current media element.