Skip to main content

parseSrt()v4.0.216

Parses the contents of a SubRip file (.srt) and returns an array of Caption items.

Example usage
import {parseSrt} from '@remotion/captions';

const input = `
1
00:00:00,000 --> 00:00:02,500
Welcome to the Example Subtitle File!

2
00:00:03,000 --> 00:00:06,000
This is a demonstration of SRT subtitles.

3
00:00:07,000 --> 00:00:10,500
You can use SRT files to add subtitles to your videos.
`.trim();

const {captions} = parseSrt({input});

/* captions = [
  {
    confidence: 1,
    endMs: 2500,
    startMs: 0,
    text: 'Welcome to the Example Subtitle File!',
    timestampMs: 1250,
  },
  {
    confidence: 1,
    endMs: 6000,
    startMs: 3000,
    text: 'This is a demonstration of SRT subtitles.',
    timestampMs: 4500,
  },
  {
    confidence: 1,
    endMs: 10500,
    startMs: 7000,
    text: 'You can use SRT files to add subtitles to your videos.',
    timestampMs: 8750,
  },
]
*/

API​

input​

The contents of a .srt file as a string.

strict?v4.0.530​

Defaults to false for compatibility with tolerant parsing. Set to true to reject malformed or empty files instead of ignoring unrecognized cues. Strict parsing validates every cue's timestamps (including complete tokens and minute/second ranges), end-before-start errors, and trailing content. Recognized timing-line settings such as align:start position:0% or X1:100 X2:200 Y1:300 Y2:400 are ignored. Errors include cue and line context. Studio imports use strict parsing.

Return value​

An object with the following properties:

captions​

An array of Caption items.

Compatibility​

BrowsersServersEnvironments
Chrome
Firefox
Safari
Node.js
Bun
Serverless Functions

See also​