@remotion/renderer 4.0.404 → 4.0.406

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 (182) hide show
  1. package/dist/assets/apply-tone-frequency.d.ts +1 -2
  2. package/dist/assets/convert-assets-to-file-urls.d.ts +1 -2
  3. package/dist/assets/download-and-map-assets-to-file.d.ts +2 -3
  4. package/dist/assets/download-and-map-assets-to-file.js +1 -0
  5. package/dist/assets/download-file.d.ts +1 -0
  6. package/dist/assets/download-file.js +17 -1
  7. package/dist/assets/download-map.d.ts +1 -0
  8. package/dist/assets/download-map.js +2 -0
  9. package/dist/assets/get-audio-channels.d.ts +2 -3
  10. package/dist/assets/inline-audio-mixing.d.ts +1 -2
  11. package/dist/browser/Browser.d.ts +5 -5
  12. package/dist/browser/Browser.js +65 -74
  13. package/dist/browser/BrowserFetcher.d.ts +3 -5
  14. package/dist/browser/BrowserFetcher.js +1 -0
  15. package/dist/browser/BrowserPage.d.ts +4 -4
  16. package/dist/browser/BrowserPage.js +223 -218
  17. package/dist/browser/BrowserRunner.d.ts +1 -2
  18. package/dist/browser/Connection.js +99 -112
  19. package/dist/browser/ConsoleMessage.d.ts +1 -1
  20. package/dist/browser/ConsoleMessage.js +9 -16
  21. package/dist/browser/DOMWorld.d.ts +1 -1
  22. package/dist/browser/DOMWorld.js +75 -89
  23. package/dist/browser/Errors.js +2 -4
  24. package/dist/browser/EventEmitter.js +2 -1
  25. package/dist/browser/ExecutionContext.js +117 -120
  26. package/dist/browser/FrameManager.js +249 -244
  27. package/dist/browser/HTTPRequest.js +11 -22
  28. package/dist/browser/HTTPResponse.js +3 -16
  29. package/dist/browser/JSHandle.js +17 -30
  30. package/dist/browser/LifecycleWatcher.js +122 -128
  31. package/dist/browser/NetworkEventManager.js +31 -40
  32. package/dist/browser/NetworkManager.js +210 -203
  33. package/dist/browser/NodeWebSocketTransport.js +3 -0
  34. package/dist/browser/Target.d.ts +1 -1
  35. package/dist/browser/Target.js +32 -39
  36. package/dist/browser/TaskQueue.js +5 -18
  37. package/dist/browser/TimeoutSettings.js +12 -25
  38. package/dist/browser/browser-download-progress-bar.d.ts +1 -2
  39. package/dist/browser/handle-failed-resource.d.ts +1 -2
  40. package/dist/browser/handle-failed-resource.js +4 -3
  41. package/dist/call-ffmpeg.d.ts +4 -5
  42. package/dist/can-concat-seamlessly.d.ts +2 -4
  43. package/dist/can-use-parallel-encoding.d.ts +1 -2
  44. package/dist/check-version-requirements.d.ts +1 -2
  45. package/dist/client.d.ts +181 -181
  46. package/dist/codec-supports-media.d.ts +3 -4
  47. package/dist/collect-assets.d.ts +1 -1
  48. package/dist/combine-audio.d.ts +2 -4
  49. package/dist/combine-chunks.d.ts +1 -2
  50. package/dist/combine-video-streams.d.ts +2 -4
  51. package/dist/compositor/compositor.d.ts +3 -3
  52. package/dist/compositor/compositor.js +51 -32
  53. package/dist/compositor/get-executable-path.d.ts +3 -3
  54. package/dist/compress-audio.d.ts +2 -4
  55. package/dist/create-audio.d.ts +2 -4
  56. package/dist/create-silent-audio.d.ts +1 -2
  57. package/dist/crf.d.ts +4 -6
  58. package/dist/cycle-browser-tabs.d.ts +1 -2
  59. package/dist/ensure-browser.d.ts +44 -1
  60. package/dist/error-handling/handle-javascript-exception.d.ts +1 -1
  61. package/dist/error-handling/handle-javascript-exception.js +7 -1
  62. package/dist/error-handling/symbolicateable-error.d.ts +1 -1
  63. package/dist/error-handling/symbolicateable-error.js +4 -0
  64. package/dist/error-handling.js +1 -1
  65. package/dist/esm/client.mjs +7 -2
  66. package/dist/esm/index.mjs +81 -40
  67. package/dist/extract-audio.d.ts +2 -3
  68. package/dist/ffmpeg-args.d.ts +6 -12
  69. package/dist/get-browser-instance.d.ts +4 -6
  70. package/dist/get-codec-name.d.ts +3 -6
  71. package/dist/get-compositions.d.ts +1 -1
  72. package/dist/get-concurrency.d.ts +1 -1
  73. package/dist/get-extension-from-codec.d.ts +2 -3
  74. package/dist/get-frame-padded-index.d.ts +1 -2
  75. package/dist/get-local-browser-executable.d.ts +2 -4
  76. package/dist/get-prores-profile-name.d.ts +1 -3
  77. package/dist/get-silent-parts.d.ts +4 -5
  78. package/dist/get-video-metadata.d.ts +3 -4
  79. package/dist/get-video-threads-flag.d.ts +1 -2
  80. package/dist/goto-page-or-throw.d.ts +1 -1
  81. package/dist/guess-extension-for-media.d.ts +2 -3
  82. package/dist/image-format.d.ts +2 -3
  83. package/dist/index.d.ts +173 -172
  84. package/dist/index.js +16 -16
  85. package/dist/is-audio-codec.d.ts +1 -2
  86. package/dist/log-level.d.ts +1 -1
  87. package/dist/logger.d.ts +6 -6
  88. package/dist/make-page.d.ts +2 -4
  89. package/dist/memory/from-proc-meminfo.d.ts +1 -2
  90. package/dist/memory/get-available-memory.d.ts +1 -2
  91. package/dist/mime-types.js +2 -1
  92. package/dist/mux-video-and-audio.d.ts +2 -3
  93. package/dist/offthread-video-server.d.ts +1 -2
  94. package/dist/offthread-video-server.js +6 -18
  95. package/dist/open-browser.d.ts +1 -1
  96. package/dist/open-browser.js +6 -5
  97. package/dist/options/api-key.js +3 -1
  98. package/dist/options/audio-bitrate.js +9 -1
  99. package/dist/options/audio-codec.d.ts +10 -13
  100. package/dist/options/beep-on-finish.js +1 -1
  101. package/dist/options/binaries-directory.js +9 -1
  102. package/dist/options/chrome-mode.d.ts +3 -3
  103. package/dist/options/chrome-mode.js +6 -1
  104. package/dist/options/color-space.d.ts +5 -9
  105. package/dist/options/color-space.js +7 -1
  106. package/dist/options/crf.js +1 -1
  107. package/dist/options/cross-site-isolation.js +2 -1
  108. package/dist/options/dark-mode.js +2 -1
  109. package/dist/options/delete-after.js +11 -1
  110. package/dist/options/disallow-parallel-encoding.js +1 -1
  111. package/dist/options/enable-lambda-insights.js +2 -1
  112. package/dist/options/enable-multiprocess-on-linux.js +13 -1
  113. package/dist/options/encoding-buffer-size.js +3 -1
  114. package/dist/options/encoding-max-rate.js +3 -1
  115. package/dist/options/enforce-audio.js +1 -1
  116. package/dist/options/folder-expiry.js +4 -1
  117. package/dist/options/for-seamless-aac-concatenation.js +3 -1
  118. package/dist/options/gl.d.ts +6 -6
  119. package/dist/options/gl.js +28 -2
  120. package/dist/options/hardware-acceleration.d.ts +2 -2
  121. package/dist/options/headless.js +4 -1
  122. package/dist/options/image-sequence-pattern.js +5 -1
  123. package/dist/options/index.d.ts +25 -25
  124. package/dist/options/jpeg-quality.js +1 -1
  125. package/dist/options/latency-hint.js +10 -1
  126. package/dist/options/license-key.js +2 -1
  127. package/dist/options/log-level.d.ts +3 -4
  128. package/dist/options/log-level.js +16 -1
  129. package/dist/options/metadata.js +7 -2
  130. package/dist/options/mute.js +1 -1
  131. package/dist/options/number-of-gif-loops.js +13 -1
  132. package/dist/options/offthreadvideo-cache-size.js +11 -1
  133. package/dist/options/offthreadvideo-threads.js +2 -1
  134. package/dist/options/on-browser-download.js +2 -1
  135. package/dist/options/options-map.d.ts +93 -93
  136. package/dist/options/overwrite.js +5 -1
  137. package/dist/options/prefer-lossless.js +4 -1
  138. package/dist/options/public-dir.js +2 -1
  139. package/dist/options/public-license-key.js +3 -1
  140. package/dist/options/public-path.js +7 -1
  141. package/dist/options/repro.js +1 -1
  142. package/dist/options/scale.js +5 -1
  143. package/dist/options/timeout.js +4 -1
  144. package/dist/options/video-bitrate.js +7 -1
  145. package/dist/options/video-cache-size.js +8 -1
  146. package/dist/options/video-codec.d.ts +6 -6
  147. package/dist/options/video-codec.js +1 -1
  148. package/dist/options/webhook-custom-data.js +1 -1
  149. package/dist/options/x264-preset.d.ts +5 -6
  150. package/dist/options/x264-preset.js +23 -1
  151. package/dist/p-limit.d.ts +1 -1
  152. package/dist/pixel-format.d.ts +2 -3
  153. package/dist/pool.js +2 -0
  154. package/dist/port-config.d.ts +5 -6
  155. package/dist/prespawn-ffmpeg.js +5 -4
  156. package/dist/prestitcher-memory-usage.d.ts +1 -2
  157. package/dist/print-useful-error-message.d.ts +1 -2
  158. package/dist/prores-profile.d.ts +2 -4
  159. package/dist/puppeteer-evaluate.d.ts +2 -2
  160. package/dist/puppeteer-screenshot.d.ts +3 -4
  161. package/dist/pure.d.ts +5 -5
  162. package/dist/render-frame-and-retry-target-close.d.ts +8 -8
  163. package/dist/render-frame-with-option-to-reject.d.ts +4 -6
  164. package/dist/render-frame.d.ts +8 -8
  165. package/dist/render-has-audio.d.ts +2 -3
  166. package/dist/render-media.js +2 -1
  167. package/dist/replace-browser.d.ts +1 -2
  168. package/dist/repro.d.ts +1 -1
  169. package/dist/screenshot-task.d.ts +3 -4
  170. package/dist/seek-to-frame.d.ts +2 -3
  171. package/dist/serve-handler/index.d.ts +1 -1
  172. package/dist/serve-handler/range-parser.d.ts +2 -2
  173. package/dist/serve-static.d.ts +1 -2
  174. package/dist/set-props-and-env.js +3 -1
  175. package/dist/stringify-ffmpeg-filter.d.ts +1 -2
  176. package/dist/take-frame.d.ts +1 -2
  177. package/dist/test-gpu.d.ts +2 -4
  178. package/dist/validate-even-dimensions-with-codec.d.ts +2 -4
  179. package/dist/validate-ffmpeg-override.d.ts +1 -1
  180. package/dist/validate-number-of-gif-loops.d.ts +1 -2
  181. package/dist/validate-output-filename.d.ts +2 -4
  182. package/package.json +16 -14
@@ -12,7 +12,9 @@ const cliFlag = 'for-seamless-aac-concatenation';
12
12
  exports.forSeamlessAacConcatenationOption = {
13
13
  name: 'For seamless AAC concatenation',
14
14
  cliFlag,
15
- description: () => ((0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: ["If enabled, the audio is trimmed to the nearest AAC frame, which is required for seamless concatenation of AAC files. This is a requirement if you later want to combine multiple video snippets seamlessly.", (0, jsx_runtime_1.jsx)("br", {}), (0, jsx_runtime_1.jsx)("br", {}), " This option is used internally. There is currently no documentation yet for to concatenate the audio chunks."] })),
15
+ description: () => (jsx_runtime_1.jsxs(jsx_runtime_1.Fragment, { children: ["If enabled, the audio is trimmed to the nearest AAC frame, which is required for seamless concatenation of AAC files. This is a requirement if you later want to combine multiple video snippets seamlessly.",
16
+ jsx_runtime_1.jsx("br", {}), jsx_runtime_1.jsx("br", {}),
17
+ " This option is used internally. There is currently no documentation yet for to concatenate the audio chunks."] })),
16
18
  docLink: 'https://remotion.dev/docs/renderer',
17
19
  getValue: ({ commandLine }) => {
18
20
  if (commandLine[cliFlag]) {
@@ -1,24 +1,24 @@
1
1
  export declare const validOpenGlRenderers: readonly ["swangle", "angle", "egl", "swiftshader", "vulkan", "angle-egl"];
2
2
  export type OpenGlRenderer = (typeof validOpenGlRenderers)[number];
3
3
  export declare const DEFAULT_OPENGL_RENDERER: OpenGlRenderer | null;
4
- export declare const getChromiumOpenGlRenderer: () => "angle" | "swangle" | "egl" | "swiftshader" | "vulkan" | "angle-egl" | null;
5
- export declare const setChromiumOpenGlRenderer: (renderer: OpenGlRenderer) => void;
4
+ export declare const getChromiumOpenGlRenderer: () => "angle" | "angle-egl" | "egl" | "swangle" | "swiftshader" | "vulkan" | null;
5
+ export declare const setChromiumOpenGlRenderer: (renderer: "angle" | "angle-egl" | "egl" | "swangle" | "swiftshader" | "vulkan") => void;
6
6
  export declare const glOption: {
7
7
  cliFlag: "gl";
8
8
  docLink: string;
9
9
  name: string;
10
- type: OpenGlRenderer | null;
10
+ type: "angle" | "angle-egl" | "egl" | "swangle" | "swiftshader" | "vulkan" | null;
11
11
  ssrName: string;
12
12
  description: () => import("react/jsx-runtime").JSX.Element;
13
13
  getValue: ({ commandLine }: {
14
14
  commandLine: Record<string, unknown>;
15
15
  }) => {
16
- value: OpenGlRenderer;
16
+ value: "angle" | "angle-egl" | "egl" | "swangle" | "swiftshader" | "vulkan";
17
17
  source: string;
18
18
  } | {
19
19
  value: null;
20
20
  source: string;
21
21
  };
22
- setConfig: (value: OpenGlRenderer | null) => void;
22
+ setConfig: (value: "angle" | "angle-egl" | "egl" | "swangle" | "swiftshader" | "vulkan" | null) => void;
23
23
  };
24
- export declare const validateOpenGlRenderer: (option: unknown) => OpenGlRenderer | null;
24
+ export declare const validateOpenGlRenderer: (option: unknown) => "angle" | "angle-egl" | "egl" | "swangle" | "swiftshader" | "vulkan" | null;
@@ -20,7 +20,15 @@ const setChromiumOpenGlRenderer = (renderer) => {
20
20
  };
21
21
  exports.setChromiumOpenGlRenderer = setChromiumOpenGlRenderer;
22
22
  const AngleChangelog = () => {
23
- return ((0, jsx_runtime_1.jsxs)("details", { style: { fontSize: '0.9em', marginBottom: '1em' }, children: [(0, jsx_runtime_1.jsx)("summary", { children: "Changelog" }), (0, jsx_runtime_1.jsxs)("ul", { children: [(0, jsx_runtime_1.jsxs)("li", { children: ["From Remotion v2.6.7 until v3.0.7, the default for Remotion Lambda was", ' ', (0, jsx_runtime_1.jsx)("code", { children: "swiftshader" }), ", but from v3.0.8 the default is", ' ', (0, jsx_runtime_1.jsx)("code", { children: "swangle" }), " (Swiftshader on Angle) since Chrome 101 added support for it."] }), (0, jsx_runtime_1.jsxs)("li", { children: ["From Remotion v2.4.3 until v2.6.6, the default was ", (0, jsx_runtime_1.jsx)("code", { children: "angle" }), ", however it turns out to have a small memory leak that could crash long Remotion renders."] })] })] }));
23
+ return (jsx_runtime_1.jsxs("details", { style: { fontSize: '0.9em', marginBottom: '1em' }, children: [
24
+ jsx_runtime_1.jsx("summary", { children: "Changelog" }), jsx_runtime_1.jsxs("ul", { children: [
25
+ jsx_runtime_1.jsxs("li", { children: ["From Remotion v2.6.7 until v3.0.7, the default for Remotion Lambda was", ' ', jsx_runtime_1.jsx("code", { children: "swiftshader" }),
26
+ ", but from v3.0.8 the default is", ' ', jsx_runtime_1.jsx("code", { children: "swangle" }),
27
+ " (Swiftshader on Angle) since Chrome 101 added support for it."] }), jsx_runtime_1.jsxs("li", { children: ["From Remotion v2.4.3 until v2.6.6, the default was ",
28
+ jsx_runtime_1.jsx("code", { children: "angle" }),
29
+ ", however it turns out to have a small memory leak that could crash long Remotion renders."] })
30
+ ] })
31
+ ] }));
24
32
  };
25
33
  const cliFlag = 'gl';
26
34
  exports.glOption = {
@@ -30,7 +38,25 @@ exports.glOption = {
30
38
  type: 'angle',
31
39
  ssrName: 'gl',
32
40
  description: () => {
33
- return ((0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: [(0, jsx_runtime_1.jsx)(AngleChangelog, {}), (0, jsx_runtime_1.jsxs)("p", { children: ["Select the OpenGL renderer backend for Chromium. ", (0, jsx_runtime_1.jsx)("br", {}), "Accepted values:"] }), (0, jsx_runtime_1.jsxs)("ul", { children: [(0, jsx_runtime_1.jsx)("li", { children: (0, jsx_runtime_1.jsx)("code", { children: '"angle"' }) }), (0, jsx_runtime_1.jsx)("li", { children: (0, jsx_runtime_1.jsx)("code", { children: '"egl"' }) }), (0, jsx_runtime_1.jsx)("li", { children: (0, jsx_runtime_1.jsx)("code", { children: '"swiftshader"' }) }), (0, jsx_runtime_1.jsx)("li", { children: (0, jsx_runtime_1.jsx)("code", { children: '"swangle"' }) }), (0, jsx_runtime_1.jsxs)("li", { children: [(0, jsx_runtime_1.jsx)("code", { children: '"vulkan"' }), " (", (0, jsx_runtime_1.jsx)("em", { children: "from Remotion v4.0.41" }), ")"] }), (0, jsx_runtime_1.jsxs)("li", { children: [(0, jsx_runtime_1.jsx)("code", { children: '"angle-egl"' }), " (", (0, jsx_runtime_1.jsx)("em", { children: "from Remotion v4.0.51" }), ")"] })] }), (0, jsx_runtime_1.jsxs)("p", { children: ["The default is ", (0, jsx_runtime_1.jsx)("code", { children: "null" }), ", letting Chrome decide, except on Lambda where the default is ", (0, jsx_runtime_1.jsx)("code", { children: '"swangle"' })] })] }));
41
+ return (jsx_runtime_1.jsxs(jsx_runtime_1.Fragment, { children: [
42
+ jsx_runtime_1.jsx(AngleChangelog, {}), jsx_runtime_1.jsxs("p", { children: ["Select the OpenGL renderer backend for Chromium. ",
43
+ jsx_runtime_1.jsx("br", {}),
44
+ "Accepted values:"] }), jsx_runtime_1.jsxs("ul", { children: [
45
+ jsx_runtime_1.jsx("li", { children: jsx_runtime_1.jsx("code", { children: '"angle"' }) }), jsx_runtime_1.jsx("li", { children: jsx_runtime_1.jsx("code", { children: '"egl"' }) }), jsx_runtime_1.jsx("li", { children: jsx_runtime_1.jsx("code", { children: '"swiftshader"' }) }), jsx_runtime_1.jsx("li", { children: jsx_runtime_1.jsx("code", { children: '"swangle"' }) }), jsx_runtime_1.jsxs("li", { children: [
46
+ jsx_runtime_1.jsx("code", { children: '"vulkan"' }),
47
+ " (",
48
+ jsx_runtime_1.jsx("em", { children: "from Remotion v4.0.41" }),
49
+ ")"] }), jsx_runtime_1.jsxs("li", { children: [
50
+ jsx_runtime_1.jsx("code", { children: '"angle-egl"' }),
51
+ " (",
52
+ jsx_runtime_1.jsx("em", { children: "from Remotion v4.0.51" }),
53
+ ")"] })
54
+ ] }), jsx_runtime_1.jsxs("p", { children: ["The default is ",
55
+ jsx_runtime_1.jsx("code", { children: "null" }),
56
+ ", letting Chrome decide, except on Lambda where the default is ",
57
+ jsx_runtime_1.jsx("code", { children: '"swangle"' })
58
+ ] })
59
+ ] }));
34
60
  },
35
61
  getValue: ({ commandLine }) => {
36
62
  if (commandLine[cliFlag]) {
@@ -7,12 +7,12 @@ export declare const hardwareAccelerationOption: {
7
7
  description: () => string;
8
8
  ssrName: string;
9
9
  docLink: string;
10
- type: HardwareAccelerationOption;
10
+ type: "disable" | "if-possible" | "required";
11
11
  getValue: ({ commandLine }: {
12
12
  commandLine: Record<string, unknown>;
13
13
  }) => {
14
14
  source: string;
15
15
  value: "disable" | "if-possible" | "required";
16
16
  };
17
- setConfig: (value: HardwareAccelerationOption) => void;
17
+ setConfig: (value: "disable" | "if-possible" | "required") => void;
18
18
  };
@@ -8,7 +8,10 @@ const cliFlag = 'disable-headless';
8
8
  exports.headlessOption = {
9
9
  name: 'Disable Headless Mode',
10
10
  cliFlag,
11
- description: () => ((0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: ["Deprecated - will be removed in 5.0.0. With the migration to", ' ', (0, jsx_runtime_1.jsx)("a", { href: "/docs/miscellaneous/chrome-headless-shell", children: "Chrome Headless Shell" }), ", this option is not functional anymore.", (0, jsx_runtime_1.jsx)("br", {}), (0, jsx_runtime_1.jsx)("br", {}), " If disabled, the render will open an actual Chrome window where you can see the render happen. The default is headless mode."] })),
11
+ description: () => (jsx_runtime_1.jsxs(jsx_runtime_1.Fragment, { children: ["Deprecated - will be removed in 5.0.0. With the migration to", ' ', jsx_runtime_1.jsx("a", { href: "/docs/miscellaneous/chrome-headless-shell", children: "Chrome Headless Shell" }),
12
+ ", this option is not functional anymore.",
13
+ jsx_runtime_1.jsx("br", {}), jsx_runtime_1.jsx("br", {}),
14
+ " If disabled, the render will open an actual Chrome window where you can see the render happen. The default is headless mode."] })),
12
15
  ssrName: 'headless',
13
16
  docLink: 'https://www.remotion.dev/docs/chromium-flags#--disable-headless',
14
17
  type: false,
@@ -9,7 +9,11 @@ exports.imageSequencePatternOption = {
9
9
  name: 'Image Sequence Pattern',
10
10
  cliFlag,
11
11
  ssrName: 'imageSequencePattern',
12
- description: () => ((0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: ["Pattern for naming image sequence files. Supports ", (0, jsx_runtime_1.jsx)("code", { children: "[frame]" }), " for the zero-padded frame number and ", (0, jsx_runtime_1.jsx)("code", { children: "[ext]" }), " for the file extension."] })),
12
+ description: () => (jsx_runtime_1.jsxs(jsx_runtime_1.Fragment, { children: ["Pattern for naming image sequence files. Supports ",
13
+ jsx_runtime_1.jsx("code", { children: "[frame]" }),
14
+ " for the zero-padded frame number and ",
15
+ jsx_runtime_1.jsx("code", { children: "[ext]" }),
16
+ " for the file extension."] })),
13
17
  docLink: null,
14
18
  type: 'string',
15
19
  getValue: ({ commandLine }) => {
@@ -2,12 +2,12 @@ import type { AnyRemotionOption } from './option';
2
2
  export declare const allOptions: {
3
3
  audioCodecOption: {
4
4
  cliFlag: "audio-codec";
5
- setConfig: (audioCodec: "mp3" | "aac" | "pcm-16" | "opus" | null) => void;
5
+ setConfig: (audioCodec: "aac" | "mp3" | "opus" | "pcm-16" | null) => void;
6
6
  getValue: ({ commandLine }: {
7
7
  commandLine: Record<string, unknown>;
8
8
  }) => {
9
9
  source: string;
10
- value: import("./audio-codec").AudioCodec;
10
+ value: "aac" | "mp3" | "opus" | "pcm-16";
11
11
  } | {
12
12
  source: string;
13
13
  value: null;
@@ -16,7 +16,7 @@ export declare const allOptions: {
16
16
  docLink: string;
17
17
  name: string;
18
18
  ssrName: "audioCodec";
19
- type: import("./audio-codec").AudioCodec;
19
+ type: "aac" | "mp3" | "opus" | "pcm-16";
20
20
  };
21
21
  scaleOption: {
22
22
  name: string;
@@ -135,17 +135,17 @@ export declare const allOptions: {
135
135
  description: () => import("react/jsx-runtime").JSX.Element;
136
136
  ssrName: string;
137
137
  docLink: string;
138
- type: import("..").Codec;
138
+ type: "aac" | "gif" | "h264" | "h264-mkv" | "h264-ts" | "h265" | "mp3" | "prores" | "vp8" | "vp9" | "wav";
139
139
  getValue: ({ commandLine }: {
140
140
  commandLine: Record<string, unknown>;
141
141
  }, { compositionCodec, configFile, downloadName, outName, uiCodec, }: {
142
142
  outName: string | null;
143
143
  downloadName: string | null;
144
- configFile: import("..").Codec | null;
145
- uiCodec: import("..").Codec | null;
146
- compositionCodec: import("..").Codec | null;
144
+ configFile: "aac" | "gif" | "h264" | "h264-mkv" | "h264-ts" | "h265" | "mp3" | "prores" | "vp8" | "vp9" | "wav" | null;
145
+ uiCodec: "aac" | "gif" | "h264" | "h264-mkv" | "h264-ts" | "h265" | "mp3" | "prores" | "vp8" | "vp9" | "wav" | null;
146
+ compositionCodec: "aac" | "gif" | "h264" | "h264-mkv" | "h264-ts" | "h265" | "mp3" | "prores" | "vp8" | "vp9" | "wav" | null;
147
147
  }) => {
148
- value: import("..").Codec;
148
+ value: "aac" | "gif" | "h264" | "h264-mkv" | "h264-ts" | "h265" | "mp3" | "prores" | "vp8" | "vp9" | "wav";
149
149
  source: string;
150
150
  };
151
151
  setConfig: (newCodec: import("..").CodecOrUndefined) => void;
@@ -202,14 +202,14 @@ export declare const allOptions: {
202
202
  description: () => import("react/jsx-runtime").JSX.Element;
203
203
  docLink: string;
204
204
  ssrName: string;
205
- type: import("./color-space").ColorSpace | null;
205
+ type: "bt2020-ncl" | "bt709" | "default" | null;
206
206
  getValue: ({ commandLine }: {
207
207
  commandLine: Record<string, unknown>;
208
208
  }) => {
209
209
  source: string;
210
- value: import("./color-space").ColorSpace;
210
+ value: "bt2020-ncl" | "bt709" | "default";
211
211
  };
212
- setConfig: (value: "default" | "bt709" | "bt2020-ncl" | null) => void;
212
+ setConfig: (value: "bt2020-ncl" | "bt709" | "default" | null) => void;
213
213
  };
214
214
  deleteAfterOption: {
215
215
  name: string;
@@ -278,19 +278,19 @@ export declare const allOptions: {
278
278
  cliFlag: "gl";
279
279
  docLink: string;
280
280
  name: string;
281
- type: import("./gl").OpenGlRenderer | null;
281
+ type: "angle" | "angle-egl" | "egl" | "swangle" | "swiftshader" | "vulkan" | null;
282
282
  ssrName: string;
283
283
  description: () => import("react/jsx-runtime").JSX.Element;
284
284
  getValue: ({ commandLine }: {
285
285
  commandLine: Record<string, unknown>;
286
286
  }) => {
287
- value: import("./gl").OpenGlRenderer;
287
+ value: "angle" | "angle-egl" | "egl" | "swangle" | "swiftshader" | "vulkan";
288
288
  source: string;
289
289
  } | {
290
290
  value: null;
291
291
  source: string;
292
292
  };
293
- setConfig: (value: import("./gl").OpenGlRenderer | null) => void;
293
+ setConfig: (value: "angle" | "angle-egl" | "egl" | "swangle" | "swiftshader" | "vulkan" | null) => void;
294
294
  };
295
295
  enableLambdaInsights: {
296
296
  name: string;
@@ -415,17 +415,17 @@ export declare const allOptions: {
415
415
  description: () => import("react/jsx-runtime").JSX.Element;
416
416
  ssrName: "x264Preset";
417
417
  docLink: string;
418
- type: import("./x264-preset").X264Preset | null;
418
+ type: "fast" | "faster" | "medium" | "placebo" | "slow" | "slower" | "superfast" | "ultrafast" | "veryfast" | "veryslow" | null;
419
419
  getValue: ({ commandLine }: {
420
420
  commandLine: Record<string, unknown>;
421
421
  }) => {
422
- value: import("./x264-preset").X264Preset;
422
+ value: "fast" | "faster" | "medium" | "placebo" | "slow" | "slower" | "superfast" | "ultrafast" | "veryfast" | "veryslow";
423
423
  source: string;
424
424
  } | {
425
425
  value: null;
426
426
  source: string;
427
427
  };
428
- setConfig: (profile: import("./x264-preset").X264Preset | null) => void;
428
+ setConfig: (profile: "fast" | "faster" | "medium" | "placebo" | "slow" | "slower" | "superfast" | "ultrafast" | "veryfast" | "veryslow" | null) => void;
429
429
  };
430
430
  logLevelOption: {
431
431
  cliFlag: "log";
@@ -436,11 +436,11 @@ export declare const allOptions: {
436
436
  getValue: ({ commandLine }: {
437
437
  commandLine: Record<string, unknown>;
438
438
  }) => {
439
- value: import("..").LogLevel;
439
+ value: "error" | "info" | "trace" | "verbose" | "warn";
440
440
  source: string;
441
441
  };
442
- setConfig: (newLogLevel: import("..").LogLevel) => void;
443
- type: import("..").LogLevel;
442
+ setConfig: (newLogLevel: "error" | "info" | "trace" | "verbose" | "warn") => void;
443
+ type: "error" | "info" | "trace" | "verbose" | "warn";
444
444
  };
445
445
  delayRenderTimeoutInMillisecondsOption: {
446
446
  name: string;
@@ -637,14 +637,14 @@ export declare const allOptions: {
637
637
  description: () => string;
638
638
  ssrName: string;
639
639
  docLink: string;
640
- type: import("./hardware-acceleration").HardwareAccelerationOption;
640
+ type: "disable" | "if-possible" | "required";
641
641
  getValue: ({ commandLine }: {
642
642
  commandLine: Record<string, unknown>;
643
643
  }) => {
644
644
  source: string;
645
645
  value: "disable" | "if-possible" | "required";
646
646
  };
647
- setConfig: (value: import("./hardware-acceleration").HardwareAccelerationOption) => void;
647
+ setConfig: (value: "disable" | "if-possible" | "required") => void;
648
648
  };
649
649
  chromeModeOption: {
650
650
  cliFlag: "chrome-mode";
@@ -655,11 +655,11 @@ export declare const allOptions: {
655
655
  getValue: ({ commandLine }: {
656
656
  commandLine: Record<string, unknown>;
657
657
  }) => {
658
- value: import("./chrome-mode").ChromeMode;
658
+ value: "chrome-for-testing" | "headless-shell";
659
659
  source: string;
660
660
  };
661
- setConfig: (newChromeMode: import("./chrome-mode").ChromeMode) => void;
662
- type: import("./chrome-mode").ChromeMode;
661
+ setConfig: (newChromeMode: "chrome-for-testing" | "headless-shell") => void;
662
+ type: "chrome-for-testing" | "headless-shell";
663
663
  };
664
664
  apiKeyOption: {
665
665
  name: string;
@@ -20,7 +20,7 @@ const cliFlag = 'jpeg-quality';
20
20
  exports.jpegQualityOption = {
21
21
  name: 'JPEG Quality',
22
22
  cliFlag,
23
- description: () => ((0, 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.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
24
  ssrName: 'jpegQuality',
25
25
  docLink: 'https://www.remotion.dev/docs/renderer/render-media#jpeg-quality',
26
26
  type: 0,
@@ -7,7 +7,16 @@ let value = null;
7
7
  exports.audioLatencyHintOption = {
8
8
  name: 'Audio Latency Hint',
9
9
  cliFlag,
10
- description: () => ((0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: ["Sets the", ' ', (0, jsx_runtime_1.jsx)("a", { href: "https://developer.mozilla.org/en-US/docs/Web/API/AudioContext/AudioContext", children: "audio latency" }), ' ', "hint for the global ", (0, jsx_runtime_1.jsx)("code", { children: "AudioContext" }), " context that Remotion uses to play audio.", (0, jsx_runtime_1.jsx)("br", {}), "Possible values: ", (0, jsx_runtime_1.jsx)("code", { children: "interactive" }), ", ", (0, jsx_runtime_1.jsx)("code", { children: "balanced" }), ",", ' ', (0, jsx_runtime_1.jsx)("code", { children: "playback" })] })),
10
+ 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
+ jsx_runtime_1.jsx("code", { children: "AudioContext" }),
12
+ " context that Remotion uses to play audio.",
13
+ jsx_runtime_1.jsx("br", {}),
14
+ "Possible values: ",
15
+ jsx_runtime_1.jsx("code", { children: "interactive" }),
16
+ ", ",
17
+ jsx_runtime_1.jsx("code", { children: "balanced" }),
18
+ ",", ' ', jsx_runtime_1.jsx("code", { children: "playback" })
19
+ ] })),
11
20
  ssrName: 'audioLatencyHint',
12
21
  docLink: 'https://www.remotion.dev/docs/renderer/render-media',
13
22
  type: 'interactive',
@@ -7,7 +7,8 @@ const cliFlag = 'licenseKey-key';
7
7
  exports.licenseKeyOption = {
8
8
  name: 'License key',
9
9
  cliFlag,
10
- description: () => ((0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: ["License key for sending a usage event using", ' ', (0, jsx_runtime_1.jsx)("code", { children: "@remotion/licensing" }), "."] })),
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
  ssrName: 'licenseKey',
12
13
  docLink: 'https://www.remotion.dev/docs/licensing',
13
14
  type: null,
@@ -1,4 +1,3 @@
1
- import type { LogLevel } from '../log-level';
2
1
  export declare const logLevelOption: {
3
2
  cliFlag: "log";
4
3
  name: string;
@@ -8,9 +7,9 @@ export declare const logLevelOption: {
8
7
  getValue: ({ commandLine }: {
9
8
  commandLine: Record<string, unknown>;
10
9
  }) => {
11
- value: LogLevel;
10
+ value: "error" | "info" | "trace" | "verbose" | "warn";
12
11
  source: string;
13
12
  };
14
- setConfig: (newLogLevel: LogLevel) => void;
15
- type: LogLevel;
13
+ setConfig: (newLogLevel: "error" | "info" | "trace" | "verbose" | "warn") => void;
14
+ type: "error" | "info" | "trace" | "verbose" | "warn";
16
15
  };
@@ -9,7 +9,22 @@ exports.logLevelOption = {
9
9
  cliFlag,
10
10
  name: 'Log Level',
11
11
  ssrName: 'logLevel',
12
- description: () => ((0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: ["One of ", (0, jsx_runtime_1.jsx)("code", { children: "trace" }), ", ", (0, jsx_runtime_1.jsx)("code", { children: "verbose" }), ", ", (0, jsx_runtime_1.jsx)("code", { children: "info" }), ",", ' ', (0, jsx_runtime_1.jsx)("code", { children: "warn" }), ", ", (0, jsx_runtime_1.jsx)("code", { children: "error" }), ".", (0, jsx_runtime_1.jsx)("br", {}), " Determines how much info is being logged to the console.", (0, jsx_runtime_1.jsx)("br", {}), (0, jsx_runtime_1.jsx)("br", {}), " Default ", (0, jsx_runtime_1.jsx)("code", { children: "info" }), "."] })),
12
+ description: () => (jsx_runtime_1.jsxs(jsx_runtime_1.Fragment, { children: ["One of ",
13
+ jsx_runtime_1.jsx("code", { children: "trace" }),
14
+ ", ",
15
+ jsx_runtime_1.jsx("code", { children: "verbose" }),
16
+ ", ",
17
+ jsx_runtime_1.jsx("code", { children: "info" }),
18
+ ",", ' ', jsx_runtime_1.jsx("code", { children: "warn" }),
19
+ ", ",
20
+ jsx_runtime_1.jsx("code", { children: "error" }),
21
+ ".",
22
+ jsx_runtime_1.jsx("br", {}),
23
+ " Determines how much info is being logged to the console.",
24
+ jsx_runtime_1.jsx("br", {}), jsx_runtime_1.jsx("br", {}),
25
+ " Default ",
26
+ jsx_runtime_1.jsx("code", { children: "info" }),
27
+ "."] })),
13
28
  docLink: 'https://www.remotion.dev/docs/troubleshooting/debug-failed-render',
14
29
  getValue: ({ commandLine }) => {
15
30
  if (commandLine[cliFlag]) {
@@ -9,9 +9,14 @@ exports.metadataOption = {
9
9
  cliFlag,
10
10
  description: (mode) => {
11
11
  if (mode === 'ssr') {
12
- return ((0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: ["An object containing metadata to be embedded in the video. See", ' ', (0, jsx_runtime_1.jsx)("a", { href: "/docs/metadata", children: "here" }), " for which metadata is accepted."] }));
12
+ return (jsx_runtime_1.jsxs(jsx_runtime_1.Fragment, { children: ["An object containing metadata to be embedded in the video. See", ' ', jsx_runtime_1.jsx("a", { href: "/docs/metadata", children: "here" }),
13
+ " for which metadata is accepted."] }));
13
14
  }
14
- return ((0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: ["Metadata to be embedded in the video. See", ' ', (0, jsx_runtime_1.jsx)("a", { href: "/docs/metadata", children: "here" }), " for which metadata is accepted.", (0, jsx_runtime_1.jsx)("br", {}), "The parameter must be in the format of ", (0, jsx_runtime_1.jsx)("code", { children: "--metadata key=value" }), ' ', "and can be passed multiple times."] }));
15
+ return (jsx_runtime_1.jsxs(jsx_runtime_1.Fragment, { children: ["Metadata to be embedded in the video. See", ' ', jsx_runtime_1.jsx("a", { href: "/docs/metadata", children: "here" }),
16
+ " for which metadata is accepted.",
17
+ jsx_runtime_1.jsx("br", {}),
18
+ "The parameter must be in the format of ",
19
+ jsx_runtime_1.jsx("code", { children: "--metadata key=value" }), ' ', "and can be passed multiple times."] }));
15
20
  },
16
21
  docLink: 'https://www.remotion.dev/docs/metadata',
17
22
  type: {},
@@ -8,7 +8,7 @@ const cliFlag = 'muted';
8
8
  exports.mutedOption = {
9
9
  name: 'Muted',
10
10
  cliFlag,
11
- description: () => (0, jsx_runtime_1.jsx)(jsx_runtime_1.Fragment, { children: "The Audio of the video will be omitted." }),
11
+ description: () => jsx_runtime_1.jsx(jsx_runtime_1.Fragment, { children: "The Audio of the video will be omitted." }),
12
12
  ssrName: 'muted',
13
13
  docLink: 'https://www.remotion.dev/docs/audio/muting',
14
14
  type: false,
@@ -13,7 +13,19 @@ exports.numberOfGifLoopsOption = {
13
13
  name: 'Number of GIF loops',
14
14
  cliFlag,
15
15
  description: () => {
16
- return ((0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: ["Allows you to set the number of loops as follows:", (0, jsx_runtime_1.jsxs)("ul", { children: [(0, jsx_runtime_1.jsxs)("li", { children: [(0, jsx_runtime_1.jsx)("code", { children: "null" }), " (or omitting in the CLI) plays the GIF indefinitely."] }), (0, jsx_runtime_1.jsxs)("li", { children: [(0, jsx_runtime_1.jsx)("code", { children: "0" }), " disables looping"] }), (0, jsx_runtime_1.jsxs)("li", { children: [(0, jsx_runtime_1.jsx)("code", { children: "1" }), " loops the GIF once (plays twice in total)"] }), (0, jsx_runtime_1.jsxs)("li", { children: [(0, jsx_runtime_1.jsx)("code", { children: "2" }), " loops the GIF twice (plays three times in total) and so on."] })] })] }));
16
+ return (jsx_runtime_1.jsxs(jsx_runtime_1.Fragment, { children: ["Allows you to set the number of loops as follows:",
17
+ jsx_runtime_1.jsxs("ul", { children: [
18
+ jsx_runtime_1.jsxs("li", { children: [
19
+ jsx_runtime_1.jsx("code", { children: "null" }),
20
+ " (or omitting in the CLI) plays the GIF indefinitely."] }), jsx_runtime_1.jsxs("li", { children: [
21
+ jsx_runtime_1.jsx("code", { children: "0" }),
22
+ " disables looping"] }), jsx_runtime_1.jsxs("li", { children: [
23
+ jsx_runtime_1.jsx("code", { children: "1" }),
24
+ " loops the GIF once (plays twice in total)"] }), jsx_runtime_1.jsxs("li", { children: [
25
+ jsx_runtime_1.jsx("code", { children: "2" }),
26
+ " loops the GIF twice (plays three times in total) and so on."] })
27
+ ] })
28
+ ] }));
17
29
  },
18
30
  ssrName: 'numberOfGifLoops',
19
31
  docLink: 'https://www.remotion.dev/docs/render-as-gif#changing-the-number-of-loops',
@@ -11,7 +11,17 @@ const cliFlag = 'offthreadvideo-cache-size-in-bytes';
11
11
  exports.offthreadVideoCacheSizeInBytesOption = {
12
12
  name: 'OffthreadVideo cache size',
13
13
  cliFlag,
14
- description: () => ((0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: ["From v4.0, Remotion has a cache for", ' ', (0, jsx_runtime_1.jsx)("a", { href: "https://remotion.dev/docs/offthreadvideo", children: (0, jsx_runtime_1.jsx)("code", { children: "<OffthreadVideo>" }) }), ' ', "frames. The default is ", (0, jsx_runtime_1.jsx)("code", { children: "null" }), ", corresponding to half of the system memory available when the render starts.", (0, jsx_runtime_1.jsx)("br", {}), " This option allows to override the size of the cache. The higher it is, the faster the render will be, but the more memory will be used.", (0, jsx_runtime_1.jsx)("br", {}), "The used value will be printed when running in verbose mode.", (0, jsx_runtime_1.jsx)("br", {}), "Default: ", (0, jsx_runtime_1.jsx)("code", { children: "null" })] })),
14
+ 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
+ jsx_runtime_1.jsx("code", { children: "null" }),
16
+ ", corresponding to half of the system memory available when the render starts.",
17
+ jsx_runtime_1.jsx("br", {}),
18
+ " This option allows to override the size of the cache. The higher it is, the faster the render will be, but the more memory will be used.",
19
+ jsx_runtime_1.jsx("br", {}),
20
+ "The used value will be printed when running in verbose mode.",
21
+ jsx_runtime_1.jsx("br", {}),
22
+ "Default: ",
23
+ jsx_runtime_1.jsx("code", { children: "null" })
24
+ ] })),
15
25
  ssrName: 'offthreadVideoCacheSizeInBytes',
16
26
  docLink: 'https://www.remotion.dev/docs/offthreadvideo',
17
27
  type: 0,
@@ -11,7 +11,8 @@ const cliFlag = 'offthreadvideo-video-threads';
11
11
  exports.offthreadVideoThreadsOption = {
12
12
  name: 'OffthreadVideo threads',
13
13
  cliFlag,
14
- description: () => ((0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: ["The number of threads that", (0, jsx_runtime_1.jsx)("a", { href: "https://remotion.dev/docs/offthreadvideo", children: (0, 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."] })),
14
+ description: () => (jsx_runtime_1.jsxs(jsx_runtime_1.Fragment, { children: ["The number of threads that",
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."] })),
15
16
  ssrName: 'offthreadVideoThreads',
16
17
  docLink: 'https://www.remotion.dev/docs/offthreadvideo',
17
18
  type: 0,
@@ -6,7 +6,8 @@ const cliFlag = 'on-browser-download';
6
6
  exports.onBrowserDownloadOption = {
7
7
  name: 'Browser download callback function',
8
8
  cliFlag,
9
- description: () => ((0, 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.", ' ', (0, jsx_runtime_1.jsx)("a", { href: "/docs/renderer/ensure-browser#onbrowserdownload", children: "See here for how to use this option." })] })),
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
  ssrName: 'onBrowserDownload',
11
12
  docLink: 'https://www.remotion.dev/docs/renderer/ensure-browser',
12
13
  type: undefined,