Captions that follow along to the video.
npm install captions-viewerA web component to display captions as a video plays. Think Spotify or Apple Music lyrics. Includes automatic scrolling to the caption cue as the video plays, and events when a chapter is clicked.
The component takes a webvtt or srt caption file and renders to a list. Caption parsing uses the faster native browser textTracks for vtt files, or a super small srt parser. Classes are updated depending on if the cue is upcoming, active or passed, and a little JS is used to move the cue into view. Cues are sorted, and larger gaps show a progress bar.
HLS streaming files with captions are supported, but take a few extra steps to send caption cues to the component. Examples are shown below.
The component has been tested with about 3,000 cues (2hr move) for performance.
Also check out the other component that makes it easier to manage starting and ending live streams for viewers https://livestreamwrapper.vercel.app/demo/
While this remains under 1.0, things are probably going to change.
``bash`
npm i captions-viewer
`html`
`html`
`html`
First, provide the path to a caption file the src parameter on the element. This must be an already created vtt or srt captions file. The caption file procesesd by the browser-native caption parser for vtt with a backup lightweight parser for srt or if there is a problem.
This example will display captions, but will not follow the video yet:
`html
`
To make the captions to update when the video is playing, and respond to clicks, the captions component needs to be linked to the video player. Simply use the config setup and pass the video element shown below. Most (if not all) have a property to get the native
Simple example connecting a native video tag to the component:
`html
`
For more fine-tunned control or if the video/audio element is not available, setup the listeners as shown below:
`html
`
HLS videos work the same way as flat mp4 files when there is a separate caption file.
If the captions/subtitles are in the HLS stream, such as during a live stream, caption cues are progressively loaded as each video chunk is downloaded. Simply pass the video element hls.js creates to the reader component:
`html`
| Name | Default | Description |
| - | - | - |
| src | null | Location of the vtt/srt file. |playhead
| | 0 | The current video/audio player time, in seconds, to keep the player and reader in-sync. (see more below) |youtube
| | false | Enable true if the caption vtt track came from YouTube for some special handling. |textTrack
| | undefined | Will hold the HTMLTextTrack. The native browser text track object. Pass this along for more custom player implementations. |captions
| | undefined | Read-only property of the internal caption cues list. Useful for debugging. |paused
| | false | The on/off button. If the reader system is enabled or not. |
| Name | Default | Description |
| - | - | - |
| singleline | false | True will show all text for a cue on a single line. False will obey the line breaks in the caption file. |disable
| | empty | Turn off displaying timecode chapters or text. Use a pipe \| between each option, such as timecode\|chapters |
| Name | Default | Description |
| - | - | - |
| debounce | 5000 | Control the time between scrolling. Time in ms between the last scroll (user or automatic) |nudge
| | 0.5 | Amount in seconds to adjust the cues to trigger sooner. 0.5 means the cue will show 500ms sooner than the timecode. |spacer
| | 5 | Time in seconds between cues where a spacer (progress bar) will display |
| Name | Default | Description |
| - | - | - |
| height | 300px | Height of the scrolling box. Valid CSS unit. |color
| | 360 | The Hue (0-360) of the base color to use. This is put into an hsla color. |theme
| | light, dark | Light theme shades the text darker for a whiter background. Dark will lighten text for a darker background. |stylesheet
| | true | True/False to enable the default stylesheet. False will remove all styling, default is True. See the guide below. |
| Name | Description | Type | Default |
| - | - | - | - |
| player | (Required) The video or audio element. | htmlElement | undefined |lang
| | Language code that matches the tracks code. | string | en |refresh
| | Time in milliseconds to update cues as player plays. | number | player timeUpdate |
Example:
`javascript`
const captions = document.querySelector('captions-viewer');
captions.config({
player: document.querySelector('video'),
lang: 'fr',
refresh: 500,
});
A toggle to stop/start the component without removing it. All events, scrolling and updating will stop.
`html`
Calling this method with the name of the theme will immediately change the color scheme. Options are currently only dark for making the text lighter for dark backgrounds, light for dark text on ligher backgrounds, and blank/empty for user's system theme.
`javascript`
captions.setTheme('dark');
Live streaming and HLS can push text cue updates as the video plays. To update the reader with new use, this method will append those cues. This method expects a textTrack cue list of all the current cues, plus new cues. It has better performance by only rendering the new cues than pushing updates to the textTrack property as textTrack is a complete refresh and re-render of all the cues.
`javascript`
const tracks = player.textTracks;
const track = tracks[0]; // example, pick the first track.
track.addEventListener('cuechange', (e) => {
component.updateCues(e.target);
});
| Name | Description |
| - | - |
| parsed | When the caption file has been parsed. |error
| | Fires when an error occurs. Returns the text description of the error. |seek
| | Fires when a click/select is made on a caption cue. Returns the start of that cue in seconds. |cuechange
| | Fires when cues change. Returns the internal cue object of the single active track, or the last one if there are multiple. undefined if no cue is active. |
To display a "no captions" message, add the custom element:
`html`
Your Custom Message
For more examples, see the /demo folder.
Show captions for a video using the native caption tracy system, with a dynamic container height, custom color, and only showing timecode and the text. The theme is set for dark, so the background will darker with lighter captions.
`html
player="#demo_video"
height="30vw"
singleline="true"
color="300"
theme="dark"
disable="chapters"
>
`
YouTube captions are not accessible publicly. One way is to download the vtt option from YouTube in the Creator Studio, put it on your own server. Another is using YouTube's API.
Note when using the YouTube vtt file, one edit may be needed to the first cue. Normally there is a blank line between the timecode and cue code. Each browser handles this slightly differently, so to provide browser parity simply add text in this blank line. Any text will do, and will be removed by the parser.
`text
WEBVTT
Kind: captions
Language: en
00:00:00.000 --> 00:00:02.810 align:start position:0%
[add any text here]
hello<00:00:00.539>
...etc
`
`html
disable="chapters"
debounce="1000"
youtube="true"
>
``