Skip to content

ReferenceText tracks

getTextTracks

The text tracks a filter or track definition matches, from the media or the app

Import

import { getTextTracks } from '@videojs/react';

getTextTracks returns the tracks in textTrackList that a filter or track definition matches, from the media and the app alike. Each track’s source says which. The list comes from the text track feature.

A filter picks tracks by kind, label, or language, or with a function. Each given field must match, and a list of kinds matches any kind in it. Without a filter, getTextTracks returns every track.

Usage

In a component, useTextTracks re-renders when the tracks change. getTextTracks reads them once, such as in an event handler. Pass it a store typed with your player’s features, such as the one the preset’s usePlayer returns:

import { getTextTracks } from '@videojs/react';
import { usePlayer } from '@videojs/react/video';

function LogChaptersButton() {
  const store = usePlayer();

  return <button onClick={() => console.log(getTextTracks(store, { kind: 'chapters' }))}>Log chapter tracks</button>;
}

API Reference

getTextTracks(source, filter?): MediaTextTrack[]

Parameters

ParameterTypeDefaultDetails
source*object—
filterobject{}

Return Value

MediaTextTrack[]