Skip to content

🎥 Make videos programmatically with React

Docs: Simplify option API links and show config examples

Jonny Burger93fd508a6e09
diff --git a/packages/docs/docs/config.mdx b/packages/docs/docs/config.mdx
index 143d709024..40be139a35 100644
--- a/packages/docs/docs/config.mdx
+++ b/packages/docs/docs/config.mdx
@@ -282,6 +282,12 @@ The [`--disable-canvas-tabs`](/docs/options/disable-canvas-tabs) flag takes prec
<Options id="editor" />
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setDefaultEditor('cursor');
+```
+
See [Opening files in a code editor](/docs/studio/open-in-editor) for built-in editor IDs, custom editor configuration, and platform support.
## `setDefaultCodingAgent()`<AvailableFrom v="4.0.506" />
diff --git a/packages/docs/docs/options/allow-html-in-canvas.mdx b/packages/docs/docs/options/allow-html-in-canvas.mdx
index c7d80c2d49..0a9aff096f 100644
--- a/packages/docs/docs/options/allow-html-in-canvas.mdx
+++ b/packages/docs/docs/options/allow-html-in-canvas.mdx
@@ -18,15 +18,20 @@ Use `--allow-html-in-canvas` with the following commands. Follow a command link
| ------------------------------------- | ------------------------ |
| [`remotion studio`](/docs/cli/studio) | `--allow-html-in-canvas` |
-## API and configuration references
+## APIs that have this option
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
+The following APIs accept this option:
-| Reference | Name |
-| -------------------------------------------------------------------------------- | -------------------------------------- |
-| [Configuration file](/docs/config#setallowhtmlincanvasenabled) | `Config.setAllowHtmlInCanvasEnabled()` |
-| [`renderMediaOnWeb()`](/docs/web-renderer/render-media-on-web#allowhtmlincanvas) | `allowHtmlInCanvas` |
-| [`renderStillOnWeb()`](/docs/web-renderer/render-still-on-web#allowhtmlincanvas) | `allowHtmlInCanvas` |
+- [`renderMediaOnWeb()`](/docs/web-renderer/render-media-on-web#allowhtmlincanvas)
+- [`renderStillOnWeb()`](/docs/web-renderer/render-still-on-web#allowhtmlincanvas)
+
+## Config file
+
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setAllowHtmlInCanvasEnabled(true);
+```
## See also
diff --git a/packages/docs/docs/options/api-key.mdx b/packages/docs/docs/options/api-key.mdx
index 7ef666a754..f2288a7201 100644
--- a/packages/docs/docs/options/api-key.mdx
+++ b/packages/docs/docs/options/api-key.mdx
@@ -10,15 +10,13 @@ custom_edit_url: https://github.com/remotion-dev/remotion/edit/main/packages/ren
API key for sending a usage event using `@remotion/licensing`.
-## API and configuration references
+## APIs that have this option
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
+The following APIs accept this option:
-| Reference | Name |
-| ------------------------------------------------------------------ | --------------------- |
-| [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#apikey) | `apiKey` (deprecated) |
-| [`renderMedia()`](/docs/renderer/render-media#apikey) | `apiKey` (deprecated) |
-| [`renderStill()`](/docs/renderer/render-still#apikey) | `apiKey` (deprecated) |
+- [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#apikey) (deprecated)
+- [`renderMedia()`](/docs/renderer/render-media#apikey) (deprecated)
+- [`renderStill()`](/docs/renderer/render-still#apikey) (deprecated)
## See also
diff --git a/packages/docs/docs/options/audio-bitrate.mdx b/packages/docs/docs/options/audio-bitrate.mdx
index b9bcec03d2..ce61c2e8ad 100644
--- a/packages/docs/docs/options/audio-bitrate.mdx
+++ b/packages/docs/docs/options/audio-bitrate.mdx
@@ -22,21 +22,26 @@ Use `--audio-bitrate` with the following commands. Follow a command link for its
| [`remotion lambda render`](/docs/lambda/cli/render) | `--audio-bitrate <value>` |
| [`remotion cloudrun render`](/docs/cloudrun/cli/render) | `--audio-bitrate <value>` |
-## API and configuration references
-
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
-
-| Reference | Name |
-| ----------------------------------------------------------------------------------------- | -------------------------- |
-| [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#audiobitrate) | `audioBitrate` |
-| [Configuration file](/docs/config#setaudiobitrate) | `Config.setAudioBitrate()` |
-| [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#audiobitrate) | `audioBitrate` |
-| [`combineChunks()`](/docs/renderer/combine-chunks#audiobitrate) | `audioBitrate` |
-| [`renderMedia()`](/docs/renderer/render-media#audiobitrate) | `audioBitrate` |
-| [`stitchFramesToVideo()`](/docs/renderer/stitch-frames-to-video#audiobitrate) | `audioBitrate` |
-| [`canRenderMediaOnWeb()`](/docs/web-renderer/can-render-media-on-web#audiobitrate) | `audioBitrate` |
-| [`getEncodableAudioCodecs()`](/docs/web-renderer/get-encodable-audio-codecs#audiobitrate) | `options.audioBitrate` |
-| [`renderMediaOnWeb()`](/docs/web-renderer/render-media-on-web#audiobitrate) | `audioBitrate` |
+## APIs that have this option
+
+The following APIs accept this option:
+
+- [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#audiobitrate)
+- [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#audiobitrate)
+- [`combineChunks()`](/docs/renderer/combine-chunks#audiobitrate)
+- [`renderMedia()`](/docs/renderer/render-media#audiobitrate)
+- [`stitchFramesToVideo()`](/docs/renderer/stitch-frames-to-video#audiobitrate)
+- [`canRenderMediaOnWeb()`](/docs/web-renderer/can-render-media-on-web#audiobitrate)
+- [`getEncodableAudioCodecs()`](/docs/web-renderer/get-encodable-audio-codecs#audiobitrate)
+- [`renderMediaOnWeb()`](/docs/web-renderer/render-media-on-web#audiobitrate)
+
+## Config file
+
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setAudioBitrate('128K');
+```
## See also
diff --git a/packages/docs/docs/options/audio-codec.mdx b/packages/docs/docs/options/audio-codec.mdx
index 843b0e5339..916f5e1196 100644
--- a/packages/docs/docs/options/audio-codec.mdx
+++ b/packages/docs/docs/options/audio-codec.mdx
@@ -21,20 +21,25 @@ Use `--audio-codec` with the following commands. Follow a command link for its s
| [`remotion lambda render`](/docs/lambda/cli/render) | `--audio-codec <value>` |
| [`remotion cloudrun render`](/docs/cloudrun/cli/render) | `--audio-codec <value>` |
-## API and configuration references
-
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
-
-| Reference | Name |
-| -------------------------------------------------------------------------------- | ------------------------ |
-| [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#audiocodec) | `audioCodec` |
-| [Configuration file](/docs/config#setaudiocodec) | `Config.setAudioCodec()` |
-| [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#audiocodec) | `audioCodec` |
-| [`combineChunks()`](/docs/renderer/combine-chunks#audiocodec) | `audioCodec` |
-| [`renderMedia()`](/docs/renderer/render-media#audiocodec) | `audioCodec` |
-| [`stitchFramesToVideo()`](/docs/renderer/stitch-frames-to-video#audiocodec) | `audioCodec` |
-| [`canRenderMediaOnWeb()`](/docs/web-renderer/can-render-media-on-web#audiocodec) | `audioCodec` |
-| [`renderMediaOnWeb()`](/docs/web-renderer/render-media-on-web#audiocodec) | `audioCodec` |
+## APIs that have this option
+
+The following APIs accept this option:
+
+- [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#audiocodec)
+- [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#audiocodec)
+- [`combineChunks()`](/docs/renderer/combine-chunks#audiocodec)
+- [`renderMedia()`](/docs/renderer/render-media#audiocodec)
+- [`stitchFramesToVideo()`](/docs/renderer/stitch-frames-to-video#audiocodec)
+- [`canRenderMediaOnWeb()`](/docs/web-renderer/can-render-media-on-web#audiocodec)
+- [`renderMediaOnWeb()`](/docs/web-renderer/render-media-on-web#audiocodec)
+
+## Config file
+
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setAudioCodec('pcm-16');
+```
## See also
diff --git a/packages/docs/docs/options/audio-latency-hint.mdx b/packages/docs/docs/options/audio-latency-hint.mdx
index cb2b3726b6..94c53e3bb9 100644
--- a/packages/docs/docs/options/audio-latency-hint.mdx
+++ b/packages/docs/docs/options/audio-latency-hint.mdx
@@ -22,13 +22,13 @@ Use `--audio-latency-hint` with the following commands. Follow a command link fo
| [`remotion compositions`](/docs/cli/compositions) | `--audio-latency-hint <value>` |
| [`remotion bundle`](/docs/cli/bundle) | `--audio-latency-hint <value>` |
-## API and configuration references
+## Config file
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
-
-| Reference | Name |
-| ------------------------------------------------------ | ------------------------------ |
-| [Configuration file](/docs/config#setaudiolatencyhint) | `Config.setAudioLatencyHint()` |
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setAudioLatencyHint('interactive');
+```
## See also
diff --git a/packages/docs/docs/options/beep-on-finish.mdx b/packages/docs/docs/options/beep-on-finish.mdx
index ffe2f3f608..2864b87c94 100644
--- a/packages/docs/docs/options/beep-on-finish.mdx
+++ b/packages/docs/docs/options/beep-on-finish.mdx
@@ -18,13 +18,13 @@ Use `--beep-on-finish` with the following commands. Follow a command link for it
| ------------------------------------- | ------------------ |
| [`remotion studio`](/docs/cli/studio) | `--beep-on-finish` |
-## API and configuration references
+## Config file
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
-
-| Reference | Name |
-| -------------------------------------------------- | -------------------------- |
-| [Configuration file](/docs/config#setbeeponfinish) | `Config.setBeepOnFinish()` |
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setBeepOnFinish(true);
+```
## See also
diff --git a/packages/docs/docs/options/binaries-directory.mdx b/packages/docs/docs/options/binaries-directory.mdx
index aaae467ac3..3d89a30990 100644
--- a/packages/docs/docs/options/binaries-directory.mdx
+++ b/packages/docs/docs/options/binaries-directory.mdx
@@ -26,23 +26,28 @@ Use `--binaries-directory` with the following commands. Follow a command link fo
| [`remotion cloudrun render`](/docs/cloudrun/cli/render) | `--binaries-directory <value>` |
| [`remotion cloudrun still`](/docs/cloudrun/cli/still) | `--binaries-directory <value>` |
-## API and configuration references
-
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
-
-| Reference | Name |
-| ---------------------------------------------------------------------------------- | ------------------------------- |
-| [Configuration file](/docs/config#setbinariesdirectory) | `Config.setBinariesDirectory()` |
-| [`combineChunks()`](/docs/renderer/combine-chunks#binariesdirectory) | `binariesDirectory` |
-| [`extractAudio()`](/docs/renderer/extract-audio#binariesdirectory) | `binariesDirectory` |
-| [`getCompositions()`](/docs/renderer/get-compositions#binariesdirectory) | `binariesDirectory` |
-| [`getSilentParts()`](/docs/renderer/get-silent-parts#binariesdirectory) | `binariesDirectory` |
-| [`getVideoMetadata()`](/docs/renderer/get-video-metadata#binariesdirectory) | `binariesDirectory` |
-| [`renderFrames()`](/docs/renderer/render-frames#binariesdirectory) | `binariesDirectory` |
-| [`renderMedia()`](/docs/renderer/render-media#binariesdirectory) | `binariesDirectory` |
-| [`renderStill()`](/docs/renderer/render-still#binariesdirectory) | `binariesDirectory` |
-| [`selectComposition()`](/docs/renderer/select-composition#binariesdirectory) | `binariesDirectory` |
-| [`stitchFramesToVideo()`](/docs/renderer/stitch-frames-to-video#binariesdirectory) | `binariesDirectory` |
+## APIs that have this option
+
+The following APIs accept this option:
+
+- [`combineChunks()`](/docs/renderer/combine-chunks#binariesdirectory)
+- [`extractAudio()`](/docs/renderer/extract-audio#binariesdirectory)
+- [`getCompositions()`](/docs/renderer/get-compositions#binariesdirectory)
+- [`getSilentParts()`](/docs/renderer/get-silent-parts#binariesdirectory)
+- [`getVideoMetadata()`](/docs/renderer/get-video-metadata#binariesdirectory)
+- [`renderFrames()`](/docs/renderer/render-frames#binariesdirectory)
+- [`renderMedia()`](/docs/renderer/render-media#binariesdirectory)
+- [`renderStill()`](/docs/renderer/render-still#binariesdirectory)
+- [`selectComposition()`](/docs/renderer/select-composition#binariesdirectory)
+- [`stitchFramesToVideo()`](/docs/renderer/stitch-frames-to-video#binariesdirectory)
+
+## Config file
+
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setBinariesDirectory('/path/to/custom/directory');
+```
## See also
diff --git a/packages/docs/docs/options/browser-executable.mdx b/packages/docs/docs/options/browser-executable.mdx
index 20fc1db739..5c43503594 100644
--- a/packages/docs/docs/options/browser-executable.mdx
+++ b/packages/docs/docs/options/browser-executable.mdx
@@ -28,20 +28,25 @@ Use `--browser-executable` with the following commands. Follow a command link fo
| [`remotion cloudrun render`](/docs/cloudrun/cli/render) | `--browser-executable <value>` |
| [`remotion cloudrun still`](/docs/cloudrun/cli/still) | `--browser-executable <value>` |
-## API and configuration references
-
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
-
-| Reference | Name |
-| ---------------------------------------------------------------------------- | ------------------------------- |
-| [Configuration file](/docs/config#setbrowserexecutable) | `Config.setBrowserExecutable()` |
-| [`ensureBrowser()`](/docs/renderer/ensure-browser#browserexecutable) | `browserExecutable` |
-| [`getCompositions()`](/docs/renderer/get-compositions#browserexecutable) | `browserExecutable` |
-| [`openBrowser()`](/docs/renderer/open-browser#browserexecutable) | `options.browserExecutable` |
-| [`renderFrames()`](/docs/renderer/render-frames#browserexecutable) | `browserExecutable` |
-| [`renderMedia()`](/docs/renderer/render-media#browserexecutable) | `browserExecutable` |
-| [`renderStill()`](/docs/renderer/render-still#browserexecutable) | `browserExecutable` |
-| [`selectComposition()`](/docs/renderer/select-composition#browserexecutable) | `browserExecutable` |
+## APIs that have this option
+
+The following APIs accept this option:
+
+- [`ensureBrowser()`](/docs/renderer/ensure-browser#browserexecutable)
+- [`getCompositions()`](/docs/renderer/get-compositions#browserexecutable)
+- [`openBrowser()`](/docs/renderer/open-browser#browserexecutable)
+- [`renderFrames()`](/docs/renderer/render-frames#browserexecutable)
+- [`renderMedia()`](/docs/renderer/render-media#browserexecutable)
+- [`renderStill()`](/docs/renderer/render-still#browserexecutable)
+- [`selectComposition()`](/docs/renderer/select-composition#browserexecutable)
+
+## Config file
+
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setBrowserExecutable('/usr/bin/google-chrome-stable');
+```
## See also
diff --git a/packages/docs/docs/options/buffer-size.mdx b/packages/docs/docs/options/buffer-size.mdx
index 8f9ec8ca43..9b60742b36 100644
--- a/packages/docs/docs/options/buffer-size.mdx
+++ b/packages/docs/docs/options/buffer-size.mdx
@@ -22,17 +22,22 @@ Use `--buffer-size` with the following commands. Follow a command link for its s
| [`remotion lambda render`](/docs/lambda/cli/render) | `--buffer-size <value>` |
| [`remotion cloudrun render`](/docs/cloudrun/cli/render) | `--buffer-size <value>` |
-## API and configuration references
+## APIs that have this option
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
+The following APIs accept this option:
-| Reference | Name |
-| ---------------------------------------------------------------------------- | -------------------------------- |
-| [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#buffersize) | `bufferSize` |
-| [Configuration file](/docs/config#setencodingbuffersize) | `Config.setEncodingBufferSize()` |
-| [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#buffersize) | `bufferSize` |
-| [`renderMedia()`](/docs/renderer/render-media#buffersize) | `bufferSize` |
-| [`stitchFramesToVideo()`](/docs/renderer/stitch-frames-to-video#buffersize) | `bufferSize` |
+- [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#buffersize)
+- [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#buffersize)
+- [`renderMedia()`](/docs/renderer/render-media#buffersize)
+- [`stitchFramesToVideo()`](/docs/renderer/stitch-frames-to-video#buffersize)
+
+## Config file
+
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setEncodingBufferSize('10000k');
+```
## See also
diff --git a/packages/docs/docs/options/bundle-cache.mdx b/packages/docs/docs/options/bundle-cache.mdx
index 9106c6112f..6e628b62e6 100644
--- a/packages/docs/docs/options/bundle-cache.mdx
+++ b/packages/docs/docs/options/bundle-cache.mdx
@@ -25,16 +25,21 @@ Use `--bundle-cache` with the following commands. Follow a command link for its
| [`remotion lambda sites create`](/docs/lambda/cli/sites/create) | `--bundle-cache` |
| [`remotion cloudrun sites create`](/docs/cloudrun/cli/sites/create) | `--bundle-cache` |
-## API and configuration references
+## APIs that have this option
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
+The following APIs accept this option:
-| Reference | Name |
-| --------------------------------------------------------- | ---------------------------- |
-| [`bundle()`](/docs/bundle#enablecaching) | `enableCaching` |
-| [`deploySite()`](/docs/cloudrun/deploysite#enablecaching) | `options.enableCaching` |
-| [Configuration file](/docs/config#setcachingenabled) | `Config.setCachingEnabled()` |
-| [`deploySite()`](/docs/lambda/deploysite#enablecaching) | `options.enableCaching` |
+- [`bundle()`](/docs/bundle#enablecaching)
+- [`deploySite()`](/docs/cloudrun/deploysite#enablecaching)
+- [`deploySite()`](/docs/lambda/deploysite#enablecaching)
+
+## Config file
+
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setCachingEnabled(false);
+```
## See also
diff --git a/packages/docs/docs/options/chrome-mode.mdx b/packages/docs/docs/options/chrome-mode.mdx
index 9ce8650d2c..356772ecbd 100644
--- a/packages/docs/docs/options/chrome-mode.mdx
+++ b/packages/docs/docs/options/chrome-mode.mdx
@@ -23,20 +23,27 @@ Use `--chrome-mode` with the following commands. Follow a command link for its s
| [`remotion benchmark`](/docs/cli/benchmark) | `--chrome-mode <value>` |
| [`remotion gpu`](/docs/cli/gpu) | `--chrome-mode <value>` |
-## API and configuration references
-
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
-
-| Reference | Name |
-| --------------------------------------------------------------------- | ------------------------ |
-| [Configuration file](/docs/config#setchromemode) | `Config.setChromeMode()` |
-| [`ensureBrowser()`](/docs/renderer/ensure-browser#chromemode) | `chromeMode` |
-| [`getCompositions()`](/docs/renderer/get-compositions#chromemode) | `chromeMode` |
-| [`openBrowser()`](/docs/renderer/open-browser#chromemode) | `chromeMode` |
-| [`renderFrames()`](/docs/renderer/render-frames#chromemode) | `chromeMode` |
-| [`renderMedia()`](/docs/renderer/render-media#chromemode) | `chromeMode` |
-| [`renderStill()`](/docs/renderer/render-still#chromemode) | `chromeMode` |
-| [`selectComposition()`](/docs/renderer/select-composition#chromemode) | `chromeMode` |
+## APIs that have this option
+
+The following APIs accept this option:
+
+- [`ensureBrowser()`](/docs/renderer/ensure-browser#chromemode)
+- [`getCompositions()`](/docs/renderer/get-compositions#chromemode)
+- [`openBrowser()`](/docs/renderer/open-browser#chromemode)
+- [`renderFrames()`](/docs/renderer/render-frames#chromemode)
+- [`renderMedia()`](/docs/renderer/render-media#chromemode)
+- [`renderStill()`](/docs/renderer/render-still#chromemode)
+- [`selectComposition()`](/docs/renderer/select-composition#chromemode)
+
+## Config file
+
+```tsx twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+
+// ---cut---
+
+Config.setChromeMode('chrome-for-testing');
+```
## See also
diff --git a/packages/docs/docs/options/codec.mdx b/packages/docs/docs/options/codec.mdx
index ab937e32d6..ab603f68fc 100644
--- a/packages/docs/docs/options/codec.mdx
+++ b/packages/docs/docs/options/codec.mdx
@@ -21,18 +21,23 @@ Use `--codec` with the following commands. Follow a command link for its syntax
| [`remotion lambda render`](/docs/lambda/cli/render) | `--codec <value>` |
| [`remotion cloudrun render`](/docs/cloudrun/cli/render) | `--codec <value>` |
-## API and configuration references
-
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
-
-| Reference | Name |
-| ----------------------------------------------------------------------- | ------------------- |
-| [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#codec) | `codec` |
-| [Configuration file](/docs/config#setcodec) | `Config.setCodec()` |
-| [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#codec) | `codec` |
-| [`combineChunks()`](/docs/renderer/combine-chunks#codec) | `codec` |
-| [`renderMedia()`](/docs/renderer/render-media#codec) | `codec` |
-| [`stitchFramesToVideo()`](/docs/renderer/stitch-frames-to-video#codec) | `codec` |
+## APIs that have this option
+
+The following APIs accept this option:
+
+- [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#codec)
+- [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#codec)
+- [`combineChunks()`](/docs/renderer/combine-chunks#codec)
+- [`renderMedia()`](/docs/renderer/render-media#codec)
+- [`stitchFramesToVideo()`](/docs/renderer/stitch-frames-to-video#codec)
+
+## Config file
+
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setCodec('h265');
+```
## See also
diff --git a/packages/docs/docs/options/coding-agent.mdx b/packages/docs/docs/options/coding-agent.mdx
index 79337f130d..2a1fb1ea0d 100644
--- a/packages/docs/docs/options/coding-agent.mdx
+++ b/packages/docs/docs/options/coding-agent.mdx
@@ -18,13 +18,13 @@ Use `--coding-agent` with the following commands. Follow a command link for its
| ------------------------------------- | ------------------------ |
| [`remotion studio`](/docs/cli/studio) | `--coding-agent <value>` |
-## API and configuration references
+## Config file
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
-
-| Reference | Name |
-| -------------------------------------------------------- | -------------------------------- |
-| [Configuration file](/docs/config#setdefaultcodingagent) | `Config.setDefaultCodingAgent()` |
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setDefaultCodingAgent('codex');
+```
## See also
diff --git a/packages/docs/docs/options/color-space.mdx b/packages/docs/docs/options/color-space.mdx
index 91393728a8..4075bb3fc1 100644
--- a/packages/docs/docs/options/color-space.mdx
+++ b/packages/docs/docs/options/color-space.mdx
@@ -22,16 +22,14 @@ Use `--color-space` with the following commands. Follow a command link for its s
| [`remotion lambda render`](/docs/lambda/cli/render) | `--color-space <value>` |
| [`remotion cloudrun render`](/docs/cloudrun/cli/render) | `--color-space <value>` |
-## API and configuration references
+## APIs that have this option
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
+The following APIs accept this option:
-| Reference | Name |
-| ---------------------------------------------------------------------------- | ------------ |
-| [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#colorspace) | `colorSpace` |
-| [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#colorspace) | `colorSpace` |
-| [`renderMedia()`](/docs/renderer/render-media#colorspace) | `colorSpace` |
-| [`stitchFramesToVideo()`](/docs/renderer/stitch-frames-to-video#colorspace) | `colorSpace` |
+- [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#colorspace)
+- [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#colorspace)
+- [`renderMedia()`](/docs/renderer/render-media#colorspace)
+- [`stitchFramesToVideo()`](/docs/renderer/stitch-frames-to-video#colorspace)
## See also
diff --git a/packages/docs/docs/options/concurrencies.mdx b/packages/docs/docs/options/concurrencies.mdx
index dcbfdd7869..9267149cf1 100644
--- a/packages/docs/docs/options/concurrencies.mdx
+++ b/packages/docs/docs/options/concurrencies.mdx
@@ -18,13 +18,13 @@ Use `--concurrencies` with the following commands. Follow a command link for its
| ------------------------------------------- | ------------------------- |
| [`remotion benchmark`](/docs/cli/benchmark) | `--concurrencies <value>` |
-## API and configuration references
+## Config file
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
-
-| Reference | Name |
-| ------------------------------------------------------------ | ------------------------------------ |
-| [Configuration file](/docs/config#setbenchmarkconcurrencies) | `Config.setBenchmarkConcurrencies()` |
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setBenchmarkConcurrencies('1,4,8');
+```
## See also
diff --git a/packages/docs/docs/options/concurrency.mdx b/packages/docs/docs/options/concurrency.mdx
index fc7d81ada7..7cab669ee4 100644
--- a/packages/docs/docs/options/concurrency.mdx
+++ b/packages/docs/docs/options/concurrency.mdx
@@ -22,17 +22,22 @@ Use `--concurrency` with the following commands. Follow a command link for its s
| [`remotion lambda render`](/docs/lambda/cli/render) | `--concurrency <value>` |
| [`remotion cloudrun render`](/docs/cloudrun/cli/render) | `--concurrency <value>` |
-## API and configuration references
+## APIs that have this option
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
+The following APIs accept this option:
-| Reference | Name |
-| ----------------------------------------------------------------------------- | ------------------------- |
-| [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#concurrency) | `concurrency` |
-| [Configuration file](/docs/config#setconcurrency) | `Config.setConcurrency()` |
-| [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#concurrency) | `concurrency` |
-| [`renderFrames()`](/docs/renderer/render-frames#concurrency) | `concurrency` |
-| [`renderMedia()`](/docs/renderer/render-media#concurrency) | `concurrency` |
+- [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#concurrency)
+- [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#concurrency)
+- [`renderFrames()`](/docs/renderer/render-frames#concurrency)
+- [`renderMedia()`](/docs/renderer/render-media#concurrency)
+
+## Config file
+
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setConcurrency(8);
+```
## See also
diff --git a/packages/docs/docs/options/crf.mdx b/packages/docs/docs/options/crf.mdx
index 827ee6187c..81b806c071 100644
--- a/packages/docs/docs/options/crf.mdx
+++ b/packages/docs/docs/options/crf.mdx
@@ -22,17 +22,22 @@ Use `--crf` with the following commands. Follow a command link for its syntax an
| [`remotion lambda render`](/docs/lambda/cli/render) | `--crf <value>` |
| [`remotion cloudrun render`](/docs/cloudrun/cli/render) | `--crf <value>` |
-## API and configuration references
+## APIs that have this option
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
+The following APIs accept this option:
-| Reference | Name |
-| --------------------------------------------------------------------- | ----------------- |
-| [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#crf) | `crf` |
-| [Configuration file](/docs/config#setcrf) | `Config.setCrf()` |
-| [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#crf) | `crf` |
-| [`renderMedia()`](/docs/renderer/render-media#crf) | `crf` |
-| [`stitchFramesToVideo()`](/docs/renderer/stitch-frames-to-video#crf) | `crf` |
+- [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#crf)
+- [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#crf)
+- [`renderMedia()`](/docs/renderer/render-media#crf)
+- [`stitchFramesToVideo()`](/docs/renderer/stitch-frames-to-video#crf)
+
+## Config file
+
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setCrf(16);
+```
## See also
diff --git a/packages/docs/docs/options/cross-site-isolation.mdx b/packages/docs/docs/options/cross-site-isolation.mdx
index 9308d19d03..e307205b68 100644
--- a/packages/docs/docs/options/cross-site-isolation.mdx
+++ b/packages/docs/docs/options/cross-site-isolation.mdx
@@ -18,13 +18,13 @@ Use `--cross-site-isolation` with the following commands. Follow a command link
| ------------------------------------- | ------------------------ |
| [`remotion studio`](/docs/cli/studio) | `--cross-site-isolation` |
-## API and configuration references
+## Config file
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
-
-| Reference | Name |
-| -------------------------------------------------------------- | -------------------------------------- |
-| [Configuration file](/docs/config#setenablecrosssiteisolation) | `Config.setEnableCrossSiteIsolation()` |
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setEnableCrossSiteIsolation(true);
+```
## See also
diff --git a/packages/docs/docs/options/dark-mode.mdx b/packages/docs/docs/options/dark-mode.mdx
index a6eb969fd0..ddd8794ba5 100644
--- a/packages/docs/docs/options/dark-mode.mdx
+++ b/packages/docs/docs/options/dark-mode.mdx
@@ -28,18 +28,24 @@ Use `--dark-mode` with the following commands. Follow a command link for its syn
| [`remotion cloudrun render`](/docs/cloudrun/cli/render) | `--dark-mode` |
| [`remotion cloudrun still`](/docs/cloudrun/cli/still) | `--dark-mode` |
-## API and configuration references
-
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
-
-| Reference | Name |
-| ---------------------------------------------------------------------------- | ------------------------------ |
-| [Configuration file](/docs/config#setchromiumdarkmode) | `Config.setChromiumDarkMode()` |
-| [`getCompositionsOnLambda()`](/docs/lambda/getcompositionsonlambda#darkmode) | `chromiumOptions.darkMode` |
-| [`renderStillOnLambda()`](/docs/lambda/renderstillonlambda#darkmode) | `chromiumOptions.darkMode` |
-| [`renderFrames()`](/docs/renderer/render-frames#darkmode) | `chromiumOptions.darkMode` |
-| [`renderMedia()`](/docs/renderer/render-media#darkmode) | `darkMode` |
-| [`renderStill()`](/docs/renderer/render-still#darkmode) | `chromiumOptions.darkMode` |
+## APIs that have this option
+
+The following APIs accept this option:
+
+- [`getCompositionsOnLambda()`](/docs/lambda/getcompositionsonlambda#darkmode)
+- [`renderStillOnLambda()`](/docs/lambda/renderstillonlambda#darkmode)
+- [`renderFrames()`](/docs/renderer/render-frames#darkmode)
+- [`renderMedia()`](/docs/renderer/render-media#darkmode)
+- [`renderStill()`](/docs/renderer/render-still#darkmode)
+
+## Config file
+
+```tsx twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+
+// ---cut---
+Config.setChromiumDarkMode(true);
+```
## See also
diff --git a/packages/docs/docs/options/delete-after.mdx b/packages/docs/docs/options/delete-after.mdx
index 79b3a084c5..bb67944cdb 100644
--- a/packages/docs/docs/options/delete-after.mdx
+++ b/packages/docs/docs/options/delete-after.mdx
@@ -19,15 +19,20 @@ Use `--delete-after` with the following commands. Follow a command link for its
| [`remotion lambda render`](/docs/lambda/cli/render) | `--delete-after <value>` |
| [`remotion lambda still`](/docs/lambda/cli/still) | `--delete-after <value>` |
-## API and configuration references
+## APIs that have this option
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
+The following APIs accept this option:
-| Reference | Name |
-| ----------------------------------------------------------------------- | ------------------------- |
-| [Configuration file](/docs/config#setdeleteafter) | `Config.setDeleteAfter()` |
-| [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#deleteafter) | `deleteAfter` |
-| [`renderStillOnLambda()`](/docs/lambda/renderstillonlambda#deleteafter) | `deleteAfter` |
+- [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#deleteafter)
+- [`renderStillOnLambda()`](/docs/lambda/renderstillonlambda#deleteafter)
+
+## Config file
+
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setDeleteAfter('3-days');
+```
## See also
diff --git a/packages/docs/docs/options/disable-ask-ai.mdx b/packages/docs/docs/options/disable-ask-ai.mdx
index 64f2920823..21340ee338 100644
--- a/packages/docs/docs/options/disable-ask-ai.mdx
+++ b/packages/docs/docs/options/disable-ask-ai.mdx
@@ -25,16 +25,21 @@ Use `--disable-ask-ai` with the following commands. Follow a command link for it
| [`remotion lambda sites create`](/docs/lambda/cli/sites/create) | `--disable-ask-ai` |
| [`remotion cloudrun sites create`](/docs/cloudrun/cli/sites/create) | `--disable-ask-ai` |
-## API and configuration references
+## APIs that have this option
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
+The following APIs accept this option:
-| Reference | Name |
-| -------------------------------------------------------- | -------------------------- |
-| [`bundle()`](/docs/bundle#askaienabled) | `askAIEnabled` |
-| [`deploySite()`](/docs/cloudrun/deploysite#askaienabled) | `options.askAIEnabled` |
-| [Configuration file](/docs/config#setaskaienabled) | `Config.setAskAIEnabled()` |
-| [`deploySite()`](/docs/lambda/deploysite#askaienabled) | `options.askAIEnabled` |
+- [`bundle()`](/docs/bundle#askaienabled)
+- [`deploySite()`](/docs/cloudrun/deploysite#askaienabled)
+- [`deploySite()`](/docs/lambda/deploysite#askaienabled)
+
+## Config file
+
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setAskAIEnabled(false);
+```
## See also
diff --git a/packages/docs/docs/options/disable-canvas-tabs.mdx b/packages/docs/docs/options/disable-canvas-tabs.mdx
index a9ed0d60ec..4bf536a3bd 100644
--- a/packages/docs/docs/options/disable-canvas-tabs.mdx
+++ b/packages/docs/docs/options/disable-canvas-tabs.mdx
@@ -18,6 +18,14 @@ Use `--disable-canvas-tabs` with the following commands. Follow a command link f
| ------------------------------------- | ----------------------- |
| [`remotion studio`](/docs/cli/studio) | `--disable-canvas-tabs` |
+## Config file
+
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setCanvasTabsEnabled(false);
+```
+
## See also
- [All options](/docs/options)
diff --git a/packages/docs/docs/options/disable-headless.mdx b/packages/docs/docs/options/disable-headless.mdx
index 0728c8c1cd..de4a46559a 100644
--- a/packages/docs/docs/options/disable-headless.mdx
+++ b/packages/docs/docs/options/disable-headless.mdx
@@ -28,16 +28,23 @@ Use `--disable-headless` with the following commands. Follow a command link for
| [`remotion cloudrun render`](/docs/cloudrun/cli/render) | `--disable-headless` |
| [`remotion cloudrun still`](/docs/cloudrun/cli/still) | `--disable-headless` |
-## API and configuration references
+## APIs that have this option
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
+The following APIs accept this option:
-| Reference | Name |
-| ---------------------------------------------------------- | ---------------------------------- |
-| [Configuration file](/docs/config#setchromiumheadlessmode) | `Config.setChromiumHeadlessMode()` |
-| [`renderFrames()`](/docs/renderer/render-frames#headless) | `chromiumOptions.headless` |
-| [`renderMedia()`](/docs/renderer/render-media#headless) | `chromiumOptions.headless` |
-| [`renderStill()`](/docs/renderer/render-still#headless) | `chromiumOptions.headless` |
+- [`renderFrames()`](/docs/renderer/render-frames#headless)
+- [`renderMedia()`](/docs/renderer/render-media#headless)
+- [`renderStill()`](/docs/renderer/render-still#headless)
+
+## Config file
+
+```tsx twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+
+// ---cut---
+
+Config.setChromiumHeadlessMode(false);
+```
## See also
diff --git a/packages/docs/docs/options/disable-interactivity.mdx b/packages/docs/docs/options/disable-interactivity.mdx
index 5307ddc32d..2f928490d4 100644
--- a/packages/docs/docs/options/disable-interactivity.mdx
+++ b/packages/docs/docs/options/disable-interactivity.mdx
@@ -18,13 +18,13 @@ Use `--disable-interactivity` with the following commands. Follow a command link
| ------------------------------------- | ------------------------- |
| [`remotion studio`](/docs/cli/studio) | `--disable-interactivity` |
-## API and configuration references
+## Config file
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
-
-| Reference | Name |
-| ---------------------------------------------------------- | ---------------------------------- |
-| [Configuration file](/docs/config#setinteractivityenabled) | `Config.setInteractivityEnabled()` |
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setInteractivityEnabled(false);
+```
## See also
diff --git a/packages/docs/docs/options/disable-keyboard-shortcuts.mdx b/packages/docs/docs/options/disable-keyboard-shortcuts.mdx
index 4d0f99aaa7..7bb607d4e8 100644
--- a/packages/docs/docs/options/disable-keyboard-shortcuts.mdx
+++ b/packages/docs/docs/options/disable-keyboard-shortcuts.mdx
@@ -25,16 +25,21 @@ Use `--disable-keyboard-shortcuts` with the following commands. Follow a command
| [`remotion lambda sites create`](/docs/lambda/cli/sites/create) | `--disable-keyboard-shortcuts` |
| [`remotion cloudrun sites create`](/docs/cloudrun/cli/sites/create) | `--disable-keyboard-shortcuts` |
-## API and configuration references
+## APIs that have this option
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
+The following APIs accept this option:
-| Reference | Name |
-| -------------------------------------------------------------------- | -------------------------------------- |
-| [`bundle()`](/docs/bundle#keyboardshortcutsenabled) | `keyboardShortcutsEnabled` |
-| [`deploySite()`](/docs/cloudrun/deploysite#keyboardshortcutsenabled) | `options.keyboardShortcutsEnabled` |
-| [Configuration file](/docs/config#setkeyboardshortcutsenabled) | `Config.setKeyboardShortcutsEnabled()` |
-| [`deploySite()`](/docs/lambda/deploysite#keyboardshortcutsenabled) | `options.keyboardShortcutsEnabled` |
+- [`bundle()`](/docs/bundle#keyboardshortcutsenabled)
+- [`deploySite()`](/docs/cloudrun/deploysite#keyboardshortcutsenabled)
+- [`deploySite()`](/docs/lambda/deploysite#keyboardshortcutsenabled)
+
+## Config file
+
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setKeyboardShortcutsEnabled(false);
+```
## See also
diff --git a/packages/docs/docs/options/disable-web-security.mdx b/packages/docs/docs/options/disable-web-security.mdx
index f8997f93c6..52acaa7f35 100644
--- a/packages/docs/docs/options/disable-web-security.mdx
+++ b/packages/docs/docs/options/disable-web-security.mdx
@@ -28,21 +28,28 @@ Use `--disable-web-security` with the following commands. Follow a command link
| [`remotion cloudrun render`](/docs/cloudrun/cli/render) | `--disable-web-security` |
| [`remotion cloudrun still`](/docs/cloudrun/cli/still) | `--disable-web-security` |
-## API and configuration references
-
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
-
-| Reference | Name |
-| -------------------------------------------------------------------------------------- | ---------------------------------------- |
-| [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#disablewebsecurity) | `chromiumOptions.disableWebSecurity` |
-| [`renderStillOnCloudrun()`](/docs/cloudrun/renderstilloncloudrun#disablewebsecurity) | `chromiumOptions.disableWebSecurity` |
-| [Configuration file](/docs/config#setchromiumdisablewebsecurity) | `Config.setChromiumDisableWebSecurity()` |
-| [`getCompositionsOnLambda()`](/docs/lambda/getcompositionsonlambda#disablewebsecurity) | `chromiumOptions.disableWebSecurity` |
-| [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#disablewebsecurity) | `chromiumOptions.disableWebSecurity` |
-| [`renderStillOnLambda()`](/docs/lambda/renderstillonlambda#disablewebsecurity) | `chromiumOptions.disableWebSecurity` |
-| [`renderFrames()`](/docs/renderer/render-frames#disablewebsecurity) | `chromiumOptions.disableWebSecurity` |
-| [`renderMedia()`](/docs/renderer/render-media#disablewebsecurity) | `chromiumOptions.disableWebSecurity` |
-| [`renderStill()`](/docs/renderer/render-still#disablewebsecurity) | `chromiumOptions.disableWebSecurity` |
+## APIs that have this option
+
+The following APIs accept this option:
+
+- [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#disablewebsecurity)
+- [`renderStillOnCloudrun()`](/docs/cloudrun/renderstilloncloudrun#disablewebsecurity)
+- [`getCompositionsOnLambda()`](/docs/lambda/getcompositionsonlambda#disablewebsecurity)
+- [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#disablewebsecurity)
+- [`renderStillOnLambda()`](/docs/lambda/renderstillonlambda#disablewebsecurity)
+- [`renderFrames()`](/docs/renderer/render-frames#disablewebsecurity)
+- [`renderMedia()`](/docs/renderer/render-media#disablewebsecurity)
+- [`renderStill()`](/docs/renderer/render-still#disablewebsecurity)
+
+## Config file
+
+```tsx twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+
+// ---cut---
+
+Config.setChromiumDisableWebSecurity(true);
+```
## See also
diff --git a/packages/docs/docs/options/disallow-parallel-encoding.mdx b/packages/docs/docs/options/disallow-parallel-encoding.mdx
index d988b2784f..f00c098fc1 100644
--- a/packages/docs/docs/options/disallow-parallel-encoding.mdx
+++ b/packages/docs/docs/options/disallow-parallel-encoding.mdx
@@ -19,14 +19,19 @@ Use `--disallow-parallel-encoding` with the following commands. Follow a command
| [`remotion render`](/docs/cli/render) | `--disallow-parallel-encoding` |
| [`remotion benchmark`](/docs/cli/benchmark) | `--disallow-parallel-encoding` |
-## API and configuration references
+## APIs that have this option
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
+The following APIs accept this option:
-| Reference | Name |
-| ----------------------------------------------------------------------- | -------------------------------------- |
-| [Configuration file](/docs/config#setdisallowparallelencoding) | `Config.setDisallowParallelEncoding()` |
-| [`renderMedia()`](/docs/renderer/render-media#disallowparallelencoding) | `disallowParallelEncoding` |
+- [`renderMedia()`](/docs/renderer/render-media#disallowparallelencoding)
+
+## Config file
+
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setDisallowParallelEncoding(true);
+```
## See also
diff --git a/packages/docs/docs/options/duration.mdx b/packages/docs/docs/options/duration.mdx
index 1fb1743516..8ac21c3965 100644
--- a/packages/docs/docs/options/duration.mdx
+++ b/packages/docs/docs/options/duration.mdx
@@ -24,13 +24,13 @@ Use `--duration` with the following commands. Follow a command link for its synt
| [`remotion cloudrun render`](/docs/cloudrun/cli/render) | `--duration <value>` |
| [`remotion cloudrun still`](/docs/cloudrun/cli/still) | `--duration <value>` |
-## API and configuration references
+## Config file
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
-
-| Reference | Name |
-| --------------------------------------------------- | --------------------------- |
-| [Configuration file](/docs/config#overrideduration) | `Config.overrideDuration()` |
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.overrideDuration(300);
+```
## See also
diff --git a/packages/docs/docs/options/editor.mdx b/packages/docs/docs/options/editor.mdx
index 8c162f3c41..ce972aacac 100644
--- a/packages/docs/docs/options/editor.mdx
+++ b/packages/docs/docs/options/editor.mdx
@@ -18,13 +18,13 @@ Use `--editor` with the following commands. Follow a command link for its syntax
| ------------------------------------- | ------------------ |
| [`remotion studio`](/docs/cli/studio) | `--editor <value>` |
-## API and configuration references
+## Config file
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
-
-| Reference | Name |
-| --------------------------------------------------- | --------------------------- |
-| [Configuration file](/docs/config#setdefaulteditor) | `Config.setDefaultEditor()` |
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setDefaultEditor('cursor');
+```
## See also
diff --git a/packages/docs/docs/options/enable-cancellation.mdx b/packages/docs/docs/options/enable-cancellation.mdx
index 258fa16cff..daeb508419 100644
--- a/packages/docs/docs/options/enable-cancellation.mdx
+++ b/packages/docs/docs/options/enable-cancellation.mdx
@@ -18,13 +18,13 @@ Use `--enable-cancellation` with the following commands. Follow a command link f
| --------------------------------------------------- | ----------------------- |
| [`remotion lambda render`](/docs/lambda/cli/render) | `--enable-cancellation` |
-## API and configuration references
+## Config file
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
-
-| Reference | Name |
-| -------------------------------------------------------- | -------------------------------- |
-| [Configuration file](/docs/config#setenablecancellation) | `Config.setEnableCancellation()` |
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setEnableCancellation(true);
+```
## See also
diff --git a/packages/docs/docs/options/enable-folder-expiry.mdx b/packages/docs/docs/options/enable-folder-expiry.mdx
index 3f07f9310c..d349f90623 100644
--- a/packages/docs/docs/options/enable-folder-expiry.mdx
+++ b/packages/docs/docs/options/enable-folder-expiry.mdx
@@ -18,14 +18,19 @@ Use `--enable-folder-expiry` with the following commands. Follow a command link
| --------------------------------------------------------------- | ------------------------ |
| [`remotion lambda sites create`](/docs/lambda/cli/sites/create) | `--enable-folder-expiry` |
-## API and configuration references
+## APIs that have this option
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
+The following APIs accept this option:
-| Reference | Name |
-| -------------------------------------------------------------------------- | -------------------------------- |
-| [Configuration file](/docs/config#setenablefolderexpiry) | `Config.setEnableFolderExpiry()` |
-| [`getOrCreateBucket()`](/docs/lambda/getorcreatebucket#enablefolderexpiry) | `enableFolderExpiry` |
+- [`getOrCreateBucket()`](/docs/lambda/getorcreatebucket#enablefolderexpiry)
+
+## Config file
+
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setEnableFolderExpiry(true);
+```
## See also
diff --git a/packages/docs/docs/options/enable-lambda-insights.mdx b/packages/docs/docs/options/enable-lambda-insights.mdx
index 91e263dd3a..4081b27d47 100644
--- a/packages/docs/docs/options/enable-lambda-insights.mdx
+++ b/packages/docs/docs/options/enable-lambda-insights.mdx
@@ -18,14 +18,19 @@ Use `--enable-lambda-insights` with the following commands. Follow a command lin
| ----------------------------------------------------------------------- | -------------------------- |
| [`remotion lambda functions deploy`](/docs/lambda/cli/functions/deploy) | `--enable-lambda-insights` |
-## API and configuration references
+## APIs that have this option
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
+The following APIs accept this option:
-| Reference | Name |
-| ---------------------------------------------------------------------- | ---------------------------- |
-| [Configuration file](/docs/config#setlambdainsights) | `Config.setLambdaInsights()` |
-| [`deployFunction()`](/docs/lambda/deployfunction#enablelambdainsights) | `enableLambdaInsights` |
+- [`deployFunction()`](/docs/lambda/deployfunction#enablelambdainsights)
+
+## Config file
+
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setLambdaInsights(true);
+```
## See also
diff --git a/packages/docs/docs/options/enable-multiprocess-on-linux.mdx b/packages/docs/docs/options/enable-multiprocess-on-linux.mdx
index d017f2973c..7026bff4e4 100644
--- a/packages/docs/docs/options/enable-multiprocess-on-linux.mdx
+++ b/packages/docs/docs/options/enable-multiprocess-on-linux.mdx
@@ -28,16 +28,23 @@ Use `--enable-multiprocess-on-linux` with the following commands. Follow a comma
| [`remotion cloudrun render`](/docs/cloudrun/cli/render) | `--enable-multiprocess-on-linux` |
| [`remotion cloudrun still`](/docs/cloudrun/cli/still) | `--enable-multiprocess-on-linux` |
-## API and configuration references
+## APIs that have this option
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
+The following APIs accept this option:
-| Reference | Name |
-| -------------------------------------------------------------------------- | ------------------------------------------- |
-| [Configuration file](/docs/config#setchromiummultiprocessonlinux) | `Config.setChromiumMultiProcessOnLinux()` |
-| [`renderFrames()`](/docs/renderer/render-frames#enablemultiprocessonlinux) | `chromiumOptions.enableMultiProcessOnLinux` |
-| [`renderMedia()`](/docs/renderer/render-media#enablemultiprocessonlinux) | `chromiumOptions.enableMultiProcessOnLinux` |
-| [`renderStill()`](/docs/renderer/render-still#enablemultiprocessonlinux) | `chromiumOptions.enableMultiProcessOnLinux` |
+- [`renderFrames()`](/docs/renderer/render-frames#enablemultiprocessonlinux)
+- [`renderMedia()`](/docs/renderer/render-media#enablemultiprocessonlinux)
+- [`renderStill()`](/docs/renderer/render-still#enablemultiprocessonlinux)
+
+## Config file
+
+```tsx twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+
+// ---cut---
+
+Config.setChromiumMultiProcessOnLinux(true);
+```
## See also
diff --git a/packages/docs/docs/options/enforce-audio-track.mdx b/packages/docs/docs/options/enforce-audio-track.mdx
index 872bcf50e3..70d62ad142 100644
--- a/packages/docs/docs/options/enforce-audio-track.mdx
+++ b/packages/docs/docs/options/enforce-audio-track.mdx
@@ -31,16 +31,21 @@ Use `--enforce-audio-track` with the following commands. Follow a command link f
| [`remotion benchmark`](/docs/cli/benchmark) | `--enforce-audio-track` |
| [`remotion cloudrun render`](/docs/cloudrun/cli/render) | `--enforce-audio-track` |
-## API and configuration references
+## APIs that have this option
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
+The following APIs accept this option:
-| Reference | Name |
-| ----------------------------------------------------------------------------------- | ------------------------------- |
-| [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#enforceaudiotrack) | `enforceAudioTrack` |
-| [Configuration file](/docs/config#setenforceaudiotrack) | `Config.setEnforceAudioTrack()` |
-| [`renderMedia()`](/docs/renderer/render-media#enforceaudiotrack) | `enforceAudioTrack` |
-| [`stitchFramesToVideo()`](/docs/renderer/stitch-frames-to-video#enforceaudiotrack) | `enforceAudioTrack` |
+- [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#enforceaudiotrack)
+- [`renderMedia()`](/docs/renderer/render-media#enforceaudiotrack)
+- [`stitchFramesToVideo()`](/docs/renderer/stitch-frames-to-video#enforceaudiotrack)
+
+## Config file
+
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setEnforceAudioTrack(true);
+```
## See also
diff --git a/packages/docs/docs/options/env-file.mdx b/packages/docs/docs/options/env-file.mdx
index 8cb609ffa0..8be4814119 100644
--- a/packages/docs/docs/options/env-file.mdx
+++ b/packages/docs/docs/options/env-file.mdx
@@ -27,13 +27,13 @@ Use `--env-file` with the following commands. Follow a command link for its synt
| [`remotion cloudrun render`](/docs/cloudrun/cli/render) | `--env-file <value>` |
| [`remotion cloudrun still`](/docs/cloudrun/cli/still) | `--env-file <value>` |
-## API and configuration references
+## Config file
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
-
-| Reference | Name |
-| ---------------------------------------------------- | ---------------------------- |
-| [Configuration file](/docs/config#setdotenvlocation) | `Config.setDotEnvLocation()` |
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setDotEnvLocation('.my-env');
+```
## See also
diff --git a/packages/docs/docs/options/every-nth-frame.mdx b/packages/docs/docs/options/every-nth-frame.mdx
index 2099318115..6f59977f99 100644
--- a/packages/docs/docs/options/every-nth-frame.mdx
+++ b/packages/docs/docs/options/every-nth-frame.mdx
@@ -22,18 +22,23 @@ Use `--every-nth-frame` with the following commands. Follow a command link for i
| [`remotion lambda render`](/docs/lambda/cli/render) | `--every-nth-frame <value>` |
| [`remotion cloudrun render`](/docs/cloudrun/cli/render) | `--every-nth-frame <value>` |
-## API and configuration references
-
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
-
-| Reference | Name |
-| ------------------------------------------------------------------------------- | --------------------------- |
-| [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#everynthframe) | `everyNthFrame` |
-| [Configuration file](/docs/config#seteverynthframe) | `Config.setEveryNthFrame()` |
-| [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#everynthframe) | `everyNthFrame` |
-| [`combineChunks()`](/docs/renderer/combine-chunks#everynthframe) | `everyNthFrame` |
-| [`renderFrames()`](/docs/renderer/render-frames#everynthframe) | `everyNthFrame` |
-| [`renderMedia()`](/docs/renderer/render-media#everynthframe) | `everyNthFrame` |
+## APIs that have this option
+
+The following APIs accept this option:
+
+- [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#everynthframe)
+- [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#everynthframe)
+- [`combineChunks()`](/docs/renderer/combine-chunks#everynthframe)
+- [`renderFrames()`](/docs/renderer/render-frames#everynthframe)
+- [`renderMedia()`](/docs/renderer/render-media#everynthframe)
+
+## Config file
+
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setEveryNthFrame(2);
+```
## See also
diff --git a/packages/docs/docs/options/experimental-keep-audio-context-alive.mdx b/packages/docs/docs/options/experimental-keep-audio-context-alive.mdx
index b0cf26b41a..c405272ae6 100644
--- a/packages/docs/docs/options/experimental-keep-audio-context-alive.mdx
+++ b/packages/docs/docs/options/experimental-keep-audio-context-alive.mdx
@@ -18,13 +18,13 @@ Use `--experimental-keep-audio-context-alive` with the following commands. Follo
| ------------------------------------- | ----------------------------------------- |
| [`remotion studio`](/docs/cli/studio) | `--experimental-keep-audio-context-alive` |
-## API and configuration references
+## Config file
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
-
-| Reference | Name |
-| ----------------------------------------------------------------------- | ----------------------------------------------- |
-| [Configuration file](/docs/config#setexperimentalkeepaudiocontextalive) | `Config.setExperimentalKeepAudioContextAlive()` |
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setExperimentalKeepAudioContextAlive(true);
+```
## See also
diff --git a/packages/docs/docs/options/for-seamless-aac-concatenation.mdx b/packages/docs/docs/options/for-seamless-aac-concatenation.mdx
index d9c0224924..6401dd9636 100644
--- a/packages/docs/docs/options/for-seamless-aac-concatenation.mdx
+++ b/packages/docs/docs/options/for-seamless-aac-concatenation.mdx
@@ -20,15 +20,20 @@ Use `--for-seamless-aac-concatenation` with the following commands. Follow a com
| [`remotion render`](/docs/cli/render) | `--for-seamless-aac-concatenation` |
| [`remotion benchmark`](/docs/cli/benchmark) | `--for-seamless-aac-concatenation` |
-## API and configuration references
+## APIs that have this option
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
+The following APIs accept this option:
-| Reference | Name |
-| -------------------------------------------------------------------------------------------- | ----------------------------------------- |
-| [Configuration file](/docs/config#setforseamlessaacconcatenation) | `Config.setForSeamlessAacConcatenation()` |
-| [`renderMedia()`](/docs/renderer/render-media#forseamlessaacconcatenation) | `forSeamlessAacConcatenation` |
-| [`stitchFramesToVideo()`](/docs/renderer/stitch-frames-to-video#forseamlessaacconcatenation) | `forSeamlessAacConcatenation` |
+- [`renderMedia()`](/docs/renderer/render-media#forseamlessaacconcatenation)
+- [`stitchFramesToVideo()`](/docs/renderer/stitch-frames-to-video#forseamlessaacconcatenation)
+
+## Config file
+
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setForSeamlessAacConcatenation(true);
+```
## See also
diff --git a/packages/docs/docs/options/force-new.mdx b/packages/docs/docs/options/force-new.mdx
index 9db8cc7f88..ee0ce4d57c 100644
--- a/packages/docs/docs/options/force-new.mdx
+++ b/packages/docs/docs/options/force-new.mdx
@@ -18,13 +18,13 @@ Use `--force-new` with the following commands. Follow a command link for its syn
| ------------------------------------- | ------------- |
| [`remotion studio`](/docs/cli/studio) | `--force-new` |
-## API and configuration references
+## Config file
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
-
-| Reference | Name |
-| ----------------------------------------------------------- | ----------------------------------- |
-| [Configuration file](/docs/config#setforcenewstudioenabled) | `Config.setForceNewStudioEnabled()` |
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setForceNewStudioEnabled(true);
+```
## See also
diff --git a/packages/docs/docs/options/fps.mdx b/packages/docs/docs/options/fps.mdx
index 498cfb3db6..bf167b42df 100644
--- a/packages/docs/docs/options/fps.mdx
+++ b/packages/docs/docs/options/fps.mdx
@@ -24,13 +24,13 @@ Use `--fps` with the following commands. Follow a command link for its syntax an
| [`remotion cloudrun render`](/docs/cloudrun/cli/render) | `--fps <value>` |
| [`remotion cloudrun still`](/docs/cloudrun/cli/still) | `--fps <value>` |
-## API and configuration references
+## Config file
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
-
-| Reference | Name |
-| ---------------------------------------------- | ---------------------- |
-| [Configuration file](/docs/config#overridefps) | `Config.overrideFps()` |
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.overrideFps(25);
+```
## See also
diff --git a/packages/docs/docs/options/frame.mdx b/packages/docs/docs/options/frame.mdx
index 1747108f11..d028b4d878 100644
--- a/packages/docs/docs/options/frame.mdx
+++ b/packages/docs/docs/options/frame.mdx
@@ -20,16 +20,14 @@ Use `--frame` with the following commands. Follow a command link for its syntax
| [`remotion lambda still`](/docs/lambda/cli/still) | `--frame <value>` |
| [`remotion cloudrun still`](/docs/cloudrun/cli/still) | `--frame <value>` |
-## API and configuration references
+## APIs that have this option
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
+The following APIs accept this option:
-| Reference | Name |
-| ----------------------------------------------------------------------- | ------- |
-| [`renderStillOnCloudrun()`](/docs/cloudrun/renderstilloncloudrun#frame) | `frame` |
-| [`renderStillOnLambda()`](/docs/lambda/renderstillonlambda#frame) | `frame` |
-| [`renderStill()`](/docs/renderer/render-still#frame) | `frame` |
-| [`renderStillOnWeb()`](/docs/web-renderer/render-still-on-web#frame) | `frame` |
+- [`renderStillOnCloudrun()`](/docs/cloudrun/renderstilloncloudrun#frame)
+- [`renderStillOnLambda()`](/docs/lambda/renderstillonlambda#frame)
+- [`renderStill()`](/docs/renderer/render-still#frame)
+- [`renderStillOnWeb()`](/docs/web-renderer/render-still-on-web#frame)
## See also
diff --git a/packages/docs/docs/options/frames.mdx b/packages/docs/docs/options/frames.mdx
index 4e6c23c4bb..24f57659d2 100644
--- a/packages/docs/docs/options/frames.mdx
+++ b/packages/docs/docs/options/frames.mdx
@@ -21,19 +21,24 @@ Use `--frames` with the following commands. Follow a command link for its syntax
| [`remotion lambda render`](/docs/lambda/cli/render) | `--frames <value>` |
| [`remotion cloudrun render`](/docs/cloudrun/cli/render) | `--frames <value>` |
-## API and configuration references
-
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
-
-| Reference | Name |
-| ---------------------------------------------------------------------------- | ------------------------ |
-| [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#framerange) | `frameRange` |
-| [Configuration file](/docs/config#setframerange) | `Config.setFrameRange()` |
-| [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#framerange) | `frameRange` |
-| [`combineChunks()`](/docs/renderer/combine-chunks#framerange) | `frameRange` |
-| [`renderFrames()`](/docs/renderer/render-frames#framerange) | `frameRange` |
-| [`renderMedia()`](/docs/renderer/render-media#framerange) | `frameRange` |
-| [`renderMediaOnWeb()`](/docs/web-renderer/render-media-on-web#framerange) | `frameRange` |
+## APIs that have this option
+
+The following APIs accept this option:
+
+- [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#framerange)
+- [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#framerange)
+- [`combineChunks()`](/docs/renderer/combine-chunks#framerange)
+- [`renderFrames()`](/docs/renderer/render-frames#framerange)
+- [`renderMedia()`](/docs/renderer/render-media#framerange)
+- [`renderMediaOnWeb()`](/docs/web-renderer/render-media-on-web#framerange)
+
+## Config file
+
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setFrameRange(90); // To render only the 91st frame
+```
## See also
diff --git a/packages/docs/docs/options/gl.mdx b/packages/docs/docs/options/gl.mdx
index ea5fcdda31..1944cddc22 100644
--- a/packages/docs/docs/options/gl.mdx
+++ b/packages/docs/docs/options/gl.mdx
@@ -46,21 +46,28 @@ Use `--gl` with the following commands. Follow a command link for its syntax and
| [`remotion cloudrun render`](/docs/cloudrun/cli/render) | `--gl <value>` |
| [`remotion cloudrun still`](/docs/cloudrun/cli/still) | `--gl <value>` |
-## API and configuration references
-
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
-
-| Reference | Name |
-| ---------------------------------------------------------------------- | ------------------------------------ |
-| [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#gl) | `chromiumOptions.gl` |
-| [`renderStillOnCloudrun()`](/docs/cloudrun/renderstilloncloudrun#gl) | `chromiumOptions.gl` |
-| [Configuration file](/docs/config#setchromiumopenglrenderer) | `Config.setChromiumOpenGlRenderer()` |
-| [`getCompositionsOnLambda()`](/docs/lambda/getcompositionsonlambda#gl) | `chromiumOptions.gl` |
-| [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#gl) | `chromiumOptions.gl` |
-| [`renderStillOnLambda()`](/docs/lambda/renderstillonlambda#gl) | `chromiumOptions.gl` |
-| [`renderFrames()`](/docs/renderer/render-frames#gl) | `chromiumOptions.gl` |
-| [`renderMedia()`](/docs/renderer/render-media#gl) | `chromiumOptions.gl` |
-| [`renderStill()`](/docs/renderer/render-still#gl) | `chromiumOptions.gl` |
+## APIs that have this option
+
+The following APIs accept this option:
+
+- [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#gl)
+- [`renderStillOnCloudrun()`](/docs/cloudrun/renderstilloncloudrun#gl)
+- [`getCompositionsOnLambda()`](/docs/lambda/getcompositionsonlambda#gl)
+- [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#gl)
+- [`renderStillOnLambda()`](/docs/lambda/renderstillonlambda#gl)
+- [`renderFrames()`](/docs/renderer/render-frames#gl)
+- [`renderMedia()`](/docs/renderer/render-media#gl)
+- [`renderStill()`](/docs/renderer/render-still#gl)
+
+## Config file
+
+```tsx twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+
+// ---cut---
+
+Config.setChromiumOpenGlRenderer('angle');
+```
## See also
diff --git a/packages/docs/docs/options/gop.mdx b/packages/docs/docs/options/gop.mdx
index 52d5e97bbb..d8fb08c330 100644
--- a/packages/docs/docs/options/gop.mdx
+++ b/packages/docs/docs/options/gop.mdx
@@ -22,17 +22,22 @@ Use `--gop` with the following commands. Follow a command link for its syntax an
| [`remotion lambda render`](/docs/lambda/cli/render) | `--gop <value>` |
| [`remotion cloudrun render`](/docs/cloudrun/cli/render) | `--gop <value>` |
-## API and configuration references
+## APIs that have this option
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
+The following APIs accept this option:
-| Reference | Name |
-| ------------------------------------------------------------------------- | --------------------- |
-| [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#gopsize) | `gopSize` |
-| [Configuration file](/docs/config#setgopsize) | `Config.setGopSize()` |
-| [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#gopsize) | `gopSize` |
-| [`renderMedia()`](/docs/renderer/render-media#gopsize) | `gopSize` |
-| [`stitchFramesToVideo()`](/docs/renderer/stitch-frames-to-video#gopsize) | `gopSize` |
+- [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#gopsize)
+- [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#gopsize)
+- [`renderMedia()`](/docs/renderer/render-media#gopsize)
+- [`stitchFramesToVideo()`](/docs/renderer/stitch-frames-to-video#gopsize)
+
+## Config file
+
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setGopSize(239);
+```
## See also
diff --git a/packages/docs/docs/options/hardware-acceleration.mdx b/packages/docs/docs/options/hardware-acceleration.mdx
index a569e5ccd4..c733127c5f 100644
--- a/packages/docs/docs/options/hardware-acceleration.mdx
+++ b/packages/docs/docs/options/hardware-acceleration.mdx
@@ -24,16 +24,21 @@ Use `--hardware-acceleration` with the following commands. Follow a command link
| [`remotion render`](/docs/cli/render) | `--hardware-acceleration <value>` |
| [`remotion benchmark`](/docs/cli/benchmark) | `--hardware-acceleration <value>` |
-## API and configuration references
+## APIs that have this option
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
+The following APIs accept this option:
-| Reference | Name |
-| ------------------------------------------------------------------------------------- | ---------------------------------- |
-| [Configuration file](/docs/config#sethardwareacceleration) | `Config.setHardwareAcceleration()` |
-| [`renderMedia()`](/docs/renderer/render-media#hardwareacceleration) | `hardwareAcceleration` |
-| [`stitchFramesToVideo()`](/docs/renderer/stitch-frames-to-video#hardwareacceleration) | `hardwareAcceleration` |
-| [`renderMediaOnWeb()`](/docs/web-renderer/render-media-on-web#hardwareacceleration) | `hardwareAcceleration` |
+- [`renderMedia()`](/docs/renderer/render-media#hardwareacceleration)
+- [`stitchFramesToVideo()`](/docs/renderer/stitch-frames-to-video#hardwareacceleration)
+- [`renderMediaOnWeb()`](/docs/web-renderer/render-media-on-web#hardwareacceleration)
+
+## Config file
+
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setHardwareAcceleration('if-possible');
+```
## See also
diff --git a/packages/docs/docs/options/height.mdx b/packages/docs/docs/options/height.mdx
index 36e74ddb3a..150698733e 100644
--- a/packages/docs/docs/options/height.mdx
+++ b/packages/docs/docs/options/height.mdx
@@ -24,13 +24,13 @@ Use `--height` with the following commands. Follow a command link for its syntax
| [`remotion cloudrun render`](/docs/cloudrun/cli/render) | `--height <value>` |
| [`remotion cloudrun still`](/docs/cloudrun/cli/still) | `--height <value>` |
-## API and configuration references
+## Config file
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
-
-| Reference | Name |
-| ------------------------------------------------- | ------------------------- |
-| [Configuration file](/docs/config#overrideheight) | `Config.overrideHeight()` |
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.overrideHeight(600);
+```
## See also
diff --git a/packages/docs/docs/options/ignore-certificate-errors.mdx b/packages/docs/docs/options/ignore-certificate-errors.mdx
index 54c0d1d90f..1ab62029d2 100644
--- a/packages/docs/docs/options/ignore-certificate-errors.mdx
+++ b/packages/docs/docs/options/ignore-certificate-errors.mdx
@@ -28,21 +28,28 @@ Use `--ignore-certificate-errors` with the following commands. Follow a command
| [`remotion cloudrun render`](/docs/cloudrun/cli/render) | `--ignore-certificate-errors` |
| [`remotion cloudrun still`](/docs/cloudrun/cli/still) | `--ignore-certificate-errors` |
-## API and configuration references
-
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
-
-| Reference | Name |
-| ------------------------------------------------------------------------------------------- | --------------------------------------------- |
-| [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#ignorecertificateerrors) | `chromiumOptions.ignoreCertificateErrors` |
-| [`renderStillOnCloudrun()`](/docs/cloudrun/renderstilloncloudrun#ignorecertificateerrors) | `chromiumOptions.ignoreCertificateErrors` |
-| [Configuration file](/docs/config#setchromiumignorecertificateerrors) | `Config.setChromiumIgnoreCertificateErrors()` |
-| [`getCompositionsOnLambda()`](/docs/lambda/getcompositionsonlambda#ignorecertificateerrors) | `chromiumOptions.ignoreCertificateErrors` |
-| [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#ignorecertificateerrors) | `chromiumOptions.ignoreCertificateErrors` |
-| [`renderStillOnLambda()`](/docs/lambda/renderstillonlambda#ignorecertificateerrors) | `chromiumOptions.ignoreCertificateErrors` |
-| [`renderFrames()`](/docs/renderer/render-frames#ignorecertificateerrors) | `chromiumOptions.ignoreCertificateErrors` |
-| [`renderMedia()`](/docs/renderer/render-media#ignorecertificateerrors) | `chromiumOptions.ignoreCertificateErrors` |
-| [`renderStill()`](/docs/renderer/render-still#ignorecertificateerrors) | `chromiumOptions.ignoreCertificateErrors` |
+## APIs that have this option
+
+The following APIs accept this option:
+
+- [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#ignorecertificateerrors)
+- [`renderStillOnCloudrun()`](/docs/cloudrun/renderstilloncloudrun#ignorecertificateerrors)
+- [`getCompositionsOnLambda()`](/docs/lambda/getcompositionsonlambda#ignorecertificateerrors)
+- [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#ignorecertificateerrors)
+- [`renderStillOnLambda()`](/docs/lambda/renderstillonlambda#ignorecertificateerrors)
+- [`renderFrames()`](/docs/renderer/render-frames#ignorecertificateerrors)
+- [`renderMedia()`](/docs/renderer/render-media#ignorecertificateerrors)
+- [`renderStill()`](/docs/renderer/render-still#ignorecertificateerrors)
+
+## Config file
+
+```tsx twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+
+// ---cut---
+
+Config.setChromiumIgnoreCertificateErrors(true);
+```
## See also
diff --git a/packages/docs/docs/options/image-sequence-pattern.mdx b/packages/docs/docs/options/image-sequence-pattern.mdx
index 8057cd9a35..a542e0dc34 100644
--- a/packages/docs/docs/options/image-sequence-pattern.mdx
+++ b/packages/docs/docs/options/image-sequence-pattern.mdx
@@ -18,14 +18,19 @@ Use `--image-sequence-pattern` with the following commands. Follow a command lin
| ------------------------------------- | ---------------------------------- |
| [`remotion render`](/docs/cli/render) | `--image-sequence-pattern <value>` |
-## API and configuration references
+## APIs that have this option
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
+The following APIs accept this option:
-| Reference | Name |
-| ---------------------------------------------------------------------- | ---------------------------------- |
-| [Configuration file](/docs/config#setimagesequencepattern) | `Config.setImageSequencePattern()` |
-| [`renderFrames()`](/docs/renderer/render-frames#imagesequencepattern-) | `imageSequencePattern` |
+- [`renderFrames()`](/docs/renderer/render-frames#imagesequencepattern-)
+
+## Config file
+
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setImageSequencePattern('frame_[frame]_custom.[ext]');
+```
## See also
diff --git a/packages/docs/docs/options/index.mdx b/packages/docs/docs/options/index.mdx
index ed20553a1a..45d0a5e553 100644
--- a/packages/docs/docs/options/index.mdx
+++ b/packages/docs/docs/options/index.mdx
@@ -39,12 +39,12 @@ Only the CLI reads the config file. In programmatic APIs, you need to pass all o
| [Dark Mode](/docs/options/dark-mode) | `--dark-mode` | `Config.setChromiumDarkMode()`, `chromiumOptions.darkMode`, `darkMode` |
| [Default coding agent](/docs/options/coding-agent) | `--coding-agent` | `Config.setDefaultCodingAgent()` |
| [Default editor](/docs/options/editor) | `--editor` | `Config.setDefaultEditor()` |
-| [delayRender() timeout](/docs/options/timeout) | `--timeout` | `timeoutInMilliseconds` |
+| [delayRender() timeout](/docs/options/timeout) | `--timeout` | `Config.setDelayRenderTimeoutInMilliseconds()`, `timeoutInMilliseconds` |
| [Disable browser auto-open](/docs/options/no-open) | `--no-open` | `Config.setShouldOpenBrowser()` |
| [Disable Git source](/docs/options/disable-git-source) | `--disable-git-source` | — |
| [Disable Headless Mode](/docs/options/disable-headless) | `--disable-headless` | `Config.setChromiumHeadlessMode()`, `chromiumOptions.headless` |
| [Disable or Enable keyboard shortcuts](/docs/options/disable-keyboard-shortcuts) | `--disable-keyboard-shortcuts` | `keyboardShortcutsEnabled`, `options.keyboardShortcutsEnabled`, `Config.setKeyboardShortcutsEnabled()` |
-| [Disable or enable Studio canvas tabs](/docs/options/disable-canvas-tabs) | `--disable-canvas-tabs` | — |
+| [Disable or enable Studio canvas tabs](/docs/options/disable-canvas-tabs) | `--disable-canvas-tabs` | `Config.setCanvasTabsEnabled()` |
| [Disable or enable Studio interactivity](/docs/options/disable-interactivity) | `--disable-interactivity` | `Config.setInteractivityEnabled()` |
| [Disable or Enable the Ask AI option](/docs/options/disable-ask-ai) | `--disable-ask-ai` | `askAIEnabled`, `options.askAIEnabled`, `Config.setAskAIEnabled()` |
| [Disable web security](/docs/options/disable-web-security) | `--disable-web-security` | `chromiumOptions.disableWebSecurity`, `Config.setChromiumDisableWebSecurity()` |
@@ -91,7 +91,7 @@ Only the CLI reads the config file. In programmatic APIs, you need to pass all o
| [Overwrite output](/docs/options/overwrite) | `--overwrite` | `overwrite` |
| [Package Manager](/docs/options/package-manager) | `--package-manager` | — |
| [Pixel format](/docs/options/pixel-format) | `--pixel-format` | `pixelFormat`, `Config.setPixelFormat()` |
-| [Port](/docs/options/port) | `--port` | — |
+| [Port](/docs/options/port) | `--port` | `Config.setStudioPort()`, `Config.setRendererPort()` |
| [Prefer lossless](/docs/options/prefer-lossless) | `--prefer-lossless` | `preferLossless`, `Config.setPreferLosslessAudio()` |
| [Preview Sample Rate](/docs/options/preview-sample-rate) | `--preview-sample-rate` | `Config.setPreviewSampleRate()` |
| [ProRes profile](/docs/options/prores-profile) | `--prores-profile` | `proResProfile`, `Config.setProResProfile()` |
diff --git a/packages/docs/docs/options/ipv4.mdx b/packages/docs/docs/options/ipv4.mdx
index 22681f795d..054ed060f4 100644
--- a/packages/docs/docs/options/ipv4.mdx
+++ b/packages/docs/docs/options/ipv4.mdx
@@ -18,13 +18,13 @@ Use `--ipv4` with the following commands. Follow a command link for its syntax a
| ------------------------------------- | -------- |
| [`remotion studio`](/docs/cli/studio) | `--ipv4` |
-## API and configuration references
+## Config file
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
-
-| Reference | Name |
-| ------------------------------------------ | ------------------ |
-| [Configuration file](/docs/config#setipv4) | `Config.setIPv4()` |
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setIPv4(true);
+```
## See also
diff --git a/packages/docs/docs/options/is-production.mdx b/packages/docs/docs/options/is-production.mdx
index b4b378d308..136a51cfd0 100644
--- a/packages/docs/docs/options/is-production.mdx
+++ b/packages/docs/docs/options/is-production.mdx
@@ -19,18 +19,16 @@ Use `--is-production` with the following commands. Follow a command link for its
| [`remotion lambda render`](/docs/lambda/cli/render) | `--is-production` |
| [`remotion lambda still`](/docs/lambda/cli/still) | `--is-production` |
-## API and configuration references
-
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
-
-| Reference | Name |
-| --------------------------------------------------------------------------- | -------------- |
-| [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#isproduction) | `isProduction` |
-| [`renderStillOnLambda()`](/docs/lambda/renderstillonlambda#isproduction) | `isProduction` |
-| [`renderMedia()`](/docs/renderer/render-media#isproduction) | `isProduction` |
-| [`renderStill()`](/docs/renderer/render-still#isproduction) | `isProduction` |
-| [`renderMediaOnWeb()`](/docs/web-renderer/render-media-on-web#isproduction) | `isProduction` |
-| [`renderStillOnWeb()`](/docs/web-renderer/render-still-on-web#isproduction) | `isProduction` |
+## APIs that have this option
+
+The following APIs accept this option:
+
+- [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#isproduction)
+- [`renderStillOnLambda()`](/docs/lambda/renderstillonlambda#isproduction)
+- [`renderMedia()`](/docs/renderer/render-media#isproduction)
+- [`renderStill()`](/docs/renderer/render-still#isproduction)
+- [`renderMediaOnWeb()`](/docs/web-renderer/render-media-on-web#isproduction)
+- [`renderStillOnWeb()`](/docs/web-renderer/render-still-on-web#isproduction)
## See also
diff --git a/packages/docs/docs/options/jpeg-quality.mdx b/packages/docs/docs/options/jpeg-quality.mdx
index fd146b3e08..ad2ad1d805 100644
--- a/packages/docs/docs/options/jpeg-quality.mdx
+++ b/packages/docs/docs/options/jpeg-quality.mdx
@@ -25,20 +25,25 @@ Use `--jpeg-quality` with the following commands. Follow a command link for its
| [`remotion cloudrun render`](/docs/cloudrun/cli/render) | `--jpeg-quality <value>` |
| [`remotion cloudrun still`](/docs/cloudrun/cli/still) | `--jpeg-quality <value>` |
-## API and configuration references
-
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
-
-| Reference | Name |
-| ----------------------------------------------------------------------------- | ------------------------- |
-| [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#jpegquality) | `jpegQuality` |
-| [`renderStillOnCloudrun()`](/docs/cloudrun/renderstilloncloudrun#jpegquality) | `jpegQuality` |
-| [Configuration file](/docs/config#setjpegquality) | `Config.setJpegQuality()` |
-| [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#jpegquality) | `jpegQuality` |
-| [`renderStillOnLambda()`](/docs/lambda/renderstillonlambda#jpegquality) | `jpegQuality` |
-| [`renderFrames()`](/docs/renderer/render-frames#jpegquality) | `jpegQuality` |
-| [`renderMedia()`](/docs/renderer/render-media#jpegquality) | `jpegQuality` |
-| [`renderStill()`](/docs/renderer/render-still#jpegquality) | `jpegQuality` |
+## APIs that have this option
+
+The following APIs accept this option:
+
+- [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#jpegquality)
+- [`renderStillOnCloudrun()`](/docs/cloudrun/renderstilloncloudrun#jpegquality)
+- [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#jpegquality)
+- [`renderStillOnLambda()`](/docs/lambda/renderstillonlambda#jpegquality)
+- [`renderFrames()`](/docs/renderer/render-frames#jpegquality)
+- [`renderMedia()`](/docs/renderer/render-media#jpegquality)
+- [`renderStill()`](/docs/renderer/render-still#jpegquality)
+
+## Config file
+
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setJpegQuality(90);
+```
## See also
diff --git a/packages/docs/docs/options/license-key.mdx b/packages/docs/docs/options/license-key.mdx
index b75d5b856d..c42a0804ec 100644
--- a/packages/docs/docs/options/license-key.mdx
+++ b/packages/docs/docs/options/license-key.mdx
@@ -19,18 +19,16 @@ Use `--license-key` with the following commands. Follow a command link for its s
| [`remotion lambda render`](/docs/lambda/cli/render) | `--license-key <value>` |
| [`remotion lambda still`](/docs/lambda/cli/still) | `--license-key <value>` |
-## API and configuration references
-
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
-
-| Reference | Name |
-| ------------------------------------------------------------------------- | ------------ |
-| [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#licensekey) | `licenseKey` |
-| [`renderStillOnLambda()`](/docs/lambda/renderstillonlambda#licensekey) | `licenseKey` |
-| [`renderMedia()`](/docs/renderer/render-media#licensekey) | `licenseKey` |
-| [`renderStill()`](/docs/renderer/render-still#licensekey) | `licenseKey` |
-| [`renderMediaOnWeb()`](/docs/web-renderer/render-media-on-web#licensekey) | `licenseKey` |
-| [`renderStillOnWeb()`](/docs/web-renderer/render-still-on-web#licensekey) | `licenseKey` |
+## APIs that have this option
+
+The following APIs accept this option:
+
+- [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#licensekey)
+- [`renderStillOnLambda()`](/docs/lambda/renderstillonlambda#licensekey)
+- [`renderMedia()`](/docs/renderer/render-media#licensekey)
+- [`renderStill()`](/docs/renderer/render-still#licensekey)
+- [`renderMediaOnWeb()`](/docs/web-renderer/render-media-on-web#licensekey)
+- [`renderStillOnWeb()`](/docs/web-renderer/render-still-on-web#licensekey)
## See also
diff --git a/packages/docs/docs/options/log.mdx b/packages/docs/docs/options/log.mdx
index 33b2929142..7d45cf87b6 100644
--- a/packages/docs/docs/options/log.mdx
+++ b/packages/docs/docs/options/log.mdx
@@ -31,36 +31,41 @@ Use `--log` with the following commands. Follow a command link for its syntax an
| [`remotion lambda still`](/docs/lambda/cli/still) | `--log <value>` |
| [`remotion lambda compositions`](/docs/lambda/cli/compositions) | `--log <value>` |
-## API and configuration references
+## APIs that have this option
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
+The following APIs accept this option:
-| Reference | Name |
-| ---------------------------------------------------------------------------- | ---------------------- |
-| [`deploySite()`](/docs/cloudrun/deploysite#loglevel) | `logLevel` |
-| [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#loglevel) | `logLevel` |
-| [`renderStillOnCloudrun()`](/docs/cloudrun/renderstilloncloudrun#loglevel) | `logLevel` |
-| [Configuration file](/docs/config#setloglevel) | `Config.setLogLevel()` |
-| [`deploySite()`](/docs/lambda/deploysite#loglevel) | `logLevel` |
-| [`deploySiteFromBundle()`](/docs/lambda/deploysitefrombundle#loglevel) | `logLevel` |
-| [`getCompositionsOnLambda()`](/docs/lambda/getcompositionsonlambda#loglevel) | `logLevel` |
-| [`getFunctionInfo()`](/docs/lambda/getfunctioninfo#loglevel) | `logLevel` |
-| [`getFunctions()`](/docs/lambda/getfunctions#loglevel) | `logLevel` |
-| [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#loglevel) | `logLevel` |
-| [`renderStillOnLambda()`](/docs/lambda/renderstillonlambda#loglevel) | `logLevel` |
-| [`combineChunks()`](/docs/renderer/combine-chunks#loglevel) | `logLevel` |
-| [`ensureBrowser()`](/docs/renderer/ensure-browser#loglevel) | `logLevel` |
-| [`extractAudio()`](/docs/renderer/extract-audio#loglevel) | `logLevel` |
-| [`getCompositions()`](/docs/renderer/get-compositions#loglevel) | `logLevel` |
-| [`getSilentParts()`](/docs/renderer/get-silent-parts#loglevel) | `logLevel` |
-| [`getVideoMetadata()`](/docs/renderer/get-video-metadata#loglevel) | `logLevel` |
-| [`openBrowser()`](/docs/renderer/open-browser#loglevel) | `options.logLevel` |
-| [`renderFrames()`](/docs/renderer/render-frames#loglevel) | `logLevel` |
-| [`renderMedia()`](/docs/renderer/render-media#loglevel) | `logLevel` |
-| [`renderStill()`](/docs/renderer/render-still#loglevel) | `logLevel` |
-| [`selectComposition()`](/docs/renderer/select-composition#loglevel) | `logLevel` |
-| [`renderMediaOnWeb()`](/docs/web-renderer/render-media-on-web#loglevel) | `logLevel` |
-| [`renderStillOnWeb()`](/docs/web-renderer/render-still-on-web#loglevel) | `logLevel` |
+- [`deploySite()`](/docs/cloudrun/deploysite#loglevel)
+- [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#loglevel)
+- [`renderStillOnCloudrun()`](/docs/cloudrun/renderstilloncloudrun#loglevel)
+- [`deploySite()`](/docs/lambda/deploysite#loglevel)
+- [`deploySiteFromBundle()`](/docs/lambda/deploysitefrombundle#loglevel)
+- [`getCompositionsOnLambda()`](/docs/lambda/getcompositionsonlambda#loglevel)
+- [`getFunctionInfo()`](/docs/lambda/getfunctioninfo#loglevel)
+- [`getFunctions()`](/docs/lambda/getfunctions#loglevel)
+- [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#loglevel)
+- [`renderStillOnLambda()`](/docs/lambda/renderstillonlambda#loglevel)
+- [`combineChunks()`](/docs/renderer/combine-chunks#loglevel)
+- [`ensureBrowser()`](/docs/renderer/ensure-browser#loglevel)
+- [`extractAudio()`](/docs/renderer/extract-audio#loglevel)
+- [`getCompositions()`](/docs/renderer/get-compositions#loglevel)
+- [`getSilentParts()`](/docs/renderer/get-silent-parts#loglevel)
+- [`getVideoMetadata()`](/docs/renderer/get-video-metadata#loglevel)
+- [`openBrowser()`](/docs/renderer/open-browser#loglevel)
+- [`renderFrames()`](/docs/renderer/render-frames#loglevel)
+- [`renderMedia()`](/docs/renderer/render-media#loglevel)
+- [`renderStill()`](/docs/renderer/render-still#loglevel)
+- [`selectComposition()`](/docs/renderer/select-composition#loglevel)
+- [`renderMediaOnWeb()`](/docs/web-renderer/render-media-on-web#loglevel)
+- [`renderStillOnWeb()`](/docs/web-renderer/render-still-on-web#loglevel)
+
+## Config file
+
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setLogLevel('verbose');
+```
## See also
diff --git a/packages/docs/docs/options/max-rate.mdx b/packages/docs/docs/options/max-rate.mdx
index 6466d13f68..cdc49fa107 100644
--- a/packages/docs/docs/options/max-rate.mdx
+++ b/packages/docs/docs/options/max-rate.mdx
@@ -22,17 +22,22 @@ Use `--max-rate` with the following commands. Follow a command link for its synt
| [`remotion lambda render`](/docs/lambda/cli/render) | `--max-rate <value>` |
| [`remotion cloudrun render`](/docs/cloudrun/cli/render) | `--max-rate <value>` |
-## API and configuration references
+## APIs that have this option
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
+The following APIs accept this option:
-| Reference | Name |
-| ------------------------------------------------------------------------- | ----------------------------- |
-| [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#maxrate) | `maxRate` |
-| [Configuration file](/docs/config#setencodingmaxrate) | `Config.setEncodingMaxRate()` |
-| [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#maxrate) | `maxRate` |
-| [`renderMedia()`](/docs/renderer/render-media#maxrate) | `maxRate` |
-| [`stitchFramesToVideo()`](/docs/renderer/stitch-frames-to-video#maxrate) | `maxRate` |
+- [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#maxrate)
+- [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#maxrate)
+- [`renderMedia()`](/docs/renderer/render-media#maxrate)
+- [`stitchFramesToVideo()`](/docs/renderer/stitch-frames-to-video#maxrate)
+
+## Config file
+
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setEncodingMaxRate('5000k');
+```
## See also
diff --git a/packages/docs/docs/options/media-cache-size-in-bytes.mdx b/packages/docs/docs/options/media-cache-size-in-bytes.mdx
index 35f323f1a2..801621b897 100644
--- a/packages/docs/docs/options/media-cache-size-in-bytes.mdx
+++ b/packages/docs/docs/options/media-cache-size-in-bytes.mdx
@@ -26,24 +26,22 @@ Use `--media-cache-size-in-bytes` with the following commands. Follow a command
| [`remotion cloudrun render`](/docs/cloudrun/cli/render) | `--media-cache-size-in-bytes <value>` |
| [`remotion cloudrun still`](/docs/cloudrun/cli/still) | `--media-cache-size-in-bytes <value>` |
-## API and configuration references
-
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
-
-| Reference | Name |
-| ----------------------------------------------------------------------------------------- | ----------------------- |
-| [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#mediacachesizeinbytes) | `mediaCacheSizeInBytes` |
-| [`renderStillOnCloudrun()`](/docs/cloudrun/renderstilloncloudrun#mediacachesizeinbytes) | `mediaCacheSizeInBytes` |
-| [`getCompositionsOnLambda()`](/docs/lambda/getcompositionsonlambda#mediacachesizeinbytes) | `mediaCacheSizeInBytes` |
-| [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#mediacachesizeinbytes) | `mediaCacheSizeInBytes` |
-| [`renderStillOnLambda()`](/docs/lambda/renderstillonlambda#mediacachesizeinbytes) | `mediaCacheSizeInBytes` |
-| [`getCompositions()`](/docs/renderer/get-compositions#mediacachesizeinbytes) | `mediaCacheSizeInBytes` |
-| [`renderFrames()`](/docs/renderer/render-frames#mediacachesizeinbytes) | `mediaCacheSizeInBytes` |
-| [`renderMedia()`](/docs/renderer/render-media#mediacachesizeinbytes) | `mediaCacheSizeInBytes` |
-| [`renderStill()`](/docs/renderer/render-still#mediacachesizeinbytes) | `mediaCacheSizeInBytes` |
-| [`selectComposition()`](/docs/renderer/select-composition#mediacachesizeinbytes) | `mediaCacheSizeInBytes` |
-| [`renderMediaOnWeb()`](/docs/web-renderer/render-media-on-web#mediacachesizeinbytes) | `mediaCacheSizeInBytes` |
-| [`renderStillOnWeb()`](/docs/web-renderer/render-still-on-web#mediacachesizeinbytes) | `mediaCacheSizeInBytes` |
+## APIs that have this option
+
+The following APIs accept this option:
+
+- [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#mediacachesizeinbytes)
+- [`renderStillOnCloudrun()`](/docs/cloudrun/renderstilloncloudrun#mediacachesizeinbytes)
+- [`getCompositionsOnLambda()`](/docs/lambda/getcompositionsonlambda#mediacachesizeinbytes)
+- [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#mediacachesizeinbytes)
+- [`renderStillOnLambda()`](/docs/lambda/renderstillonlambda#mediacachesizeinbytes)
+- [`getCompositions()`](/docs/renderer/get-compositions#mediacachesizeinbytes)
+- [`renderFrames()`](/docs/renderer/render-frames#mediacachesizeinbytes)
+- [`renderMedia()`](/docs/renderer/render-media#mediacachesizeinbytes)
+- [`renderStill()`](/docs/renderer/render-still#mediacachesizeinbytes)
+- [`selectComposition()`](/docs/renderer/select-composition#mediacachesizeinbytes)
+- [`renderMediaOnWeb()`](/docs/web-renderer/render-media-on-web#mediacachesizeinbytes)
+- [`renderStillOnWeb()`](/docs/web-renderer/render-still-on-web#mediacachesizeinbytes)
## See also
diff --git a/packages/docs/docs/options/metadata.mdx b/packages/docs/docs/options/metadata.mdx
index d1a1e5f30b..af058d8ecc 100644
--- a/packages/docs/docs/options/metadata.mdx
+++ b/packages/docs/docs/options/metadata.mdx
@@ -27,19 +27,17 @@ Use `--metadata` with the following commands. Follow a command link for its synt
| [`remotion lambda render`](/docs/lambda/cli/render) | `--metadata <value>` |
| [`remotion cloudrun render`](/docs/cloudrun/cli/render) | `--metadata <value>` |
-## API and configuration references
-
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
-
-| Reference | Name |
-| -------------------------------------------------------------------------- | ---------- |
-| [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#metadata) | `metadata` |
-| [`renderStillOnCloudrun()`](/docs/cloudrun/renderstilloncloudrun#metadata) | `metadata` |
-| [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#metadata) | `metadata` |
-| [`combineChunks()`](/docs/renderer/combine-chunks#metadata) | `metadata` |
-| [`renderMedia()`](/docs/renderer/render-media#metadata) | `metadata` |
-| [`stitchFramesToVideo()`](/docs/renderer/stitch-frames-to-video#metadata) | `metadata` |
-| [`renderMediaOnWeb()`](/docs/web-renderer/render-media-on-web#metadata) | `metadata` |
+## APIs that have this option
+
+The following APIs accept this option:
+
+- [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#metadata)
+- [`renderStillOnCloudrun()`](/docs/cloudrun/renderstilloncloudrun#metadata)
+- [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#metadata)
+- [`combineChunks()`](/docs/renderer/combine-chunks#metadata)
+- [`renderMedia()`](/docs/renderer/render-media#metadata)
+- [`stitchFramesToVideo()`](/docs/renderer/stitch-frames-to-video#metadata)
+- [`renderMediaOnWeb()`](/docs/web-renderer/render-media-on-web#metadata)
## See also
diff --git a/packages/docs/docs/options/muted.mdx b/packages/docs/docs/options/muted.mdx
index 0e6b3e06bc..8c51b8bbc5 100644
--- a/packages/docs/docs/options/muted.mdx
+++ b/packages/docs/docs/options/muted.mdx
@@ -22,20 +22,25 @@ Use `--muted` with the following commands. Follow a command link for its syntax
| [`remotion lambda render`](/docs/lambda/cli/render) | `--muted` |
| [`remotion cloudrun render`](/docs/cloudrun/cli/render) | `--muted` |
-## API and configuration references
-
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
-
-| Reference | Name |
-| --------------------------------------------------------------------------- | ------------------- |
-| [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#muted) | `muted` |
-| [Configuration file](/docs/config#setmuted) | `Config.setMuted()` |
-| [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#muted) | `muted` |
-| [`renderFrames()`](/docs/renderer/render-frames#muted) | `muted` |
-| [`renderMedia()`](/docs/renderer/render-media#muted) | `muted` |
-| [`stitchFramesToVideo()`](/docs/renderer/stitch-frames-to-video#muted) | `muted` |
-| [`canRenderMediaOnWeb()`](/docs/web-renderer/can-render-media-on-web#muted) | `muted` |
-| [`renderMediaOnWeb()`](/docs/web-renderer/render-media-on-web#muted) | `muted` |
+## APIs that have this option
+
+The following APIs accept this option:
+
+- [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#muted)
+- [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#muted)
+- [`renderFrames()`](/docs/renderer/render-frames#muted)
+- [`renderMedia()`](/docs/renderer/render-media#muted)
+- [`stitchFramesToVideo()`](/docs/renderer/stitch-frames-to-video#muted)
+- [`canRenderMediaOnWeb()`](/docs/web-renderer/can-render-media-on-web#muted)
+- [`renderMediaOnWeb()`](/docs/web-renderer/render-media-on-web#muted)
+
+## Config file
+
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setMuted(true);
+```
## See also
diff --git a/packages/docs/docs/options/no-open.mdx b/packages/docs/docs/options/no-open.mdx
index 0e81bbbf1f..499819c35f 100644
--- a/packages/docs/docs/options/no-open.mdx
+++ b/packages/docs/docs/options/no-open.mdx
@@ -18,13 +18,14 @@ Use `--no-open` with the following commands. Follow a command link for its synta
| ------------------------------------- | ----------- |
| [`remotion studio`](/docs/cli/studio) | `--no-open` |
-## API and configuration references
+## Config file
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
-| Reference | Name |
-| ------------------------------------------------------- | ------------------------------- |
-| [Configuration file](/docs/config#setshouldopenbrowser) | `Config.setShouldOpenBrowser()` |
+// ---cut---
+Config.setShouldOpenBrowser(false);
+```
## See also
diff --git a/packages/docs/docs/options/number-of-gif-loops.mdx b/packages/docs/docs/options/number-of-gif-loops.mdx
index 0188da3f54..5ab8d13165 100644
--- a/packages/docs/docs/options/number-of-gif-loops.mdx
+++ b/packages/docs/docs/options/number-of-gif-loops.mdx
@@ -27,18 +27,23 @@ Use `--number-of-gif-loops` with the following commands. Follow a command link f
| [`remotion lambda render`](/docs/lambda/cli/render) | `--number-of-gif-loops <value>` |
| [`remotion cloudrun render`](/docs/cloudrun/cli/render) | `--number-of-gif-loops <value>` |
-## API and configuration references
-
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
-
-| Reference | Name |
-| ---------------------------------------------------------------------------------- | ------------------------------ |
-| [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#numberofgifloops) | `numberOfGifLoops` |
-| [Configuration file](/docs/config#setnumberofgifloops) | `Config.setNumberOfGifLoops()` |
-| [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#numberofgifloops) | `numberOfGifLoops` |
-| [`combineChunks()`](/docs/renderer/combine-chunks#numberofgifloops) | `numberOfGifLoops` |
-| [`renderMedia()`](/docs/renderer/render-media#numberofgifloops) | `numberOfGifLoops` |
-| [`stitchFramesToVideo()`](/docs/renderer/stitch-frames-to-video#numberofgifloops) | `numberOfGifLoops` |
+## APIs that have this option
+
+The following APIs accept this option:
+
+- [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#numberofgifloops)
+- [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#numberofgifloops)
+- [`combineChunks()`](/docs/renderer/combine-chunks#numberofgifloops)
+- [`renderMedia()`](/docs/renderer/render-media#numberofgifloops)
+- [`stitchFramesToVideo()`](/docs/renderer/stitch-frames-to-video#numberofgifloops)
+
+## Config file
+
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setNumberOfGifLoops(2);
+```
## See also
diff --git a/packages/docs/docs/options/number-of-shared-audio-tags.mdx b/packages/docs/docs/options/number-of-shared-audio-tags.mdx
index 8ec33857e0..96ffac68fb 100644
--- a/packages/docs/docs/options/number-of-shared-audio-tags.mdx
+++ b/packages/docs/docs/options/number-of-shared-audio-tags.mdx
@@ -18,13 +18,14 @@ Use `--number-of-shared-audio-tags` with the following commands. Follow a comman
| ------------------------------------- | --------------------------------------- |
| [`remotion studio`](/docs/cli/studio) | `--number-of-shared-audio-tags <value>` |
-## API and configuration references
+## Config file
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
-| Reference | Name |
-| ------------------------------------------------------------- | ------------------------------------- |
-| [Configuration file](/docs/config#setnumberofsharedaudiotags) | `Config.setNumberOfSharedAudioTags()` |
+// ---cut---
+Config.setNumberOfSharedAudioTags(5);
+```
## See also
diff --git a/packages/docs/docs/options/offthreadvideo-cache-size-in-bytes.mdx b/packages/docs/docs/options/offthreadvideo-cache-size-in-bytes.mdx
index 22055e8216..5de2c1465b 100644
--- a/packages/docs/docs/options/offthreadvideo-cache-size-in-bytes.mdx
+++ b/packages/docs/docs/options/offthreadvideo-cache-size-in-bytes.mdx
@@ -26,22 +26,20 @@ Use `--offthreadvideo-cache-size-in-bytes` with the following commands. Follow a
| [`remotion cloudrun render`](/docs/cloudrun/cli/render) | `--offthreadvideo-cache-size-in-bytes <value>` |
| [`remotion cloudrun still`](/docs/cloudrun/cli/still) | `--offthreadvideo-cache-size-in-bytes <value>` |
-## API and configuration references
-
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
-
-| Reference | Name |
-| -------------------------------------------------------------------------------------------------- | -------------------------------- |
-| [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#offthreadvideocachesizeinbytes) | `offthreadVideoCacheSizeInBytes` |
-| [`renderStillOnCloudrun()`](/docs/cloudrun/renderstilloncloudrun#offthreadvideocachesizeinbytes) | `offthreadVideoCacheSizeInBytes` |
-| [`getCompositionsOnLambda()`](/docs/lambda/getcompositionsonlambda#offthreadvideocachesizeinbytes) | `offthreadVideoCacheSizeInBytes` |
-| [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#offthreadvideocachesizeinbytes) | `offthreadVideoCacheSizeInBytes` |
-| [`renderStillOnLambda()`](/docs/lambda/renderstillonlambda#offthreadvideocachesizeinbytes) | `offthreadVideoCacheSizeInBytes` |
-| [`getCompositions()`](/docs/renderer/get-compositions#offthreadvideocachesizeinbytes) | `offthreadVideoCacheSizeInBytes` |
-| [`renderFrames()`](/docs/renderer/render-frames#offthreadvideocachesizeinbytes) | `offthreadVideoCacheSizeInBytes` |
-| [`renderMedia()`](/docs/renderer/render-media#offthreadvideocachesizeinbytes) | `offthreadVideoCacheSizeInBytes` |
-| [`renderStill()`](/docs/renderer/render-still#offthreadvideocachesizeinbytes) | `offthreadVideoCacheSizeInBytes` |
-| [`selectComposition()`](/docs/renderer/select-composition#offthreadvideocachesizeinbytes) | `offthreadVideoCacheSizeInBytes` |
+## APIs that have this option
+
+The following APIs accept this option:
+
+- [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#offthreadvideocachesizeinbytes)
+- [`renderStillOnCloudrun()`](/docs/cloudrun/renderstilloncloudrun#offthreadvideocachesizeinbytes)
+- [`getCompositionsOnLambda()`](/docs/lambda/getcompositionsonlambda#offthreadvideocachesizeinbytes)
+- [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#offthreadvideocachesizeinbytes)
+- [`renderStillOnLambda()`](/docs/lambda/renderstillonlambda#offthreadvideocachesizeinbytes)
+- [`getCompositions()`](/docs/renderer/get-compositions#offthreadvideocachesizeinbytes)
+- [`renderFrames()`](/docs/renderer/render-frames#offthreadvideocachesizeinbytes)
+- [`renderMedia()`](/docs/renderer/render-media#offthreadvideocachesizeinbytes)
+- [`renderStill()`](/docs/renderer/render-still#offthreadvideocachesizeinbytes)
+- [`selectComposition()`](/docs/renderer/select-composition#offthreadvideocachesizeinbytes)
## See also
diff --git a/packages/docs/docs/options/offthreadvideo-video-threads.mdx b/packages/docs/docs/options/offthreadvideo-video-threads.mdx
index aab0524ba8..29eb729e92 100644
--- a/packages/docs/docs/options/offthreadvideo-video-threads.mdx
+++ b/packages/docs/docs/options/offthreadvideo-video-threads.mdx
@@ -25,22 +25,20 @@ Use `--offthreadvideo-video-threads` with the following commands. Follow a comma
| [`remotion lambda still`](/docs/lambda/cli/still) | `--offthreadvideo-video-threads <value>` |
| [`remotion cloudrun render`](/docs/cloudrun/cli/render) | `--offthreadvideo-video-threads <value>` |
-## API and configuration references
-
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
-
-| Reference | Name |
-| ----------------------------------------------------------------------------------------- | ----------------------- |
-| [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#offthreadvideothreads) | `offthreadVideoThreads` |
-| [`renderStillOnCloudrun()`](/docs/cloudrun/renderstilloncloudrun#offthreadvideothreads) | `offthreadVideoThreads` |
-| [`getCompositionsOnLambda()`](/docs/lambda/getcompositionsonlambda#offthreadvideothreads) | `offthreadVideoThreads` |
-| [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#offthreadvideothreads) | `offthreadVideoThreads` |
-| [`renderStillOnLambda()`](/docs/lambda/renderstillonlambda#offthreadvideothreads) | `offthreadVideoThreads` |
-| [`getCompositions()`](/docs/renderer/get-compositions#offthreadvideothreads) | `offthreadVideoThreads` |
-| [`renderFrames()`](/docs/renderer/render-frames#offthreadvideothreads) | `offthreadVideoThreads` |
-| [`renderMedia()`](/docs/renderer/render-media#offthreadvideothreads) | `offthreadVideoThreads` |
-| [`renderStill()`](/docs/renderer/render-still#offthreadvideothreads) | `offthreadVideoThreads` |
-| [`selectComposition()`](/docs/renderer/select-composition#offthreadvideothreads) | `offthreadVideoThreads` |
+## APIs that have this option
+
+The following APIs accept this option:
+
+- [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#offthreadvideothreads)
+- [`renderStillOnCloudrun()`](/docs/cloudrun/renderstilloncloudrun#offthreadvideothreads)
+- [`getCompositionsOnLambda()`](/docs/lambda/getcompositionsonlambda#offthreadvideothreads)
+- [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#offthreadvideothreads)
+- [`renderStillOnLambda()`](/docs/lambda/renderstillonlambda#offthreadvideothreads)
+- [`getCompositions()`](/docs/renderer/get-compositions#offthreadvideothreads)
+- [`renderFrames()`](/docs/renderer/render-frames#offthreadvideothreads)
+- [`renderMedia()`](/docs/renderer/render-media#offthreadvideothreads)
+- [`renderStill()`](/docs/renderer/render-still#offthreadvideothreads)
+- [`selectComposition()`](/docs/renderer/select-composition#offthreadvideothreads)
## See also
diff --git a/packages/docs/docs/options/on-browser-download.mdx b/packages/docs/docs/options/on-browser-download.mdx
index 2cb7ccb455..3dd6d02d08 100644
--- a/packages/docs/docs/options/on-browser-download.mdx
+++ b/packages/docs/docs/options/on-browser-download.mdx
@@ -10,19 +10,17 @@ custom_edit_url: https://github.com/remotion-dev/remotion/edit/main/packages/ren
Gets called when no compatible local browser is detected on the system and this API needs to download a browser. Return a callback to observe progress. [See here for how to use this option.](/docs/renderer/ensure-browser#onbrowserdownload)
-## API and configuration references
+## APIs that have this option
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
+The following APIs accept this option:
-| Reference | Name |
-| ---------------------------------------------------------------------------- | --------------------------- |
-| [`ensureBrowser()`](/docs/renderer/ensure-browser#onbrowserdownload) | `onBrowserDownload` |
-| [`getCompositions()`](/docs/renderer/get-compositions#onbrowserdownload) | `onBrowserDownload` |
-| [`openBrowser()`](/docs/renderer/open-browser#onbrowserdownload) | `options.onBrowserDownload` |
-| [`renderFrames()`](/docs/renderer/render-frames#onbrowserdownload) | `onBrowserDownload` |
-| [`renderMedia()`](/docs/renderer/render-media#onbrowserdownload) | `onBrowserDownload` |
-| [`renderStill()`](/docs/renderer/render-still#onbrowserdownload) | `onBrowserDownload` |
-| [`selectComposition()`](/docs/renderer/select-composition#onbrowserdownload) | `onBrowserDownload` |
+- [`ensureBrowser()`](/docs/renderer/ensure-browser#onbrowserdownload)
+- [`getCompositions()`](/docs/renderer/get-compositions#onbrowserdownload)
+- [`openBrowser()`](/docs/renderer/open-browser#onbrowserdownload)
+- [`renderFrames()`](/docs/renderer/render-frames#onbrowserdownload)
+- [`renderMedia()`](/docs/renderer/render-media#onbrowserdownload)
+- [`renderStill()`](/docs/renderer/render-still#onbrowserdownload)
+- [`selectComposition()`](/docs/renderer/select-composition#onbrowserdownload)
## See also
diff --git a/packages/docs/docs/options/out-dir.mdx b/packages/docs/docs/options/out-dir.mdx
index 7579829b69..2bc2b673d3 100644
--- a/packages/docs/docs/options/out-dir.mdx
+++ b/packages/docs/docs/options/out-dir.mdx
@@ -18,14 +18,19 @@ Use `--out-dir` with the following commands. Follow a command link for its synta
| ------------------------------------- | ------------------- |
| [`remotion bundle`](/docs/cli/bundle) | `--out-dir <value>` |
-## API and configuration references
+## APIs that have this option
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
+The following APIs accept this option:
-| Reference | Name |
-| -------------------------------------------------- | -------------------------- |
-| [`bundle()`](/docs/bundle#outdir) | `outDir` |
-| [Configuration file](/docs/config#setbundleoutdir) | `Config.setBundleOutDir()` |
+- [`bundle()`](/docs/bundle#outdir)
+
+## Config file
+
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setBundleOutDir('./custom-build-dir');
+```
## See also
diff --git a/packages/docs/docs/options/overwrite.mdx b/packages/docs/docs/options/overwrite.mdx
index dab12cf4cb..33dfb4fee0 100644
--- a/packages/docs/docs/options/overwrite.mdx
+++ b/packages/docs/docs/options/overwrite.mdx
@@ -21,15 +21,13 @@ Use `--overwrite` with the following commands. Follow a command link for its syn
| [`remotion benchmark`](/docs/cli/benchmark) | `--overwrite` |
| [`remotion lambda render`](/docs/lambda/cli/render) | `--overwrite` |
-## API and configuration references
+## APIs that have this option
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
+The following APIs accept this option:
-| Reference | Name |
-| --------------------------------------------------------------------- | ----------- |
-| [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#overwrite) | `overwrite` |
-| [`renderMedia()`](/docs/renderer/render-media#overwrite) | `overwrite` |
-| [`renderStill()`](/docs/renderer/render-still#overwrite) | `overwrite` |
+- [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#overwrite)
+- [`renderMedia()`](/docs/renderer/render-media#overwrite)
+- [`renderStill()`](/docs/renderer/render-still#overwrite)
## See also
diff --git a/packages/docs/docs/options/pixel-format.mdx b/packages/docs/docs/options/pixel-format.mdx
index 5692abdc44..569b3a3d2f 100644
--- a/packages/docs/docs/options/pixel-format.mdx
+++ b/packages/docs/docs/options/pixel-format.mdx
@@ -22,17 +22,22 @@ Use `--pixel-format` with the following commands. Follow a command link for its
| [`remotion lambda render`](/docs/lambda/cli/render) | `--pixel-format <value>` |
| [`remotion cloudrun render`](/docs/cloudrun/cli/render) | `--pixel-format <value>` |
-## API and configuration references
+## APIs that have this option
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
+The following APIs accept this option:
-| Reference | Name |
-| ----------------------------------------------------------------------------- | ------------------------- |
-| [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#pixelformat) | `pixelFormat` |
-| [Configuration file](/docs/config#setpixelformat) | `Config.setPixelFormat()` |
-| [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#pixelformat) | `pixelFormat` |
-| [`renderMedia()`](/docs/renderer/render-media#pixelformat) | `pixelFormat` |
-| [`stitchFramesToVideo()`](/docs/renderer/stitch-frames-to-video#pixelformat) | `pixelFormat` |
+- [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#pixelformat)
+- [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#pixelformat)
+- [`renderMedia()`](/docs/renderer/render-media#pixelformat)
+- [`stitchFramesToVideo()`](/docs/renderer/stitch-frames-to-video#pixelformat)
+
+## Config file
+
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setPixelFormat('yuv420p');
+```
## See also
diff --git a/packages/docs/docs/options/port.mdx b/packages/docs/docs/options/port.mdx
index 56ea666afd..6e4ce87c3f 100644
--- a/packages/docs/docs/options/port.mdx
+++ b/packages/docs/docs/options/port.mdx
@@ -26,6 +26,20 @@ Use `--port` with the following commands. Follow a command link for its syntax a
| [`remotion cloudrun render`](/docs/cloudrun/cli/render) | `--port <value>` |
| [`remotion cloudrun still`](/docs/cloudrun/cli/still) | `--port <value>` |
+## Config file
+
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setStudioPort(3003);
+```
+
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setRendererPort(3004);
+```
+
## See also
- [All options](/docs/options)
diff --git a/packages/docs/docs/options/prefer-lossless.mdx b/packages/docs/docs/options/prefer-lossless.mdx
index 40fb340a89..99a86c4e48 100644
--- a/packages/docs/docs/options/prefer-lossless.mdx
+++ b/packages/docs/docs/options/prefer-lossless.mdx
@@ -18,16 +18,21 @@ Use `--prefer-lossless` with the following commands. Follow a command link for i
| --------------------------------------------------- | ------------------- |
| [`remotion lambda render`](/docs/lambda/cli/render) | `--prefer-lossless` |
-## API and configuration references
+## APIs that have this option
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
+The following APIs accept this option:
-| Reference | Name |
-| -------------------------------------------------------------------------------- | --------------------------------- |
-| [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#preferlossless) | `preferLossless` |
-| [Configuration file](/docs/config#setpreferlosslessaudio) | `Config.setPreferLosslessAudio()` |
-| [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#preferlossless) | `preferLossless` |
-| [`combineChunks()`](/docs/renderer/combine-chunks#preferlossless) | `preferLossless` |
+- [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#preferlossless)
+- [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#preferlossless)
+- [`combineChunks()`](/docs/renderer/combine-chunks#preferlossless)
+
+## Config file
+
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setPreferLosslessAudio(true);
+```
## See also
diff --git a/packages/docs/docs/options/preview-sample-rate.mdx b/packages/docs/docs/options/preview-sample-rate.mdx
index 123d3f5311..1ffa01881e 100644
--- a/packages/docs/docs/options/preview-sample-rate.mdx
+++ b/packages/docs/docs/options/preview-sample-rate.mdx
@@ -18,13 +18,13 @@ Use `--preview-sample-rate` with the following commands. Follow a command link f
| ------------------------------------- | ------------------------------- |
| [`remotion studio`](/docs/cli/studio) | `--preview-sample-rate <value>` |
-## API and configuration references
+## Config file
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
-
-| Reference | Name |
-| ------------------------------------------------------- | ------------------------------- |
-| [Configuration file](/docs/config#setpreviewsamplerate) | `Config.setPreviewSampleRate()` |
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setPreviewSampleRate(44100);
+```
## See also
diff --git a/packages/docs/docs/options/prores-profile.mdx b/packages/docs/docs/options/prores-profile.mdx
index fbaaa9065a..1c6153e5b1 100644
--- a/packages/docs/docs/options/prores-profile.mdx
+++ b/packages/docs/docs/options/prores-profile.mdx
@@ -22,17 +22,22 @@ Use `--prores-profile` with the following commands. Follow a command link for it
| [`remotion lambda render`](/docs/lambda/cli/render) | `--prores-profile <value>` |
| [`remotion cloudrun render`](/docs/cloudrun/cli/render) | `--prores-profile <value>` |
-## API and configuration references
+## APIs that have this option
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
+The following APIs accept this option:
-| Reference | Name |
-| ------------------------------------------------------------------------------- | --------------------------- |
-| [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#proresprofile) | `proResProfile` |
-| [Configuration file](/docs/config#setproresprofile) | `Config.setProResProfile()` |
-| [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#proresprofile) | `proResProfile` |
-| [`renderMedia()`](/docs/renderer/render-media#proresprofile) | `proResProfile` |
-| [`stitchFramesToVideo()`](/docs/renderer/stitch-frames-to-video#proresprofile) | `proResProfile` |
+- [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#proresprofile)
+- [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#proresprofile)
+- [`renderMedia()`](/docs/renderer/render-media#proresprofile)
+- [`stitchFramesToVideo()`](/docs/renderer/stitch-frames-to-video#proresprofile)
+
+## Config file
+
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setProResProfile('4444');
+```
## See also
diff --git a/packages/docs/docs/options/public-dir.mdx b/packages/docs/docs/options/public-dir.mdx
index b31e481313..82abb43112 100644
--- a/packages/docs/docs/options/public-dir.mdx
+++ b/packages/docs/docs/options/public-dir.mdx
@@ -24,16 +24,21 @@ Use `--public-dir` with the following commands. Follow a command link for its sy
| [`remotion benchmark`](/docs/cli/benchmark) | `--public-dir <value>` |
| [`remotion lambda sites create`](/docs/lambda/cli/sites/create) | `--public-dir <value>` |
-## API and configuration references
+## APIs that have this option
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
+The following APIs accept this option:
-| Reference | Name |
-| ----------------------------------------------------- | ----------------------- |
-| [`bundle()`](/docs/bundle#publicdir) | `publicDir` |
-| [`deploySite()`](/docs/cloudrun/deploysite#publicdir) | `options.publicDir` |
-| [Configuration file](/docs/config#setpublicdir) | `Config.setPublicDir()` |
-| [`deploySite()`](/docs/lambda/deploysite#publicdir) | `options.publicDir` |
+- [`bundle()`](/docs/bundle#publicdir)
+- [`deploySite()`](/docs/cloudrun/deploysite#publicdir)
+- [`deploySite()`](/docs/lambda/deploysite#publicdir)
+
+## Config file
+
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setPublicDir('./custom-public-dir');
+```
## See also
diff --git a/packages/docs/docs/options/public-license-key.mdx b/packages/docs/docs/options/public-license-key.mdx
index 80bc0aa2c8..1de96f2582 100644
--- a/packages/docs/docs/options/public-license-key.mdx
+++ b/packages/docs/docs/options/public-license-key.mdx
@@ -20,13 +20,13 @@ Use `--public-license-key` with the following commands. Follow a command link fo
| [`remotion render`](/docs/cli/render) | `--public-license-key <value>` |
| [`remotion still`](/docs/cli/still) | `--public-license-key <value>` |
-## API and configuration references
+## Config file
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
-
-| Reference | Name |
-| ------------------------------------------------------ | ------------------------------ |
-| [Configuration file](/docs/config#setpubliclicensekey) | `Config.setPublicLicenseKey()` |
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setPublicLicenseKey('your-license-key');
+```
## See also
diff --git a/packages/docs/docs/options/public-path.mdx b/packages/docs/docs/options/public-path.mdx
index 3392038746..592bd3de68 100644
--- a/packages/docs/docs/options/public-path.mdx
+++ b/packages/docs/docs/options/public-path.mdx
@@ -22,13 +22,11 @@ Use `--public-path` with the following commands. Follow a command link for its s
| [`remotion bundle`](/docs/cli/bundle) | `--public-path <value>` |
| [`remotion benchmark`](/docs/cli/benchmark) | `--public-path <value>` |
-## API and configuration references
+## APIs that have this option
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
+The following APIs accept this option:
-| Reference | Name |
-| ------------------------------------- | ------------ |
-| [`bundle()`](/docs/bundle#publicpath) | `publicPath` |
+- [`bundle()`](/docs/bundle#publicpath)
## See also
diff --git a/packages/docs/docs/options/repro.mdx b/packages/docs/docs/options/repro.mdx
index 0a2062ad27..ef599f4e51 100644
--- a/packages/docs/docs/options/repro.mdx
+++ b/packages/docs/docs/options/repro.mdx
@@ -19,13 +19,11 @@ Use `--repro` with the following commands. Follow a command link for its syntax
| [`remotion studio`](/docs/cli/studio) | `--repro` |
| [`remotion render`](/docs/cli/render) | `--repro` |
-## API and configuration references
+## APIs that have this option
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
+The following APIs accept this option:
-| Reference | Name |
-| ---------------------------------------------------- | ------- |
-| [`renderMedia()`](/docs/renderer/render-media#repro) | `repro` |
+- [`renderMedia()`](/docs/renderer/render-media#repro)
## See also
diff --git a/packages/docs/docs/options/rspack.mdx b/packages/docs/docs/options/rspack.mdx
index 58d521ef69..3ecccb245b 100644
--- a/packages/docs/docs/options/rspack.mdx
+++ b/packages/docs/docs/options/rspack.mdx
@@ -25,15 +25,20 @@ Use `--rspack` with the following commands. Follow a command link for its syntax
| [`remotion lambda sites create`](/docs/lambda/cli/sites/create) | `--rspack` |
| [`remotion cloudrun sites create`](/docs/cloudrun/cli/sites/create) | `--rspack` |
-## API and configuration references
+## APIs that have this option
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
+The following APIs accept this option:
-| Reference | Name |
-| -------------------------------------------------- | -------------------- |
-| [`deploySite()`](/docs/cloudrun/deploysite#rspack) | `options.rspack` |
-| [Configuration file](/docs/config#setrspack) | `Config.setRspack()` |
-| [`deploySite()`](/docs/lambda/deploysite#rspack) | `options.rspack` |
+- [`deploySite()`](/docs/cloudrun/deploysite#rspack)
+- [`deploySite()`](/docs/lambda/deploysite#rspack)
+
+## Config file
+
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setRspack(true);
+```
## See also
diff --git a/packages/docs/docs/options/runs.mdx b/packages/docs/docs/options/runs.mdx
index eded8f9df5..0443aea491 100644
--- a/packages/docs/docs/options/runs.mdx
+++ b/packages/docs/docs/options/runs.mdx
@@ -18,13 +18,13 @@ Use `--runs` with the following commands. Follow a command link for its syntax a
| ------------------------------------------- | ---------------- |
| [`remotion benchmark`](/docs/cli/benchmark) | `--runs <value>` |
-## API and configuration references
+## Config file
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
-
-| Reference | Name |
-| --------------------------------------------------- | --------------------------- |
-| [Configuration file](/docs/config#setbenchmarkruns) | `Config.setBenchmarkRuns()` |
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setBenchmarkRuns(5);
+```
## See also
diff --git a/packages/docs/docs/options/sample-rate.mdx b/packages/docs/docs/options/sample-rate.mdx
index 553517723e..97e5c2e24b 100644
--- a/packages/docs/docs/options/sample-rate.mdx
+++ b/packages/docs/docs/options/sample-rate.mdx
@@ -22,17 +22,22 @@ Use `--sample-rate` with the following commands. Follow a command link for its s
| [`remotion lambda render`](/docs/lambda/cli/render) | `--sample-rate <value>` |
| [`remotion cloudrun render`](/docs/cloudrun/cli/render) | `--sample-rate <value>` |
-## API and configuration references
+## APIs that have this option
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
+The following APIs accept this option:
-| Reference | Name |
-| ---------------------------------------------------------------------------- | ------------------------ |
-| [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#samplerate) | `sampleRate` |
-| [Configuration file](/docs/config#setsamplerate) | `Config.setSampleRate()` |
-| [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#samplerate) | `sampleRate` |
-| [`renderMedia()`](/docs/renderer/render-media#samplerate) | `sampleRate` |
-| [`renderMediaOnWeb()`](/docs/web-renderer/render-media-on-web#samplerate) | `sampleRate` |
+- [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#samplerate)
+- [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#samplerate)
+- [`renderMedia()`](/docs/renderer/render-media#samplerate)
+- [`renderMediaOnWeb()`](/docs/web-renderer/render-media-on-web#samplerate)
+
+## Config file
+
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setSampleRate(44100);
+```
## See also
diff --git a/packages/docs/docs/options/scale.mdx b/packages/docs/docs/options/scale.mdx
index aa64719bd5..d78c8f32ab 100644
--- a/packages/docs/docs/options/scale.mdx
+++ b/packages/docs/docs/options/scale.mdx
@@ -25,23 +25,28 @@ Use `--scale` with the following commands. Follow a command link for its syntax
| [`remotion cloudrun render`](/docs/cloudrun/cli/render) | `--scale <value>` |
| [`remotion cloudrun still`](/docs/cloudrun/cli/still) | `--scale <value>` |
-## API and configuration references
-
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
-
-| Reference | Name |
-| --------------------------------------------------------------------------- | ------------------- |
-| [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#scale) | `scale` |
-| [`renderStillOnCloudrun()`](/docs/cloudrun/renderstilloncloudrun#scale) | `scale` |
-| [Configuration file](/docs/config#setscale) | `Config.setScale()` |
-| [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#scale) | `scale` |
-| [`renderStillOnLambda()`](/docs/lambda/renderstillonlambda#scale) | `scale` |
-| [`renderFrames()`](/docs/renderer/render-frames#scale) | `scale` |
-| [`renderMedia()`](/docs/renderer/render-media#scale) | `scale` |
-| [`renderStill()`](/docs/renderer/render-still#scale) | `scale` |
-| [`canRenderMediaOnWeb()`](/docs/web-renderer/can-render-media-on-web#scale) | `scale` |
-| [`renderMediaOnWeb()`](/docs/web-renderer/render-media-on-web#scale) | `scale` |
-| [`renderStillOnWeb()`](/docs/web-renderer/render-still-on-web#scale) | `scale` |
+## APIs that have this option
+
+The following APIs accept this option:
+
+- [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#scale)
+- [`renderStillOnCloudrun()`](/docs/cloudrun/renderstilloncloudrun#scale)
+- [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#scale)
+- [`renderStillOnLambda()`](/docs/lambda/renderstillonlambda#scale)
+- [`renderFrames()`](/docs/renderer/render-frames#scale)
+- [`renderMedia()`](/docs/renderer/render-media#scale)
+- [`renderStill()`](/docs/renderer/render-still#scale)
+- [`canRenderMediaOnWeb()`](/docs/web-renderer/can-render-media-on-web#scale)
+- [`renderMediaOnWeb()`](/docs/web-renderer/render-media-on-web#scale)
+- [`renderStillOnWeb()`](/docs/web-renderer/render-still-on-web#scale)
+
+## Config file
+
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setScale(2);
+```
## See also
diff --git a/packages/docs/docs/options/separate-audio-to.mdx b/packages/docs/docs/options/separate-audio-to.mdx
index 309f74ea66..5fb132cb14 100644
--- a/packages/docs/docs/options/separate-audio-to.mdx
+++ b/packages/docs/docs/options/separate-audio-to.mdx
@@ -18,14 +18,12 @@ Use `--separate-audio-to` with the following commands. Follow a command link for
| ------------------------------------- | ----------------------------- |
| [`remotion render`](/docs/cli/render) | `--separate-audio-to <value>` |
-## API and configuration references
+## APIs that have this option
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
+The following APIs accept this option:
-| Reference | Name |
-| -------------------------------------------------------------------------------- | ----------------- |
-| [`renderMedia()`](/docs/renderer/render-media#separateaudioto) | `separateAudioTo` |
-| [`stitchFramesToVideo()`](/docs/renderer/stitch-frames-to-video#separateaudioto) | `separateAudioTo` |
+- [`renderMedia()`](/docs/renderer/render-media#separateaudioto)
+- [`stitchFramesToVideo()`](/docs/renderer/stitch-frames-to-video#separateaudioto)
## See also
diff --git a/packages/docs/docs/options/sequence.mdx b/packages/docs/docs/options/sequence.mdx
index cb2a87c6d9..25ab681557 100644
--- a/packages/docs/docs/options/sequence.mdx
+++ b/packages/docs/docs/options/sequence.mdx
@@ -18,13 +18,13 @@ Use `--sequence` with the following commands. Follow a command link for its synt
| ------------------------------------- | ------------ |
| [`remotion render`](/docs/cli/render) | `--sequence` |
-## API and configuration references
+## Config file
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
-
-| Reference | Name |
-| --------------------------------------------------- | --------------------------- |
-| [Configuration file](/docs/config#setimagesequence) | `Config.setImageSequence()` |
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setImageSequence(true);
+```
## See also
diff --git a/packages/docs/docs/options/still-image-format.mdx b/packages/docs/docs/options/still-image-format.mdx
index 6ae45c1399..35d25c11a1 100644
--- a/packages/docs/docs/options/still-image-format.mdx
+++ b/packages/docs/docs/options/still-image-format.mdx
@@ -21,16 +21,21 @@ Use `--image-format` with the following commands. Follow a command link for its
| [`remotion lambda still`](/docs/lambda/cli/still) | `--image-format <value>` |
| [`remotion cloudrun still`](/docs/cloudrun/cli/still) | `--image-format <value>` |
-## API and configuration references
+## APIs that have this option
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
+The following APIs accept this option:
-| Reference | Name |
-| ----------------------------------------------------------------------------- | ------------------------------ |
-| [`renderStillOnCloudrun()`](/docs/cloudrun/renderstilloncloudrun#imageformat) | `imageFormat` |
-| [Configuration file](/docs/config#setstillimageformat) | `Config.setStillImageFormat()` |
-| [`renderStillOnLambda()`](/docs/lambda/renderstillonlambda#imageformat) | `imageFormat` |
-| [`renderStill()`](/docs/renderer/render-still#imageformat) | `imageFormat` |
+- [`renderStillOnCloudrun()`](/docs/cloudrun/renderstilloncloudrun#imageformat)
+- [`renderStillOnLambda()`](/docs/lambda/renderstillonlambda#imageformat)
+- [`renderStill()`](/docs/renderer/render-still#imageformat)
+
+## Config file
+
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setStillImageFormat('pdf');
+```
## See also
diff --git a/packages/docs/docs/options/throw-if-site-exists.mdx b/packages/docs/docs/options/throw-if-site-exists.mdx
index 7177af709a..8fdc38f1b7 100644
--- a/packages/docs/docs/options/throw-if-site-exists.mdx
+++ b/packages/docs/docs/options/throw-if-site-exists.mdx
@@ -18,14 +18,12 @@ Use `--throw-if-site-exists` with the following commands. Follow a command link
| --------------------------------------------------------------- | ------------------------ |
| [`remotion lambda sites create`](/docs/lambda/cli/sites/create) | `--throw-if-site-exists` |
-## API and configuration references
+## APIs that have this option
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
+The following APIs accept this option:
-| Reference | Name |
-| ------------------------------------------------------------------------------- | ------------------- |
-| [`deploySite()`](/docs/lambda/deploysite#throwifsiteexists) | `throwIfSiteExists` |
-| [`deploySiteFromBundle()`](/docs/lambda/deploysitefrombundle#throwifsiteexists) | `throwIfSiteExists` |
+- [`deploySite()`](/docs/lambda/deploysite#throwifsiteexists)
+- [`deploySiteFromBundle()`](/docs/lambda/deploysitefrombundle#throwifsiteexists)
## See also
diff --git a/packages/docs/docs/options/timeout.mdx b/packages/docs/docs/options/timeout.mdx
index f03d6de59c..2797498666 100644
--- a/packages/docs/docs/options/timeout.mdx
+++ b/packages/docs/docs/options/timeout.mdx
@@ -28,20 +28,26 @@ Use `--timeout` with the following commands. Follow a command link for its synta
| [`remotion cloudrun render`](/docs/cloudrun/cli/render) | `--timeout <value>` |
| [`remotion cloudrun still`](/docs/cloudrun/cli/still) | `--timeout <value>` |
-## API and configuration references
-
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
-
-| Reference | Name |
-| ----------------------------------------------------------------------------------------- | ----------------------- |
-| [`getCompositionsOnLambda()`](/docs/lambda/getcompositionsonlambda#timeoutinmilliseconds) | `timeoutInMilliseconds` |
-| [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#timeoutinmilliseconds) | `timeoutInMilliseconds` |
-| [`renderStillOnLambda()`](/docs/lambda/renderstillonlambda#timeoutinmilliseconds) | `timeoutInMilliseconds` |
-| [`getCompositions()`](/docs/renderer/get-compositions#timeoutinmilliseconds) | `timeoutInMilliseconds` |
-| [`renderFrames()`](/docs/renderer/render-frames#timeoutinmilliseconds) | `timeoutInMilliseconds` |
-| [`renderMedia()`](/docs/renderer/render-media#timeoutinmilliseconds) | `timeoutInMilliseconds` |
-| [`renderStill()`](/docs/renderer/render-still#timeoutinmilliseconds) | `timeoutInMilliseconds` |
-| [`selectComposition()`](/docs/renderer/select-composition#timeoutinmilliseconds) | `timeoutInMilliseconds` |
+## APIs that have this option
+
+The following APIs accept this option:
+
+- [`getCompositionsOnLambda()`](/docs/lambda/getcompositionsonlambda#timeoutinmilliseconds)
+- [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#timeoutinmilliseconds)
+- [`renderStillOnLambda()`](/docs/lambda/renderstillonlambda#timeoutinmilliseconds)
+- [`getCompositions()`](/docs/renderer/get-compositions#timeoutinmilliseconds)
+- [`renderFrames()`](/docs/renderer/render-frames#timeoutinmilliseconds)
+- [`renderMedia()`](/docs/renderer/render-media#timeoutinmilliseconds)
+- [`renderStill()`](/docs/renderer/render-still#timeoutinmilliseconds)
+- [`selectComposition()`](/docs/renderer/select-composition#timeoutinmilliseconds)
+
+## Config file
+
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setDelayRenderTimeoutInMilliseconds(60000);
+```
## See also
diff --git a/packages/docs/docs/options/user-agent.mdx b/packages/docs/docs/options/user-agent.mdx
index 8a228a670b..a6c40c6c53 100644
--- a/packages/docs/docs/options/user-agent.mdx
+++ b/packages/docs/docs/options/user-agent.mdx
@@ -28,17 +28,15 @@ Use `--user-agent` with the following commands. Follow a command link for its sy
| [`remotion cloudrun render`](/docs/cloudrun/cli/render) | `--user-agent <value>` |
| [`remotion cloudrun still`](/docs/cloudrun/cli/still) | `--user-agent <value>` |
-## API and configuration references
+## APIs that have this option
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
+The following APIs accept this option:
-| Reference | Name |
-| ----------------------------------------------------------------------------- | --------------------------- |
-| [`getCompositionsOnLambda()`](/docs/lambda/getcompositionsonlambda#useragent) | `chromiumOptions.userAgent` |
-| [`renderStillOnLambda()`](/docs/lambda/renderstillonlambda#useragent) | `chromiumOptions.userAgent` |
-| [`renderFrames()`](/docs/renderer/render-frames#useragent) | `chromiumOptions.userAgent` |
-| [`renderMedia()`](/docs/renderer/render-media#useragent) | `userAgent` |
-| [`renderStill()`](/docs/renderer/render-still#useragent) | `chromiumOptions.userAgent` |
+- [`getCompositionsOnLambda()`](/docs/lambda/getcompositionsonlambda#useragent)
+- [`renderStillOnLambda()`](/docs/lambda/renderstillonlambda#useragent)
+- [`renderFrames()`](/docs/renderer/render-frames#useragent)
+- [`renderMedia()`](/docs/renderer/render-media#useragent)
+- [`renderStill()`](/docs/renderer/render-still#useragent)
## See also
diff --git a/packages/docs/docs/options/video-bitrate.mdx b/packages/docs/docs/options/video-bitrate.mdx
index 20ad03f067..8480f7341b 100644
--- a/packages/docs/docs/options/video-bitrate.mdx
+++ b/packages/docs/docs/options/video-bitrate.mdx
@@ -22,20 +22,25 @@ Use `--video-bitrate` with the following commands. Follow a command link for its
| [`remotion lambda render`](/docs/lambda/cli/render) | `--video-bitrate <value>` |
| [`remotion cloudrun render`](/docs/cloudrun/cli/render) | `--video-bitrate <value>` |
-## API and configuration references
-
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
-
-| Reference | Name |
-| ----------------------------------------------------------------------------------------- | -------------------------- |
-| [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#videobitrate) | `videoBitrate` |
-| [Configuration file](/docs/config#setvideobitrate) | `Config.setVideoBitrate()` |
-| [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#videobitrate) | `videoBitrate` |
-| [`renderMedia()`](/docs/renderer/render-media#videobitrate) | `videoBitrate` |
-| [`stitchFramesToVideo()`](/docs/renderer/stitch-frames-to-video#videobitrate) | `videoBitrate` |
-| [`canRenderMediaOnWeb()`](/docs/web-renderer/can-render-media-on-web#videobitrate) | `videoBitrate` |
-| [`getEncodableVideoCodecs()`](/docs/web-renderer/get-encodable-video-codecs#videobitrate) | `options.videoBitrate` |
-| [`renderMediaOnWeb()`](/docs/web-renderer/render-media-on-web#videobitrate) | `videoBitrate` |
+## APIs that have this option
+
+The following APIs accept this option:
+
+- [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#videobitrate)
+- [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#videobitrate)
+- [`renderMedia()`](/docs/renderer/render-media#videobitrate)
+- [`stitchFramesToVideo()`](/docs/renderer/stitch-frames-to-video#videobitrate)
+- [`canRenderMediaOnWeb()`](/docs/web-renderer/can-render-media-on-web#videobitrate)
+- [`getEncodableVideoCodecs()`](/docs/web-renderer/get-encodable-video-codecs#videobitrate)
+- [`renderMediaOnWeb()`](/docs/web-renderer/render-media-on-web#videobitrate)
+
+## Config file
+
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setVideoBitrate('1M');
+```
## See also
diff --git a/packages/docs/docs/options/video-image-format.mdx b/packages/docs/docs/options/video-image-format.mdx
index 0b1c6a4c94..b20af9dfea 100644
--- a/packages/docs/docs/options/video-image-format.mdx
+++ b/packages/docs/docs/options/video-image-format.mdx
@@ -22,17 +22,22 @@ Use `--image-format` with the following commands. Follow a command link for its
| [`remotion lambda render`](/docs/lambda/cli/render) | `--image-format <value>` |
| [`remotion cloudrun render`](/docs/cloudrun/cli/render) | `--image-format <value>` |
-## API and configuration references
+## APIs that have this option
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
+The following APIs accept this option:
-| Reference | Name |
-| ----------------------------------------------------------------------------- | ------------------------------ |
-| [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#imageformat) | `imageFormat` |
-| [Configuration file](/docs/config#setvideoimageformat) | `Config.setVideoImageFormat()` |
-| [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#imageformat) | `imageFormat` |
-| [`renderFrames()`](/docs/renderer/render-frames#imageformat) | `imageFormat` |
-| [`renderMedia()`](/docs/renderer/render-media#imageformat) | `imageFormat` |
+- [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#imageformat)
+- [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#imageformat)
+- [`renderFrames()`](/docs/renderer/render-frames#imageformat)
+- [`renderMedia()`](/docs/renderer/render-media#imageformat)
+
+## Config file
+
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setVideoImageFormat('png');
+```
## See also
diff --git a/packages/docs/docs/options/webpack-poll.mdx b/packages/docs/docs/options/webpack-poll.mdx
index 7d02495792..d7b61d98be 100644
--- a/packages/docs/docs/options/webpack-poll.mdx
+++ b/packages/docs/docs/options/webpack-poll.mdx
@@ -18,13 +18,13 @@ Use `--webpack-poll` with the following commands. Follow a command link for its
| ------------------------------------- | ------------------------ |
| [`remotion studio`](/docs/cli/studio) | `--webpack-poll <value>` |
-## API and configuration references
+## Config file
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
-
-| Reference | Name |
-| ------------------------------------------------------------------ | ------------------------------------------ |
-| [Configuration file](/docs/config#setwebpackpollinginmilliseconds) | `Config.setWebpackPollingInMilliseconds()` |
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setWebpackPollingInMilliseconds(1000);
+```
## See also
diff --git a/packages/docs/docs/options/width.mdx b/packages/docs/docs/options/width.mdx
index 8178fab53d..37e87f95f1 100644
--- a/packages/docs/docs/options/width.mdx
+++ b/packages/docs/docs/options/width.mdx
@@ -24,13 +24,13 @@ Use `--width` with the following commands. Follow a command link for its syntax
| [`remotion cloudrun render`](/docs/cloudrun/cli/render) | `--width <value>` |
| [`remotion cloudrun still`](/docs/cloudrun/cli/still) | `--width <value>` |
-## API and configuration references
+## Config file
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
-
-| Reference | Name |
-| ------------------------------------------------ | ------------------------ |
-| [Configuration file](/docs/config#overridewidth) | `Config.overrideWidth()` |
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.overrideWidth(900);
+```
## See also
diff --git a/packages/docs/docs/options/x264-preset.mdx b/packages/docs/docs/options/x264-preset.mdx
index d330d4238d..454dd4fe19 100644
--- a/packages/docs/docs/options/x264-preset.mdx
+++ b/packages/docs/docs/options/x264-preset.mdx
@@ -22,17 +22,22 @@ Use `--x264-preset` with the following commands. Follow a command link for its s
| [`remotion lambda render`](/docs/lambda/cli/render) | `--x264-preset <value>` |
| [`remotion cloudrun render`](/docs/cloudrun/cli/render) | `--x264-preset <value>` |
-## API and configuration references
+## APIs that have this option
-Follow a reference for the parameter name, default value, and examples in that API or configuration method.
+The following APIs accept this option:
-| Reference | Name |
-| ---------------------------------------------------------------------------- | ------------------------ |
-| [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#x264preset) | `x264Preset` |
-| [Configuration file](/docs/config#setx264preset) | `Config.setX264Preset()` |
-| [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#x264preset) | `x264Preset` |
-| [`renderMedia()`](/docs/renderer/render-media#x264preset) | `x264Preset` |
-| [`stitchFramesToVideo()`](/docs/renderer/stitch-frames-to-video#x264preset) | `x264Preset` |
+- [`renderMediaOnCloudrun()`](/docs/cloudrun/rendermediaoncloudrun#x264preset)
+- [`renderMediaOnLambda()`](/docs/lambda/rendermediaonlambda#x264preset)
+- [`renderMedia()`](/docs/renderer/render-media#x264preset)
+- [`stitchFramesToVideo()`](/docs/renderer/stitch-frames-to-video#x264preset)
+
+## Config file
+
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setX264Preset('fast');
+```
## See also
diff --git a/packages/docs/generate-option-docs.ts b/packages/docs/generate-option-docs.ts
index a9ba8beef1..3ec9f58714 100644
--- a/packages/docs/generate-option-docs.ts
+++ b/packages/docs/generate-option-docs.ts
@@ -115,24 +115,41 @@ const generateOptionDocs = async () => {
);
}
- if (usages.length > 0) {
+ const apiReferences = [
+ ...new Map(
+ usages
+ .filter((usage) => !usage.config)
+ .map((usage) => [usage.url, usage]),
+ ).values(),
+ ];
+ if (apiReferences.length > 0) {
sections.push(
'',
- '## API and configuration references',
+ '## APIs that have this option',
'',
- 'Follow a reference for the parameter name, default value, and examples in that API or configuration method.',
+ 'The following APIs accept this option:',
'',
- '| Reference | Name |',
- '| --- | --- |',
- ...usages.map((usage) => {
- const title = usage.title.endsWith('()')
- ? `\`${usage.title}\``
- : usage.title;
- return `| [${title}](${usage.url}) | \`${usage.name}\`${usage.deprecated ? ' (deprecated)' : ''} |`;
- }),
+ ...apiReferences.map(
+ (usage) =>
+ `- [\`${usage.title}\`](${usage.url})${usage.deprecated ? ' (deprecated)' : ''}`,
+ ),
);
}
+ const configReferences = usages.filter(
+ (usage) => usage.config && !usage.deprecated,
+ );
+ if (configReferences.length > 0) {
+ sections.push('', '## Config file');
+ for (const usage of configReferences) {
+ if (usage.configExample === null) {
+ throw new Error(`No config example found for ${usage.url}`);
+ }
+
+ sections.push('', usage.configExample);
+ }
+ }
+
sections.push('', '## See also', '', '- [All options](/docs/options)');
if (option.docLink !== null) {
sections.push(
diff --git a/packages/docs/option-references.ts b/packages/docs/option-references.ts
index ed894c7c06..f556842af7 100644
--- a/packages/docs/option-references.ts
+++ b/packages/docs/option-references.ts
@@ -8,6 +8,8 @@ export type OptionReference = {
url: string;
name: string;
cli: boolean;
+ config: boolean;
+ configExample: string | null;
deprecated: boolean;
};
@@ -26,6 +28,7 @@ type MarkdownNode =
children: MarkdownNode[];
}
| {type: 'mdxFlowExpression' | 'mdxTextExpression'; value: string}
+ | {type: 'link'; url: string; children: MarkdownNode[]}
| {
type:
| 'root'
@@ -33,13 +36,16 @@ type MarkdownNode =
| 'emphasis'
| 'strong'
| 'delete'
- | 'link'
| 'list'
| 'listItem'
| 'blockquote';
children: MarkdownNode[];
}
- | {type: 'code' | 'html' | 'thematicBreak' | 'break' | 'mdxjsEsm'};
+ | {
+ type: 'code';
+ position: {start: {offset: number}; end: {offset: number}};
+ }
+ | {type: 'html' | 'thematicBreak' | 'break' | 'mdxjsEsm'};
export const collectOptionReferences = (
options: readonly AnyRemotionOption<unknown>[],
@@ -121,6 +127,7 @@ export const collectOptionReferences = (
let heading: {
name: string;
url: string;
+ configExample: string | null;
deprecated: boolean;
} | null = null;
const parents: {depth: number; name: string}[] = [];
@@ -157,6 +164,8 @@ export const collectOptionReferences = (
url: currentHeading.url,
name,
cli,
+ config,
+ configExample: currentHeading.configExample,
deprecated: currentHeading.deprecated,
});
references.set(id, entries);
@@ -190,6 +199,31 @@ export const collectOptionReferences = (
}
const name = headingCode(node)?.replace(/\?$/, '') ?? null;
+ let configExample: string | null = null;
+ if (config) {
+ for (
+ let index = tree.children.indexOf(node) + 1;
+ index < tree.children.length;
+ index++
+ ) {
+ const sibling = tree.children[index];
+ if (sibling.type === 'heading' && sibling.depth <= node.depth) {
+ break;
+ }
+
+ if (sibling.type === 'code') {
+ const snippet = content.slice(
+ sibling.position.start.offset,
+ sibling.position.end.offset,
+ );
+ if (/^ {0,3}(?:`{3,}|~{3,})/.test(snippet)) {
+ configExample = snippet;
+ break;
+ }
+ }
+ }
+ }
+
heading =
name === null || !inputSection
? null
@@ -198,6 +232,7 @@ export const collectOptionReferences = (
? `Config.${name}`
: [...parents.map((parent) => parent.name), name].join('.'),
url: `${docUrl}#${anchor}`,
+ configExample,
deprecated: source.includes('~~'),
};
// Some pages use inconsistent heading depths for sibling fields.
@@ -254,6 +289,25 @@ export const collectOptionReferences = (
return;
}
+ if (
+ config &&
+ heading !== null &&
+ !heading.deprecated &&
+ node.type === 'paragraph' &&
+ text(node).includes('flag takes precedence over this option')
+ ) {
+ for (const child of node.children) {
+ if (child.type !== 'link') {
+ continue;
+ }
+
+ const id = child.url.match(/^\/docs\/options\/([a-z0-9-]+)$/)?.[1];
+ if (id && options.some((option) => option.id === id)) {
+ addReference(id, heading);
+ }
+ }
+ }
+
if (
(node.type === 'mdxJsxFlowElement' ||
node.type === 'mdxJsxTextElement') &&