@remotion/captions

Available from v4.0.216

The @remotion/captions package provides utilities for dealing with subtitles.

At the centre of this caption is the Caption type, which defines a standard shape for captions from different sources.

Captions can be generated from several sources and converted into the Caption type:

• @remotion/install-whisper-cpp — using toCaptions()
• @remotion/whisper-web — using toCaptions()
• @remotion/openai-whisper — using openAiWhisperApiToCaptions()
• @remotion/elevenlabs — using elevenLabsTranscriptToCaptions()

Remotion CLI

npx remotion add @remotion/captions

npm

npm i --save-exact @remotion/captions@4.0.442

This assumes you are currently using v4.0.442 of Remotion.
Also update remotion and all `@remotion/*` packages to the same version.
Remove all ^ character in front of the version numbers of it as it can lead to a version conflict.

bun

pnpm i @remotion/captions@4.0.442

This assumes you are currently using v4.0.442 of Remotion.
Also update remotion and all `@remotion/*` packages to the same version.
Remove all ^ character in front of the version numbers of it as it can lead to a version conflict.

pnpm

bun i @remotion/captions@4.0.442

This assumes you are currently using v4.0.442 of Remotion.
Also update remotion and all `@remotion/*` packages to the same version.
Remove all ^ character in front of the version numbers of it as it can lead to a version conflict.

yarn

yarn --exact add @remotion/captions@4.0.442

This assumes you are currently using v4.0.442 of Remotion.
Also update remotion and all `@remotion/*` packages to the same version.
Remove all ^ character in front of the version numbers of it as it can lead to a version conflict.

APIs

Caption

An object shape for captions

parseSrt()

Parse a .srt file into a Caption array

serializeSrt()

Serialize a .srt file into a Caption array

createTikTokStyleCaptions()

Structure the captions for TikTok-style display

License

MIT