@remotion/renderer 4.0.533 → 4.0.535

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 (285) 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/BrowserPage.js +4 -0
  5. package/dist/browser/Connection.js +5 -17
  6. package/dist/browser/DOMWorld.js +19 -13
  7. package/dist/browser/devtools-commands.d.ts +13 -1
  8. package/dist/browser/devtools-types.d.ts +62 -0
  9. package/dist/browser/get-chrome-download-url.d.ts +1 -1
  10. package/dist/browser/get-chrome-download-url.js +19 -33
  11. package/dist/can-use-parallel-encoding.d.ts +0 -1
  12. package/dist/can-use-parallel-encoding.js +10 -10
  13. package/dist/client.d.ts +402 -4
  14. package/dist/client.js +2 -0
  15. package/dist/combine-chunks.d.ts +2 -1
  16. package/dist/combine-chunks.js +81 -52
  17. package/dist/combine-video-streams.js +3 -0
  18. package/dist/compositor/get-executable-path.js +30 -15
  19. package/dist/cycle-browser-tabs.js +9 -1
  20. package/dist/ensure-browser.d.ts +3 -0
  21. package/dist/ensure-browser.js +30 -6
  22. package/dist/esm/client.mjs +1325 -954
  23. package/dist/esm/index.mjs +4465 -3324
  24. package/dist/esm/pure.mjs +36 -10
  25. package/dist/file-extensions.js +4 -1
  26. package/dist/get-mp4-brand.d.ts +1 -0
  27. package/dist/get-mp4-brand.js +21 -0
  28. package/dist/get-video-threads-flag.js +5 -1
  29. package/dist/image-format.d.ts +1 -0
  30. package/dist/image-format.js +8 -4
  31. package/dist/index.d.ts +58 -2
  32. package/dist/index.js +4 -0
  33. package/dist/memory/from-macos-sysctl.d.ts +1 -0
  34. package/dist/memory/from-macos-sysctl.js +50 -0
  35. package/dist/memory/from-proc-meminfo.d.ts +1 -1
  36. package/dist/memory/from-proc-meminfo.js +7 -4
  37. package/dist/memory/get-available-memory.js +29 -21
  38. package/dist/mux-video-and-audio.js +11 -2
  39. package/dist/next-frame-to-render.d.ts +3 -7
  40. package/dist/next-frame-to-render.js +3 -22
  41. package/dist/open-browser.js +1 -0
  42. package/dist/options/allow-html-in-canvas.d.ts +1 -0
  43. package/dist/options/allow-html-in-canvas.js +2 -1
  44. package/dist/options/api-key.d.ts +1 -0
  45. package/dist/options/api-key.js +2 -1
  46. package/dist/options/ask-ai.d.ts +1 -0
  47. package/dist/options/ask-ai.js +2 -1
  48. package/dist/options/audio-bitrate.d.ts +1 -0
  49. package/dist/options/audio-bitrate.js +2 -1
  50. package/dist/options/audio-codec.d.ts +1 -0
  51. package/dist/options/audio-codec.js +13 -6
  52. package/dist/options/beep-on-finish.d.ts +1 -0
  53. package/dist/options/beep-on-finish.js +2 -1
  54. package/dist/options/benchmark-concurrencies.d.ts +1 -0
  55. package/dist/options/benchmark-concurrencies.js +2 -1
  56. package/dist/options/binaries-directory.d.ts +1 -0
  57. package/dist/options/binaries-directory.js +2 -1
  58. package/dist/options/browser-executable.d.ts +1 -0
  59. package/dist/options/browser-executable.js +2 -1
  60. package/dist/options/browser.d.ts +1 -0
  61. package/dist/options/browser.js +2 -1
  62. package/dist/options/bundle-cache.d.ts +1 -0
  63. package/dist/options/bundle-cache.js +2 -1
  64. package/dist/options/canvas-tabs.d.ts +1 -0
  65. package/dist/options/canvas-tabs.js +2 -1
  66. package/dist/options/chrome-mode.d.ts +1 -0
  67. package/dist/options/chrome-mode.js +2 -1
  68. package/dist/options/color-space.d.ts +1 -0
  69. package/dist/options/color-space.js +2 -1
  70. package/dist/options/concurrency.d.ts +1 -0
  71. package/dist/options/concurrency.js +2 -1
  72. package/dist/options/config.d.ts +1 -0
  73. package/dist/options/config.js +2 -1
  74. package/dist/options/crf.d.ts +1 -0
  75. package/dist/options/crf.js +2 -1
  76. package/dist/options/cross-site-isolation.d.ts +1 -0
  77. package/dist/options/cross-site-isolation.js +2 -1
  78. package/dist/options/dark-mode.d.ts +1 -0
  79. package/dist/options/dark-mode.js +2 -1
  80. package/dist/options/default-coding-agent.d.ts +1 -0
  81. package/dist/options/default-coding-agent.js +2 -1
  82. package/dist/options/default-editor.d.ts +1 -0
  83. package/dist/options/default-editor.js +2 -1
  84. package/dist/options/default-premount-in-seconds.d.ts +19 -0
  85. package/dist/options/default-premount-in-seconds.js +36 -0
  86. package/dist/options/delete-after.d.ts +1 -0
  87. package/dist/options/delete-after.js +2 -1
  88. package/dist/options/disable-git-source.d.ts +1 -0
  89. package/dist/options/disable-git-source.js +2 -1
  90. package/dist/options/disable-shared-memory-capture.d.ts +17 -0
  91. package/dist/options/disable-shared-memory-capture.js +30 -0
  92. package/dist/options/disable-web-security.d.ts +1 -0
  93. package/dist/options/disable-web-security.js +2 -1
  94. package/dist/options/disallow-parallel-encoding.d.ts +1 -0
  95. package/dist/options/disallow-parallel-encoding.js +2 -1
  96. package/dist/options/enable-cancellation.d.ts +1 -0
  97. package/dist/options/enable-cancellation.js +2 -1
  98. package/dist/options/enable-lambda-insights.d.ts +1 -0
  99. package/dist/options/enable-lambda-insights.js +2 -1
  100. package/dist/options/enable-multiprocess-on-linux.d.ts +1 -0
  101. package/dist/options/enable-multiprocess-on-linux.js +2 -1
  102. package/dist/options/encoding-buffer-size.d.ts +1 -0
  103. package/dist/options/encoding-buffer-size.js +2 -1
  104. package/dist/options/encoding-max-rate.d.ts +1 -0
  105. package/dist/options/encoding-max-rate.js +2 -1
  106. package/dist/options/enforce-audio.d.ts +1 -0
  107. package/dist/options/enforce-audio.js +2 -1
  108. package/dist/options/env-file.d.ts +1 -0
  109. package/dist/options/env-file.js +2 -1
  110. package/dist/options/every-nth-frame.d.ts +1 -0
  111. package/dist/options/every-nth-frame.js +2 -1
  112. package/dist/options/experimental-keep-audio-context-alive.d.ts +1 -0
  113. package/dist/options/experimental-keep-audio-context-alive.js +2 -1
  114. package/dist/options/experimental-sequence-activity-limit.d.ts +19 -0
  115. package/dist/options/experimental-sequence-activity-limit.js +40 -0
  116. package/dist/options/experimental-sequence-activity.d.ts +19 -0
  117. package/dist/options/experimental-sequence-activity.js +38 -0
  118. package/dist/options/experimental-tracks.d.ts +19 -0
  119. package/dist/options/experimental-tracks.js +43 -0
  120. package/dist/options/folder-expiry.d.ts +1 -0
  121. package/dist/options/folder-expiry.js +2 -1
  122. package/dist/options/for-seamless-aac-concatenation.d.ts +1 -0
  123. package/dist/options/for-seamless-aac-concatenation.js +2 -1
  124. package/dist/options/force-new-studio.d.ts +1 -0
  125. package/dist/options/force-new-studio.js +2 -1
  126. package/dist/options/frames.d.ts +1 -0
  127. package/dist/options/frames.js +2 -1
  128. package/dist/options/gl.d.ts +1 -0
  129. package/dist/options/gl.js +2 -1
  130. package/dist/options/gop-size.d.ts +1 -0
  131. package/dist/options/gop-size.js +2 -1
  132. package/dist/options/hardware-acceleration.d.ts +1 -0
  133. package/dist/options/hardware-acceleration.js +2 -1
  134. package/dist/options/headless.d.ts +1 -0
  135. package/dist/options/headless.js +2 -1
  136. package/dist/options/ignore-certificate-errors.d.ts +1 -0
  137. package/dist/options/ignore-certificate-errors.js +2 -1
  138. package/dist/options/image-sequence-pattern.d.ts +2 -1
  139. package/dist/options/image-sequence-pattern.js +2 -1
  140. package/dist/options/image-sequence.d.ts +1 -0
  141. package/dist/options/image-sequence.js +2 -1
  142. package/dist/options/index.d.ts +211 -2
  143. package/dist/options/index.js +12 -0
  144. package/dist/options/interactivity.d.ts +1 -0
  145. package/dist/options/interactivity.js +2 -1
  146. package/dist/options/ipv4.d.ts +1 -0
  147. package/dist/options/ipv4.js +2 -1
  148. package/dist/options/is-production.d.ts +1 -0
  149. package/dist/options/is-production.js +2 -1
  150. package/dist/options/jpeg-quality.d.ts +1 -0
  151. package/dist/options/jpeg-quality.js +6 -2
  152. package/dist/options/keyboard-shortcuts.d.ts +1 -0
  153. package/dist/options/keyboard-shortcuts.js +2 -1
  154. package/dist/options/latency-hint.d.ts +1 -0
  155. package/dist/options/latency-hint.js +2 -1
  156. package/dist/options/license-key.d.ts +1 -0
  157. package/dist/options/license-key.js +2 -1
  158. package/dist/options/log-level.d.ts +1 -0
  159. package/dist/options/log-level.js +2 -1
  160. package/dist/options/metadata.d.ts +1 -0
  161. package/dist/options/metadata.js +2 -1
  162. package/dist/options/mute.d.ts +1 -0
  163. package/dist/options/mute.js +2 -1
  164. package/dist/options/no-open.d.ts +1 -0
  165. package/dist/options/no-open.js +2 -1
  166. package/dist/options/number-of-gif-loops.d.ts +1 -0
  167. package/dist/options/number-of-gif-loops.js +2 -1
  168. package/dist/options/number-of-shared-audio-tags.d.ts +1 -0
  169. package/dist/options/number-of-shared-audio-tags.js +2 -1
  170. package/dist/options/offthreadvideo-cache-size.d.ts +1 -0
  171. package/dist/options/offthreadvideo-cache-size.js +2 -1
  172. package/dist/options/offthreadvideo-threads.d.ts +1 -0
  173. package/dist/options/offthreadvideo-threads.js +2 -1
  174. package/dist/options/on-browser-download.d.ts +1 -0
  175. package/dist/options/on-browser-download.js +2 -1
  176. package/dist/options/option.d.ts +1 -0
  177. package/dist/options/options-map.d.ts +189 -1
  178. package/dist/options/options-map.js +4 -0
  179. package/dist/options/out-dir.d.ts +1 -0
  180. package/dist/options/out-dir.js +2 -1
  181. package/dist/options/override-duration.d.ts +1 -0
  182. package/dist/options/override-duration.js +2 -1
  183. package/dist/options/override-fps.d.ts +1 -0
  184. package/dist/options/override-fps.js +2 -1
  185. package/dist/options/override-height.d.ts +1 -0
  186. package/dist/options/override-height.js +2 -1
  187. package/dist/options/override-width.d.ts +1 -0
  188. package/dist/options/override-width.js +2 -1
  189. package/dist/options/overwrite.d.ts +1 -0
  190. package/dist/options/overwrite.js +2 -1
  191. package/dist/options/package-manager.d.ts +1 -0
  192. package/dist/options/package-manager.js +2 -1
  193. package/dist/options/pixel-format.d.ts +1 -0
  194. package/dist/options/pixel-format.js +2 -1
  195. package/dist/options/port.d.ts +1 -0
  196. package/dist/options/port.js +2 -1
  197. package/dist/options/prefer-lossless.d.ts +1 -0
  198. package/dist/options/prefer-lossless.js +2 -1
  199. package/dist/options/preview-sample-rate.d.ts +1 -0
  200. package/dist/options/preview-sample-rate.js +2 -1
  201. package/dist/options/props.d.ts +1 -0
  202. package/dist/options/props.js +2 -1
  203. package/dist/options/prores-profile.d.ts +1 -0
  204. package/dist/options/prores-profile.js +2 -1
  205. package/dist/options/public-dir.d.ts +1 -0
  206. package/dist/options/public-dir.js +2 -1
  207. package/dist/options/public-license-key.d.ts +1 -0
  208. package/dist/options/public-license-key.js +2 -1
  209. package/dist/options/public-path.d.ts +1 -0
  210. package/dist/options/public-path.js +2 -1
  211. package/dist/options/repro.d.ts +1 -0
  212. package/dist/options/repro.js +2 -1
  213. package/dist/options/rspack.d.ts +2 -1
  214. package/dist/options/rspack.js +2 -1
  215. package/dist/options/runs.d.ts +1 -0
  216. package/dist/options/runs.js +2 -1
  217. package/dist/options/sample-rate.d.ts +1 -0
  218. package/dist/options/sample-rate.js +2 -1
  219. package/dist/options/scale.d.ts +1 -0
  220. package/dist/options/scale.js +2 -1
  221. package/dist/options/separate-audio.d.ts +1 -0
  222. package/dist/options/separate-audio.js +3 -2
  223. package/dist/options/show-premounting.d.ts +19 -0
  224. package/dist/options/show-premounting.js +33 -0
  225. package/dist/options/skip-skills.d.ts +1 -0
  226. package/dist/options/skip-skills.js +2 -1
  227. package/dist/options/still-frame.d.ts +1 -0
  228. package/dist/options/still-frame.js +2 -1
  229. package/dist/options/still-image-format.d.ts +1 -0
  230. package/dist/options/still-image-format.js +2 -1
  231. package/dist/options/throw-if-site-exists.d.ts +1 -0
  232. package/dist/options/throw-if-site-exists.js +2 -1
  233. package/dist/options/timeout.d.ts +1 -0
  234. package/dist/options/timeout.js +2 -1
  235. package/dist/options/user-agent.d.ts +1 -0
  236. package/dist/options/user-agent.js +2 -1
  237. package/dist/options/version-flag.d.ts +1 -0
  238. package/dist/options/version-flag.js +2 -1
  239. package/dist/options/video-bitrate.d.ts +1 -0
  240. package/dist/options/video-bitrate.js +2 -1
  241. package/dist/options/video-cache-size.d.ts +1 -0
  242. package/dist/options/video-cache-size.js +2 -1
  243. package/dist/options/video-codec.d.ts +1 -0
  244. package/dist/options/video-codec.js +5 -3
  245. package/dist/options/video-image-format.d.ts +1 -0
  246. package/dist/options/video-image-format.js +7 -2
  247. package/dist/options/webhook-custom-data.d.ts +1 -0
  248. package/dist/options/webhook-custom-data.js +2 -1
  249. package/dist/options/webpack-poll.d.ts +1 -0
  250. package/dist/options/webpack-poll.js +2 -1
  251. package/dist/options/x264-preset.d.ts +1 -0
  252. package/dist/options/x264-preset.js +2 -1
  253. package/dist/prespawn-ffmpeg.d.ts +20 -0
  254. package/dist/prespawn-ffmpeg.js +157 -29
  255. package/dist/probe-shared-memory-capture.d.ts +8 -0
  256. package/dist/probe-shared-memory-capture.js +111 -0
  257. package/dist/puppeteer-screenshot.d.ts +3 -1
  258. package/dist/puppeteer-screenshot.js +1 -0
  259. package/dist/pure.d.ts +1 -1
  260. package/dist/remotion-shared-memory-ffmpeg.d.ts +26 -0
  261. package/dist/remotion-shared-memory-ffmpeg.js +312 -0
  262. package/dist/remotion-shared-memory.d.ts +49 -0
  263. package/dist/remotion-shared-memory.js +359 -0
  264. package/dist/render-frame-and-retry-target-close.d.ts +5 -2
  265. package/dist/render-frame-and-retry-target-close.js +20 -4
  266. package/dist/render-frame-with-option-to-reject.d.ts +4 -1
  267. package/dist/render-frame-with-option-to-reject.js +206 -115
  268. package/dist/render-frame.d.ts +4 -5
  269. package/dist/render-frame.js +3 -1
  270. package/dist/render-frames.d.ts +3 -0
  271. package/dist/render-frames.js +15 -18
  272. package/dist/render-media.d.ts +1 -1
  273. package/dist/render-media.js +131 -46
  274. package/dist/render-still.js +1 -0
  275. package/dist/screenshot-background.d.ts +2 -0
  276. package/dist/screenshot-background.js +20 -0
  277. package/dist/screenshot-task.d.ts +4 -2
  278. package/dist/screenshot-task.js +40 -21
  279. package/dist/seek-to-frame.js +1 -1
  280. package/dist/stitch-frames-to-video.js +71 -10
  281. package/dist/take-frame.d.ts +11 -3
  282. package/dist/take-frame.js +10 -8
  283. package/dist/validate-output-filename.d.ts +1 -1
  284. package/dist/validate-output-filename.js +10 -2
  285. package/package.json +13 -13
@@ -22,8 +22,10 @@ const cross_site_isolation_1 = require("./cross-site-isolation");
22
22
  const dark_mode_1 = require("./dark-mode");
23
23
  const default_coding_agent_1 = require("./default-coding-agent");
24
24
  const default_editor_1 = require("./default-editor");
25
+ const default_premount_in_seconds_1 = require("./default-premount-in-seconds");
25
26
  const delete_after_1 = require("./delete-after");
26
27
  const disable_git_source_1 = require("./disable-git-source");
28
+ const disable_shared_memory_capture_1 = require("./disable-shared-memory-capture");
27
29
  const disable_web_security_1 = require("./disable-web-security");
28
30
  const disallow_parallel_encoding_1 = require("./disallow-parallel-encoding");
29
31
  const enable_cancellation_1 = require("./enable-cancellation");
@@ -35,6 +37,9 @@ const enforce_audio_1 = require("./enforce-audio");
35
37
  const env_file_1 = require("./env-file");
36
38
  const every_nth_frame_1 = require("./every-nth-frame");
37
39
  const experimental_keep_audio_context_alive_1 = require("./experimental-keep-audio-context-alive");
40
+ const experimental_sequence_activity_1 = require("./experimental-sequence-activity");
41
+ const experimental_sequence_activity_limit_1 = require("./experimental-sequence-activity-limit");
42
+ const experimental_tracks_1 = require("./experimental-tracks");
38
43
  const folder_expiry_1 = require("./folder-expiry");
39
44
  const for_seamless_aac_concatenation_1 = require("./for-seamless-aac-concatenation");
40
45
  const force_new_studio_1 = require("./force-new-studio");
@@ -84,6 +89,7 @@ const runs_1 = require("./runs");
84
89
  const sample_rate_1 = require("./sample-rate");
85
90
  const scale_1 = require("./scale");
86
91
  const separate_audio_1 = require("./separate-audio");
92
+ const show_premounting_1 = require("./show-premounting");
87
93
  const skip_skills_1 = require("./skip-skills");
88
94
  const still_frame_1 = require("./still-frame");
89
95
  const still_image_format_1 = require("./still-image-format");
@@ -99,6 +105,7 @@ const webhook_custom_data_1 = require("./webhook-custom-data");
99
105
  const webpack_poll_1 = require("./webpack-poll");
100
106
  const x264_preset_1 = require("./x264-preset");
101
107
  exports.allOptions = {
108
+ showPremountingOption: show_premounting_1.showPremountingOption,
102
109
  allowHtmlInCanvasOption: allow_html_in_canvas_1.allowHtmlInCanvasOption,
103
110
  audioCodecOption: audio_codec_1.audioCodecOption,
104
111
  benchmarkConcurrenciesOption: benchmark_concurrencies_1.benchmarkConcurrenciesOption,
@@ -120,6 +127,7 @@ exports.allOptions = {
120
127
  deleteAfterOption: delete_after_1.deleteAfterOption,
121
128
  disableWebSecurityOption: disable_web_security_1.disableWebSecurityOption,
122
129
  disallowParallelEncodingOption: disallow_parallel_encoding_1.disallowParallelEncodingOption,
130
+ disableSharedMemoryCaptureOption: disable_shared_memory_capture_1.disableSharedMemoryCaptureOption,
123
131
  folderExpiryOption: folder_expiry_1.folderExpiryOption,
124
132
  enableCancellationOption: enable_cancellation_1.enableCancellationOption,
125
133
  enableMultiprocessOnLinuxOption: enable_multiprocess_on_linux_1.enableMultiprocessOnLinuxOption,
@@ -163,6 +171,7 @@ exports.allOptions = {
163
171
  darkModeOption: dark_mode_1.darkModeOption,
164
172
  defaultCodingAgentOption: default_coding_agent_1.defaultCodingAgentOption,
165
173
  defaultEditorOption: default_editor_1.defaultEditorOption,
174
+ defaultPremountInSecondsOption: default_premount_in_seconds_1.defaultPremountInSecondsOption,
166
175
  publicLicenseKeyOption: public_license_key_1.publicLicenseKeyOption,
167
176
  isProductionOption: is_production_1.isProductionOption,
168
177
  askAIOption: ask_ai_1.askAIOption,
@@ -172,6 +181,9 @@ exports.allOptions = {
172
181
  framesOption: frames_1.framesOption,
173
182
  forceNewStudioOption: force_new_studio_1.forceNewStudioOption,
174
183
  experimentalKeepAudioContextAliveOption: experimental_keep_audio_context_alive_1.experimentalKeepAudioContextAliveOption,
184
+ experimentalTracksOption: experimental_tracks_1.experimentalTracksOption,
185
+ experimentalSequenceActivityOption: experimental_sequence_activity_1.experimentalSequenceActivityOption,
186
+ experimentalSequenceActivityLimitOption: experimental_sequence_activity_limit_1.experimentalSequenceActivityLimitOption,
175
187
  numberOfSharedAudioTagsOption: number_of_shared_audio_tags_1.numberOfSharedAudioTagsOption,
176
188
  ipv4Option: ipv4_1.ipv4Option,
177
189
  stillImageFormatOption: still_image_format_1.stillImageFormatOption,
@@ -1,5 +1,6 @@
1
1
  export declare const interactivityOption: {
2
2
  name: string;
3
+ addedIn: string;
3
4
  cliFlag: "disable-interactivity";
4
5
  description: () => import("react/jsx-runtime").JSX.Element;
5
6
  ssrName: null;
@@ -7,10 +7,11 @@ let configuredInteractivityEnabled = null;
7
7
  const cliFlag = 'disable-interactivity';
8
8
  exports.interactivityOption = {
9
9
  name: 'Disable or enable Studio interactivity',
10
+ addedIn: '4.0.487',
10
11
  cliFlag,
11
12
  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
13
  ssrName: null,
13
- docLink: 'https://www.remotion.dev/docs/config#setinteractivityenabled',
14
+ docLink: 'https://www.remotion.dev/docs/options/disable-interactivity',
14
15
  type: false,
15
16
  getValue: ({ commandLine }) => {
16
17
  if (commandLine[cliFlag] !== undefined && commandLine[cliFlag] !== null) {
@@ -1,5 +1,6 @@
1
1
  export declare const ipv4Option: {
2
2
  name: string;
3
+ addedIn: string;
3
4
  cliFlag: "ipv4";
4
5
  description: () => import("react/jsx-runtime").JSX.Element;
5
6
  ssrName: null;
@@ -6,10 +6,11 @@ let forceIPv4 = false;
6
6
  const cliFlag = 'ipv4';
7
7
  exports.ipv4Option = {
8
8
  name: 'IPv4',
9
+ addedIn: '4.0.125',
9
10
  cliFlag,
10
11
  description: () => (jsx_runtime_1.jsx(jsx_runtime_1.Fragment, { children: "Forces Remotion to bind to an IPv4 interface for the Studio server." })),
11
12
  ssrName: null,
12
- docLink: 'https://www.remotion.dev/docs/cli/studio',
13
+ docLink: 'https://www.remotion.dev/docs/options/ipv4',
13
14
  type: false,
14
15
  getValue: ({ commandLine }) => {
15
16
  if (commandLine[cliFlag] !== undefined && commandLine[cliFlag] !== null) {
@@ -1,5 +1,6 @@
1
1
  export declare const isProductionOption: {
2
2
  name: string;
3
+ addedIn: string;
3
4
  cliFlag: "is-production";
4
5
  description: () => import("react/jsx-runtime").JSX.Element;
5
6
  ssrName: "isProduction";
@@ -6,13 +6,14 @@ const cliFlag = 'is-production';
6
6
  let currentIsProductionKey = null;
7
7
  exports.isProductionOption = {
8
8
  name: 'Is Production',
9
+ addedIn: '4.0.409',
9
10
  cliFlag,
10
11
  description: () => (jsx_runtime_1.jsxs(jsx_runtime_1.Fragment, { children: ["Pass ",
11
12
  jsx_runtime_1.jsx("code", { children: "false" }),
12
13
  " 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
14
  "."] })),
14
15
  ssrName: 'isProduction',
15
- docLink: 'https://www.remotion.dev/docs/licensing',
16
+ docLink: 'https://www.remotion.dev/docs/options/is-production',
16
17
  getValue: ({ commandLine }) => {
17
18
  if (commandLine[cliFlag] !== undefined && commandLine[cliFlag] !== null) {
18
19
  return {
@@ -2,6 +2,7 @@ export declare const setJpegQuality: (q: number | undefined) => void;
2
2
  export declare const getJpegQuality: () => number;
3
3
  export declare const jpegQualityOption: {
4
4
  name: string;
5
+ addedIn: string;
5
6
  cliFlag: "jpeg-quality";
6
7
  description: () => import("react/jsx-runtime").JSX.Element;
7
8
  ssrName: string;
@@ -19,10 +19,14 @@ exports.getJpegQuality = getJpegQuality;
19
19
  const cliFlag = 'jpeg-quality';
20
20
  exports.jpegQualityOption = {
21
21
  name: 'JPEG Quality',
22
+ addedIn: '4.0.0',
22
23
  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." })),
24
+ 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.",
25
+ jsx_runtime_1.jsx("br", {}),
26
+ "This option has no effect when", ' ', jsx_runtime_1.jsx("a", { href: "/docs/shared-memory-capture", children: "shared-memory capture" }),
27
+ " is active."] })),
24
28
  ssrName: 'jpegQuality',
25
- docLink: 'https://www.remotion.dev/docs/renderer/render-media#jpeg-quality',
29
+ docLink: 'https://www.remotion.dev/docs/options/jpeg-quality',
26
30
  type: 0,
27
31
  setConfig: exports.setJpegQuality,
28
32
  getValue: ({ commandLine }) => {
@@ -1,5 +1,6 @@
1
1
  export declare const keyboardShortcutsOption: {
2
2
  name: string;
3
+ addedIn: string;
3
4
  cliFlag: "disable-keyboard-shortcuts";
4
5
  description: () => import("react/jsx-runtime").JSX.Element;
5
6
  ssrName: null;
@@ -7,10 +7,11 @@ let configuredKeyboardShortcutsEnabled = null;
7
7
  const cliFlag = 'disable-keyboard-shortcuts';
8
8
  exports.keyboardShortcutsOption = {
9
9
  name: 'Disable or Enable keyboard shortcuts',
10
+ addedIn: '3.2.11',
10
11
  cliFlag,
11
12
  description: () => (jsx_runtime_1.jsx(jsx_runtime_1.Fragment, { children: "Enable or disable keyboard shortcuts in the Remotion Studio." })),
12
13
  ssrName: null,
13
- docLink: 'https://www.remotion.dev/docs/config#setkeyboardshortcutsenabled',
14
+ docLink: 'https://www.remotion.dev/docs/options/disable-keyboard-shortcuts',
14
15
  type: false,
15
16
  getValue: ({ commandLine }) => {
16
17
  if (commandLine[cliFlag] !== undefined && commandLine[cliFlag] !== null) {
@@ -1,5 +1,6 @@
1
1
  export declare const audioLatencyHintOption: {
2
2
  name: string;
3
+ addedIn: string;
3
4
  cliFlag: "audio-latency-hint";
4
5
  description: () => import("react/jsx-runtime").JSX.Element;
5
6
  ssrName: "audioLatencyHint";
@@ -6,6 +6,7 @@ const cliFlag = 'audio-latency-hint';
6
6
  let value = null;
7
7
  exports.audioLatencyHintOption = {
8
8
  name: 'Audio Latency Hint',
9
+ addedIn: '4.0.303',
9
10
  cliFlag,
10
11
  description: () => (jsx_runtime_1.jsxs(jsx_runtime_1.Fragment, { children: ["Sets the", ' ', jsx_runtime_1.jsx("a", { href: "https://developer.mozilla.org/en-US/docs/Web/API/AudioContext/AudioContext", children: "audio latency" }), ' ', "hint for the global ",
11
12
  jsx_runtime_1.jsx("code", { children: "AudioContext" }),
@@ -18,7 +19,7 @@ exports.audioLatencyHintOption = {
18
19
  ",", ' ', jsx_runtime_1.jsx("code", { children: "playback" })
19
20
  ] })),
20
21
  ssrName: 'audioLatencyHint',
21
- docLink: 'https://www.remotion.dev/docs/renderer/render-media',
22
+ docLink: 'https://www.remotion.dev/docs/options/audio-latency-hint',
22
23
  type: 'playback',
23
24
  getValue: ({ commandLine }) => {
24
25
  const val = commandLine[cliFlag];
@@ -1,5 +1,6 @@
1
1
  export declare const licenseKeyOption: {
2
2
  name: string;
3
+ addedIn: string;
3
4
  cliFlag: "license-key";
4
5
  description: () => import("react/jsx-runtime").JSX.Element;
5
6
  ssrName: "licenseKey";
@@ -6,11 +6,12 @@ let currentLicenseKey = null;
6
6
  const cliFlag = 'license-key';
7
7
  exports.licenseKeyOption = {
8
8
  name: 'License key',
9
+ addedIn: '4.0.409',
9
10
  cliFlag,
10
11
  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
12
  "."] })),
12
13
  ssrName: 'licenseKey',
13
- docLink: 'https://www.remotion.dev/docs/licensing',
14
+ docLink: 'https://www.remotion.dev/docs/options/license-key',
14
15
  type: null,
15
16
  getValue: ({ commandLine }) => {
16
17
  if (commandLine[cliFlag] !== undefined) {
@@ -1,6 +1,7 @@
1
1
  export declare const logLevelOption: {
2
2
  cliFlag: "log";
3
3
  name: string;
4
+ addedIn: string;
4
5
  ssrName: string;
5
6
  description: () => import("react/jsx-runtime").JSX.Element;
6
7
  docLink: string;
@@ -9,6 +9,7 @@ const cliFlag = 'log';
9
9
  exports.logLevelOption = {
10
10
  cliFlag,
11
11
  name: 'Log Level',
12
+ addedIn: '2.0.1',
12
13
  ssrName: 'logLevel',
13
14
  description: () => (jsx_runtime_1.jsxs(jsx_runtime_1.Fragment, { children: ["One of ",
14
15
  jsx_runtime_1.jsx("code", { children: "trace" }),
@@ -26,7 +27,7 @@ exports.logLevelOption = {
26
27
  " Default ",
27
28
  jsx_runtime_1.jsx("code", { children: "info" }),
28
29
  "."] })),
29
- docLink: 'https://www.remotion.dev/docs/troubleshooting/debug-failed-render',
30
+ docLink: 'https://www.remotion.dev/docs/options/log',
30
31
  getValue: ({ commandLine }) => {
31
32
  if (commandLine[cliFlag]) {
32
33
  if (!(0, log_level_1.isValidLogLevel)(commandLine[cliFlag])) {
@@ -1,6 +1,7 @@
1
1
  export type Metadata = Record<string, string>;
2
2
  export declare const metadataOption: {
3
3
  name: string;
4
+ addedIn: string;
4
5
  cliFlag: "metadata";
5
6
  description: (mode: "cli" | "ssr") => import("react/jsx-runtime").JSX.Element;
6
7
  docLink: string;
@@ -6,6 +6,7 @@ let metadata = {};
6
6
  const cliFlag = 'metadata';
7
7
  exports.metadataOption = {
8
8
  name: 'Metadata',
9
+ addedIn: '4.0.216',
9
10
  cliFlag,
10
11
  description: (mode) => {
11
12
  if (mode === 'ssr') {
@@ -18,7 +19,7 @@ exports.metadataOption = {
18
19
  "The parameter must be in the format of ",
19
20
  jsx_runtime_1.jsx("code", { children: "--metadata key=value" }), ' ', "and can be passed multiple times."] }));
20
21
  },
21
- docLink: 'https://www.remotion.dev/docs/metadata',
22
+ docLink: 'https://www.remotion.dev/docs/options/metadata',
22
23
  type: {},
23
24
  getValue: ({ commandLine }) => {
24
25
  if (commandLine[cliFlag] !== undefined) {
@@ -1,5 +1,6 @@
1
1
  export declare const mutedOption: {
2
2
  name: string;
3
+ addedIn: string;
3
4
  cliFlag: "muted";
4
5
  description: () => import("react/jsx-runtime").JSX.Element;
5
6
  ssrName: string;
@@ -7,10 +7,11 @@ let mutedState = DEFAULT_MUTED_STATE;
7
7
  const cliFlag = 'muted';
8
8
  exports.mutedOption = {
9
9
  name: 'Muted',
10
+ addedIn: '3.2.1',
10
11
  cliFlag,
11
12
  description: () => jsx_runtime_1.jsx(jsx_runtime_1.Fragment, { children: "The Audio of the video will be omitted." }),
12
13
  ssrName: 'muted',
13
- docLink: 'https://www.remotion.dev/docs/audio/muting',
14
+ docLink: 'https://www.remotion.dev/docs/options/muted',
14
15
  type: false,
15
16
  getValue: ({ commandLine }) => {
16
17
  // we set in minimist `muted` default as null
@@ -1,5 +1,6 @@
1
1
  export declare const noOpenOption: {
2
2
  name: string;
3
+ addedIn: string;
3
4
  cliFlag: "no-open";
4
5
  description: () => import("react/jsx-runtime").JSX.Element;
5
6
  ssrName: null;
@@ -6,10 +6,11 @@ let shouldOpenBrowser = true;
6
6
  const cliFlag = 'no-open';
7
7
  exports.noOpenOption = {
8
8
  name: 'Disable browser auto-open',
9
+ addedIn: '3.3.19',
9
10
  cliFlag,
10
11
  description: () => (jsx_runtime_1.jsx(jsx_runtime_1.Fragment, { children: "If specified, Remotion will not open a browser window when starting the Studio." })),
11
12
  ssrName: null,
12
- docLink: 'https://www.remotion.dev/docs/cli/studio#--no-open',
13
+ docLink: 'https://www.remotion.dev/docs/options/no-open',
13
14
  type: false,
14
15
  getValue: ({ commandLine }) => {
15
16
  // Minimist quirk: `--no-open` sets `open` to `false`.
@@ -1,6 +1,7 @@
1
1
  export type NumberOfGifLoops = number | null;
2
2
  export declare const numberOfGifLoopsOption: {
3
3
  name: string;
4
+ addedIn: string;
4
5
  cliFlag: "number-of-gif-loops";
5
6
  description: () => import("react/jsx-runtime").JSX.Element;
6
7
  ssrName: "numberOfGifLoops";
@@ -11,6 +11,7 @@ const validate = (newLoop) => {
11
11
  const cliFlag = 'number-of-gif-loops';
12
12
  exports.numberOfGifLoopsOption = {
13
13
  name: 'Number of GIF loops',
14
+ addedIn: '3.1.0',
14
15
  cliFlag,
15
16
  description: () => {
16
17
  return (jsx_runtime_1.jsxs(jsx_runtime_1.Fragment, { children: ["Allows you to set the number of loops as follows:",
@@ -28,7 +29,7 @@ exports.numberOfGifLoopsOption = {
28
29
  ] }));
29
30
  },
30
31
  ssrName: 'numberOfGifLoops',
31
- docLink: 'https://www.remotion.dev/docs/render-as-gif#changing-the-number-of-loops',
32
+ docLink: 'https://www.remotion.dev/docs/options/number-of-gif-loops',
32
33
  type: 0,
33
34
  getValue: ({ commandLine }) => {
34
35
  if (commandLine[cliFlag] !== undefined) {
@@ -1,5 +1,6 @@
1
1
  export declare const numberOfSharedAudioTagsOption: {
2
2
  name: string;
3
+ addedIn: string;
3
4
  cliFlag: "number-of-shared-audio-tags";
4
5
  description: () => import("react/jsx-runtime").JSX.Element;
5
6
  ssrName: null;
@@ -7,10 +7,11 @@ let configuredNumberOfSharedAudioTags = null;
7
7
  const cliFlag = 'number-of-shared-audio-tags';
8
8
  exports.numberOfSharedAudioTagsOption = {
9
9
  name: 'Number of shared audio tags',
10
+ addedIn: '3.3.2',
10
11
  cliFlag,
11
12
  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
13
  ssrName: null,
13
- docLink: 'https://www.remotion.dev/docs/config#setnumberofsharedaudiotags',
14
+ docLink: 'https://www.remotion.dev/docs/options/number-of-shared-audio-tags',
14
15
  type: 0,
15
16
  getValue: ({ commandLine }) => {
16
17
  if (commandLine[cliFlag] !== undefined) {
@@ -1,6 +1,7 @@
1
1
  export declare const getOffthreadVideoCacheSizeInBytes: () => number | null;
2
2
  export declare const offthreadVideoCacheSizeInBytesOption: {
3
3
  name: string;
4
+ addedIn: string;
4
5
  cliFlag: "offthreadvideo-cache-size-in-bytes";
5
6
  description: () => import("react/jsx-runtime").JSX.Element;
6
7
  ssrName: "offthreadVideoCacheSizeInBytes";
@@ -10,6 +10,7 @@ exports.getOffthreadVideoCacheSizeInBytes = getOffthreadVideoCacheSizeInBytes;
10
10
  const cliFlag = 'offthreadvideo-cache-size-in-bytes';
11
11
  exports.offthreadVideoCacheSizeInBytesOption = {
12
12
  name: 'OffthreadVideo cache size',
13
+ addedIn: '4.0.23',
13
14
  cliFlag,
14
15
  description: () => (jsx_runtime_1.jsxs(jsx_runtime_1.Fragment, { children: ["From v4.0, Remotion has a cache for", ' ', jsx_runtime_1.jsx("a", { href: "https://remotion.dev/docs/offthreadvideo", children: jsx_runtime_1.jsx("code", { children: "<OffthreadVideo>" }) }), ' ', "frames. The default is ",
15
16
  jsx_runtime_1.jsx("code", { children: "null" }),
@@ -23,7 +24,7 @@ exports.offthreadVideoCacheSizeInBytesOption = {
23
24
  jsx_runtime_1.jsx("code", { children: "null" })
24
25
  ] })),
25
26
  ssrName: 'offthreadVideoCacheSizeInBytes',
26
- docLink: 'https://www.remotion.dev/docs/offthreadvideo',
27
+ docLink: 'https://www.remotion.dev/docs/options/offthreadvideo-cache-size-in-bytes',
27
28
  type: 0,
28
29
  getValue: ({ commandLine }) => {
29
30
  if (commandLine[cliFlag] !== undefined) {
@@ -1,6 +1,7 @@
1
1
  export declare const getOffthreadVideoThreads: () => number | null;
2
2
  export declare const offthreadVideoThreadsOption: {
3
3
  name: string;
4
+ addedIn: string;
4
5
  cliFlag: "offthreadvideo-video-threads";
5
6
  description: () => import("react/jsx-runtime").JSX.Element;
6
7
  ssrName: "offthreadVideoThreads";
@@ -10,11 +10,12 @@ exports.getOffthreadVideoThreads = getOffthreadVideoThreads;
10
10
  const cliFlag = 'offthreadvideo-video-threads';
11
11
  exports.offthreadVideoThreadsOption = {
12
12
  name: 'OffthreadVideo threads',
13
+ addedIn: '4.0.261',
13
14
  cliFlag,
14
15
  description: () => (jsx_runtime_1.jsxs(jsx_runtime_1.Fragment, { children: ["The number of threads that",
15
16
  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
17
  ssrName: 'offthreadVideoThreads',
17
- docLink: 'https://www.remotion.dev/docs/offthreadvideo',
18
+ docLink: 'https://www.remotion.dev/docs/options/offthreadvideo-video-threads',
18
19
  type: 0,
19
20
  getValue: ({ commandLine }) => {
20
21
  if (commandLine[cliFlag] !== undefined) {
@@ -13,6 +13,7 @@ export type OnBrowserDownload = (options: {
13
13
  };
14
14
  export declare const onBrowserDownloadOption: {
15
15
  name: string;
16
+ addedIn: string;
16
17
  cliFlag: "on-browser-download";
17
18
  description: () => import("react/jsx-runtime").JSX.Element;
18
19
  ssrName: "onBrowserDownload";
@@ -5,11 +5,12 @@ const jsx_runtime_1 = require("react/jsx-runtime");
5
5
  const cliFlag = 'on-browser-download';
6
6
  exports.onBrowserDownloadOption = {
7
7
  name: 'Browser download callback function',
8
+ addedIn: '4.0.137',
8
9
  cliFlag,
9
10
  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
11
  ] })),
11
12
  ssrName: 'onBrowserDownload',
12
- docLink: 'https://www.remotion.dev/docs/renderer/ensure-browser',
13
+ docLink: 'https://www.remotion.dev/docs/options/on-browser-download',
13
14
  type: undefined,
14
15
  getValue: () => {
15
16
  throw new Error('does not support config file');
@@ -1,6 +1,7 @@
1
1
  import type { TypeOfOption } from '../client';
2
2
  export type RemotionOption<SsrName extends string, Type> = {
3
3
  name: string;
4
+ addedIn: string;
4
5
  cliFlag: string;
5
6
  ssrName: SsrName | null;
6
7
  description: (mode: 'ssr' | 'cli') => React.ReactNode;