@remotion/renderer 4.0.533 → 4.0.534

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (174) hide show
  1. package/dist/aac-priming.js +6 -2
  2. package/dist/browser/BrowserFetcher.d.ts +7 -1
  3. package/dist/browser/BrowserFetcher.js +33 -13
  4. package/dist/browser/Connection.js +5 -17
  5. package/dist/browser/DOMWorld.js +19 -13
  6. package/dist/browser/devtools-commands.d.ts +13 -1
  7. package/dist/browser/devtools-types.d.ts +62 -0
  8. package/dist/browser/get-chrome-download-url.d.ts +1 -1
  9. package/dist/browser/get-chrome-download-url.js +19 -33
  10. package/dist/can-use-parallel-encoding.d.ts +0 -1
  11. package/dist/can-use-parallel-encoding.js +10 -10
  12. package/dist/client.d.ts +87 -4
  13. package/dist/client.js +2 -0
  14. package/dist/cycle-browser-tabs.js +9 -1
  15. package/dist/ensure-browser.js +30 -6
  16. package/dist/esm/client.mjs +937 -796
  17. package/dist/esm/index.mjs +4125 -3027
  18. package/dist/esm/pure.mjs +33 -9
  19. package/dist/file-extensions.js +4 -1
  20. package/dist/get-mp4-brand.d.ts +1 -0
  21. package/dist/get-mp4-brand.js +21 -0
  22. package/dist/image-format.d.ts +1 -0
  23. package/dist/image-format.js +8 -4
  24. package/dist/index.d.ts +11 -1
  25. package/dist/index.js +4 -0
  26. package/dist/memory/from-macos-sysctl.d.ts +1 -0
  27. package/dist/memory/from-macos-sysctl.js +50 -0
  28. package/dist/memory/from-proc-meminfo.d.ts +1 -1
  29. package/dist/memory/from-proc-meminfo.js +7 -4
  30. package/dist/memory/get-available-memory.js +29 -21
  31. package/dist/mux-video-and-audio.js +8 -2
  32. package/dist/next-frame-to-render.d.ts +3 -7
  33. package/dist/next-frame-to-render.js +3 -22
  34. package/dist/open-browser.js +1 -0
  35. package/dist/options/allow-html-in-canvas.js +1 -1
  36. package/dist/options/api-key.js +1 -1
  37. package/dist/options/ask-ai.js +1 -1
  38. package/dist/options/audio-bitrate.js +1 -1
  39. package/dist/options/audio-codec.js +12 -6
  40. package/dist/options/beep-on-finish.js +1 -1
  41. package/dist/options/benchmark-concurrencies.js +1 -1
  42. package/dist/options/binaries-directory.js +1 -1
  43. package/dist/options/browser-executable.js +1 -1
  44. package/dist/options/browser.js +1 -1
  45. package/dist/options/bundle-cache.js +1 -1
  46. package/dist/options/canvas-tabs.js +1 -1
  47. package/dist/options/chrome-mode.js +1 -1
  48. package/dist/options/color-space.js +1 -1
  49. package/dist/options/concurrency.js +1 -1
  50. package/dist/options/config.js +1 -1
  51. package/dist/options/crf.js +1 -1
  52. package/dist/options/cross-site-isolation.js +1 -1
  53. package/dist/options/dark-mode.js +1 -1
  54. package/dist/options/default-coding-agent.js +1 -1
  55. package/dist/options/default-editor.js +1 -1
  56. package/dist/options/delete-after.js +1 -1
  57. package/dist/options/disable-git-source.js +1 -1
  58. package/dist/options/disable-shared-memory-capture.d.ts +16 -0
  59. package/dist/options/disable-shared-memory-capture.js +29 -0
  60. package/dist/options/disable-web-security.js +1 -1
  61. package/dist/options/disallow-parallel-encoding.js +1 -1
  62. package/dist/options/enable-cancellation.js +1 -1
  63. package/dist/options/enable-lambda-insights.js +1 -1
  64. package/dist/options/enable-multiprocess-on-linux.js +1 -1
  65. package/dist/options/encoding-buffer-size.js +1 -1
  66. package/dist/options/encoding-max-rate.js +1 -1
  67. package/dist/options/enforce-audio.js +1 -1
  68. package/dist/options/env-file.js +1 -1
  69. package/dist/options/every-nth-frame.js +1 -1
  70. package/dist/options/experimental-keep-audio-context-alive.js +1 -1
  71. package/dist/options/experimental-tracks.d.ts +18 -0
  72. package/dist/options/experimental-tracks.js +42 -0
  73. package/dist/options/folder-expiry.js +1 -1
  74. package/dist/options/for-seamless-aac-concatenation.js +1 -1
  75. package/dist/options/force-new-studio.js +1 -1
  76. package/dist/options/frames.js +1 -1
  77. package/dist/options/gl.js +1 -1
  78. package/dist/options/gop-size.js +1 -1
  79. package/dist/options/hardware-acceleration.js +1 -1
  80. package/dist/options/headless.js +1 -1
  81. package/dist/options/ignore-certificate-errors.js +1 -1
  82. package/dist/options/image-sequence-pattern.d.ts +1 -1
  83. package/dist/options/image-sequence-pattern.js +1 -1
  84. package/dist/options/image-sequence.js +1 -1
  85. package/dist/options/index.d.ts +36 -2
  86. package/dist/options/index.js +4 -0
  87. package/dist/options/interactivity.js +1 -1
  88. package/dist/options/ipv4.js +1 -1
  89. package/dist/options/is-production.js +1 -1
  90. package/dist/options/jpeg-quality.js +5 -2
  91. package/dist/options/keyboard-shortcuts.js +1 -1
  92. package/dist/options/latency-hint.js +1 -1
  93. package/dist/options/license-key.js +1 -1
  94. package/dist/options/log-level.js +1 -1
  95. package/dist/options/metadata.js +1 -1
  96. package/dist/options/mute.js +1 -1
  97. package/dist/options/no-open.js +1 -1
  98. package/dist/options/number-of-gif-loops.js +1 -1
  99. package/dist/options/number-of-shared-audio-tags.js +1 -1
  100. package/dist/options/offthreadvideo-cache-size.js +1 -1
  101. package/dist/options/offthreadvideo-threads.js +1 -1
  102. package/dist/options/on-browser-download.js +1 -1
  103. package/dist/options/options-map.d.ts +49 -1
  104. package/dist/options/options-map.js +4 -0
  105. package/dist/options/out-dir.js +1 -1
  106. package/dist/options/override-duration.js +1 -1
  107. package/dist/options/override-fps.js +1 -1
  108. package/dist/options/override-height.js +1 -1
  109. package/dist/options/override-width.js +1 -1
  110. package/dist/options/overwrite.js +1 -1
  111. package/dist/options/package-manager.js +1 -1
  112. package/dist/options/pixel-format.js +1 -1
  113. package/dist/options/port.js +1 -1
  114. package/dist/options/prefer-lossless.js +1 -1
  115. package/dist/options/preview-sample-rate.js +1 -1
  116. package/dist/options/props.js +1 -1
  117. package/dist/options/prores-profile.js +1 -1
  118. package/dist/options/public-dir.js +1 -1
  119. package/dist/options/public-license-key.js +1 -1
  120. package/dist/options/public-path.js +1 -1
  121. package/dist/options/repro.js +1 -1
  122. package/dist/options/rspack.d.ts +1 -1
  123. package/dist/options/rspack.js +1 -1
  124. package/dist/options/runs.js +1 -1
  125. package/dist/options/sample-rate.js +1 -1
  126. package/dist/options/scale.js +1 -1
  127. package/dist/options/separate-audio.js +1 -1
  128. package/dist/options/skip-skills.js +1 -1
  129. package/dist/options/still-frame.js +1 -1
  130. package/dist/options/still-image-format.js +1 -1
  131. package/dist/options/throw-if-site-exists.js +1 -1
  132. package/dist/options/timeout.js +1 -1
  133. package/dist/options/user-agent.js +1 -1
  134. package/dist/options/version-flag.js +1 -1
  135. package/dist/options/video-bitrate.js +1 -1
  136. package/dist/options/video-cache-size.js +1 -1
  137. package/dist/options/video-codec.js +4 -3
  138. package/dist/options/video-image-format.js +6 -2
  139. package/dist/options/webhook-custom-data.js +1 -1
  140. package/dist/options/webpack-poll.js +1 -1
  141. package/dist/options/x264-preset.js +1 -1
  142. package/dist/prespawn-ffmpeg.d.ts +20 -0
  143. package/dist/prespawn-ffmpeg.js +152 -29
  144. package/dist/probe-shared-memory-capture.d.ts +8 -0
  145. package/dist/probe-shared-memory-capture.js +111 -0
  146. package/dist/puppeteer-screenshot.d.ts +3 -1
  147. package/dist/puppeteer-screenshot.js +1 -0
  148. package/dist/pure.d.ts +1 -1
  149. package/dist/remotion-shared-memory-ffmpeg.d.ts +26 -0
  150. package/dist/remotion-shared-memory-ffmpeg.js +312 -0
  151. package/dist/remotion-shared-memory.d.ts +49 -0
  152. package/dist/remotion-shared-memory.js +359 -0
  153. package/dist/render-frame-and-retry-target-close.d.ts +5 -2
  154. package/dist/render-frame-and-retry-target-close.js +20 -4
  155. package/dist/render-frame-with-option-to-reject.d.ts +4 -1
  156. package/dist/render-frame-with-option-to-reject.js +206 -115
  157. package/dist/render-frame.d.ts +4 -5
  158. package/dist/render-frame.js +3 -1
  159. package/dist/render-frames.d.ts +3 -0
  160. package/dist/render-frames.js +15 -18
  161. package/dist/render-media.d.ts +1 -1
  162. package/dist/render-media.js +131 -46
  163. package/dist/render-still.js +1 -0
  164. package/dist/screenshot-background.d.ts +2 -0
  165. package/dist/screenshot-background.js +20 -0
  166. package/dist/screenshot-task.d.ts +4 -2
  167. package/dist/screenshot-task.js +40 -21
  168. package/dist/seek-to-frame.js +1 -1
  169. package/dist/stitch-frames-to-video.js +71 -10
  170. package/dist/take-frame.d.ts +11 -3
  171. package/dist/take-frame.js +10 -8
  172. package/dist/validate-output-filename.d.ts +1 -1
  173. package/dist/validate-output-filename.js +10 -2
  174. package/package.json +13 -13
@@ -10,7 +10,7 @@ exports.interactivityOption = {
10
10
  cliFlag,
11
11
  description: () => (jsx_runtime_1.jsx(jsx_runtime_1.Fragment, { children: "Enable or disable interactive editing in the Remotion Studio. When disabled, the Studio keeps previewing and source navigation available, but disables preview outlines, the sequence inspector, visual controls, timeline selection and timeline editing gestures." })),
12
12
  ssrName: null,
13
- docLink: 'https://www.remotion.dev/docs/config#setinteractivityenabled',
13
+ docLink: 'https://www.remotion.dev/docs/options/disable-interactivity',
14
14
  type: false,
15
15
  getValue: ({ commandLine }) => {
16
16
  if (commandLine[cliFlag] !== undefined && commandLine[cliFlag] !== null) {
@@ -9,7 +9,7 @@ exports.ipv4Option = {
9
9
  cliFlag,
10
10
  description: () => (jsx_runtime_1.jsx(jsx_runtime_1.Fragment, { children: "Forces Remotion to bind to an IPv4 interface for the Studio server." })),
11
11
  ssrName: null,
12
- docLink: 'https://www.remotion.dev/docs/cli/studio',
12
+ docLink: 'https://www.remotion.dev/docs/options/ipv4',
13
13
  type: false,
14
14
  getValue: ({ commandLine }) => {
15
15
  if (commandLine[cliFlag] !== undefined && commandLine[cliFlag] !== null) {
@@ -12,7 +12,7 @@ exports.isProductionOption = {
12
12
  " if this a development render to not count it as a billable render on remotion.pro. Only can be used in conjuction with", ' ', jsx_runtime_1.jsx("code", { children: "licenseKey" }),
13
13
  "."] })),
14
14
  ssrName: 'isProduction',
15
- docLink: 'https://www.remotion.dev/docs/licensing',
15
+ docLink: 'https://www.remotion.dev/docs/options/is-production',
16
16
  getValue: ({ commandLine }) => {
17
17
  if (commandLine[cliFlag] !== undefined && commandLine[cliFlag] !== null) {
18
18
  return {
@@ -20,9 +20,12 @@ const cliFlag = 'jpeg-quality';
20
20
  exports.jpegQualityOption = {
21
21
  name: 'JPEG Quality',
22
22
  cliFlag,
23
- description: () => (jsx_runtime_1.jsx(jsx_runtime_1.Fragment, { children: "Sets the quality of the generated JPEG images. Must be an integer between 0 and 100. Default: 80." })),
23
+ description: () => (jsx_runtime_1.jsxs(jsx_runtime_1.Fragment, { children: ["Sets the quality of the generated JPEG images. Must be an integer between 0 and 100. Default: 80.",
24
+ jsx_runtime_1.jsx("br", {}),
25
+ "This option has no effect when", ' ', jsx_runtime_1.jsx("a", { href: "/docs/shared-memory-capture", children: "shared-memory capture" }),
26
+ " is active."] })),
24
27
  ssrName: 'jpegQuality',
25
- docLink: 'https://www.remotion.dev/docs/renderer/render-media#jpeg-quality',
28
+ docLink: 'https://www.remotion.dev/docs/options/jpeg-quality',
26
29
  type: 0,
27
30
  setConfig: exports.setJpegQuality,
28
31
  getValue: ({ commandLine }) => {
@@ -10,7 +10,7 @@ exports.keyboardShortcutsOption = {
10
10
  cliFlag,
11
11
  description: () => (jsx_runtime_1.jsx(jsx_runtime_1.Fragment, { children: "Enable or disable keyboard shortcuts in the Remotion Studio." })),
12
12
  ssrName: null,
13
- docLink: 'https://www.remotion.dev/docs/config#setkeyboardshortcutsenabled',
13
+ docLink: 'https://www.remotion.dev/docs/options/disable-keyboard-shortcuts',
14
14
  type: false,
15
15
  getValue: ({ commandLine }) => {
16
16
  if (commandLine[cliFlag] !== undefined && commandLine[cliFlag] !== null) {
@@ -18,7 +18,7 @@ exports.audioLatencyHintOption = {
18
18
  ",", ' ', jsx_runtime_1.jsx("code", { children: "playback" })
19
19
  ] })),
20
20
  ssrName: 'audioLatencyHint',
21
- docLink: 'https://www.remotion.dev/docs/renderer/render-media',
21
+ docLink: 'https://www.remotion.dev/docs/options/audio-latency-hint',
22
22
  type: 'playback',
23
23
  getValue: ({ commandLine }) => {
24
24
  const val = commandLine[cliFlag];
@@ -10,7 +10,7 @@ exports.licenseKeyOption = {
10
10
  description: () => (jsx_runtime_1.jsxs(jsx_runtime_1.Fragment, { children: ["License key for sending a usage event using", ' ', jsx_runtime_1.jsx("code", { children: "@remotion/licensing" }),
11
11
  "."] })),
12
12
  ssrName: 'licenseKey',
13
- docLink: 'https://www.remotion.dev/docs/licensing',
13
+ docLink: 'https://www.remotion.dev/docs/options/license-key',
14
14
  type: null,
15
15
  getValue: ({ commandLine }) => {
16
16
  if (commandLine[cliFlag] !== undefined) {
@@ -26,7 +26,7 @@ exports.logLevelOption = {
26
26
  " Default ",
27
27
  jsx_runtime_1.jsx("code", { children: "info" }),
28
28
  "."] })),
29
- docLink: 'https://www.remotion.dev/docs/troubleshooting/debug-failed-render',
29
+ docLink: 'https://www.remotion.dev/docs/options/log',
30
30
  getValue: ({ commandLine }) => {
31
31
  if (commandLine[cliFlag]) {
32
32
  if (!(0, log_level_1.isValidLogLevel)(commandLine[cliFlag])) {
@@ -18,7 +18,7 @@ exports.metadataOption = {
18
18
  "The parameter must be in the format of ",
19
19
  jsx_runtime_1.jsx("code", { children: "--metadata key=value" }), ' ', "and can be passed multiple times."] }));
20
20
  },
21
- docLink: 'https://www.remotion.dev/docs/metadata',
21
+ docLink: 'https://www.remotion.dev/docs/options/metadata',
22
22
  type: {},
23
23
  getValue: ({ commandLine }) => {
24
24
  if (commandLine[cliFlag] !== undefined) {
@@ -10,7 +10,7 @@ exports.mutedOption = {
10
10
  cliFlag,
11
11
  description: () => jsx_runtime_1.jsx(jsx_runtime_1.Fragment, { children: "The Audio of the video will be omitted." }),
12
12
  ssrName: 'muted',
13
- docLink: 'https://www.remotion.dev/docs/audio/muting',
13
+ docLink: 'https://www.remotion.dev/docs/options/muted',
14
14
  type: false,
15
15
  getValue: ({ commandLine }) => {
16
16
  // we set in minimist `muted` default as null
@@ -9,7 +9,7 @@ exports.noOpenOption = {
9
9
  cliFlag,
10
10
  description: () => (jsx_runtime_1.jsx(jsx_runtime_1.Fragment, { children: "If specified, Remotion will not open a browser window when starting the Studio." })),
11
11
  ssrName: null,
12
- docLink: 'https://www.remotion.dev/docs/cli/studio#--no-open',
12
+ docLink: 'https://www.remotion.dev/docs/options/no-open',
13
13
  type: false,
14
14
  getValue: ({ commandLine }) => {
15
15
  // Minimist quirk: `--no-open` sets `open` to `false`.
@@ -28,7 +28,7 @@ exports.numberOfGifLoopsOption = {
28
28
  ] }));
29
29
  },
30
30
  ssrName: 'numberOfGifLoops',
31
- docLink: 'https://www.remotion.dev/docs/render-as-gif#changing-the-number-of-loops',
31
+ docLink: 'https://www.remotion.dev/docs/options/number-of-gif-loops',
32
32
  type: 0,
33
33
  getValue: ({ commandLine }) => {
34
34
  if (commandLine[cliFlag] !== undefined) {
@@ -10,7 +10,7 @@ exports.numberOfSharedAudioTagsOption = {
10
10
  cliFlag,
11
11
  description: () => (jsx_runtime_1.jsxs(jsx_runtime_1.Fragment, { children: ["Set number of shared audio tags. See", ' ', jsx_runtime_1.jsx("a", { href: "https://www.remotion.dev/docs/player/autoplay#using-the-numberofsharedaudiotags-prop", children: "Using the numberOfSharedAudioTags prop" }), ' ', "for more information."] })),
12
12
  ssrName: null,
13
- docLink: 'https://www.remotion.dev/docs/config#setnumberofsharedaudiotags',
13
+ docLink: 'https://www.remotion.dev/docs/options/number-of-shared-audio-tags',
14
14
  type: 0,
15
15
  getValue: ({ commandLine }) => {
16
16
  if (commandLine[cliFlag] !== undefined) {
@@ -23,7 +23,7 @@ exports.offthreadVideoCacheSizeInBytesOption = {
23
23
  jsx_runtime_1.jsx("code", { children: "null" })
24
24
  ] })),
25
25
  ssrName: 'offthreadVideoCacheSizeInBytes',
26
- docLink: 'https://www.remotion.dev/docs/offthreadvideo',
26
+ docLink: 'https://www.remotion.dev/docs/options/offthreadvideo-cache-size-in-bytes',
27
27
  type: 0,
28
28
  getValue: ({ commandLine }) => {
29
29
  if (commandLine[cliFlag] !== undefined) {
@@ -14,7 +14,7 @@ exports.offthreadVideoThreadsOption = {
14
14
  description: () => (jsx_runtime_1.jsxs(jsx_runtime_1.Fragment, { children: ["The number of threads that",
15
15
  jsx_runtime_1.jsx("a", { href: "https://remotion.dev/docs/offthreadvideo", children: jsx_runtime_1.jsx("code", { children: "<OffthreadVideo>" }) }), ' ', "can start to extract frames. The default is", ' ', exports.DEFAULT_RENDER_FRAMES_OFFTHREAD_VIDEO_THREADS, ". Increase carefully, as too many threads may cause instability."] })),
16
16
  ssrName: 'offthreadVideoThreads',
17
- docLink: 'https://www.remotion.dev/docs/offthreadvideo',
17
+ docLink: 'https://www.remotion.dev/docs/options/offthreadvideo-video-threads',
18
18
  type: 0,
19
19
  getValue: ({ commandLine }) => {
20
20
  if (commandLine[cliFlag] !== undefined) {
@@ -9,7 +9,7 @@ exports.onBrowserDownloadOption = {
9
9
  description: () => (jsx_runtime_1.jsxs(jsx_runtime_1.Fragment, { children: ["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.", ' ', jsx_runtime_1.jsx("a", { href: "/docs/renderer/ensure-browser#onbrowserdownload", children: "See here for how to use this option." })
10
10
  ] })),
11
11
  ssrName: 'onBrowserDownload',
12
- docLink: 'https://www.remotion.dev/docs/renderer/ensure-browser',
12
+ docLink: 'https://www.remotion.dev/docs/options/on-browser-download',
13
13
  type: undefined,
14
14
  getValue: () => {
15
15
  throw new Error('does not support config file');
@@ -217,6 +217,22 @@ export declare const optionsMap: {
217
217
  setConfig(value: boolean): void;
218
218
  id: "disallow-parallel-encoding";
219
219
  };
220
+ readonly disableSharedMemoryCapture: {
221
+ name: string;
222
+ cliFlag: "disable-shared-memory-capture";
223
+ description: () => import("react/jsx-runtime").JSX.Element;
224
+ ssrName: string;
225
+ docLink: string;
226
+ type: boolean;
227
+ getValue: ({ commandLine }: {
228
+ commandLine: Record<string, unknown>;
229
+ }) => {
230
+ value: boolean;
231
+ source: string;
232
+ };
233
+ setConfig(value: boolean): void;
234
+ id: "disable-shared-memory-capture";
235
+ };
220
236
  readonly jpegQuality: {
221
237
  name: string;
222
238
  cliFlag: "jpeg-quality";
@@ -1139,7 +1155,7 @@ export declare const optionsMap: {
1139
1155
  cliFlag: "image-sequence-pattern";
1140
1156
  ssrName: string;
1141
1157
  description: () => import("react/jsx-runtime").JSX.Element;
1142
- docLink: null;
1158
+ docLink: string;
1143
1159
  type: string | null;
1144
1160
  getValue: ({ commandLine }: {
1145
1161
  commandLine: Record<string, unknown>;
@@ -1172,6 +1188,22 @@ export declare const optionsMap: {
1172
1188
  };
1173
1189
  };
1174
1190
  readonly renderMediaOnLambda: {
1191
+ readonly disableSharedMemoryCapture: {
1192
+ name: string;
1193
+ cliFlag: "disable-shared-memory-capture";
1194
+ description: () => import("react/jsx-runtime").JSX.Element;
1195
+ ssrName: string;
1196
+ docLink: string;
1197
+ type: boolean;
1198
+ getValue: ({ commandLine }: {
1199
+ commandLine: Record<string, unknown>;
1200
+ }) => {
1201
+ value: boolean;
1202
+ source: string;
1203
+ };
1204
+ setConfig(value: boolean): void;
1205
+ id: "disable-shared-memory-capture";
1206
+ };
1175
1207
  readonly mediaCacheSizeInBytes: {
1176
1208
  name: string;
1177
1209
  cliFlag: "media-cache-size-in-bytes";
@@ -1761,6 +1793,22 @@ export declare const optionsMap: {
1761
1793
  };
1762
1794
  };
1763
1795
  readonly renderMediaOnCloudRun: {
1796
+ readonly disableSharedMemoryCapture: {
1797
+ name: string;
1798
+ cliFlag: "disable-shared-memory-capture";
1799
+ description: () => import("react/jsx-runtime").JSX.Element;
1800
+ ssrName: string;
1801
+ docLink: string;
1802
+ type: boolean;
1803
+ getValue: ({ commandLine }: {
1804
+ commandLine: Record<string, unknown>;
1805
+ }) => {
1806
+ value: boolean;
1807
+ source: string;
1808
+ };
1809
+ setConfig(value: boolean): void;
1810
+ id: "disable-shared-memory-capture";
1811
+ };
1764
1812
  readonly mediaCacheSizeInBytes: {
1765
1813
  name: string;
1766
1814
  cliFlag: "media-cache-size-in-bytes";
@@ -9,6 +9,7 @@ const chrome_mode_1 = require("./chrome-mode");
9
9
  const color_space_1 = require("./color-space");
10
10
  const crf_1 = require("./crf");
11
11
  const delete_after_1 = require("./delete-after");
12
+ const disable_shared_memory_capture_1 = require("./disable-shared-memory-capture");
12
13
  const disallow_parallel_encoding_1 = require("./disallow-parallel-encoding");
13
14
  const encoding_buffer_size_1 = require("./encoding-buffer-size");
14
15
  const encoding_max_rate_1 = require("./encoding-max-rate");
@@ -50,6 +51,7 @@ exports.optionsMap = {
50
51
  colorSpace: color_space_1.colorSpaceOption,
51
52
  codec: video_codec_1.videoCodecOption,
52
53
  disallowParallelEncoding: disallow_parallel_encoding_1.disallowParallelEncodingOption,
54
+ disableSharedMemoryCapture: disable_shared_memory_capture_1.disableSharedMemoryCaptureOption,
53
55
  jpegQuality: jpeg_quality_1.jpegQualityOption,
54
56
  encodingMaxRate: encoding_max_rate_1.encodingMaxRateOption,
55
57
  encodingBufferSize: encoding_buffer_size_1.encodingBufferSizeOption,
@@ -118,6 +120,7 @@ exports.optionsMap = {
118
120
  sampleRate: sample_rate_1.sampleRateOption,
119
121
  },
120
122
  renderMediaOnLambda: {
123
+ disableSharedMemoryCapture: disable_shared_memory_capture_1.disableSharedMemoryCaptureOption,
121
124
  mediaCacheSizeInBytes: video_cache_size_1.mediaCacheSizeInBytesOption,
122
125
  offthreadVideoCacheSizeInBytes: offthreadvideo_cache_size_1.offthreadVideoCacheSizeInBytesOption,
123
126
  offthreadVideoThreads: offthreadvideo_threads_1.offthreadVideoThreadsOption,
@@ -157,6 +160,7 @@ exports.optionsMap = {
157
160
  timeoutInMilliseconds: timeout_1.delayRenderTimeoutInMillisecondsOption,
158
161
  },
159
162
  renderMediaOnCloudRun: {
163
+ disableSharedMemoryCapture: disable_shared_memory_capture_1.disableSharedMemoryCaptureOption,
160
164
  mediaCacheSizeInBytes: video_cache_size_1.mediaCacheSizeInBytesOption,
161
165
  offthreadVideoCacheSizeInBytes: offthreadvideo_cache_size_1.offthreadVideoCacheSizeInBytesOption,
162
166
  offthreadVideoThreads: offthreadvideo_threads_1.offthreadVideoThreadsOption,
@@ -14,7 +14,7 @@ exports.outDirOption = {
14
14
  "."] }));
15
15
  },
16
16
  ssrName: 'outDir',
17
- docLink: 'https://www.remotion.dev/docs/cli/bundle#--out-dir',
17
+ docLink: 'https://www.remotion.dev/docs/options/out-dir',
18
18
  getValue: ({ commandLine }) => {
19
19
  if (commandLine[cliFlag] !== undefined) {
20
20
  return {
@@ -10,7 +10,7 @@ exports.overrideDurationOption = {
10
10
  cliFlag,
11
11
  description: () => jsx_runtime_1.jsx(jsx_runtime_1.Fragment, { children: "Overrides the duration in frames of the composition." }),
12
12
  ssrName: null,
13
- docLink: 'https://www.remotion.dev/docs/config#overrideduration',
13
+ docLink: 'https://www.remotion.dev/docs/options/duration',
14
14
  type: null,
15
15
  getValue: ({ commandLine }) => {
16
16
  if (commandLine[cliFlag] !== undefined) {
@@ -10,7 +10,7 @@ exports.overrideFpsOption = {
10
10
  cliFlag,
11
11
  description: () => jsx_runtime_1.jsx(jsx_runtime_1.Fragment, { children: "Overrides the frames per second of the composition." }),
12
12
  ssrName: null,
13
- docLink: 'https://www.remotion.dev/docs/config#overridefps',
13
+ docLink: 'https://www.remotion.dev/docs/options/fps',
14
14
  type: null,
15
15
  getValue: ({ commandLine }) => {
16
16
  if (commandLine[cliFlag] !== undefined) {
@@ -10,7 +10,7 @@ exports.overrideHeightOption = {
10
10
  cliFlag,
11
11
  description: () => jsx_runtime_1.jsx(jsx_runtime_1.Fragment, { children: "Overrides the height of the composition." }),
12
12
  ssrName: null,
13
- docLink: 'https://www.remotion.dev/docs/config#overrideheight',
13
+ docLink: 'https://www.remotion.dev/docs/options/height',
14
14
  type: null,
15
15
  getValue: ({ commandLine }) => {
16
16
  if (commandLine[cliFlag] !== undefined) {
@@ -10,7 +10,7 @@ exports.overrideWidthOption = {
10
10
  cliFlag,
11
11
  description: () => jsx_runtime_1.jsx(jsx_runtime_1.Fragment, { children: "Overrides the width of the composition." }),
12
12
  ssrName: null,
13
- docLink: 'https://www.remotion.dev/docs/config#overridewidth',
13
+ docLink: 'https://www.remotion.dev/docs/options/width',
14
14
  type: null,
15
15
  getValue: ({ commandLine }) => {
16
16
  if (commandLine[cliFlag] !== undefined) {
@@ -18,7 +18,7 @@ exports.overwriteOption = {
18
18
  jsx_runtime_1.jsx("code", { children: "true" }),
19
19
  "."] })),
20
20
  ssrName: 'overwrite',
21
- docLink: 'https://www.remotion.dev/docs/config#setoverwriteoutput',
21
+ docLink: 'https://www.remotion.dev/docs/options/overwrite',
22
22
  type: false,
23
23
  getValue: ({ commandLine }, defaultValue) => {
24
24
  if (commandLine[cliFlag] !== undefined && commandLine[cliFlag] !== null) {
@@ -22,7 +22,7 @@ exports.packageManagerOption = {
22
22
  "."] }));
23
23
  },
24
24
  ssrName: 'packageManager',
25
- docLink: 'https://www.remotion.dev/docs/cli/upgrade#--package-manager',
25
+ docLink: 'https://www.remotion.dev/docs/options/package-manager',
26
26
  getValue: ({ commandLine }) => {
27
27
  if (commandLine[cliFlag] !== undefined) {
28
28
  return {
@@ -11,7 +11,7 @@ exports.pixelFormatOption = {
11
11
  description: () => (jsx_runtime_1.jsxs(jsx_runtime_1.Fragment, { children: ["Sets the pixel format in FFmpeg. See", ' ', jsx_runtime_1.jsx("a", { href: "https://trac.ffmpeg.org/wiki/Chroma%20Subsampling", children: "the FFmpeg docs for an explanation" }),
12
12
  ". Acceptable values: ", pixel_format_1.validPixelFormats.map((f) => `"${f}"`).join(', '), "."] })),
13
13
  ssrName: 'pixelFormat',
14
- docLink: 'https://www.remotion.dev/docs/config#setpixelformat',
14
+ docLink: 'https://www.remotion.dev/docs/options/pixel-format',
15
15
  type: pixel_format_1.DEFAULT_PIXEL_FORMAT,
16
16
  getValue: ({ commandLine }, options) => {
17
17
  if (options === null || options === void 0 ? void 0 : options.uiPixelFormat) {
@@ -9,7 +9,7 @@ exports.portOption = {
9
9
  cliFlag,
10
10
  description: () => (jsx_runtime_1.jsx(jsx_runtime_1.Fragment, { children: "Set a custom HTTP server port for the Studio or the render process. If not defined, Remotion will try to find a free port." })),
11
11
  ssrName: null,
12
- docLink: 'https://www.remotion.dev/docs/config#setstudioport',
12
+ docLink: 'https://www.remotion.dev/docs/options/port',
13
13
  getValue: ({ commandLine }) => {
14
14
  if (commandLine[cliFlag] !== undefined) {
15
15
  return {
@@ -11,7 +11,7 @@ exports.preferLosslessAudioOption = {
11
11
  jsx_runtime_1.jsx("code", { children: "audioCodec" }),
12
12
  ", it takes priority over", ' ', jsx_runtime_1.jsx("code", { children: "preferLossless" }),
13
13
  "."] })),
14
- docLink: 'https://www.remotion.dev/docs/encoding',
14
+ docLink: 'https://www.remotion.dev/docs/options/prefer-lossless',
15
15
  type: false,
16
16
  ssrName: 'preferLossless',
17
17
  getValue: ({ commandLine }) => {
@@ -11,7 +11,7 @@ exports.previewSampleRateOption = {
11
11
  jsx_runtime_1.jsx("code", { children: "48000" }),
12
12
  " Hz."] })),
13
13
  ssrName: null,
14
- docLink: 'https://www.remotion.dev/docs/config#setpreviewsamplerate',
14
+ docLink: 'https://www.remotion.dev/docs/options/preview-sample-rate',
15
15
  type: null,
16
16
  getValue: ({ commandLine }) => {
17
17
  if (commandLine[cliFlag] !== undefined) {
@@ -12,7 +12,7 @@ exports.propsOption = {
12
12
  jsx_runtime_1.jsx("code", { children: "./path/to/props.json" }),
13
13
  ")."] })),
14
14
  ssrName: null,
15
- docLink: 'https://www.remotion.dev/docs/passing-props#passing-input-props-in-the-cli',
15
+ docLink: 'https://www.remotion.dev/docs/options/props',
16
16
  getValue: ({ commandLine }) => {
17
17
  if (commandLine[cliFlag] !== undefined) {
18
18
  return {
@@ -21,7 +21,7 @@ exports.proResProfileOption = {
21
21
  ". See", ' ', jsx_runtime_1.jsx("a", { href: "https://video.stackexchange.com/a/14715", children: "here" }),
22
22
  " for an explanation of possible values."] })),
23
23
  ssrName: 'proResProfile',
24
- docLink: 'https://www.remotion.dev/docs/config#setproresprofile',
24
+ docLink: 'https://www.remotion.dev/docs/options/prores-profile',
25
25
  type: undefined,
26
26
  getValue: ({ commandLine }, options) => {
27
27
  if (options === null || options === void 0 ? void 0 : options.uiProResProfile) {
@@ -12,7 +12,7 @@ exports.publicDirOption = {
12
12
  ". If not defined, Remotion will assume the location is the `public` folder in your Remotion root."] }));
13
13
  },
14
14
  ssrName: 'publicDir',
15
- docLink: 'https://www.remotion.dev/docs/terminology/public-dir',
15
+ docLink: 'https://www.remotion.dev/docs/options/public-dir',
16
16
  getValue: ({ commandLine }) => {
17
17
  if (commandLine[cliFlag] !== undefined) {
18
18
  return {
@@ -11,7 +11,7 @@ exports.publicLicenseKeyOption = {
11
11
  jsx_runtime_1.jsx("a", { href: "https://remotion.pro/dashboard", children: "remotion.pro" }),
12
12
  ". If you are eligible for the free license, pass \"free-license\"."] })),
13
13
  ssrName: 'publicLicenseKey',
14
- docLink: 'https://www.remotion.dev/docs/licensing',
14
+ docLink: 'https://www.remotion.dev/docs/options/public-license-key',
15
15
  getValue: ({ commandLine }) => {
16
16
  if (commandLine[cliFlag] !== undefined) {
17
17
  return {
@@ -15,7 +15,7 @@ exports.publicPathOption = {
15
15
  " to host the bundle at a fixed location."] }));
16
16
  },
17
17
  ssrName: 'publicPath',
18
- docLink: 'https://www.remotion.dev/docs/renderer',
18
+ docLink: 'https://www.remotion.dev/docs/options/public-path',
19
19
  getValue: ({ commandLine }) => {
20
20
  if (commandLine[cliFlag] !== undefined) {
21
21
  return {
@@ -12,7 +12,7 @@ exports.reproOption = {
12
12
  cliFlag,
13
13
  description: () => (jsx_runtime_1.jsx(jsx_runtime_1.Fragment, { children: "Create a ZIP that you can submit to Remotion if asked for a reproduction." })),
14
14
  ssrName: 'repro',
15
- docLink: 'https://www.remotion.dev/docs/render-media#repro',
15
+ docLink: 'https://www.remotion.dev/docs/options/repro',
16
16
  type: false,
17
17
  getValue: ({ commandLine }) => {
18
18
  if (commandLine[cliFlag] !== undefined && commandLine[cliFlag] !== null) {
@@ -3,7 +3,7 @@ export declare const rspackOption: {
3
3
  cliFlag: "rspack";
4
4
  description: () => import("react/jsx-runtime").JSX.Element;
5
5
  ssrName: null;
6
- docLink: null;
6
+ docLink: string;
7
7
  type: boolean;
8
8
  getValue: ({ commandLine }: {
9
9
  commandLine: Record<string, unknown>;
@@ -10,7 +10,7 @@ exports.rspackOption = {
10
10
  cliFlag,
11
11
  description: () => (jsx_runtime_1.jsx(jsx_runtime_1.Fragment, { children: "Uses Rspack instead of Webpack as the bundler for the Studio or bundle." })),
12
12
  ssrName: null,
13
- docLink: null,
13
+ docLink: 'https://www.remotion.dev/docs/options/rspack',
14
14
  type: false,
15
15
  getValue: ({ commandLine }) => {
16
16
  if (commandLine[cliFlag] !== undefined && commandLine[cliFlag] !== null) {
@@ -12,7 +12,7 @@ exports.runsOption = {
12
12
  jsx_runtime_1.jsx("code", { children: DEFAULT_RUNS }),
13
13
  "."] })),
14
14
  ssrName: null,
15
- docLink: 'https://www.remotion.dev/docs/cli/benchmark#--runs',
15
+ docLink: 'https://www.remotion.dev/docs/options/runs',
16
16
  type: DEFAULT_RUNS,
17
17
  getValue: ({ commandLine }) => {
18
18
  if (commandLine[cliFlag] !== undefined) {
@@ -10,7 +10,7 @@ exports.sampleRateOption = {
10
10
  description: () => (jsx_runtime_1.jsxs(jsx_runtime_1.Fragment, { children: ["Controls the sample rate of the output audio. The default is", ' ', jsx_runtime_1.jsx("code", { children: "48000" }),
11
11
  " Hz. Match this to your source audio to avoid resampling artifacts."] })),
12
12
  ssrName: 'sampleRate',
13
- docLink: 'https://www.remotion.dev/docs/sample-rate',
13
+ docLink: 'https://www.remotion.dev/docs/options/sample-rate',
14
14
  type: 48000,
15
15
  getValue: ({ commandLine }, compositionSampleRate) => {
16
16
  if (commandLine[cliFlag] !== undefined) {
@@ -18,7 +18,7 @@ exports.scaleOption = {
18
18
  jsx_runtime_1.jsx("a", { href: "https://www.remotion.dev/docs/scaling", children: "Scaling" }),
19
19
  " for more details."] })),
20
20
  ssrName: 'scale',
21
- docLink: 'https://www.remotion.dev/docs/scaling',
21
+ docLink: 'https://www.remotion.dev/docs/options/scale',
22
22
  type: 0,
23
23
  getValue: ({ commandLine }) => {
24
24
  if (commandLine[cliFlag] !== undefined) {
@@ -6,7 +6,7 @@ const cliFlag = 'separate-audio-to';
6
6
  exports.separateAudioOption = {
7
7
  cliFlag,
8
8
  description: () => `If set, the audio will not be included in the main output but rendered as a separate file at the location you pass. If the render contains no audio, a silent audio file is produced even when enforceAudioTrack is false. The muted option still takes precedence. It is recommended to use an absolute path. If a relative path is passed, it is relative to the Remotion Root.`,
9
- docLink: 'https://remotion.dev/docs/renderer/render-media',
9
+ docLink: 'https://www.remotion.dev/docs/options/separate-audio-to',
10
10
  getValue: ({ commandLine }) => {
11
11
  if (commandLine[cliFlag]) {
12
12
  return {
@@ -8,7 +8,7 @@ exports.skipSkillsOption = {
8
8
  cliFlag,
9
9
  description: () => (jsx_runtime_1.jsx(jsx_runtime_1.Fragment, { children: "Do not update installed Remotion Agent Skills while upgrading Remotion." })),
10
10
  ssrName: null,
11
- docLink: 'https://www.remotion.dev/docs/cli/upgrade#--skip-skills',
11
+ docLink: 'https://www.remotion.dev/docs/options/skip-skills',
12
12
  getValue: ({ commandLine }) => {
13
13
  if (commandLine[cliFlag]) {
14
14
  return {
@@ -19,7 +19,7 @@ exports.stillFrameOption = {
19
19
  ". From v3.2.27, negative values are allowed, with", ' ', jsx_runtime_1.jsx("code", { children: "-1" }),
20
20
  " being the last frame."] })),
21
21
  ssrName: 'frame',
22
- docLink: 'https://www.remotion.dev/docs/cli/still#--frame',
22
+ docLink: 'https://www.remotion.dev/docs/options/frame',
23
23
  getValue: ({ commandLine }) => {
24
24
  if (commandLine[cliFlag] !== undefined) {
25
25
  const frame = Number(commandLine[cliFlag]);
@@ -11,7 +11,7 @@ exports.stillImageFormatOption = {
11
11
  description: () => (jsx_runtime_1.jsxs(jsx_runtime_1.Fragment, { children: ["The image format to use when rendering a still. Must be one of", ' ', image_format_1.validStillImageFormats.map((f) => `"${f}"`).join(', '), ". Default:", ' ', jsx_runtime_1.jsx("code", { children: "\"png\"" }),
12
12
  "."] })),
13
13
  ssrName: 'imageFormat',
14
- docLink: 'https://www.remotion.dev/docs/renderer/render-still#imageformat',
14
+ docLink: 'https://www.remotion.dev/docs/options/still-image-format',
15
15
  type: null,
16
16
  getValue: ({ commandLine }) => {
17
17
  if (commandLine[cliFlag] !== undefined) {
@@ -6,7 +6,7 @@ const cliFlag = 'throw-if-site-exists';
6
6
  exports.throwIfSiteExistsOption = {
7
7
  cliFlag,
8
8
  description: () => `Prevents accidential update of an existing site. If there are any files in the subfolder where the site should be placed, the function will throw.`,
9
- docLink: 'https://remotion.dev/docs/lambda/deploy-site',
9
+ docLink: 'https://www.remotion.dev/docs/options/throw-if-site-exists',
10
10
  getValue: ({ commandLine }) => {
11
11
  if (commandLine[cliFlag]) {
12
12
  return {
@@ -19,7 +19,7 @@ exports.delayRenderTimeoutInMillisecondsOption = {
19
19
  jsx_runtime_1.jsx("code", { children: "30000" })
20
20
  ] })),
21
21
  ssrName: 'timeoutInMilliseconds',
22
- docLink: 'https://www.remotion.dev/docs/timeout',
22
+ docLink: 'https://www.remotion.dev/docs/options/timeout',
23
23
  type: 0,
24
24
  getValue: ({ commandLine }) => {
25
25
  if (commandLine[cliFlag] !== undefined) {
@@ -9,7 +9,7 @@ exports.userAgentOption = {
9
9
  cliFlag,
10
10
  description: () => (jsx_runtime_1.jsx(jsx_runtime_1.Fragment, { children: "Lets you set a custom user agent that the headless Chrome browser assumes." })),
11
11
  ssrName: 'userAgent',
12
- docLink: 'https://www.remotion.dev/docs/chromium-flags#--user-agent',
12
+ docLink: 'https://www.remotion.dev/docs/options/user-agent',
13
13
  type: null,
14
14
  getValue: ({ commandLine }) => {
15
15
  if (commandLine[cliFlag] !== undefined) {
@@ -8,7 +8,7 @@ exports.versionFlagOption = {
8
8
  cliFlag,
9
9
  description: () => (jsx_runtime_1.jsx(jsx_runtime_1.Fragment, { children: "Install a specific version. Also enables downgrading to an older version." })),
10
10
  ssrName: null,
11
- docLink: 'https://www.remotion.dev/docs/cli/upgrade#--version',
11
+ docLink: 'https://www.remotion.dev/docs/options/version',
12
12
  getValue: ({ commandLine }) => {
13
13
  if (commandLine[cliFlag] !== undefined) {
14
14
  return {
@@ -15,7 +15,7 @@ exports.videoBitrateOption = {
15
15
  jsx_runtime_1.jsx("code", { children: "1M" }),
16
16
  " for 1 Mbps."] })),
17
17
  ssrName: 'videoBitrate',
18
- docLink: 'https://www.remotion.dev/docs/renderer/render-media#videobitrate',
18
+ docLink: 'https://www.remotion.dev/docs/options/video-bitrate',
19
19
  type: '',
20
20
  getValue: ({ commandLine }) => {
21
21
  if (commandLine[cliFlag] !== undefined) {
@@ -19,7 +19,7 @@ exports.mediaCacheSizeInBytesOption = {
19
19
  jsx_runtime_1.jsx("br", {}),
20
20
  "The default is half of the available system memory when the render starts."] })),
21
21
  ssrName: 'mediaCacheSizeInBytes',
22
- docLink: 'https://www.remotion.dev/docs/media/cache',
22
+ docLink: 'https://www.remotion.dev/docs/options/media-cache-size-in-bytes',
23
23
  type: 0,
24
24
  getValue: ({ commandLine }) => {
25
25
  if (commandLine[cliFlag] !== undefined) {