@remotion/renderer 4.0.24 → 4.0.25

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 (91) hide show
  1. package/dist/browser/BrowserPage.js +6 -1
  2. package/dist/client.d.ts +27 -19
  3. package/dist/client.js +2 -0
  4. package/dist/create-ffmpeg-complex-filter.d.ts +1 -4
  5. package/dist/get-extension-from-codec.d.ts +2 -2
  6. package/dist/index.d.ts +3 -3
  7. package/dist/options/audio-bitrate.d.ts +1 -1
  8. package/dist/options/audio-bitrate.js +1 -1
  9. package/dist/options/crf.d.ts +1 -1
  10. package/dist/options/crf.js +1 -1
  11. package/dist/options/enforce-audio.d.ts +1 -1
  12. package/dist/options/enforce-audio.js +1 -1
  13. package/dist/options/jpeg-quality.d.ts +1 -1
  14. package/dist/options/jpeg-quality.js +1 -1
  15. package/dist/options/mute.d.ts +1 -1
  16. package/dist/options/mute.js +1 -1
  17. package/dist/options/offthreadvideo-cache-size.d.ts +1 -1
  18. package/dist/options/offthreadvideo-cache-size.js +1 -1
  19. package/dist/options/option.d.ts +1 -1
  20. package/dist/options/options-map.d.ts +10 -10
  21. package/dist/options/scale.d.ts +1 -1
  22. package/dist/options/scale.js +1 -1
  23. package/dist/options/video-bitrate.d.ts +1 -1
  24. package/dist/options/video-bitrate.js +1 -1
  25. package/dist/options/video-codec.d.ts +1 -1
  26. package/dist/options/video-codec.js +1 -1
  27. package/dist/options/webhook-custom-data.d.ts +8 -0
  28. package/dist/options/webhook-custom-data.js +14 -0
  29. package/dist/presets-profile.d.ts +7 -0
  30. package/dist/presets-profile.js +27 -0
  31. package/dist/prespawn-ffmpeg.js +4 -4
  32. package/dist/print-useful-error-message.d.ts +1 -0
  33. package/dist/print-useful-error-message.js +62 -0
  34. package/dist/pure.d.ts +3 -0
  35. package/dist/pure.js +7 -0
  36. package/dist/render-frames.js +5 -4
  37. package/dist/render-media.js +2 -1
  38. package/dist/render-still.js +5 -4
  39. package/dist/stitch-frames-to-video.js +4 -3
  40. package/dist/validate-output-filename.d.ts +1 -1
  41. package/dist/validate.d.ts +4 -0
  42. package/dist/validate.js +8 -0
  43. package/dist/wrap-with-error-handling.d.ts +3 -0
  44. package/dist/wrap-with-error-handling.js +16 -0
  45. package/package.json +9 -9
  46. package/dist/assets/get-video-stream-duration.d.ts +0 -9
  47. package/dist/assets/get-video-stream-duration.js +0 -71
  48. package/dist/browser/Product.d.ts +0 -16
  49. package/dist/browser/Product.js +0 -17
  50. package/dist/browser/create-browser-fetcher.d.ts +0 -17
  51. package/dist/browser/create-browser-fetcher.js +0 -58
  52. package/dist/browser/revisions.d.ts +0 -20
  53. package/dist/browser/revisions.js +0 -21
  54. package/dist/calculate-sar-dar-pixels.d.ts +0 -9
  55. package/dist/calculate-sar-dar-pixels.js +0 -19
  56. package/dist/determine-resize-params.d.ts +0 -4
  57. package/dist/determine-resize-params.js +0 -10
  58. package/dist/determine-vcodec-ffmpeg-flags.d.ts +0 -2
  59. package/dist/determine-vcodec-ffmpeg-flags.js +0 -13
  60. package/dist/ensure-ffmpeg.d.ts +0 -18
  61. package/dist/ensure-ffmpeg.js +0 -58
  62. package/dist/ensure-presentation-timestamp.d.ts +0 -15
  63. package/dist/ensure-presentation-timestamp.js +0 -88
  64. package/dist/extract-frame-from-video.d.ts +0 -16
  65. package/dist/extract-frame-from-video.js +0 -191
  66. package/dist/ffmpeg-executable.d.ts +0 -1
  67. package/dist/ffmpeg-executable.js +0 -2
  68. package/dist/ffmpeg-flags.d.ts +0 -31
  69. package/dist/ffmpeg-flags.js +0 -245
  70. package/dist/frame-to-ffmpeg-timestamp.d.ts +0 -1
  71. package/dist/frame-to-ffmpeg-timestamp.js +0 -8
  72. package/dist/get-can-extract-frames-fast.d.ts +0 -14
  73. package/dist/get-can-extract-frames-fast.js +0 -71
  74. package/dist/get-frame-of-video-slow.d.ts +0 -17
  75. package/dist/get-frame-of-video-slow.js +0 -72
  76. package/dist/get-video-info.d.ts +0 -8
  77. package/dist/get-video-info.js +0 -59
  78. package/dist/is-beyond-last-frame.d.ts +0 -3
  79. package/dist/is-beyond-last-frame.js +0 -12
  80. package/dist/last-frame-from-video-cache.d.ts +0 -17
  81. package/dist/last-frame-from-video-cache.js +0 -55
  82. package/dist/legacy-webpack-config.d.ts +0 -9
  83. package/dist/legacy-webpack-config.js +0 -13
  84. package/dist/quality.d.ts +0 -1
  85. package/dist/quality.js +0 -21
  86. package/dist/try-to-extract-frame-of-video-fast.d.ts +0 -12
  87. package/dist/try-to-extract-frame-of-video-fast.js +0 -55
  88. package/dist/validate-ffmpeg.d.ts +0 -7
  89. package/dist/validate-ffmpeg.js +0 -77
  90. package/dist/warn-about-ffmpeg-version.d.ts +0 -5
  91. package/dist/warn-about-ffmpeg-version.js +0 -37
@@ -151,7 +151,12 @@ class Page extends EventEmitter_1.EventEmitter {
151
151
  }
152
152
  }
153
153
  else if (log.type === 'error') {
154
- logger_1.Log.errorAdvanced({ logLevel, tag: `console.${log.type}`, indent }, log.text);
154
+ if (log.text.includes('Failed to load resource:')) {
155
+ logger_1.Log.errorAdvanced({ logLevel, tag: url, indent }, log.text);
156
+ }
157
+ else {
158
+ logger_1.Log.errorAdvanced({ logLevel, tag: `console.${log.type}`, indent }, log.text);
159
+ }
155
160
  }
156
161
  else {
157
162
  logger_1.Log.verboseAdvanced({ logLevel, tag: `console.${log.type}`, indent }, log.text);
package/dist/client.d.ts CHANGED
@@ -197,7 +197,7 @@ export declare const BrowserSafeApis: {
197
197
  scaleOption: {
198
198
  name: string;
199
199
  cliFlag: string;
200
- description: JSX.Element;
200
+ description: () => JSX.Element;
201
201
  ssrName: string;
202
202
  docLink: string;
203
203
  type: number;
@@ -205,7 +205,7 @@ export declare const BrowserSafeApis: {
205
205
  crfOption: {
206
206
  name: string;
207
207
  cliFlag: string;
208
- description: JSX.Element;
208
+ description: () => JSX.Element;
209
209
  ssrName: string;
210
210
  docLink: string;
211
211
  type: number;
@@ -213,7 +213,7 @@ export declare const BrowserSafeApis: {
213
213
  jpegQualityOption: {
214
214
  name: string;
215
215
  cliFlag: string;
216
- description: JSX.Element;
216
+ description: () => JSX.Element;
217
217
  ssrName: string;
218
218
  docLink: string;
219
219
  type: number;
@@ -221,7 +221,7 @@ export declare const BrowserSafeApis: {
221
221
  videoBitrate: {
222
222
  name: string;
223
223
  cliFlag: string;
224
- description: JSX.Element;
224
+ description: () => JSX.Element;
225
225
  ssrName: string;
226
226
  docLink: string;
227
227
  type: string;
@@ -229,7 +229,7 @@ export declare const BrowserSafeApis: {
229
229
  audioBitrateOption: {
230
230
  name: string;
231
231
  cliFlag: string;
232
- description: JSX.Element;
232
+ description: () => JSX.Element;
233
233
  ssrName: string;
234
234
  docLink: string;
235
235
  type: string;
@@ -237,7 +237,7 @@ export declare const BrowserSafeApis: {
237
237
  enforceAudioOption: {
238
238
  name: string;
239
239
  cliFlag: string;
240
- description: JSX.Element;
240
+ description: () => JSX.Element;
241
241
  ssrName: string;
242
242
  docLink: string;
243
243
  type: boolean;
@@ -245,7 +245,7 @@ export declare const BrowserSafeApis: {
245
245
  muteOption: {
246
246
  name: string;
247
247
  cliFlag: string;
248
- description: JSX.Element;
248
+ description: () => JSX.Element;
249
249
  ssrName: string;
250
250
  docLink: string;
251
251
  type: boolean;
@@ -253,7 +253,7 @@ export declare const BrowserSafeApis: {
253
253
  videoCodecOption: {
254
254
  name: string;
255
255
  cliFlag: string;
256
- description: JSX.Element;
256
+ description: () => JSX.Element;
257
257
  ssrName: string;
258
258
  docLink: string;
259
259
  type: string;
@@ -261,17 +261,25 @@ export declare const BrowserSafeApis: {
261
261
  offthreadVideoCacheSizeInBytesOption: {
262
262
  name: string;
263
263
  cliFlag: "offthreadvideo-cache-size-in-bytes";
264
- description: JSX.Element;
264
+ description: () => JSX.Element;
265
265
  ssrName: "offthreadVideoCacheSizeInBytes";
266
266
  docLink: string;
267
267
  type: number | null;
268
268
  };
269
+ webhookCustomDataOption: {
270
+ name: string;
271
+ cliFlag: "webhook-custom-data";
272
+ description: (type: "ssr" | "cli") => JSX.Element;
273
+ ssrName: "customData";
274
+ docLink: string;
275
+ type: Record<string, unknown> | null;
276
+ };
269
277
  };
270
278
  optionsMap: {
271
279
  readonly renderMedia: readonly [{
272
280
  name: string;
273
281
  cliFlag: "offthreadvideo-cache-size-in-bytes";
274
- description: JSX.Element;
282
+ description: () => JSX.Element;
275
283
  ssrName: "offthreadVideoCacheSizeInBytes";
276
284
  docLink: string;
277
285
  type: number | null;
@@ -279,7 +287,7 @@ export declare const BrowserSafeApis: {
279
287
  readonly renderStill: readonly [{
280
288
  name: string;
281
289
  cliFlag: "offthreadvideo-cache-size-in-bytes";
282
- description: JSX.Element;
290
+ description: () => JSX.Element;
283
291
  ssrName: "offthreadVideoCacheSizeInBytes";
284
292
  docLink: string;
285
293
  type: number | null;
@@ -287,7 +295,7 @@ export declare const BrowserSafeApis: {
287
295
  readonly getCompositions: readonly [{
288
296
  name: string;
289
297
  cliFlag: "offthreadvideo-cache-size-in-bytes";
290
- description: JSX.Element;
298
+ description: () => JSX.Element;
291
299
  ssrName: "offthreadVideoCacheSizeInBytes";
292
300
  docLink: string;
293
301
  type: number | null;
@@ -295,7 +303,7 @@ export declare const BrowserSafeApis: {
295
303
  readonly selectComposition: readonly [{
296
304
  name: string;
297
305
  cliFlag: "offthreadvideo-cache-size-in-bytes";
298
- description: JSX.Element;
306
+ description: () => JSX.Element;
299
307
  ssrName: "offthreadVideoCacheSizeInBytes";
300
308
  docLink: string;
301
309
  type: number | null;
@@ -303,7 +311,7 @@ export declare const BrowserSafeApis: {
303
311
  readonly renderFrames: readonly [{
304
312
  name: string;
305
313
  cliFlag: "offthreadvideo-cache-size-in-bytes";
306
- description: JSX.Element;
314
+ description: () => JSX.Element;
307
315
  ssrName: "offthreadVideoCacheSizeInBytes";
308
316
  docLink: string;
309
317
  type: number | null;
@@ -311,7 +319,7 @@ export declare const BrowserSafeApis: {
311
319
  readonly renderMediaOnLambda: readonly [{
312
320
  name: string;
313
321
  cliFlag: "offthreadvideo-cache-size-in-bytes";
314
- description: JSX.Element;
322
+ description: () => JSX.Element;
315
323
  ssrName: "offthreadVideoCacheSizeInBytes";
316
324
  docLink: string;
317
325
  type: number | null;
@@ -319,7 +327,7 @@ export declare const BrowserSafeApis: {
319
327
  readonly renderStillOnLambda: readonly [{
320
328
  name: string;
321
329
  cliFlag: "offthreadvideo-cache-size-in-bytes";
322
- description: JSX.Element;
330
+ description: () => JSX.Element;
323
331
  ssrName: "offthreadVideoCacheSizeInBytes";
324
332
  docLink: string;
325
333
  type: number | null;
@@ -327,7 +335,7 @@ export declare const BrowserSafeApis: {
327
335
  readonly getCompositionsOnLambda: readonly [{
328
336
  name: string;
329
337
  cliFlag: "offthreadvideo-cache-size-in-bytes";
330
- description: JSX.Element;
338
+ description: () => JSX.Element;
331
339
  ssrName: "offthreadVideoCacheSizeInBytes";
332
340
  docLink: string;
333
341
  type: number | null;
@@ -335,7 +343,7 @@ export declare const BrowserSafeApis: {
335
343
  readonly renderMediaOnCloudRun: readonly [{
336
344
  name: string;
337
345
  cliFlag: "offthreadvideo-cache-size-in-bytes";
338
- description: JSX.Element;
346
+ description: () => JSX.Element;
339
347
  ssrName: "offthreadVideoCacheSizeInBytes";
340
348
  docLink: string;
341
349
  type: number | null;
@@ -343,7 +351,7 @@ export declare const BrowserSafeApis: {
343
351
  readonly renderStillOnCloudRun: readonly [{
344
352
  name: string;
345
353
  cliFlag: "offthreadvideo-cache-size-in-bytes";
346
- description: JSX.Element;
354
+ description: () => JSX.Element;
347
355
  ssrName: "offthreadVideoCacheSizeInBytes";
348
356
  docLink: string;
349
357
  type: number | null;
package/dist/client.js CHANGED
@@ -18,6 +18,7 @@ const options_map_1 = require("./options/options-map");
18
18
  const scale_1 = require("./options/scale");
19
19
  const video_bitrate_1 = require("./options/video-bitrate");
20
20
  const video_codec_1 = require("./options/video-codec");
21
+ const webhook_custom_data_1 = require("./options/webhook-custom-data");
21
22
  const pixel_format_1 = require("./pixel-format");
22
23
  const prores_profile_1 = require("./prores-profile");
23
24
  const validate_output_filename_1 = require("./validate-output-filename");
@@ -48,6 +49,7 @@ exports.BrowserSafeApis = {
48
49
  muteOption: mute_1.muteOption,
49
50
  videoCodecOption: video_codec_1.videoCodecOption,
50
51
  offthreadVideoCacheSizeInBytesOption: offthreadvideo_cache_size_1.offthreadVideoCacheSizeInBytesOption,
52
+ webhookCustomDataOption: webhook_custom_data_1.webhookCustomDataOption,
51
53
  },
52
54
  optionsMap: options_map_1.optionsMap,
53
55
  codecSupportsCrf: codec_supports_media_1.codecSupportsCrf,
@@ -4,9 +4,6 @@ export declare const createFfmpegComplexFilter: ({ filters, downloadMap, }: {
4
4
  filters: PreprocessedAudioTrack[];
5
5
  downloadMap: DownloadMap;
6
6
  }) => Promise<{
7
- complexFilterFlag: [
8
- string,
9
- string
10
- ] | null;
7
+ complexFilterFlag: [string, string] | null;
11
8
  cleanup: () => void;
12
9
  }>;
@@ -1,6 +1,6 @@
1
1
  import type { AudioCodec } from './audio-codec';
2
2
  import type { Codec } from './codec';
3
3
  import type { FileExtension } from './file-extensions';
4
- export declare const getFileExtensionFromCodec: <T extends "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv" | "gif">(codec: T, audioCodec: AudioCodec | null) => FileExtension;
5
- export declare const makeFileExtensionMap: () => Record<string, ("h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv" | "gif")[]>;
4
+ export declare const getFileExtensionFromCodec: <T extends "h264" | "h265" | "vp8" | "vp9" | "prores" | "mp3" | "aac" | "wav" | "h264-mkv" | "gif">(codec: T, audioCodec: AudioCodec | null) => FileExtension;
5
+ export declare const makeFileExtensionMap: () => Record<string, ("h264" | "h265" | "vp8" | "vp9" | "prores" | "mp3" | "aac" | "wav" | "h264-mkv" | "gif")[]>;
6
6
  export declare const defaultCodecsForFileExtension: Record<FileExtension, Codec>;
package/dist/index.d.ts CHANGED
@@ -440,7 +440,7 @@ export declare const RenderInternals: {
440
440
  } & import("./options/option").ToOptions<readonly [{
441
441
  name: string;
442
442
  cliFlag: "offthreadvideo-cache-size-in-bytes";
443
- description: JSX.Element;
443
+ description: () => JSX.Element;
444
444
  ssrName: "offthreadVideoCacheSizeInBytes";
445
445
  docLink: string;
446
446
  type: number | null;
@@ -473,7 +473,7 @@ export declare const RenderInternals: {
473
473
  } & import("./options/option").ToOptions<readonly [{
474
474
  name: string;
475
475
  cliFlag: "offthreadvideo-cache-size-in-bytes";
476
- description: JSX.Element;
476
+ description: () => JSX.Element;
477
477
  ssrName: "offthreadVideoCacheSizeInBytes";
478
478
  docLink: string;
479
479
  type: number | null;
@@ -497,7 +497,7 @@ export declare const RenderInternals: {
497
497
  } & import("./options/option").ToOptions<readonly [{
498
498
  name: string;
499
499
  cliFlag: "offthreadvideo-cache-size-in-bytes";
500
- description: JSX.Element;
500
+ description: () => JSX.Element;
501
501
  ssrName: "offthreadVideoCacheSizeInBytes";
502
502
  docLink: string;
503
503
  type: number | null;
@@ -1,7 +1,7 @@
1
1
  export declare const audioBitrateOption: {
2
2
  name: string;
3
3
  cliFlag: string;
4
- description: JSX.Element;
4
+ description: () => JSX.Element;
5
5
  ssrName: string;
6
6
  docLink: string;
7
7
  type: string;
@@ -5,7 +5,7 @@ const jsx_runtime_1 = require("react/jsx-runtime");
5
5
  exports.audioBitrateOption = {
6
6
  name: 'Audio Bitrate',
7
7
  cliFlag: '--audio-bitrate',
8
- description: ((0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: ["Specify the target bitrate for the generated video. The syntax for FFMPEGs", (0, jsx_runtime_1.jsx)("code", { children: "-b:a" }), " parameter should be used. FFMPEG may encode the video in a way that will not result in the exact audio bitrate specified. Example values: ", (0, jsx_runtime_1.jsx)("code", { children: "512K" }), " for 512 kbps, ", (0, jsx_runtime_1.jsx)("code", { children: "1M" }), " for 1 Mbps. Default: ", (0, jsx_runtime_1.jsx)("code", { children: "320k" })] })),
8
+ description: () => ((0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: ["Specify the target bitrate for the generated video. The syntax for FFMPEGs", (0, jsx_runtime_1.jsx)("code", { children: "-b:a" }), " parameter should be used. FFMPEG may encode the video in a way that will not result in the exact audio bitrate specified. Example values: ", (0, jsx_runtime_1.jsx)("code", { children: "512K" }), " for 512 kbps, ", (0, jsx_runtime_1.jsx)("code", { children: "1M" }), " for 1 Mbps. Default: ", (0, jsx_runtime_1.jsx)("code", { children: "320k" })] })),
9
9
  ssrName: 'audioBitrate',
10
10
  docLink: 'https://www.remotion.dev/docs/renderer/render-media#audiobitrate-',
11
11
  type: '0',
@@ -1,7 +1,7 @@
1
1
  export declare const crfOption: {
2
2
  name: string;
3
3
  cliFlag: string;
4
- description: JSX.Element;
4
+ description: () => JSX.Element;
5
5
  ssrName: string;
6
6
  docLink: string;
7
7
  type: number;
@@ -5,7 +5,7 @@ const jsx_runtime_1 = require("react/jsx-runtime");
5
5
  exports.crfOption = {
6
6
  name: 'CRF',
7
7
  cliFlag: '--crf',
8
- description: ((0, jsx_runtime_1.jsx)(jsx_runtime_1.Fragment, { children: "No matter which codec you end up using, there's always a tradeoff between file size and video quality. You can control it by setting the CRF (Constant Rate Factor). The lower the number, the better the quality, the higher the number, the smaller the file is \u2013 of course at the cost of quality." })),
8
+ description: () => ((0, jsx_runtime_1.jsx)(jsx_runtime_1.Fragment, { children: "No matter which codec you end up using, there's always a tradeoff between file size and video quality. You can control it by setting the CRF (Constant Rate Factor). The lower the number, the better the quality, the higher the number, the smaller the file is \u2013 of course at the cost of quality." })),
9
9
  ssrName: 'crf',
10
10
  docLink: 'https://www.remotion.dev/docs/encoding/#controlling-quality-using-the-crf-setting',
11
11
  type: 0,
@@ -1,7 +1,7 @@
1
1
  export declare const enforceAudioOption: {
2
2
  name: string;
3
3
  cliFlag: string;
4
- description: JSX.Element;
4
+ description: () => JSX.Element;
5
5
  ssrName: string;
6
6
  docLink: string;
7
7
  type: boolean;
@@ -5,7 +5,7 @@ const jsx_runtime_1 = require("react/jsx-runtime");
5
5
  exports.enforceAudioOption = {
6
6
  name: 'Enforce Audio Track',
7
7
  cliFlag: '--enforce-audio-track',
8
- description: ((0, jsx_runtime_1.jsx)(jsx_runtime_1.Fragment, { children: "Render a silent audio track if there would be none otherwise." })),
8
+ description: () => ((0, jsx_runtime_1.jsx)(jsx_runtime_1.Fragment, { children: "Render a silent audio track if there would be none otherwise." })),
9
9
  ssrName: 'enforceAudioTrack',
10
10
  docLink: 'https://www.remotion.dev/docs/config#setenforceaudiotrack-',
11
11
  type: false,
@@ -1,7 +1,7 @@
1
1
  export declare const jpegQualityOption: {
2
2
  name: string;
3
3
  cliFlag: string;
4
- description: JSX.Element;
4
+ description: () => JSX.Element;
5
5
  ssrName: string;
6
6
  docLink: string;
7
7
  type: number;
@@ -5,7 +5,7 @@ const jsx_runtime_1 = require("react/jsx-runtime");
5
5
  exports.jpegQualityOption = {
6
6
  name: 'JPEG Quality',
7
7
  cliFlag: '--jpeg-quality',
8
- 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." })),
8
+ 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." })),
9
9
  ssrName: 'jpegQuality',
10
10
  docLink: 'https://www.remotion.dev/docs/renderer/render-media#jpeg-quality',
11
11
  type: 0,
@@ -1,7 +1,7 @@
1
1
  export declare const muteOption: {
2
2
  name: string;
3
3
  cliFlag: string;
4
- description: JSX.Element;
4
+ description: () => JSX.Element;
5
5
  ssrName: string;
6
6
  docLink: string;
7
7
  type: boolean;
@@ -5,7 +5,7 @@ const jsx_runtime_1 = require("react/jsx-runtime");
5
5
  exports.muteOption = {
6
6
  name: 'Muted',
7
7
  cliFlag: '--muted',
8
- description: (0, jsx_runtime_1.jsx)(jsx_runtime_1.Fragment, { children: "The Audio of the video will be omitted." }),
8
+ description: () => (0, jsx_runtime_1.jsx)(jsx_runtime_1.Fragment, { children: "The Audio of the video will be omitted." }),
9
9
  ssrName: 'muted',
10
10
  docLink: 'https://www.remotion.dev/docs/using-audio/#muted-property',
11
11
  type: false,
@@ -1,7 +1,7 @@
1
1
  export declare const offthreadVideoCacheSizeInBytesOption: {
2
2
  name: string;
3
3
  cliFlag: "offthreadvideo-cache-size-in-bytes";
4
- description: JSX.Element;
4
+ description: () => JSX.Element;
5
5
  ssrName: "offthreadVideoCacheSizeInBytes";
6
6
  docLink: string;
7
7
  type: number | null;
@@ -5,7 +5,7 @@ const jsx_runtime_1 = require("react/jsx-runtime");
5
5
  exports.offthreadVideoCacheSizeInBytesOption = {
6
6
  name: 'OffthreadVideo cache size',
7
7
  cliFlag: 'offthreadvideo-cache-size-in-bytes',
8
- 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" })] })),
8
+ 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" })] })),
9
9
  ssrName: 'offthreadVideoCacheSizeInBytes',
10
10
  docLink: 'https://www.remotion.dev/docs/offthreadvideo',
11
11
  type: 0,
@@ -3,7 +3,7 @@ export type RemotionOption<SsrName extends string, Type> = {
3
3
  name: string;
4
4
  cliFlag: string;
5
5
  ssrName: SsrName;
6
- description: React.ReactNode;
6
+ description: (mode: 'ssr' | 'cli') => React.ReactNode;
7
7
  docLink: string;
8
8
  type: Type;
9
9
  };
@@ -2,7 +2,7 @@ export declare const optionsMap: {
2
2
  readonly renderMedia: readonly [{
3
3
  name: string;
4
4
  cliFlag: "offthreadvideo-cache-size-in-bytes";
5
- description: JSX.Element;
5
+ description: () => JSX.Element;
6
6
  ssrName: "offthreadVideoCacheSizeInBytes";
7
7
  docLink: string;
8
8
  type: number | null;
@@ -10,7 +10,7 @@ export declare const optionsMap: {
10
10
  readonly renderStill: readonly [{
11
11
  name: string;
12
12
  cliFlag: "offthreadvideo-cache-size-in-bytes";
13
- description: JSX.Element;
13
+ description: () => JSX.Element;
14
14
  ssrName: "offthreadVideoCacheSizeInBytes";
15
15
  docLink: string;
16
16
  type: number | null;
@@ -18,7 +18,7 @@ export declare const optionsMap: {
18
18
  readonly getCompositions: readonly [{
19
19
  name: string;
20
20
  cliFlag: "offthreadvideo-cache-size-in-bytes";
21
- description: JSX.Element;
21
+ description: () => JSX.Element;
22
22
  ssrName: "offthreadVideoCacheSizeInBytes";
23
23
  docLink: string;
24
24
  type: number | null;
@@ -26,7 +26,7 @@ export declare const optionsMap: {
26
26
  readonly selectComposition: readonly [{
27
27
  name: string;
28
28
  cliFlag: "offthreadvideo-cache-size-in-bytes";
29
- description: JSX.Element;
29
+ description: () => JSX.Element;
30
30
  ssrName: "offthreadVideoCacheSizeInBytes";
31
31
  docLink: string;
32
32
  type: number | null;
@@ -34,7 +34,7 @@ export declare const optionsMap: {
34
34
  readonly renderFrames: readonly [{
35
35
  name: string;
36
36
  cliFlag: "offthreadvideo-cache-size-in-bytes";
37
- description: JSX.Element;
37
+ description: () => JSX.Element;
38
38
  ssrName: "offthreadVideoCacheSizeInBytes";
39
39
  docLink: string;
40
40
  type: number | null;
@@ -42,7 +42,7 @@ export declare const optionsMap: {
42
42
  readonly renderMediaOnLambda: readonly [{
43
43
  name: string;
44
44
  cliFlag: "offthreadvideo-cache-size-in-bytes";
45
- description: JSX.Element;
45
+ description: () => JSX.Element;
46
46
  ssrName: "offthreadVideoCacheSizeInBytes";
47
47
  docLink: string;
48
48
  type: number | null;
@@ -50,7 +50,7 @@ export declare const optionsMap: {
50
50
  readonly renderStillOnLambda: readonly [{
51
51
  name: string;
52
52
  cliFlag: "offthreadvideo-cache-size-in-bytes";
53
- description: JSX.Element;
53
+ description: () => JSX.Element;
54
54
  ssrName: "offthreadVideoCacheSizeInBytes";
55
55
  docLink: string;
56
56
  type: number | null;
@@ -58,7 +58,7 @@ export declare const optionsMap: {
58
58
  readonly getCompositionsOnLambda: readonly [{
59
59
  name: string;
60
60
  cliFlag: "offthreadvideo-cache-size-in-bytes";
61
- description: JSX.Element;
61
+ description: () => JSX.Element;
62
62
  ssrName: "offthreadVideoCacheSizeInBytes";
63
63
  docLink: string;
64
64
  type: number | null;
@@ -66,7 +66,7 @@ export declare const optionsMap: {
66
66
  readonly renderMediaOnCloudRun: readonly [{
67
67
  name: string;
68
68
  cliFlag: "offthreadvideo-cache-size-in-bytes";
69
- description: JSX.Element;
69
+ description: () => JSX.Element;
70
70
  ssrName: "offthreadVideoCacheSizeInBytes";
71
71
  docLink: string;
72
72
  type: number | null;
@@ -74,7 +74,7 @@ export declare const optionsMap: {
74
74
  readonly renderStillOnCloudRun: readonly [{
75
75
  name: string;
76
76
  cliFlag: "offthreadvideo-cache-size-in-bytes";
77
- description: JSX.Element;
77
+ description: () => JSX.Element;
78
78
  ssrName: "offthreadVideoCacheSizeInBytes";
79
79
  docLink: string;
80
80
  type: number | null;
@@ -1,7 +1,7 @@
1
1
  export declare const scaleOption: {
2
2
  name: string;
3
3
  cliFlag: string;
4
- description: JSX.Element;
4
+ description: () => JSX.Element;
5
5
  ssrName: string;
6
6
  docLink: string;
7
7
  type: number;
@@ -5,7 +5,7 @@ const jsx_runtime_1 = require("react/jsx-runtime");
5
5
  exports.scaleOption = {
6
6
  name: 'Scale',
7
7
  cliFlag: '--scale',
8
- description: ((0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: ["Scales the output by a factor. For example, a 1280x720px frame will become a 1920x1080px frame with a scale factor of ", (0, jsx_runtime_1.jsx)("code", { children: "1.5" }), ". Vector elements like fonts and HTML markups will be rendered with extra details."] })),
8
+ description: () => ((0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: ["Scales the output by a factor. For example, a 1280x720px frame will become a 1920x1080px frame with a scale factor of ", (0, jsx_runtime_1.jsx)("code", { children: "1.5" }), ". Vector elements like fonts and HTML markups will be rendered with extra details."] })),
9
9
  ssrName: 'scale',
10
10
  docLink: 'https://www.remotion.dev/docs/scaling',
11
11
  type: 0,
@@ -1,7 +1,7 @@
1
1
  export declare const videoBitrate: {
2
2
  name: string;
3
3
  cliFlag: string;
4
- description: JSX.Element;
4
+ description: () => JSX.Element;
5
5
  ssrName: string;
6
6
  docLink: string;
7
7
  type: string;
@@ -5,7 +5,7 @@ const jsx_runtime_1 = require("react/jsx-runtime");
5
5
  exports.videoBitrate = {
6
6
  name: 'Video Bitrate',
7
7
  cliFlag: '--video-bitrate',
8
- description: ((0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: ["Specify the target bitrate for the generated video. The syntax for FFMPEGs", (0, jsx_runtime_1.jsx)("code", { children: "-b:v" }), " parameter should be used. FFMPEG may encode the video in a way that will not result in the exact video bitrate specified. Example values: ", (0, jsx_runtime_1.jsx)("code", { children: "512K" }), " for 512 kbps, ", (0, jsx_runtime_1.jsx)("code", { children: "1M" }), " for 1 Mbps."] })),
8
+ description: () => ((0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: ["Specify the target bitrate for the generated video. The syntax for FFMPEGs", (0, jsx_runtime_1.jsx)("code", { children: "-b:v" }), " parameter should be used. FFMPEG may encode the video in a way that will not result in the exact video bitrate specified. Example values: ", (0, jsx_runtime_1.jsx)("code", { children: "512K" }), " for 512 kbps, ", (0, jsx_runtime_1.jsx)("code", { children: "1M" }), " for 1 Mbps."] })),
9
9
  ssrName: 'videoBitrate',
10
10
  docLink: 'https://www.remotion.dev/docs/renderer/render-media#videobitrate-',
11
11
  type: '',
@@ -1,7 +1,7 @@
1
1
  export declare const videoCodecOption: {
2
2
  name: string;
3
3
  cliFlag: string;
4
- description: JSX.Element;
4
+ description: () => JSX.Element;
5
5
  ssrName: string;
6
6
  docLink: string;
7
7
  type: string;
@@ -5,7 +5,7 @@ const jsx_runtime_1 = require("react/jsx-runtime");
5
5
  exports.videoCodecOption = {
6
6
  name: 'Codec',
7
7
  cliFlag: '--codec',
8
- description: ((0, jsx_runtime_1.jsx)(jsx_runtime_1.Fragment, { children: "H264 works well in most cases, but sometimes it's worth going for a different codec. WebM achieves higher compression but is slower to render. WebM and ProRes support transparency." })),
8
+ description: () => ((0, jsx_runtime_1.jsx)(jsx_runtime_1.Fragment, { children: "H264 works well in most cases, but sometimes it's worth going for a different codec. WebM achieves higher compression but is slower to render. WebM and ProRes support transparency." })),
9
9
  ssrName: 'codec',
10
10
  docLink: 'https://www.remotion.dev/docs/encoding/#choosing-a-codec',
11
11
  type: '',
@@ -0,0 +1,8 @@
1
+ export declare const webhookCustomDataOption: {
2
+ name: string;
3
+ cliFlag: "webhook-custom-data";
4
+ description: (type: "ssr" | "cli") => JSX.Element;
5
+ ssrName: "customData";
6
+ docLink: string;
7
+ type: Record<string, unknown> | null;
8
+ };
@@ -0,0 +1,14 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.webhookCustomDataOption = void 0;
4
+ const jsx_runtime_1 = require("react/jsx-runtime");
5
+ exports.webhookCustomDataOption = {
6
+ name: 'Webhook custom data',
7
+ cliFlag: 'webhook-custom-data',
8
+ description: (type) => ((0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: ["Pass up to 1,024 bytes of a JSON-serializable object to the webhook. This data will be included in the webhook payload.", ' ', type === 'cli'
9
+ ? 'Alternatively, pass a file path pointing to a JSON file'
10
+ : null] })),
11
+ ssrName: 'customData',
12
+ docLink: 'https://www.remotion.dev/docs/lambda/webhooks',
13
+ type: {},
14
+ };
@@ -0,0 +1,7 @@
1
+ import type { Codec } from './codec';
2
+ export declare const x264PresetOptions: readonly ["ultrafast", "superfast", "veryfast", "faster", "fast", "medium", "slow", "slower", "veryslow", "placebo"];
3
+ export type x264Preset = typeof x264PresetOptions[number];
4
+ export declare const validateSelectedCodecAndPresetCombination: ({ codec, x264Preset, }: {
5
+ codec: Codec;
6
+ x264Preset: "ultrafast" | "superfast" | "veryfast" | "faster" | "fast" | "medium" | "slow" | "slower" | "veryslow" | "placebo" | undefined;
7
+ }) => void;
@@ -0,0 +1,27 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.validateSelectedCodecAndPresetCombination = exports.x264PresetOptions = void 0;
4
+ exports.x264PresetOptions = [
5
+ 'ultrafast',
6
+ 'superfast',
7
+ 'veryfast',
8
+ 'faster',
9
+ 'fast',
10
+ 'medium',
11
+ 'slow',
12
+ 'slower',
13
+ 'veryslow',
14
+ 'placebo',
15
+ ];
16
+ const validateSelectedCodecAndPresetCombination = ({ codec, x264Preset, }) => {
17
+ if (typeof x264Preset !== 'undefined' && codec !== 'h264') {
18
+ throw new TypeError(`You have set a Preset profile but the codec is "${codec}". Set the codec to "h264" or remove the Preset profile.`);
19
+ }
20
+ if (x264Preset !== undefined &&
21
+ !exports.x264PresetOptions.includes(x264Preset)) {
22
+ throw new TypeError(`The Preset profile "${x264Preset}" is not valid. Valid options are ${exports.x264PresetOptions
23
+ .map((p) => `"${p}"`)
24
+ .join(', ')}`);
25
+ }
26
+ };
27
+ exports.validateSelectedCodecAndPresetCombination = validateSelectedCodecAndPresetCombination;
@@ -1,7 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.prespawnFfmpeg = void 0;
4
- const remotion_1 = require("remotion");
5
4
  const call_ffmpeg_1 = require("./call-ffmpeg");
6
5
  const codec_1 = require("./codec");
7
6
  const crf_1 = require("./crf");
@@ -10,13 +9,14 @@ const get_prores_profile_name_1 = require("./get-prores-profile-name");
10
9
  const logger_1 = require("./logger");
11
10
  const parse_ffmpeg_progress_1 = require("./parse-ffmpeg-progress");
12
11
  const pixel_format_1 = require("./pixel-format");
12
+ const validate_1 = require("./validate");
13
13
  const validate_even_dimensions_with_codec_1 = require("./validate-even-dimensions-with-codec");
14
14
  const prespawnFfmpeg = (options) => {
15
15
  var _a, _b, _c;
16
- remotion_1.Internals.validateDimension(options.height, 'height', 'passed to `stitchFramesToVideo()`');
17
- remotion_1.Internals.validateDimension(options.width, 'width', 'passed to `stitchFramesToVideo()`');
16
+ (0, validate_1.validateDimension)(options.height, 'height', 'passed to `stitchFramesToVideo()`');
17
+ (0, validate_1.validateDimension)(options.width, 'width', 'passed to `stitchFramesToVideo()`');
18
18
  const codec = (_a = options.codec) !== null && _a !== void 0 ? _a : codec_1.DEFAULT_CODEC;
19
- remotion_1.Internals.validateFps(options.fps, 'in `stitchFramesToVideo()`', codec === 'gif');
19
+ (0, validate_1.validateFps)(options.fps, 'in `stitchFramesToVideo()`', codec === 'gif');
20
20
  (0, validate_even_dimensions_with_codec_1.validateEvenDimensionsWithCodec)({
21
21
  width: options.width,
22
22
  height: options.height,
@@ -0,0 +1 @@
1
+ export declare const printUsefulErrorMessage: (err: Error) => void;