🎥 Make videos programmatically with React
docs: Mention WebVTT imports across caption guides
JonnyBurger956c90229cc5
diff --git a/packages/docs/docs/captions/GuideTableOfContents.tsx b/packages/docs/docs/captions/GuideTableOfContents.tsxindex 58a1adcb0e..1b5db7c285 100644--- a/packages/docs/docs/captions/GuideTableOfContents.tsx+++ b/packages/docs/docs/captions/GuideTableOfContents.tsx@@ -7,8 +7,8 @@ export const GuideTableOfContents: React.FC = () => {<div><Grid><TOCItem link="/docs/captions/importing">- <strong>{'Importing from .srt'}</strong>- <div>Import existing .srt subtitle files</div>+ <strong>{'Importing from .srt or .vtt'}</strong>+ <div>Import existing .srt or .vtt subtitle files</div></TOCItem><TOCItem link="/docs/captions/transcribing"><strong>{'Transcribing audio'}</strong>diff --git a/packages/docs/docs/captions/caption.mdx b/packages/docs/docs/captions/caption.mdxindex a564341c39..7c536d032e 100644--- a/packages/docs/docs/captions/caption.mdx+++ b/packages/docs/docs/captions/caption.mdx@@ -18,7 +18,7 @@ By establishing a standard data structure, we allow many operations that involve- **Transcribing**: Using the [`@remotion/install-whisper-cpp`](/docs/install-whisper-cpp), [`@remotion/openai-whisper`](/docs/openai-whisper), or [`@remotion/elevenlabs`](/docs/elevenlabs) packages- **Formatting**: For example, creating pages using [`createTikTokStyleCaptions()`](/docs/captions/create-tiktok-style-captions)-- **Parsing**: Using the [`parseSrt()`](/docs/captions/parse-srt) function+- **Parsing**: Using [`parseSrt()`](/docs/captions/parse-srt) for `.srt` files or [`parseVtt()`](/docs/captions/parse-vtt) for `.vtt` files- **Serializing**: For example to a `.srt` file using [`serializeSrt()`](/docs/captions/serialize-srt)## Fieldsdiff --git a/packages/docs/docs/captions/importing.mdx b/packages/docs/docs/captions/importing.mdxindex b19156cf72..b022d72cdd 100644--- a/packages/docs/docs/captions/importing.mdx+++ b/packages/docs/docs/captions/importing.mdx@@ -1,13 +1,13 @@---image: /generated/articles-docs-captions-importing.png-sidebar_label: Importing from .srt-title: Importing .srt subtitles into Remotion+sidebar_label: Importing from .srt or .vtt+title: Importing .srt or .vtt subtitles into Remotioncrumb: Captions----# Importing .srt subtitles into Remotion+# Importing .srt or .vtt subtitles into Remotion-If you have an existing `.srt` subtitle file, you can import it into Remotion using [`parseSrt()`](/docs/captions/parse-srt) from `@remotion/captions`.+If you have an existing subtitle file, you can import it into Remotion using [`parseSrt()`](/docs/captions/parse-srt) for `.srt` files or [`parseVtt()`](/docs/captions/parse-vtt) for WebVTT (`.vtt`) files from `@remotion/captions`.## Reading an .srt file@@ -50,6 +50,19 @@ export const MyComponent: React.FC = () => {Alternatively, you can also `fetch()` a remote file via URL.+## Reading a .vtt file<AvailableFrom v="4.0.536" />++Use the same loading pattern as above, replacing `parseSrt()` with [`parseVtt()`](/docs/captions/parse-vtt) and fetching your `.vtt` file:++```tsx twoslash title="Importing captions from .vtt"+import {parseVtt} from '@remotion/captions';+import {staticFile} from 'remotion';++const response = await fetch(staticFile('subtitles.vtt'));+const text = await response.text();+const {captions} = parseVtt({input: text});+```+## Using imported captionsOnce parsed, the captions are in the recommended [`Caption`](/docs/captions/caption) format and can be used with all `@remotion/captions` utilities.@@ -62,5 +75,6 @@ Possible next steps:## See also- [`parseSrt()`](/docs/captions/parse-srt) - API reference+- [`parseVtt()`](/docs/captions/parse-vtt) - API reference- [Displaying captions](/docs/captions/displaying) - Render captions in your video- [`Caption`](/docs/captions/caption) - The caption data structurediff --git a/packages/docs/docs/captions/parse-srt.mdx b/packages/docs/docs/captions/parse-srt.mdxindex bf95321e36..1cfba793a9 100644--- a/packages/docs/docs/captions/parse-srt.mdx+++ b/packages/docs/docs/captions/parse-srt.mdx@@ -78,4 +78,5 @@ An array of [`Caption`](/docs/captions/caption) items.## See also- [Source code for this function](https://github.com/remotion-dev/remotion/blob/main/packages/captions/src/parse-srt.ts)+- [`parseVtt()`](/docs/captions/parse-vtt) - Parse WebVTT (`.vtt`) files- [`@remotion/captions`](/docs/captions/api)diff --git a/packages/docs/src/data/articles.ts b/packages/docs/src/data/articles.tsindex ad009ab339..1d9ddba6a0 100644--- a/packages/docs/src/data/articles.ts+++ b/packages/docs/src/data/articles.ts@@ -1856,7 +1856,7 @@ export const articles = [},{id: 'captions/importing',- title: 'Importing .srt subtitles into Remotion',+ title: 'Importing .srt or .vtt subtitles into Remotion',relativePath: 'docs/captions/importing.mdx',compId: 'articles-docs-captions-importing',crumb: 'Captions',@@ -1881,6 +1881,15 @@ export const articles = [noAi: false,slug: 'captions/parse-srt',},+ {+ id: 'captions/parse-vtt',+ title: 'parseVtt()',+ relativePath: 'docs/captions/parse-vtt.mdx',+ compId: 'articles-docs-captions-parse-vtt',+ crumb: '@remotion/captions',+ noAi: false,+ slug: 'captions/parse-vtt',+ },{id: 'captions/serialize-srt',title: 'serializeSrt()',diff --git a/packages/docs/static/generated/articles-docs-captions-importing.png b/packages/docs/static/generated/articles-docs-captions-importing.pngindex f7738602e6..4b1e262da0 100644Binary files a/packages/docs/static/generated/articles-docs-captions-importing.png and b/packages/docs/static/generated/articles-docs-captions-importing.png differdiff --git a/packages/docs/static/generated/articles-docs-captions-parse-vtt.png b/packages/docs/static/generated/articles-docs-captions-parse-vtt.pngnew file mode 100644index 0000000000..942e8a68e2Binary files /dev/null and b/packages/docs/static/generated/articles-docs-captions-parse-vtt.png differ