π₯ Make videos programmatically with React
Docs: Link guides to shared options reference
Jonny Burger217a3a3f9364
diff --git a/packages/docs/docs/audio/exporting.mdx b/packages/docs/docs/audio/exporting.mdxindex dd079136c5..54a01389f8 100644--- a/packages/docs/docs/audio/exporting.mdx+++ b/packages/docs/docs/audio/exporting.mdx@@ -29,7 +29,7 @@ npx remotion render src/index.ts my-comp --codec=mp3### `renderMedia()`-To render only the audio via the server-side rendering APIs, use [`renderMedia()`](/docs/renderer/render-media) and set the [`codec`](/docs/renderer/render-media#codec) to an audio codec.+To render only the audio via the server-side rendering APIs, use [`renderMedia()`](/docs/renderer/render-media) and set the [`codec`](/docs/options/codec) to an audio codec.```tsx twoslash title="render.js"import {bundle} from '@remotion/bundler';@@ -84,7 +84,7 @@ await renderMedia({### `renderMediaOnLambda()`-To render only the audio via Lambda, use [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda) and set the [`codec`](/docs/lambda/rendermediaonlambda#codec) to an audio codec and [`imageFormat`](/docs/lambda/rendermediaonlambda#imageformat) to `none`.+To render only the audio via Lambda, use [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda) and set the [`codec`](/docs/options/codec) to an audio codec and [`imageFormat`](/docs/options/video-image-format) to `none`.```tsx twoslashimport {renderMediaOnLambda} from '@remotion/lambda';@@ -103,7 +103,7 @@ const {bucketName, renderId} = await renderMediaOnLambda({### `renderMediaOnVercel()`-To render only the audio via Vercel, use [`renderMediaOnVercel()`](/docs/vercel/render-media-on-vercel) and set the [`codec`](/docs/vercel/render-media-on-vercel#codec) to an audio codec and [`imageFormat`](/docs/vercel/render-media-on-vercel#imageformat) to `none`.+To render only the audio via Vercel, use [`renderMediaOnVercel()`](/docs/vercel/render-media-on-vercel) and set the [`codec`](/docs/options/codec) to an audio codec and [`imageFormat`](/docs/options/video-image-format) to `none`.```tsx twoslash// @module: es2022@@ -123,7 +123,7 @@ const {sandboxFilePath} = await renderMediaOnVercel({### Lambda CLI-To render via the Lambda CLI, use the [`npx remotion lambda render`](/docs/lambda/cli/render) command and pass the [`--codec`](/docs/lambda/cli/render#--codec) flag:+To render via the Lambda CLI, use the [`npx remotion lambda render`](/docs/lambda/cli/render) command and pass the [`--codec`](/docs/options/codec) flag:```shnpx remotion lambda render --codec=mp3 https://remotionlambda-qg35eyp1s1.s3.eu-central-1.amazonaws.com/sites/bf2jrbfkw my-comp@@ -141,7 +141,7 @@ npx remotion render --muted### `renderMedia()`-Pass [`muted: true`](/docs/renderer/render-media#muted) to [`renderMedia()`](/docs/renderer/render-media) to mute a render.+Pass [`muted: true`](/docs/options/muted) to [`renderMedia()`](/docs/renderer/render-media) to mute a render.```tsx twoslash title="render.js"import {bundle} from '@remotion/bundler';@@ -197,7 +197,7 @@ await renderMedia({### `renderMediaOnLambda()`-Pass [`muted: true`](/docs/lambda/rendermediaonlambda#muted) to [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda) to mute the render.+Pass [`muted: true`](/docs/options/muted) to [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda) to mute the render.```tsx twoslashimport {renderMediaOnLambda} from '@remotion/lambda';@@ -216,7 +216,7 @@ const {bucketName, renderId} = await renderMediaOnLambda({### `renderMediaOnVercel()`-Pass [`muted: true`](/docs/vercel/render-media-on-vercel#muted) to [`renderMediaOnVercel()`](/docs/vercel/render-media-on-vercel) to mute the render.+Pass [`muted: true`](/docs/options/muted) to [`renderMediaOnVercel()`](/docs/vercel/render-media-on-vercel) to mute the render.```tsx twoslash// @module: es2022@@ -236,7 +236,7 @@ const {sandboxFilePath} = await renderMediaOnVercel({### Lambda CLI-Pass [`--muted`](/docs/lambda/cli/render#--muted) to [`npx remotion lambda render`](/docs/lambda/cli/render) to mute a render when using the Lambda Command Line.+Pass [`--muted`](/docs/options/muted) to [`npx remotion lambda render`](/docs/lambda/cli/render) to mute a render when using the Lambda Command Line.```shnpx remotion lambda render --muted https://remotionlambda-qg35eyp1s1.s3.eu-central-1.amazonaws.com/sites/bf2jrbfkw my-compdiff --git a/packages/docs/docs/chromium-flags.mdx b/packages/docs/docs/chromium-flags.mdxindex 400b34ad02..34eab55831 100644--- a/packages/docs/docs/chromium-flags.mdx+++ b/packages/docs/docs/chromium-flags.mdx@@ -17,11 +17,11 @@ Remotion will automatically append the `--user-data-dir` flag.### Via Node.JS APIs-In [`getCompositions()`](/docs/renderer/get-compositions), [`renderStill()`](/docs/renderer/render-still#disablewebsecurity), [`renderMedia()`](/docs/renderer/render-media#disablewebsecurity), [`renderFrames()`](/docs/renderer/render-frames#disablewebsecurity), [`getCompositionsOnLambda()`](/docs/lambda/getcompositionsonlambda#disablewebsecurity), [`renderStillOnLambda()`](/docs/lambda/renderstillonlambda#disablewebsecurity), [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#disablewebsecurity), [`renderMediaOnVercel()`](/docs/vercel/render-media-on-vercel#chromiumoptions) and [`renderStillOnVercel()`](/docs/vercel/render-still-on-vercel#chromiumoptions), you can pass [`chromiumOptions.disableWebSecurity`](/docs/renderer/render-still#disablewebsecurity).+Pass [`chromiumOptions.disableWebSecurity`](/docs/options/disable-web-security) in rendering APIs, including [`getCompositions()`](/docs/renderer/get-compositions), [`renderMediaOnVercel()`](/docs/vercel/render-media-on-vercel#chromiumoptions) and [`renderStillOnVercel()`](/docs/vercel/render-still-on-vercel#chromiumoptions).### Via CLI flag-Pass [`--disable-web-security`](/docs/cli/render#--disable-web-security) in one of the following commands: [`remotion render`](/docs/cli/render), [`remotion compositions`](/docs/cli/compositions), [`remotion still`](/docs/cli/still), [`remotion lambda render`](/docs/lambda/cli/render), [`remotion lambda still`](/docs/lambda/cli/still), [`remotion lambda compositions`](/docs/lambda/cli/compositions).+Pass [`--disable-web-security`](/docs/options/disable-web-security).### Via config file@@ -45,11 +45,11 @@ Results in invalid SSL certificates, such as self-signed ones, being ignored.### Via Node.JS APIs-In [`getCompositions()`](/docs/renderer/get-compositions), [`renderStill()`](/docs/renderer/render-still#ignorecertificateerrors), [`renderMedia()`](/docs/renderer/render-media#ignorecertificateerrors), [`renderFrames()`](/docs/renderer/render-frames#ignorecertificateerrors), [`getCompositionsOnLambda()`](/docs/lambda/getcompositionsonlambda#disablewebsecurity), [`renderStillOnLambda()`](/docs/lambda/renderstillonlambda#ignorecertificateerrors), [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#ignorecertificateerrors), [`renderMediaOnVercel()`](/docs/vercel/render-media-on-vercel#chromiumoptions) and [`renderStillOnVercel()`](/docs/vercel/render-still-on-vercel#chromiumoptions), you can pass [`chromiumOptions.ignoreCertificateErrors`](/docs/renderer/render-still#ignorecertificateerrors).+Pass [`chromiumOptions.ignoreCertificateErrors`](/docs/options/ignore-certificate-errors) in rendering APIs, including [`getCompositions()`](/docs/renderer/get-compositions), [`renderMediaOnVercel()`](/docs/vercel/render-media-on-vercel#chromiumoptions) and [`renderStillOnVercel()`](/docs/vercel/render-still-on-vercel#chromiumoptions).### Via CLI flag-Pass [`--ignore-certificate-errors`](/docs/cli/render#--ignore-certificate-errors) in one of the following commands: [`remotion render`](/docs/cli/render), [`remotion compositions`](/docs/cli/compositions), [`remotion still`](/docs/cli/still), [`remotion lambda render`](/docs/lambda/cli/render), [`remotion lambda still`](/docs/lambda/cli/still), [`remotion lambda compositions`](/docs/lambda/cli/compositions).+Pass [`--ignore-certificate-errors`](/docs/options/ignore-certificate-errors).### Via config file@@ -84,19 +84,19 @@ On Linux, headed mode requires a running display server. It is not available on### Via Node.JS APIs-In [`getCompositions()`](/docs/renderer/get-compositions), [`renderStill()`](/docs/renderer/render-still#headless), [`renderMedia()`](/docs/renderer/render-media#headless) and [`renderFrames()`](/docs/renderer/render-frames#headless), pass [`chromiumOptions.headless: false`](/docs/renderer/render-still#headless).+Pass [`chromiumOptions.headless: false`](/docs/options/disable-headless) in rendering APIs, including [`getCompositions()`](/docs/renderer/get-compositions).Also pass `chromeMode: 'chrome-for-testing'`, or provide a compatible desktop browser using `browserExecutable`.### Via CLI flag-Pass [`--disable-headless`](/docs/cli/render#--disable-headless) together with `--chrome-mode=chrome-for-testing`:+Pass [`--disable-headless`](/docs/options/disable-headless) together with `--chrome-mode=chrome-for-testing`:```bash title="Render with a visible Chrome window"npx remotion render ... --chrome-mode=chrome-for-testing --disable-headless```-The flag is supported by [`remotion compositions`](/docs/cli/compositions), [`remotion render`](/docs/cli/render) and [`remotion still`](/docs/cli/still). Alternatively, combine it with [`--browser-executable`](/docs/cli/render#--browser-executable) to use a custom desktop browser.+Alternatively, combine it with [`--browser-executable`](/docs/options/browser-executable) to use a custom desktop browser.### Via config file@@ -121,11 +121,11 @@ Prior to `v3.3.39`, the option was called `Config.Puppeteer.setChromiumHeadlessM### Via Node.JS APIs-In [`getCompositions()`](/docs/renderer/get-compositions#chromiumoptions), [`renderStill()`](/docs/renderer/render-still#gl), [`renderMedia()`](/docs/renderer/render-media#gl), [`renderFrames()`](/docs/renderer/render-frames#gl), [`getCompositionsOnLambda()`](/docs/lambda/getcompositionsonlambda#gl), [`renderStillOnLambda()`](/docs/lambda/renderstillonlambda#gl), [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#gl), [`renderMediaOnVercel()`](/docs/vercel/render-media-on-vercel#chromiumoptions) and [`renderStillOnVercel()`](/docs/vercel/render-still-on-vercel#chromiumoptions), you can pass [`chromiumOptions.gl`](/docs/renderer/render-still#gl).+Pass [`chromiumOptions.gl`](/docs/options/gl) in rendering APIs, including [`getCompositions()`](/docs/renderer/get-compositions#chromiumoptions), [`renderMediaOnVercel()`](/docs/vercel/render-media-on-vercel#chromiumoptions) and [`renderStillOnVercel()`](/docs/vercel/render-still-on-vercel#chromiumoptions).### Via CLI flag-Pass [`--gl=swiftshader`](/docs/cli) in one of the following commands: [`remotion render`](/docs/cli/render), [`remotion compositions`](/docs/cli/compositions), [`remotion still`](/docs/cli/still), [`remotion lambda render`](/docs/lambda/cli/render), [`remotion lambda still`](/docs/lambda/cli/still), [`remotion lambda compositions`](/docs/lambda/cli/compositions).+Pass [`--gl=swiftshader`](/docs/options/gl).### Via config file@@ -145,11 +145,11 @@ Prior to `v3.3.39`, the option was called `Config.Puppeteer.setChromiumOpenGlRen### Via Node.JS APIs-In [`getCompositions()`](/docs/renderer/get-compositions#chromiumoptions), [`renderStill()`](/docs/renderer/render-still#useragent), [`renderMedia()`](/docs/renderer/render-media#useragent), [`renderFrames()`](/docs/renderer/render-frames#useragent), [`getCompositionsOnLambda()`](/docs/lambda/getcompositionsonlambda#useragent), [`renderStillOnLambda()`](/docs/lambda/renderstillonlambda#useragent), [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#chromiumoptions), [`renderMediaOnVercel()`](/docs/vercel/render-media-on-vercel#chromiumoptions) and [`renderStillOnVercel()`](/docs/vercel/render-still-on-vercel#chromiumoptions), you can pass [`chromiumOptions.userAgent`](/docs/renderer/render-still#useragent).+Pass [`chromiumOptions.userAgent`](/docs/options/user-agent) in rendering APIs, including [`getCompositions()`](/docs/renderer/get-compositions#chromiumoptions), [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#chromiumoptions), [`renderMediaOnVercel()`](/docs/vercel/render-media-on-vercel#chromiumoptions) and [`renderStillOnVercel()`](/docs/vercel/render-still-on-vercel#chromiumoptions).### Via CLI flag-Pass [`--user-agent`](/docs/cli) in one of the following commands: [`remotion render`](/docs/cli/render), [`remotion compositions`](/docs/cli/compositions), [`remotion still`](/docs/cli/still), [`remotion lambda render`](/docs/lambda/cli/render), [`remotion lambda still`](/docs/lambda/cli/still), [`remotion lambda compositions`](/docs/lambda/cli/compositions).+Pass [`--user-agent`](/docs/options/user-agent).## `--dark-mode`<AvailableFrom v="4.0.381"/>@@ -157,11 +157,11 @@ Pass [`--user-agent`](/docs/cli) in one of the following commands: [`remotion re### Via Node.JS APIs-In [`getCompositions()`](/docs/renderer/get-compositions#chromiumoptions), [`renderStill()`](/docs/renderer/render-still#darkmode), [`renderMedia()`](/docs/renderer/render-media#darkmode), [`renderFrames()`](/docs/renderer/render-frames#darkmode), [`getCompositionsOnLambda()`](/docs/lambda/getcompositionsonlambda#darkmode), [`renderStillOnLambda()`](/docs/lambda/renderstillonlambda#darkmode), [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#chromiumoptions), [`renderMediaOnVercel()`](/docs/vercel/render-media-on-vercel#chromiumoptions) and [`renderStillOnVercel()`](/docs/vercel/render-still-on-vercel#chromiumoptions), you can pass [`chromiumOptions.darkMode`](/docs/renderer/render-still#darkmode).+Pass [`chromiumOptions.darkMode`](/docs/options/dark-mode) in rendering APIs, including [`getCompositions()`](/docs/renderer/get-compositions#chromiumoptions), [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#chromiumoptions), [`renderMediaOnVercel()`](/docs/vercel/render-media-on-vercel#chromiumoptions) and [`renderStillOnVercel()`](/docs/vercel/render-still-on-vercel#chromiumoptions).### Via CLI flag-Pass [`--dark-mode`](/docs/cli) in one of the following commands: [`remotion render`](/docs/cli/render), [`remotion compositions`](/docs/cli/compositions), [`remotion still`](/docs/cli/still), [`remotion lambda render`](/docs/lambda/cli/render), [`remotion lambda still`](/docs/lambda/cli/still), [`remotion lambda compositions`](/docs/lambda/cli/compositions).+Pass [`--dark-mode`](/docs/options/dark-mode).## Need more flags?diff --git a/packages/docs/docs/config.mdx b/packages/docs/docs/config.mdxindex 0e5858af4e..143d709024 100644--- a/packages/docs/docs/config.mdx+++ b/packages/docs/docs/config.mdx@@ -87,7 +87,7 @@ import {Config} from '@remotion/cli/config';Config.setCachingEnabled(false);```-The [command line flag](/docs/cli/render#--bundle-cache) `--bundle-cache` will take precedence over this option.+The [`--bundle-cache`](/docs/options/bundle-cache) flag takes precedence over this option.## `setStudioPort()`<AvailableFrom v="4.0.61" />@@ -99,7 +99,7 @@ import {Config} from '@remotion/cli/config';Config.setStudioPort(3003);```-The [command line flag](/docs/cli/studio#--port) `--port` will take precedence over this option.+The [`--port`](/docs/options/port) flag takes precedence over this option.## `setRendererPort()`<AvailableFrom v="4.0.61" />@@ -111,7 +111,7 @@ import {Config} from '@remotion/cli/config';Config.setRendererPort(3004);```-The [command line flag](/docs/cli/render#--port) `--port` will take precedence over this option.+The [`--port`](/docs/options/port) flag takes precedence over this option.## `setPublicDir()`<AvailableFrom v="3.2.13" />@@ -123,7 +123,7 @@ import {Config} from '@remotion/cli/config';Config.setPublicDir('./custom-public-dir');```-The [command line flag](/docs/cli/render#--public-dir) `--public-dir` will take precedence over this option.+The [`--public-dir`](/docs/options/public-dir) flag takes precedence over this option.## `setBundleOutDir()`<AvailableFrom v="4.0.426" />@@ -135,7 +135,7 @@ import {Config} from '@remotion/cli/config';Config.setBundleOutDir('./custom-build-dir');```-The [command line flag](/docs/cli/bundle#--out-dir) `--out-dir` will take precedence over this option.+The [`--out-dir`](/docs/options/out-dir) flag takes precedence over this option.## `setBenchmarkRuns()`@@ -147,7 +147,7 @@ import {Config} from '@remotion/cli/config';Config.setBenchmarkRuns(5);```-The [command line flag](/docs/cli/benchmark#--runs) `--runs` will take precedence over this option.+The [`--runs`](/docs/options/runs) flag takes precedence over this option.## `setBenchmarkConcurrencies()`<AvailableFrom v="4.0.430" />@@ -159,7 +159,7 @@ import {Config} from '@remotion/cli/config';Config.setBenchmarkConcurrencies('1,4,8');```-The [command line flag](/docs/cli/benchmark#--concurrencies) `--concurrencies` will take precedence over this option.+The [`--concurrencies`](/docs/options/concurrencies) flag takes precedence over this option.## `setEntryPoint()`<AvailableFrom v="3.2.40" />@@ -191,7 +191,7 @@ import {Config} from '@remotion/cli/config';Config.setLogLevel('verbose');```-The [command line flag](/docs/cli/render#--log) `--log` will take precedence over this option.+The [`--log`](/docs/options/log) flag takes precedence over this option.## `addElementLibrary()`<AvailableFrom v="4.0.517" />@@ -232,7 +232,7 @@ import {Config} from '@remotion/cli/config';Config.setKeyboardShortcutsEnabled(false);```-The [command line flag](/docs/cli/studio#--disable-keyboard-shortcuts) `--disable-keyboard-shortcuts` will take precedence over this option.+The [`--disable-keyboard-shortcuts`](/docs/options/disable-keyboard-shortcuts) flag takes precedence over this option.## `setKeyboardShortcuts()`<AvailableFrom v="4.0.523" />@@ -264,7 +264,7 @@ import {Config} from '@remotion/cli/config';Config.setInteractivityEnabled(false);```-The [command line flag](/docs/cli/studio#--disable-interactivity) `--disable-interactivity` will take precedence over this option.+The [`--disable-interactivity`](/docs/options/disable-interactivity) flag takes precedence over this option.## `setCanvasTabsEnabled()`<AvailableFrom v="4.0.530" />@@ -276,7 +276,7 @@ import {Config} from '@remotion/cli/config';Config.setCanvasTabsEnabled(false);```-The [command line flag](/docs/cli/studio#--disable-canvas-tabs) `--disable-canvas-tabs` will take precedence over this option.+The [`--disable-canvas-tabs`](/docs/options/disable-canvas-tabs) flag takes precedence over this option.## `setDefaultEditor()`<AvailableFrom v="4.0.503" />@@ -296,7 +296,7 @@ Config.setDefaultCodingAgent('codex');Available coding agents: `codex`, `cursor`, `copilot`, and `claude-code`.-The [`--coding-agent`](/docs/cli/studio#--coding-agent) command line flag takes precedence over this option.+The [`--coding-agent`](/docs/options/coding-agent) flag takes precedence over this option.## `setAllowHtmlInCanvasEnabled()`<AvailableFrom v="4.0.447" />@@ -308,7 +308,7 @@ import {Config} from '@remotion/cli/config';Config.setAllowHtmlInCanvasEnabled(true);```-The [command line flag](/docs/cli/studio#--allow-html-in-canvas) `--allow-html-in-canvas` will take precedence over this option.+The [`--allow-html-in-canvas`](/docs/options/allow-html-in-canvas) flag takes precedence over this option.## `setRspack()`<AvailableFrom v="4.0.502" />@@ -320,7 +320,7 @@ import {Config} from '@remotion/cli/config';Config.setRspack(true);```-The [command line flag](/docs/cli/studio#--rspack) `--rspack` will take precedence over this option.+The [`--rspack`](/docs/options/rspack) flag takes precedence over this option.## ~~`setExperimentalRspackEnabled()`~~<AvailableFrom v="4.0.426" />@@ -340,7 +340,7 @@ import {Config} from '@remotion/cli/config';Config.setWebpackPollingInMilliseconds(1000);```-The [command line flag](/docs/cli/studio#--webpack-poll) `--webpack-poll` will take precedence over this option.+The [`--webpack-poll`](/docs/options/webpack-poll) flag takes precedence over this option.## `setNumberOfSharedAudioTags()`<AvailableFrom v="3.3.2" />@@ -353,7 +353,7 @@ import {Config} from '@remotion/cli/config';Config.setNumberOfSharedAudioTags(5);```-The [command line flag](/docs/cli/studio#--number-of-shared-audio-tags) `--number-of-shared-audio-tags` will take precedence over this option.+The [`--number-of-shared-audio-tags`](/docs/options/number-of-shared-audio-tags) flag takes precedence over this option.## `setShouldOpenBrowser()`<AvailableFrom v="3.3.19" />@@ -366,7 +366,7 @@ import {Config} from '@remotion/cli/config';Config.setShouldOpenBrowser(false);```-The [command line flag](/docs/cli/studio#--no-open) `--no-open` will take precedence over this option.+The [`--no-open`](/docs/options/no-open) flag takes precedence over this option.## `setBrowserExecutable()`<AvailableFrom v="1.5.0" />@@ -378,7 +378,7 @@ import {Config} from '@remotion/cli/config';Config.setBrowserExecutable('/usr/bin/google-chrome-stable');```-The [command line flag](/docs/cli/render#--browser-executable) `--browser-executable` will take precedence over this option.+The [`--browser-executable`](/docs/options/browser-executable) flag takes precedence over this option.## `setDelayRenderTimeoutInMilliseconds()`<AvailableFrom v="2.6.3" />@@ -392,7 +392,7 @@ import {Config} from '@remotion/cli/config';Config.setDelayRenderTimeoutInMilliseconds(60000);```-The [command line flag](/docs/cli/render#--timeout) `--timeout` will take precedence over this option.+The [`--timeout`](/docs/options/timeout) flag takes precedence over this option.## `setChromiumDisableWebSecurity()`<AvailableFrom v="2.6.5" />@@ -406,7 +406,7 @@ import {Config} from '@remotion/cli/config';Config.setChromiumDisableWebSecurity(true);```-The [command line flag](/docs/cli/render#--disable-web-security) `--disable-web-security` will take precedence over this option.+The [`--disable-web-security`](/docs/options/disable-web-security) flag takes precedence over this option.## `setChromiumDarkMode()`<AvailableFrom v="4.0.381" />@@ -431,7 +431,7 @@ import {Config} from '@remotion/cli/config';Config.setChromiumIgnoreCertificateErrors(true);```-The [command line flag](/docs/cli/render#--ignore-certificate-errors) `--ignore-certificate-errors` will take precedence over this option.+The [`--ignore-certificate-errors`](/docs/options/ignore-certificate-errors) flag takes precedence over this option.## `setChromiumHeadlessMode()`<AvailableFrom v="2.6.5" />@@ -469,7 +469,7 @@ import {Config} from '@remotion/cli/config';Config.setChromeMode('chrome-for-testing');```-The [command line flag](/docs/cli/render#--chrome-mode) `--chrome-mode` will take precedence over this option.+The [`--chrome-mode`](/docs/options/chrome-mode) flag takes precedence over this option.## `setChromiumOpenGlRenderer()`@@ -483,7 +483,7 @@ import {Config} from '@remotion/cli/config';Config.setChromiumOpenGlRenderer('angle');```-The [command line flag](/docs/cli/render#--gl) `--gl` will take precedence over this option.+The [`--gl`](/docs/options/gl) flag takes precedence over this option.## `setConcurrency()`@@ -495,7 +495,7 @@ import {Config} from '@remotion/cli/config';Config.setConcurrency(8);```-The [command line flag](/docs/cli/render#--concurrency) `--concurrency` will take precedence over this option.+The [`--concurrency`](/docs/options/concurrency) flag takes precedence over this option.:::tipTry to set your concurrency to `os.cpus().length` to all the threads available on your CPU for faster rendering. The drawback is that other parts of your system might slow down.@@ -540,7 +540,7 @@ import {Config} from '@remotion/cli/config';Config.setScale(2);```-The [command line flag](/docs/cli/render#--scale) `--scale` will take precedence over this option.+The [`--scale`](/docs/options/scale) flag takes precedence over this option.## `setMuted()`<AvailableFrom v="3.2.1" />@@ -552,7 +552,7 @@ import {Config} from '@remotion/cli/config';Config.setMuted(true);```-The [command line flag](/docs/cli/render#--muted) `--muted` will take precedence over this option.+The [`--muted`](/docs/options/muted) flag takes precedence over this option.## `setDisallowParallelEncoding()`<AvailableFrom v="4.0.315" />@@ -566,7 +566,7 @@ import {Config} from '@remotion/cli/config';Config.setDisallowParallelEncoding(true);```-The [command line flag](/docs/cli/render#--disallow-parallel-encoding) `--disallow-parallel-encoding` will take precedence over this option.+The [`--disallow-parallel-encoding`](/docs/options/disallow-parallel-encoding) flag takes precedence over this option.## `setEnforceAudioTrack()`<AvailableFrom v="3.2.1" />@@ -578,7 +578,7 @@ import {Config} from '@remotion/cli/config';Config.setEnforceAudioTrack(true);```-The [command line flag](/docs/cli/render#--enforce-audio-track) `--enforce-audio-track` will take precedence over this option.+The [`--enforce-audio-track`](/docs/options/enforce-audio-track) flag takes precedence over this option.## `setSampleRate()`<AvailableFrom v="4.0.448" />@@ -590,7 +590,7 @@ import {Config} from '@remotion/cli/config';Config.setSampleRate(44100);```-The [command line flag](/docs/cli/render#--sample-rate) `--sample-rate` will take precedence over this option.+The [`--sample-rate`](/docs/options/sample-rate) flag takes precedence over this option.## `setPreviewSampleRate()`<AvailableFrom v="4.0.470" />@@ -602,7 +602,7 @@ import {Config} from '@remotion/cli/config';Config.setPreviewSampleRate(44100);```-The [command line flag](/docs/cli/studio#--preview-sample-rate) `--preview-sample-rate` will take precedence over this option.+The [`--preview-sample-rate`](/docs/options/preview-sample-rate) flag takes precedence over this option.## `setForSeamlessAacConcatenation()`<AvailableFrom v="4.0.123" />@@ -614,7 +614,7 @@ import {Config} from '@remotion/cli/config';Config.setForSeamlessAacConcatenation(true);```-The [command line flag](/docs/cli/render#--for-seamless-aac-concatenation) `--for-seamless-aac-concatenation` will take precedence over this option.+The [`--for-seamless-aac-concatenation`](/docs/options/for-seamless-aac-concatenation) flag takes precedence over this option.## `setFrameRange()`<AvailableFrom v="2.0.0" />@@ -655,7 +655,7 @@ Config.setFrameRange([]);```-The [command line flag](/docs/cli/render#--frames) `--frames` will take precedence over this option.+The [`--frames`](/docs/options/frames) flag takes precedence over this option.## `setJpegQuality()`@@ -667,7 +667,7 @@ import {Config} from '@remotion/cli/config';Config.setJpegQuality(90);```-The [command line flag](/docs/cli/render#--jpeg-quality) `--jpeg-quality` will take precedence over this option.+The [`--jpeg-quality`](/docs/options/jpeg-quality) flag takes precedence over this option.## `setDotEnvLocation()`@@ -679,7 +679,7 @@ import {Config} from '@remotion/cli/config';Config.setDotEnvLocation('.my-env');```-The [command line flag](/docs/cli/render#--env-file) `--env-file` will take precedence over this option.+The [`--env-file`](/docs/options/env-file) flag takes precedence over this option.## `setEveryNthFrame()`@@ -691,7 +691,7 @@ import {Config} from '@remotion/cli/config';Config.setEveryNthFrame(2);```-The [command line flag](/docs/cli/render#--every-nth-frame) `--every-nth-frame` will take precedence over this option.+The [`--every-nth-frame`](/docs/options/every-nth-frame) flag takes precedence over this option.## `setNumberOfGifLoops()`@@ -703,7 +703,7 @@ import {Config} from '@remotion/cli/config';Config.setNumberOfGifLoops(2);```-The [command line flag](/docs/cli/render#--number-of-gif-loops) `--number-of-gif-loops` will take precedence over this option.+The [`--number-of-gif-loops`](/docs/options/number-of-gif-loops) flag takes precedence over this option.## `setOutputLocation()`<AvailableFrom v="3.1.6" />@@ -741,7 +741,7 @@ import {Config} from '@remotion/cli/config';Config.setPixelFormat('yuv420p');```-The [command line flag](/docs/cli/render#--pixel-format) `--pixel-format` will take precedence over this option.+The [`--pixel-format`](/docs/options/pixel-format) flag takes precedence over this option.## `setCodec()`<AvailableFrom v="1.4.0" />@@ -765,7 +765,7 @@ import {Config} from '@remotion/cli/config';Config.setCodec('h265');```-The [command line flag](/docs/cli/render#--codec) `--codec` will take precedence over this option.+The [`--codec`](/docs/options/codec) flag takes precedence over this option.**See also**: [Encoding guide](/docs/encoding)@@ -784,7 +784,7 @@ Choose the encoding of your audio.- Not all video containers support all audio codecs.- This option takes precedence if the `codec` option also specifies an audio codec.-The [command line flag](/docs/cli/render#--audio-codec) `--audio-codec` will take precedence over this option.+The [`--audio-codec`](/docs/options/audio-codec) flag takes precedence over this option.Refer to the [Encoding guide](/docs/encoding) to see defaults and supported combinations.@@ -798,7 +798,7 @@ import {Config} from '@remotion/cli/config';Config.setProResProfile('4444');```-The [command line flag](/docs/cli/render#--prores-profile) `--prores-profile` will take precedence over this option.+The [`--prores-profile`](/docs/options/prores-profile) flag takes precedence over this option.## `setX264Preset()`<AvailableFrom v="4.2.2" />@@ -812,7 +812,7 @@ import {Config} from '@remotion/cli/config';Config.setX264Preset('fast');```-The [command line flag](/docs/cli/render#--x264-preset) `--x264-preset` will take precedence over this option.+The [`--x264-preset`](/docs/options/x264-preset) flag takes precedence over this option.**See also**: [Encoding guide](/docs/encoding), [Transparent videos](/docs/transparent-videos)@@ -826,7 +826,7 @@ import {Config} from '@remotion/cli/config';Config.setGopSize(239);```-The [command line flag](/docs/cli/render#--gop) `--gop` will take precedence over this option.+The [`--gop`](/docs/options/gop) flag takes precedence over this option.## `setImageSequence()`<AvailableFrom v="1.4.0" />@@ -838,7 +838,7 @@ import {Config} from '@remotion/cli/config';Config.setImageSequence(true);```-The [command line flag](/docs/cli/render#--sequence) `--sequence` will take precedence over this option.+The [`--sequence`](/docs/options/sequence) flag takes precedence over this option.## `overrideHeight()`<AvailableFrom v="3.2.40" />@@ -850,7 +850,7 @@ import {Config} from '@remotion/cli/config';Config.overrideHeight(600);```-The [command line flag](/docs/cli/render#--height) `--height` will take precedence over this option.+The [`--height`](/docs/options/height) flag takes precedence over this option.## `overrideWidth()`<AvailableFrom v="3.2.40" />@@ -862,7 +862,7 @@ import {Config} from '@remotion/cli/config';Config.overrideWidth(900);```-The [command line flag](/docs/cli/render#--width) `--width` will take precedence over this option.+The [`--width`](/docs/options/width) flag takes precedence over this option.## `overrideFps()`<AvailableFrom v="4.0.424" />@@ -874,7 +874,7 @@ import {Config} from '@remotion/cli/config';Config.overrideFps(25);```-The [command line flag](/docs/cli/render#--fps) `--fps` will take precedence over this option.+The [`--fps`](/docs/options/fps) flag takes precedence over this option.## `overrideDuration()`<AvailableFrom v="4.0.424" />@@ -886,7 +886,7 @@ import {Config} from '@remotion/cli/config';Config.overrideDuration(300);```-The [command line flag](/docs/cli/render#--duration) `--duration` will take precedence over this option.+The [`--duration`](/docs/options/duration) flag takes precedence over this option.## `setCrf()`<AvailableFrom v="1.4.0" />@@ -912,7 +912,7 @@ import {Config} from '@remotion/cli/config';Config.setCrf(16);```-The [command line flag](/docs/cli/render#--crf) `--crf` will take precedence over this option.+The [`--crf`](/docs/options/crf) flag takes precedence over this option.:::noteIf you enable [hardware acceleration](/docs/hardware-acceleration), you cannot set a `crf`. Use the [`setVideoBitrate()`](#setvideobitrate) option instead.@@ -930,7 +930,7 @@ import {Config} from '@remotion/cli/config';Config.setVideoBitrate('1M');```-The [command line flag](/docs/cli/render#--video-bitrate) `--video-bitrate` will take precedence over this option.+The [`--video-bitrate`](/docs/options/video-bitrate) flag takes precedence over this option.## `setEncodingBufferSize()`<AvailableFrom v="4.0.78" />@@ -944,7 +944,7 @@ import {Config} from '@remotion/cli/config';Config.setEncodingBufferSize('10000k');```-The [command line flag](/docs/cli/render#--buffer-size) `--buffer-size` will take precedence over this option.+The [`--buffer-size`](/docs/options/buffer-size) flag takes precedence over this option.## `setEncodingMaxRate()`<AvailableFrom v="4.0.78" />@@ -958,7 +958,7 @@ import {Config} from '@remotion/cli/config';Config.setEncodingMaxRate('5000k');```-The [command line flag](/docs/cli/render#--max-rate) `--max-rate` will take precedence over this option.+The [`--max-rate`](/docs/options/max-rate) flag takes precedence over this option.## `setAudioBitrate()`<AvailableFrom v="3.2.32" />@@ -972,7 +972,7 @@ import {Config} from '@remotion/cli/config';Config.setAudioBitrate('128K');```-The [command line flag](/docs/cli/render#--audio-bitrate) `--audio-bitrate` will take precedence over this option.+The [`--audio-bitrate`](/docs/options/audio-bitrate) flag takes precedence over this option.## `setAudioLatencyHint()`<AvailableFrom v="4.0.303" />@@ -986,7 +986,7 @@ import {Config} from '@remotion/cli/config';Config.setAudioLatencyHint('interactive');```-The `--audio-latency-hint` command line flag will take precedence over this option.+The [`--audio-latency-hint`](/docs/options/audio-latency-hint) flag takes precedence over this option.## `setExperimentalKeepAudioContextAlive()`<AvailableFrom v="4.0.508" />@@ -1006,7 +1006,7 @@ import {Config} from '@remotion/cli/config';Config.setExperimentalKeepAudioContextAlive(true);```-Changing this option while the Studio is running reloads the page. The `--experimental-keep-audio-context-alive` command line flag will take precedence over this option.+Changing this option while the Studio is running reloads the page. The [`--experimental-keep-audio-context-alive`](/docs/options/experimental-keep-audio-context-alive) flag takes precedence over this option.## `setEnableFolderExpiry()`<AvailableFrom v="4.0.32" />@@ -1031,7 +1031,7 @@ import {Config} from '@remotion/cli/config';Config.setEnableCancellation(true);```-The `--enable-cancellation` command line flag will take precedence over this option.+The [`--enable-cancellation`](/docs/options/enable-cancellation) flag takes precedence over this option.## `setLambdaInsights()`<AvailableFrom v="4.0.115" />@@ -1069,7 +1069,7 @@ import {Config} from '@remotion/cli/config';Config.setBeepOnFinish(true);```-The [command line flag](/docs/cli/studio#--beep-on-finish) `--beep-on-finish` will take precedence over this option.+The [`--beep-on-finish`](/docs/options/beep-on-finish) flag takes precedence over this option.## `setEnableCrossSiteIsolation()`<AvailableFrom v="4.0.306" />@@ -1083,7 +1083,7 @@ import {Config} from '@remotion/cli/config';Config.setEnableCrossSiteIsolation(true);```-The [command line flag](/docs/cli/studio#--cross-site-isolation) `--cross-site-isolation` will take precedence over this option.+The [`--cross-site-isolation`](/docs/options/cross-site-isolation) flag takes precedence over this option.## `setAskAIEnabled()`<AvailableFrom v="4.0.407" />@@ -1097,7 +1097,7 @@ import {Config} from '@remotion/cli/config';Config.setAskAIEnabled(false);```-The [command line flag](/docs/cli/studio#--disable-ask-ai) `--disable-ask-ai` will take precedence over this option.+The [`--disable-ask-ai`](/docs/options/disable-ask-ai) flag takes precedence over this option.## `setForceNewStudioEnabled()`<AvailableFrom v="4.0.421" />@@ -1111,7 +1111,7 @@ import {Config} from '@remotion/cli/config';Config.setForceNewStudioEnabled(true);```-The [command line flag](/docs/cli/studio#--force-new) `--force-new` will take precedence over this option.+The [`--force-new`](/docs/options/force-new) flag takes precedence over this option.## `setIPv4()`<AvailableFrom v="4.0.125" />@@ -1125,7 +1125,7 @@ import {Config} from '@remotion/cli/config';Config.setIPv4(true);```-The [command line flag](/docs/cli/studio#--ipv4) `--ipv4` will take precedence over this option.+The [`--ipv4`](/docs/options/ipv4) flag takes precedence over this option.## `setBufferStateDelayInMilliseconds()`<AvailableFrom v="4.0.111" />@@ -1220,7 +1220,7 @@ import {Config} from '@remotion/cli/config';Config.setPublicLicenseKey('your-license-key');```-The [command line flag](/docs/cli/studio#--public-license-key) `--public-license-key` will take precedence over this option.+The [`--public-license-key`](/docs/options/public-license-key) flag takes precedence over this option.## `setImageSequencePattern()`@@ -1232,7 +1232,7 @@ import {Config} from '@remotion/cli/config';Config.setImageSequencePattern('frame_[frame]_custom.[ext]');```-The [command line flag](/docs/cli/render#--image-sequence-pattern) `--image-sequence-pattern` will take precedence over this option.+The [`--image-sequence-pattern`](/docs/options/image-sequence-pattern) flag takes precedence over this option.## ~~`setQuality()`~~@@ -1287,7 +1287,7 @@ import {Config} from '@remotion/cli/config';Config.setPort(3003);```-The [command line flag](/docs/cli/render#--port) `--port` will take precedence over this option. If set on `npx remotion studio`, it will set the Studio port, otherwise the renderer port.+The [`--port`](/docs/options/port) flag takes precedence over this option. If set on `npx remotion studio`, it will set the Studio port, otherwise the renderer port.## ~~`setOutputFormat()`~~@@ -1302,7 +1302,7 @@ import {Config} from '@remotion/cli/config';Config.setOutputFormat('mp4');```-The [command line flags](/docs/cli) `--sequence` and `--codec` will take precedence over this option.+The [`--sequence`](/docs/options/sequence) and [`--codec`](/docs/options/codec) flags take precedence over this option.The [command line flag](/docs/cli) `--quality` will take precedence over this option.diff --git a/packages/docs/docs/encoding.mdx b/packages/docs/docs/encoding.mdxindex cfdb6a3f7f..6f651a4101 100644--- a/packages/docs/docs/encoding.mdx+++ b/packages/docs/docs/encoding.mdx@@ -104,11 +104,11 @@ Remotion supports 6 video codecs: `h264` (_default_), `h265`, `vp8`, `vp9`, `av1Click on a browser compatibility link to see exactly which browsers are supported on caniuse.com.:::-* AV1 is not available on [Remotion Lambda](/docs/lambda) or Linux ARM64 GNU.+- AV1 is not available on [Remotion Lambda](/docs/lambda) or Linux ARM64 GNU.AV1 can achieve very small file sizes, but encoding is significantly slower than H.264 and H.265. Some runtimes ship only the essential codecs to stay lean, so `AV1` output is not available on Remotion Lambda or Linux ARM64 GNU.-You can set a config using [`Config.setCodec()` in the config file](/docs/config#setcodec) or the [`--codec`](/docs/cli) CLI flag.+Set the [codec option](/docs/options/codec).[Hardware acceleration](/docs/hardware-acceleration) is available from Remotion 4.0.228.@@ -159,7 +159,7 @@ Be cautious: Every codec has it's own range of acceptable values and a different</tr></table>-You can [set a CRF in the config file using the `Config.setCrf()`](/docs/config#setcrf) function or use the [`--crf`](/docs/cli/render#--jpeg-quality) command line flag.+Set the [CRF option](/docs/options/crf).:::noteIf you enable [hardware acceleration](/docs/hardware-acceleration), you cannot set a `crf`.@@ -167,11 +167,7 @@ If you enable [hardware acceleration](/docs/hardware-acceleration), you cannot s## Controlling quality using `--video-bitrate` and `--audio-bitrate`-Use the following options to set the video and audio bitrate:--- In the Studio: Set video and audio bitrate in the Render Dialog-- In the CLI: Use the [`--video-bitrate`](/docs/cli/render#--video-bitrate) and [`--audio-bitrate`](/docs/cli/render#--audio-bitrate) flags-- In SSR, Lambda and Cloud Run APIs: Use the [`videoBitrate`](/docs/renderer/render-media#videobitrate) and [`audioBitrate`](/docs/renderer/render-media#audiobitrate) options.+Use the [video bitrate](/docs/options/video-bitrate) and [audio bitrate](/docs/options/audio-bitrate) options, or set them in the Studio Render Dialog.This option is incompatible with other quality options.@@ -179,7 +175,7 @@ This option is incompatible with other quality options._Applies only to `prores` codec_.-For ProRes, there is no CRF option, but there are profiles which you can set using the [`--prores-profile` flag](/docs/cli/render#--prores-profile), the [`proResProfile`](/docs/renderer/render-media#proresprofile) render option, or the [`setProResProfile()`](/docs/config#setproresprofile) config file option.+For ProRes, there is no CRF option. Use the [ProRes profile option](/docs/options/prores-profile).See [Rendering ProRes](/docs/prores#choosing-a-prores-profile) for all profile values and alpha channel support.@@ -195,7 +191,7 @@ You can also [render your video as a GIF](/docs/render-as-gif)._available from v3.3.42_-Using the [`--audio-codec`](/docs/config#setaudiocodec) flag, you can set the format of the audio that is embedded in the video. Not all codec and audio codec combinations are supported and certain combinations require a certain file extension and container format.+Using the [`--audio-codec`](/docs/options/audio-codec) flag, you can set the format of the audio that is embedded in the video. Not all codec and audio codec combinations are supported and certain combinations require a certain file extension and container format.The container format will be automatically derived based on the file extension.diff --git a/packages/docs/docs/hardware-acceleration.mdx b/packages/docs/docs/hardware-acceleration.mdxindex c7c313d3e8..fd10b6ea29 100644--- a/packages/docs/docs/hardware-acceleration.mdx+++ b/packages/docs/docs/hardware-acceleration.mdx@@ -24,7 +24,7 @@ If you want the render to fail if hardware acceleration is not possible, set the### In SSR APIs-Use the [`hardwareAcceleration`](/docs/renderer/render-media#hardwareacceleration) option in the [`renderMedia()`](/docs/renderer/render-media) function.+Use the [`hardwareAcceleration`](/docs/options/hardware-acceleration) option in the [`renderMedia()`](/docs/renderer/render-media) function.```tsx twoslash {8}const serveUrl = '/path/to/bundle';@@ -56,7 +56,7 @@ await renderMedia({### In the CLI-Use the [`--hardware-acceleration`](/docs/cli/render#--hardware-acceleration) option in the `npx remotion render` command.+Use the [`--hardware-acceleration`](/docs/options/hardware-acceleration) option in the `npx remotion render` command.```bashnpx remotion render MyComp --codec prores --hardware-acceleration if-possible@@ -103,7 +103,7 @@ We recommend that you use the `--video-bitrate` flag to control the file size.We find that `--video-bitrate=8M` achieves a similar file size than software encoding when exporting a H.264 Full HD video.-The [`crf` option](/docs/encoding#controlling-quality-using-the-crf-setting) is not compatible with hardware-accelerated encoders. Instead, use the [`--video-bitrate`](/docs/cli/render#--video-bitrate) flag to control the quality and file size of the output video.+The [`crf` option](/docs/options/crf) is not compatible with hardware-accelerated encoders. Instead, use the [`--video-bitrate`](/docs/options/video-bitrate) flag to control the quality and file size of the output video.## Tell if hardware acceleration is being useddiff --git a/packages/docs/docs/media/cache.mdx b/packages/docs/docs/media/cache.mdxindex 3d76f8b68a..776335f4e4 100644--- a/packages/docs/docs/media/cache.mdx+++ b/packages/docs/docs/media/cache.mdx@@ -24,26 +24,6 @@ A minimum of 500MB and a maximum of 20GB is enforced.## Customizing the cache size-The rendering APIs allow you to customize the decoded media cache budget on a per-render basis. The same value determines the read cache size for each source:--- [`renderMedia()` β `mediaCacheSizeInBytes`](/docs/renderer/render-media#mediacachesizeinbytes)-- [`renderStill()` β `mediaCacheSizeInBytes`](/docs/renderer/render-still#mediacachesizeinbytes)-- [`selectComposition()` β `mediaCacheSizeInBytes`](/docs/renderer/select-composition#mediacachesizeinbytes)-- [`renderMediaOnCloudRun()` β `mediaCacheSizeInBytes`](/docs/cloudrun/rendermediaoncloudrun#mediacachesizeinbytes)-- [`renderStillOnCloudRun()` β `mediaCacheSizeInBytes`](/docs/cloudrun/renderstilloncloudrun#mediacachesizeinbytes)-- [`getCompositionsOnLambda()` β `mediaCacheSizeInBytes`](/docs/lambda/getcompositionsonlambda#mediacachesizeinbytes)-- [`renderMediaOnLambda()` β `mediaCacheSizeInBytes`](/docs/lambda/rendermediaonlambda#mediacachesizeinbytes)-- [`renderStillOnLambda()` β `mediaCacheSizeInBytes`](/docs/lambda/renderstillonlambda#mediacachesizeinbytes)-- [`getCompositions()` β `mediaCacheSizeInBytes`](/docs/lambda/getcompositionsonlambda#mediacachesizeinbytes)-- [`renderFrames()` β `mediaCacheSizeInBytes`](/docs/renderer/render-frames#mediacachesizeinbytes)-- [`npx remotion benchmark` β `--media-cache-size-in-bytes`](/docs/cli/benchmark#--media-cache-size-in-bytes)-- [`npx remotion compositions` β `--media-cache-size-in-bytes`](/docs/cli/compositions#--media-cache-size-in-bytes)-- [`npx remotion render` β `--media-cache-size-in-bytes`](/docs/cli/render#--media-cache-size-in-bytes)-- [`npx remotion still` β `--media-cache-size-in-bytes`](/docs/cli/still#--media-cache-size-in-bytes)-- [`npx remotion lambda render` β `--media-cache-size-in-bytes`](/docs/lambda/cli/render#--media-cache-size-in-bytes)-- [`npx remotion lambda still` β `--media-cache-size-in-bytes`](/docs/lambda/cli/still#--media-cache-size-in-bytes)-- [`npx remotion lambda compositions` β `--media-cache-size-in-bytes`](/docs/lambda/cli/compositions#--media-cache-size-in-bytes)-- [`npx remotion cloudrun render` β `--media-cache-size-in-bytes`](/docs/cloudrun/cli/render#--media-cache-size-in-bytes)-- [`npx remotion cloudrun still` β `--media-cache-size-in-bytes`](/docs/cloudrun/cli/still#--media-cache-size-in-bytes)-- [`npx remotion cloudrun render` β `--media-cache-size-in-bytes`](/docs/cloudrun/cli/render#--media-cache-size-in-bytes)-- [Remotion Studio](/docs/studio): Set the cache size under the "Advanced" tab+Use the [`mediaCacheSizeInBytes`](/docs/options/media-cache-size-in-bytes) option to customize the decoded media cache budget per render. The same value determines the read cache size for each source.++In [Remotion Studio](/docs/studio), set the cache size under the "Advanced" tab.diff --git a/packages/docs/docs/metadata.mdx b/packages/docs/docs/metadata.mdxindex 7ae25d13b4..5b58006654 100644--- a/packages/docs/docs/metadata.mdx+++ b/packages/docs/docs/metadata.mdx@@ -33,15 +33,7 @@ Input #0, mov,mp4,m4a,3gp,3g2,mj2, from 'bigbuckbunny.mp4':## Adding metadata<AvailableFrom v="4.0.216" />-You can set metadata when rendering videos with Remotion using--- [`--metadata`](/docs/cli/render#--metadata) in `npx remotion render`-- [`--metadata`](/docs/lambda/cli/render#--metadata) in `npx remotion lambda render`-- [`--metadata`](/docs/cloudrun/cli/render#--metadata) in `npx remotion cloudrun render`-- [`metadata`](/docs/renderer/render-media#metadata) in `renderMedia()`-- [`metadata`](/docs/web-renderer/render-media-on-web#metadata) in [`renderMediaOnWeb()`](/docs/web-renderer/render-media-on-web) <AvailableFrom v="4.0.517" inline />-- [`metadata`](/docs/lambda/rendermediaonlambda) in `renderMediaOnLambda()`-- [`metadata`](/docs/cloudrun/rendermediaoncloudrun) in `renderMediaOnCloudrun()`+Use the [`metadata`](/docs/options/metadata) option when rendering videos with Remotion. Supported in [`renderMediaOnWeb()`](/docs/web-renderer/render-media-on-web#metadata) from <AvailableFrom v="4.0.517" inline />.## Accepted metadatadiff --git a/packages/docs/docs/miscellaneous/linux-single-process.mdx b/packages/docs/docs/miscellaneous/linux-single-process.mdxindex 08cd2315c8..3c6b5c3648 100644--- a/packages/docs/docs/miscellaneous/linux-single-process.mdx+++ b/packages/docs/docs/miscellaneous/linux-single-process.mdx@@ -24,8 +24,8 @@ _available from v4.0.42_Enabled by default. To disable multi-process mode for Chromium during rendering on Linux:-- **renderMedia()** / **openBrowser()** / **renderFrames()**: Use the [`chromiumOptions.enableMultiProcessOnLinux`](/docs/renderer/render-media#enablemultiprocessonlinux) option.-- **CLI**: Use the [`--enable-multi-process-on-linux=false`](/docs/cli/render#--enable-multiprocess-on-linux) flag.+- **renderMedia()** / **openBrowser()** / **renderFrames()**: Use the [`chromiumOptions.enableMultiProcessOnLinux`](/docs/options/enable-multiprocess-on-linux) option.+- **CLI**: Use the [`--enable-multi-process-on-linux=false`](/docs/options/enable-multiprocess-on-linux) flag.- **Config file**: Use the [`Config.setChromiumMultiProcessInLinux()`](/docs/config#setchromiummultiprocessonlinux) option.- **Remotion Studio**: Check the toggle in the advanced settings.- **Cloud Run**: From v4.0.42, this option is automatically enabled.diff --git a/packages/docs/docs/performance.mdx b/packages/docs/docs/performance.mdxindex d3e055006d..8c4ed65a80 100644--- a/packages/docs/docs/performance.mdx+++ b/packages/docs/docs/performance.mdx@@ -20,7 +20,7 @@ See: [Comparison of video tags](/docs/video-tags)## Concurrency-The `--concurrency` flag you set can influence the rendering speed both positively and negatively. A concurrency too high and a concurrency too low can both be coutnerproductive. Use the [`npx remotion benchmark`](/docs/cli/benchmark) command to find the optimal concurrency.+The [`--concurrency`](/docs/options/concurrency) flag can increase or decrease rendering speed. Use the [`npx remotion benchmark`](/docs/cli/benchmark) command to find the optimal concurrency.## GPU effects@@ -57,7 +57,7 @@ See also the [Encoding guide](/docs/encoding) to see all tradeoffs when it comes## Resolution-Higher resolutions will make the render slower. If you can live with a lower resolution, scale down the picture using [`--scale`](/docs/cli/render#--scale)+Higher resolutions will make the render slower. If you can live with a lower resolution, scale down the picture using [`--scale`](/docs/options/scale)## Considerations for Lambdadiff --git a/packages/docs/docs/prores.mdx b/packages/docs/docs/prores.mdxindex 2ec7bb11ce..f727f5517c 100644--- a/packages/docs/docs/prores.mdx+++ b/packages/docs/docs/prores.mdx@@ -53,7 +53,7 @@ You can also return `defaultCodec: "prores"` from [`calculateMetadata()`](/docs/## Choosing a ProRes profile-Use the [`--prores-profile`](/docs/cli/render#--prores-profile) CLI flag, the [`proResProfile`](/docs/renderer/render-media#proresprofile) option, [`Config.setProResProfile()`](/docs/config#setproresprofile), or `defaultProResProfile` from [`calculateMetadata()`](/docs/calculate-metadata).+Use the [ProRes profile option](/docs/options/prores-profile), or `defaultProResProfile` from [`calculateMetadata()`](/docs/calculate-metadata).```bash title="Terminal"npx remotion render MyComp out/video.mov --codec=prores --prores-profile=hq@@ -85,7 +85,7 @@ await renderMedia({| `"4444-xq"` | `5` | 500 Mbps | Yes |Higher profiles produce larger files.-ProRes does not support [`crf`](/docs/cli/render#--crf), and [`videoBitrate`](/docs/cli/render#--video-bitrate) is ignored.+ProRes does not support [`crf`](/docs/options/crf), and [`videoBitrate`](/docs/options/video-bitrate) is ignored.## Transparent ProResdiff --git a/packages/docs/docs/quality.mdx b/packages/docs/docs/quality.mdxindex a28ab44b24..a6000857f2 100644--- a/packages/docs/docs/quality.mdx+++ b/packages/docs/docs/quality.mdx@@ -10,11 +10,11 @@ This document explains a few factors and settings that can be used to control th## CRF-The main setting to control the quality of the video is the [Constant Rate Factor (CRF)](/docs/encoding/#controlling-quality-using-the-crf-setting).+The main setting to control the quality of the video is the [Constant Rate Factor (CRF)](/docs/options/crf).All ways to render a video in Remotion allow passing a CRF value. Allowed values depend on the codec.:::note-If you enable [hardware acceleration](/docs/hardware-acceleration), you cannot set a `crf`. Use the [`--video-bitrate`](/docs/cli/render#--video-bitrate) option instead.+If you enable [hardware acceleration](/docs/hardware-acceleration), you cannot set a `crf`. Use the [`--video-bitrate`](/docs/options/video-bitrate) option instead.:::## Resolution (Unsharp text)@@ -54,17 +54,17 @@ You will have a less sharp text if the video is displayed on a high-density dispThis is because the device has a 2x pixel density, but the video is 1920x1080, which means that each pixel is 2x bigger than the device's pixel.To display the font with the same sharpness as on a low-density display, you would need to render a 4K video.-Use [Output Scaling](/docs/scaling) to render the video with a higher pixel density.+Use [Output Scaling](/docs/options/scale) to render the video with a higher pixel density.## JPEG QualityRemotion makes screenshots of the browser page by default in JPEG format.The JPEG quality by default is 80 (on a scale of 0 to 100).-You may tweak it using the [`--jpeg-quality`](/docs/cli/render#--jpeg-quality) flag or switch to PNG as the image format using [`--image-format=png`](/docs/cli/render#--image-format) (slower).+You may tweak it using the [`--jpeg-quality`](/docs/options/jpeg-quality) flag or switch to PNG as the image format using [`--image-format=png`](/docs/options/video-image-format) (slower).## Color accuracy-Export your video in [`bt709`](/docs/cli/render#--color-space) for more accurate colors.+Export your video in [`bt709`](/docs/options/color-space) for more accurate colors.:::noteThis will become the default in Remotion 5.0.@@ -77,9 +77,9 @@ GIFs only support a 256 colors palette, which leads to a big quality loss. Embra## Video bitrate-You can use the [`--video-bitrate`](/docs/cli/render#--video-bitrate) flag to control the bitrate of the video.-It is mutually exclusive with [`--crf`](/docs/cli/render#--crf) option, which means you can not use both at the same time.+You can use the [`--video-bitrate`](/docs/options/video-bitrate) flag to control the bitrate of the video.+It is mutually exclusive with [`--crf`](/docs/options/crf) option, which means you can not use both at the same time.## x264 Preset-When exporting a H.264 video, you can use the [`--x264-preset`](/docs/cli/render#--x264-preset) flag to control the quality/speed/compression tradeoff.+When exporting a H.264 video, you can use the [`--x264-preset`](/docs/options/x264-preset) flag to control the quality/speed/compression tradeoff.diff --git a/packages/docs/docs/scaling.mdx b/packages/docs/docs/scaling.mdxindex 9e6de43813..64073ffe74 100644--- a/packages/docs/docs/scaling.mdx+++ b/packages/docs/docs/scaling.mdx@@ -18,9 +18,8 @@ Remotion can support this higher resolution by:## How to scale-- In the CLI, during a render of a video or a still, pass the [`--scale`](/docs/cli/render#--scale) flag. For example: `--scale=2`-- In the Node.JS functions [`renderStill()`](/docs/renderer/render-still#scale), [`renderFrames()`](/docs/renderer/render-frames#scale), [`renderStillOnLambda()`](/docs/lambda/renderstillonlambda) and [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda), [`renderMediaOnVercel()`](/docs/vercel/render-media-on-vercel#scale) and [`renderStillOnVercel()`](/docs/vercel/render-still-on-vercel#scale), [`renderMediaOnCloudRun()`](/docs/cloudrun/rendermediaoncloudrun), [`renderStillOnCloudRun()`](/docs/cloudrun/renderstilloncloudrun), you can pass a `scale` option.-- In the client-side rendering functions [`renderMediaOnWeb()`](/docs/renderer/render-media#scale), [`renderStillOnWeb()`](/docs/renderer/render-still#scale), you can pass a `scale` option.+- In the CLI, pass the [`--scale`](/docs/options/scale) flag. For example: `--scale=2`+- In rendering APIs, pass the [`scale` option](/docs/options/scale), including in [`renderMediaOnVercel()`](/docs/vercel/render-media-on-vercel#scale) and [`renderStillOnVercel()`](/docs/vercel/render-still-on-vercel#scale).- In the [config file](/docs/config), you can pass the scale using the following statement:```ts twoslashdiff --git a/packages/docs/docs/timeout.mdx b/packages/docs/docs/timeout.mdxindex fd9e8c6564..cb88f0cac8 100644--- a/packages/docs/docs/timeout.mdx+++ b/packages/docs/docs/timeout.mdx@@ -68,8 +68,8 @@ Sometimes, you cannot avoid a frame taking longer than 30 seconds to render. ForYou can increase the default timeout:- In the Remotion Studio render dialog under "Advanced"-- Using the [`--timeout`](/docs/cli/render#--timeout) CLI flag-- Using the `timeoutInMilliseconds` option in [`renderStill()`](/docs/renderer/render-still#timeoutinmilliseconds), [`renderFrames()`](/docs/renderer/render-frames#timeoutinmilliseconds), [`getCompositions()`](/docs/renderer/get-compositions#timeoutinmilliseconds), [`renderMedia()`](/docs/renderer/render-media#timeoutinmilliseconds), [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#timeoutinmilliseconds), [`renderStillOnLambda()`](/docs/lambda/renderstillonlambda#timeoutinmilliseconds), [`renderMediaOnVercel()`](/docs/vercel/render-media-on-vercel#timeoutinmilliseconds), [`renderStillOnVercel()`](/docs/vercel/render-still-on-vercel#timeoutinmilliseconds), [`renderStillOnCloudRun()`](/docs/cloudrun/renderstilloncloudrun#delayrendertimeoutinmilliseconds) and [`renderMediaOnCloudRun()`](/docs/cloudrun/rendermediaoncloudrun#delayrendertimeoutinmilliseconds)+- Using the [timeout option](/docs/options/timeout) in CLI or API renders+- Using `timeoutInMilliseconds` in [`renderMediaOnVercel()`](/docs/vercel/render-media-on-vercel#timeoutinmilliseconds) and [`renderStillOnVercel()`](/docs/vercel/render-still-on-vercel#timeoutinmilliseconds), or `delayRenderTimeoutInMilliseconds` in [`renderStillOnCloudRun()`](/docs/cloudrun/renderstilloncloudrun#delayrendertimeoutinmilliseconds) and [`renderMediaOnCloudRun()`](/docs/cloudrun/rendermediaoncloudrun#delayrendertimeoutinmilliseconds)- Using the [`Config.setDelayRenderTimeoutInMilliseconds()`](/docs/config#setdelayrendertimeoutinmilliseconds) option in the config file, if you render on the CLI- Individually for a [`delayRender()`](/docs/delay-render) call using the [`timeoutInMilliseconds`](/docs/delay-render#modifying-the-timeout) option<AvailableFrom v="4.0.140"/>- The [`<Img>`](/docs/img#delayrendertimeoutinmilliseconds), [`<Audio>`](/docs/media/audio#delayrendertimeoutinmilliseconds), [`<Video>`](/docs/media/video#delayrendertimeoutinmilliseconds), [`<Html5Audio>`](/docs/html5-audio#delayrendertimeoutinmilliseconds), [`<Html5Video>`](/docs/html5-video#delayrendertimeoutinmilliseconds) and [`<IFrame>`](/docs/iframe#delayrendertimeoutinmilliseconds) tags support a `delayRenderTimeoutInMilliseconds` prop to control the value of `timeoutInMilliseconds` for the `delayRender()` call that those components make<AvailableFrom v="4.0.140"/>diff --git a/packages/docs/docs/troubleshooting/delay-render-proxy.mdx b/packages/docs/docs/troubleshooting/delay-render-proxy.mdxindex d07562eae8..c6302a3f2a 100644--- a/packages/docs/docs/troubleshooting/delay-render-proxy.mdx+++ b/packages/docs/docs/troubleshooting/delay-render-proxy.mdx@@ -11,7 +11,7 @@ The error message `A delayRender() "Loading <Img> with src=http://localhost:3000A delayRender() "Loading <Img> with src=http://localhost:3000/proxy?src=http%3A%2F%2Flocalhost%3A3000%2Fpublic%2Fbackground.mp4&time=683.45&transparent=false" was called but not cleared after 28000ms. See https://remotion.dev/docs/timeout for help```-occurs when loading an [`<OffthreadVideo>`](/docs/offthreadvideo) and the frame cannot be extracted within the [timeout](/docs/cli/render#--timeout).+occurs when loading an [`<OffthreadVideo>`](/docs/offthreadvideo) and the frame cannot be extracted within the [timeout](/docs/options/timeout).To be able to extract a frame, `<OffthreadVideo>` needs to:diff --git a/packages/docs/docs/troubleshooting/no-frame-found-at-position.mdx b/packages/docs/docs/troubleshooting/no-frame-found-at-position.mdxindex 6577c78b8b..c430dc51c4 100644--- a/packages/docs/docs/troubleshooting/no-frame-found-at-position.mdx+++ b/packages/docs/docs/troubleshooting/no-frame-found-at-position.mdx@@ -18,7 +18,7 @@ It means that the cache which is kept for serving frames for [`<OffthreadVideo>`The most likely cause is that the memory available for the OffthreadVideo cache is too small and any frames that are being extracted are being evicted from the cache immediately.-Consider increasing the memory available of your machine, or allowing the OffthreadVideo cache to be bigger by setting the [`offthreadVideoCacheSizeInBytes`](/docs/renderer/render-media#offthreadvideocachesizeinbytes) prop to a higher value. Only set this to a value that is lower than the memory actually available, otherwise the system might kill the process.+Consider increasing the memory available of your machine, or allowing the OffthreadVideo cache to be bigger by setting the [`offthreadVideoCacheSizeInBytes`](/docs/options/offthreadvideo-cache-size-in-bytes) prop to a higher value. Only set this to a value that is lower than the memory actually available, otherwise the system might kill the process.## Video has a gapdiff --git a/packages/docs/docs/troubleshooting/sigkill.mdx b/packages/docs/docs/troubleshooting/sigkill.mdxindex 9746fc137e..260c1f8408 100644--- a/packages/docs/docs/troubleshooting/sigkill.mdx+++ b/packages/docs/docs/troubleshooting/sigkill.mdx@@ -30,7 +30,7 @@ The same goes for the FFmpeg process.## Lower the memory usage of Remotion-You can decrease the cache size of Remotion using the [`offthreadVideoCacheSizeInBytes`](/docs/renderer/select-composition#offthreadvideocachesizeinbytes).+You can decrease the cache size of Remotion using the [`offthreadVideoCacheSizeInBytes`](/docs/options/offthreadvideo-cache-size-in-bytes).## Ensure your Remotion version is up to date@@ -43,7 +43,7 @@ Set a lower [`concurrency`](/docs/terminology/concurrency) to open less browser## Disallow parallel encoding-H.264 and H.265 videos are encoded while frames are still being rendered, so the browser and FFmpeg need memory at the same time. Use [`--disallow-parallel-encoding`](/docs/cli/render#--disallow-parallel-encoding) or [`disallowParallelEncoding`](/docs/renderer/render-media#disallowparallelencoding) to only start encoding once all frames are rendered. This lowers the peak memory usage, but makes rendering slower.+H.264 and H.265 videos are encoded while frames are still being rendered, so the browser and FFmpeg need memory at the same time. Use the [`disallowParallelEncoding` option](/docs/options/disallow-parallel-encoding) to only start encoding once all frames are rendered. This lowers the peak memory usage, but makes rendering slower.## Allocate more memory to your systemdiff --git a/packages/docs/docs/troubleshooting/timed-out-page-function.mdx b/packages/docs/docs/troubleshooting/timed-out-page-function.mdxindex 0a6588d8e9..e51d5833b3 100644--- a/packages/docs/docs/troubleshooting/timed-out-page-function.mdx+++ b/packages/docs/docs/troubleshooting/timed-out-page-function.mdx@@ -13,15 +13,15 @@ Error: Timed out evaluating page function (f, c) => {}```-generally happens if the Remotion renderer is trying to send a JavaScript command to the browser, but the browser does not respond to it within the timeout (before `v4.0.73`: 5 second, from `v4.0.73`: the [`--timeout`](/docs/cli/render#--timeout) flag, by default 30 seconds).+generally happens if the Remotion renderer is trying to send a JavaScript command to the browser, but the browser does not respond to it within the timeout (before `v4.0.73`: 5 second, from `v4.0.73`: the [`--timeout`](/docs/options/timeout) flag, by default 30 seconds).This means that the browser is hanging due to CPU and memory overload. It does not imply that a [`delayRender()`](/docs/delay-render) was not cleared.To resolve this, consider:-- Decreasing the [`--concurrency`](/docs/cli/render#--concurrency) of the render+- Decreasing the [`--concurrency`](/docs/options/concurrency) of the render- Measuring memory and CPU usage of your render and adding more resources to it-- Increasing the [`--timeout`](/docs/cli/render#--timeout) flag+- Increasing the [`--timeout`](/docs/options/timeout) flag- Looking for ways to speed up your JavaScript code- Watch out for infinite loops in your code and [debug your render](/docs/troubleshooting/debug-failed-render)diff --git a/packages/docs/docs/troubleshooting/webgl2-context.mdx b/packages/docs/docs/troubleshooting/webgl2-context.mdxindex 45a394b683..f170d78e2d 100644--- a/packages/docs/docs/troubleshooting/webgl2-context.mdx+++ b/packages/docs/docs/troubleshooting/webgl2-context.mdx@@ -17,7 +17,7 @@ Enable the ANGLE OpenGL backend so Chromium can create a WebGL context.### CLI-Pass [`--gl=angle`](/docs/cli/render#--gl) to your render command:+Pass [`--gl=angle`](/docs/options/gl) to your render command:```bashnpx remotion render MyComp out/video.mp4 --gl=angle@@ -33,7 +33,7 @@ Config.setChromiumOpenGlRenderer('angle');### Server-side rendering APIs-Pass `gl: "angle"` in [`chromiumOptions`](/docs/renderer/render-media#gl):+Pass [`gl: "angle"`](/docs/options/gl) in `chromiumOptions`:```tsx twoslashconst serveUrl = '/path/to/bundle';@@ -57,7 +57,7 @@ await renderMedia({});```-This applies to [`renderMedia()`](/docs/renderer/render-media), [`renderStill()`](/docs/renderer/render-still), [`renderFrames()`](/docs/renderer/render-frames), [`getCompositions()`](/docs/renderer/get-compositions), and the [Lambda](/docs/lambda/rendermediaonlambda) and [Vercel](/docs/vercel/render-media-on-vercel) equivalents.+This also applies to [`getCompositions()`](/docs/renderer/get-compositions) and the [Lambda](/docs/lambda/rendermediaonlambda) and [Vercel](/docs/vercel/render-media-on-vercel) APIs.### Remotion Studio@@ -65,11 +65,11 @@ When rendering from the Studio UI, open the render modal, expand **Advanced**, a## Machines without a GPU-If you are on a machine without a GPU (for example AWS Lambda), use [`--gl=swangle`](/docs/gl-options) instead. This is the default on Lambda.+If you are on a machine without a GPU (for example AWS Lambda), use [`--gl=swangle`](/docs/options/gl) instead. This is the default on Lambda.## Related- [OpenGL renderer backends](/docs/gl-options)-- [`--gl` Chromium flag](/docs/chromium-flags#--gl)+- [`--gl` option](/docs/options/gl)- [GPU rendering](/docs/gpu)- [`<HtmlInCanvas>` rendering guide](/docs/html-in-canvas#rendering)diff --git a/packages/docs/docs/webgl.mdx b/packages/docs/docs/webgl.mdxindex 643b85bc0f..7675fef594 100644--- a/packages/docs/docs/webgl.mdx+++ b/packages/docs/docs/webgl.mdx@@ -27,4 +27,4 @@ import {Config} from '@remotion/cli/config';Config.setChromiumOpenGlRenderer('angle');```-See [`Config.setChromiumOpenGlRenderer()`](/docs/config#setchromiumopenglrenderer) and the [`--gl` flag reference](/docs/gl-options) for more renderer options.+See the [`--gl` option](/docs/options/gl) for available renderers.