@remotion/renderer 4.0.24 → 4.0.26

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 (103) hide show
  1. package/dist/browser/BrowserPage.js +6 -1
  2. package/dist/client.d.ts +28 -19
  3. package/dist/client.js +2 -0
  4. package/dist/create-ffmpeg-complex-filter.d.ts +1 -4
  5. package/dist/get-compositions.d.ts +1 -1
  6. package/dist/get-compositions.js +3 -2
  7. package/dist/get-silent-parts.d.ts +1 -1
  8. package/dist/index.d.ts +28 -26
  9. package/dist/logger.d.ts +1 -1
  10. package/dist/options/audio-bitrate.d.ts +2 -1
  11. package/dist/options/audio-bitrate.js +1 -1
  12. package/dist/options/crf.d.ts +2 -1
  13. package/dist/options/crf.js +1 -1
  14. package/dist/options/enforce-audio.d.ts +2 -1
  15. package/dist/options/enforce-audio.js +1 -1
  16. package/dist/options/jpeg-quality.d.ts +2 -1
  17. package/dist/options/jpeg-quality.js +1 -1
  18. package/dist/options/mute.d.ts +2 -1
  19. package/dist/options/mute.js +1 -1
  20. package/dist/options/offthreadvideo-cache-size.d.ts +2 -1
  21. package/dist/options/offthreadvideo-cache-size.js +1 -1
  22. package/dist/options/option.d.ts +1 -1
  23. package/dist/options/options-map.d.ts +11 -10
  24. package/dist/options/scale.d.ts +2 -1
  25. package/dist/options/scale.js +1 -1
  26. package/dist/options/video-bitrate.d.ts +2 -1
  27. package/dist/options/video-bitrate.js +1 -1
  28. package/dist/options/video-codec.d.ts +2 -1
  29. package/dist/options/video-codec.js +1 -1
  30. package/dist/options/webhook-custom-data.d.ts +9 -0
  31. package/dist/options/webhook-custom-data.js +14 -0
  32. package/dist/prespawn-ffmpeg.js +4 -4
  33. package/dist/print-useful-error-message.d.ts +1 -0
  34. package/dist/print-useful-error-message.js +62 -0
  35. package/dist/provide-screenshot.d.ts +1 -0
  36. package/dist/puppeteer-screenshot.d.ts +1 -0
  37. package/dist/pure.d.ts +3 -0
  38. package/dist/pure.js +7 -0
  39. package/dist/render-frames.d.ts +1 -1
  40. package/dist/render-frames.js +8 -6
  41. package/dist/render-media.d.ts +1 -1
  42. package/dist/render-media.js +5 -3
  43. package/dist/render-still.js +8 -6
  44. package/dist/screenshot-dom-element.d.ts +1 -0
  45. package/dist/screenshot-task.d.ts +1 -0
  46. package/dist/select-composition.d.ts +1 -0
  47. package/dist/select-composition.js +5 -3
  48. package/dist/stitch-frames-to-video.d.ts +1 -0
  49. package/dist/stitch-frames-to-video.js +4 -3
  50. package/dist/take-frame-and-compose.d.ts +1 -0
  51. package/dist/validate.d.ts +4 -0
  52. package/dist/validate.js +8 -0
  53. package/dist/wrap-with-error-handling.d.ts +3 -0
  54. package/dist/wrap-with-error-handling.js +16 -0
  55. package/package.json +9 -9
  56. package/pure.d.ts +1 -0
  57. package/pure.js +1 -0
  58. package/dist/assets/get-video-stream-duration.d.ts +0 -9
  59. package/dist/assets/get-video-stream-duration.js +0 -71
  60. package/dist/browser/Product.d.ts +0 -16
  61. package/dist/browser/Product.js +0 -17
  62. package/dist/browser/create-browser-fetcher.d.ts +0 -17
  63. package/dist/browser/create-browser-fetcher.js +0 -58
  64. package/dist/browser/revisions.d.ts +0 -20
  65. package/dist/browser/revisions.js +0 -21
  66. package/dist/calculate-sar-dar-pixels.d.ts +0 -9
  67. package/dist/calculate-sar-dar-pixels.js +0 -19
  68. package/dist/determine-resize-params.d.ts +0 -4
  69. package/dist/determine-resize-params.js +0 -10
  70. package/dist/determine-vcodec-ffmpeg-flags.d.ts +0 -2
  71. package/dist/determine-vcodec-ffmpeg-flags.js +0 -13
  72. package/dist/ensure-ffmpeg.d.ts +0 -18
  73. package/dist/ensure-ffmpeg.js +0 -58
  74. package/dist/ensure-presentation-timestamp.d.ts +0 -15
  75. package/dist/ensure-presentation-timestamp.js +0 -88
  76. package/dist/extract-frame-from-video.d.ts +0 -16
  77. package/dist/extract-frame-from-video.js +0 -191
  78. package/dist/ffmpeg-executable.d.ts +0 -1
  79. package/dist/ffmpeg-executable.js +0 -2
  80. package/dist/ffmpeg-flags.d.ts +0 -31
  81. package/dist/ffmpeg-flags.js +0 -245
  82. package/dist/frame-to-ffmpeg-timestamp.d.ts +0 -1
  83. package/dist/frame-to-ffmpeg-timestamp.js +0 -8
  84. package/dist/get-can-extract-frames-fast.d.ts +0 -14
  85. package/dist/get-can-extract-frames-fast.js +0 -71
  86. package/dist/get-frame-of-video-slow.d.ts +0 -17
  87. package/dist/get-frame-of-video-slow.js +0 -72
  88. package/dist/get-video-info.d.ts +0 -8
  89. package/dist/get-video-info.js +0 -59
  90. package/dist/is-beyond-last-frame.d.ts +0 -3
  91. package/dist/is-beyond-last-frame.js +0 -12
  92. package/dist/last-frame-from-video-cache.d.ts +0 -17
  93. package/dist/last-frame-from-video-cache.js +0 -55
  94. package/dist/legacy-webpack-config.d.ts +0 -9
  95. package/dist/legacy-webpack-config.js +0 -13
  96. package/dist/quality.d.ts +0 -1
  97. package/dist/quality.js +0 -21
  98. package/dist/try-to-extract-frame-of-video-fast.d.ts +0 -12
  99. package/dist/try-to-extract-frame-of-video-fast.js +0 -55
  100. package/dist/validate-ffmpeg.d.ts +0 -7
  101. package/dist/validate-ffmpeg.js +0 -77
  102. package/dist/warn-about-ffmpeg-version.d.ts +0 -5
  103. 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
@@ -1,3 +1,4 @@
1
+ /// <reference types="react" />
1
2
  export declare const BrowserSafeApis: {
2
3
  getFileExtensionFromCodec: <T extends "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv" | "gif">(codec: T, audioCodec: "mp3" | "aac" | "pcm-16" | "opus" | null) => import("./file-extensions").FileExtension;
3
4
  validCodecs: readonly ["h264", "h265", "vp8", "vp9", "mp3", "aac", "wav", "prores", "h264-mkv", "gif"];
@@ -197,7 +198,7 @@ export declare const BrowserSafeApis: {
197
198
  scaleOption: {
198
199
  name: string;
199
200
  cliFlag: string;
200
- description: JSX.Element;
201
+ description: () => JSX.Element;
201
202
  ssrName: string;
202
203
  docLink: string;
203
204
  type: number;
@@ -205,7 +206,7 @@ export declare const BrowserSafeApis: {
205
206
  crfOption: {
206
207
  name: string;
207
208
  cliFlag: string;
208
- description: JSX.Element;
209
+ description: () => JSX.Element;
209
210
  ssrName: string;
210
211
  docLink: string;
211
212
  type: number;
@@ -213,7 +214,7 @@ export declare const BrowserSafeApis: {
213
214
  jpegQualityOption: {
214
215
  name: string;
215
216
  cliFlag: string;
216
- description: JSX.Element;
217
+ description: () => JSX.Element;
217
218
  ssrName: string;
218
219
  docLink: string;
219
220
  type: number;
@@ -221,7 +222,7 @@ export declare const BrowserSafeApis: {
221
222
  videoBitrate: {
222
223
  name: string;
223
224
  cliFlag: string;
224
- description: JSX.Element;
225
+ description: () => JSX.Element;
225
226
  ssrName: string;
226
227
  docLink: string;
227
228
  type: string;
@@ -229,7 +230,7 @@ export declare const BrowserSafeApis: {
229
230
  audioBitrateOption: {
230
231
  name: string;
231
232
  cliFlag: string;
232
- description: JSX.Element;
233
+ description: () => JSX.Element;
233
234
  ssrName: string;
234
235
  docLink: string;
235
236
  type: string;
@@ -237,7 +238,7 @@ export declare const BrowserSafeApis: {
237
238
  enforceAudioOption: {
238
239
  name: string;
239
240
  cliFlag: string;
240
- description: JSX.Element;
241
+ description: () => JSX.Element;
241
242
  ssrName: string;
242
243
  docLink: string;
243
244
  type: boolean;
@@ -245,7 +246,7 @@ export declare const BrowserSafeApis: {
245
246
  muteOption: {
246
247
  name: string;
247
248
  cliFlag: string;
248
- description: JSX.Element;
249
+ description: () => JSX.Element;
249
250
  ssrName: string;
250
251
  docLink: string;
251
252
  type: boolean;
@@ -253,7 +254,7 @@ export declare const BrowserSafeApis: {
253
254
  videoCodecOption: {
254
255
  name: string;
255
256
  cliFlag: string;
256
- description: JSX.Element;
257
+ description: () => JSX.Element;
257
258
  ssrName: string;
258
259
  docLink: string;
259
260
  type: string;
@@ -261,17 +262,25 @@ export declare const BrowserSafeApis: {
261
262
  offthreadVideoCacheSizeInBytesOption: {
262
263
  name: string;
263
264
  cliFlag: "offthreadvideo-cache-size-in-bytes";
264
- description: JSX.Element;
265
+ description: () => JSX.Element;
265
266
  ssrName: "offthreadVideoCacheSizeInBytes";
266
267
  docLink: string;
267
268
  type: number | null;
268
269
  };
270
+ webhookCustomDataOption: {
271
+ name: string;
272
+ cliFlag: "webhook-custom-data";
273
+ description: (type: "ssr" | "cli") => JSX.Element;
274
+ ssrName: "customData";
275
+ docLink: string;
276
+ type: Record<string, unknown> | null;
277
+ };
269
278
  };
270
279
  optionsMap: {
271
280
  readonly renderMedia: readonly [{
272
281
  name: string;
273
282
  cliFlag: "offthreadvideo-cache-size-in-bytes";
274
- description: JSX.Element;
283
+ description: () => JSX.Element;
275
284
  ssrName: "offthreadVideoCacheSizeInBytes";
276
285
  docLink: string;
277
286
  type: number | null;
@@ -279,7 +288,7 @@ export declare const BrowserSafeApis: {
279
288
  readonly renderStill: readonly [{
280
289
  name: string;
281
290
  cliFlag: "offthreadvideo-cache-size-in-bytes";
282
- description: JSX.Element;
291
+ description: () => JSX.Element;
283
292
  ssrName: "offthreadVideoCacheSizeInBytes";
284
293
  docLink: string;
285
294
  type: number | null;
@@ -287,7 +296,7 @@ export declare const BrowserSafeApis: {
287
296
  readonly getCompositions: readonly [{
288
297
  name: string;
289
298
  cliFlag: "offthreadvideo-cache-size-in-bytes";
290
- description: JSX.Element;
299
+ description: () => JSX.Element;
291
300
  ssrName: "offthreadVideoCacheSizeInBytes";
292
301
  docLink: string;
293
302
  type: number | null;
@@ -295,7 +304,7 @@ export declare const BrowserSafeApis: {
295
304
  readonly selectComposition: readonly [{
296
305
  name: string;
297
306
  cliFlag: "offthreadvideo-cache-size-in-bytes";
298
- description: JSX.Element;
307
+ description: () => JSX.Element;
299
308
  ssrName: "offthreadVideoCacheSizeInBytes";
300
309
  docLink: string;
301
310
  type: number | null;
@@ -303,7 +312,7 @@ export declare const BrowserSafeApis: {
303
312
  readonly renderFrames: readonly [{
304
313
  name: string;
305
314
  cliFlag: "offthreadvideo-cache-size-in-bytes";
306
- description: JSX.Element;
315
+ description: () => JSX.Element;
307
316
  ssrName: "offthreadVideoCacheSizeInBytes";
308
317
  docLink: string;
309
318
  type: number | null;
@@ -311,7 +320,7 @@ export declare const BrowserSafeApis: {
311
320
  readonly renderMediaOnLambda: readonly [{
312
321
  name: string;
313
322
  cliFlag: "offthreadvideo-cache-size-in-bytes";
314
- description: JSX.Element;
323
+ description: () => JSX.Element;
315
324
  ssrName: "offthreadVideoCacheSizeInBytes";
316
325
  docLink: string;
317
326
  type: number | null;
@@ -319,7 +328,7 @@ export declare const BrowserSafeApis: {
319
328
  readonly renderStillOnLambda: readonly [{
320
329
  name: string;
321
330
  cliFlag: "offthreadvideo-cache-size-in-bytes";
322
- description: JSX.Element;
331
+ description: () => JSX.Element;
323
332
  ssrName: "offthreadVideoCacheSizeInBytes";
324
333
  docLink: string;
325
334
  type: number | null;
@@ -327,7 +336,7 @@ export declare const BrowserSafeApis: {
327
336
  readonly getCompositionsOnLambda: readonly [{
328
337
  name: string;
329
338
  cliFlag: "offthreadvideo-cache-size-in-bytes";
330
- description: JSX.Element;
339
+ description: () => JSX.Element;
331
340
  ssrName: "offthreadVideoCacheSizeInBytes";
332
341
  docLink: string;
333
342
  type: number | null;
@@ -335,7 +344,7 @@ export declare const BrowserSafeApis: {
335
344
  readonly renderMediaOnCloudRun: readonly [{
336
345
  name: string;
337
346
  cliFlag: "offthreadvideo-cache-size-in-bytes";
338
- description: JSX.Element;
347
+ description: () => JSX.Element;
339
348
  ssrName: "offthreadVideoCacheSizeInBytes";
340
349
  docLink: string;
341
350
  type: number | null;
@@ -343,7 +352,7 @@ export declare const BrowserSafeApis: {
343
352
  readonly renderStillOnCloudRun: readonly [{
344
353
  name: string;
345
354
  cliFlag: "offthreadvideo-cache-size-in-bytes";
346
- description: JSX.Element;
355
+ description: () => JSX.Element;
347
356
  ssrName: "offthreadVideoCacheSizeInBytes";
348
357
  docLink: string;
349
358
  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
  }>;
@@ -33,7 +33,7 @@ export type GetCompositionsOptions = {
33
33
  logLevel?: LogLevel;
34
34
  offthreadVideoCacheSizeInBytes?: number | null;
35
35
  };
36
- export declare const internalGetCompositions: ({ browserExecutable, chromiumOptions, envVariables, indent, serializedInputPropsWithCustomSchema, onBrowserLog, port, puppeteerInstance, serveUrlOrWebpackUrl, server, timeoutInMilliseconds, logLevel, offthreadVideoCacheSizeInBytes, }: InternalGetCompositionsOptions) => Promise<VideoConfig[]>;
36
+ export declare const internalGetCompositions: (args_0: InternalGetCompositionsOptions) => Promise<VideoConfig[]>;
37
37
  /**
38
38
  * @description Gets the compositions defined in a Remotion project based on a Webpack bundle.
39
39
  * @see [Documentation](https://www.remotion.dev/docs/renderer/get-compositions)
@@ -12,6 +12,7 @@ const puppeteer_evaluate_1 = require("./puppeteer-evaluate");
12
12
  const seek_to_frame_1 = require("./seek-to-frame");
13
13
  const set_props_and_env_1 = require("./set-props-and-env");
14
14
  const validate_puppeteer_timeout_1 = require("./validate-puppeteer-timeout");
15
+ const wrap_with_error_handling_1 = require("./wrap-with-error-handling");
15
16
  const innerGetCompositions = async ({ envVariables, serializedInputPropsWithCustomSchema, onBrowserLog, page, proxyPort, serveUrl, timeoutInMilliseconds, indent, logLevel, }) => {
16
17
  if (onBrowserLog) {
17
18
  page.on('console', (log) => {
@@ -70,7 +71,7 @@ const innerGetCompositions = async ({ envVariables, serializedInputPropsWithCust
70
71
  };
71
72
  });
72
73
  };
73
- const internalGetCompositions = async ({ browserExecutable, chromiumOptions, envVariables, indent, serializedInputPropsWithCustomSchema, onBrowserLog, port, puppeteerInstance, serveUrlOrWebpackUrl, server, timeoutInMilliseconds, logLevel, offthreadVideoCacheSizeInBytes, }) => {
74
+ const internalGetCompositionsRaw = async ({ browserExecutable, chromiumOptions, envVariables, indent, serializedInputPropsWithCustomSchema, onBrowserLog, port, puppeteerInstance, serveUrlOrWebpackUrl, server, timeoutInMilliseconds, logLevel, offthreadVideoCacheSizeInBytes, }) => {
74
75
  const { page, cleanup: cleanupPage } = await (0, get_browser_instance_1.getPageAndCleanupFn)({
75
76
  passedInInstance: puppeteerInstance,
76
77
  browserExecutable,
@@ -128,7 +129,7 @@ const internalGetCompositions = async ({ browserExecutable, chromiumOptions, env
128
129
  });
129
130
  });
130
131
  };
131
- exports.internalGetCompositions = internalGetCompositions;
132
+ exports.internalGetCompositions = (0, wrap_with_error_handling_1.wrapWithErrorHandling)(internalGetCompositionsRaw);
132
133
  /**
133
134
  * @description Gets the compositions defined in a Remotion project based on a Webpack bundle.
134
135
  * @see [Documentation](https://www.remotion.dev/docs/renderer/get-compositions)
@@ -3,6 +3,6 @@ import type { LogLevel } from './log-level';
3
3
  export declare const getSilentParts: ({ src, noiseThresholdInDecibels: passedNoiseThresholdInDecibels, minDurationInSeconds: passedMinDuration, logLevel, }: {
4
4
  src: string;
5
5
  minDurationInSeconds?: number | undefined;
6
- logLevel?: "verbose" | "info" | "warn" | "error" | undefined;
6
+ logLevel?: "error" | "verbose" | "info" | "warn" | undefined;
7
7
  noiseThresholdInDecibels?: number | undefined;
8
8
  }) => Promise<GetSilentPartsResponse>;
package/dist/index.d.ts CHANGED
@@ -1,3 +1,5 @@
1
+ /// <reference types="node" />
2
+ /// <reference types="react" />
1
3
  import execa from 'execa';
2
4
  import { HeadlessBrowser } from './browser/Browser';
3
5
  import { SymbolicateableError } from './error-handling/symbolicateable-error';
@@ -45,7 +47,7 @@ export declare const RenderInternals: {
45
47
  downloadMap: import("./assets/download-map").DownloadMap;
46
48
  remotionRoot: string;
47
49
  concurrency: number;
48
- logLevel: "verbose" | "info" | "warn" | "error";
50
+ logLevel: "error" | "verbose" | "info" | "warn";
49
51
  indent: boolean;
50
52
  offthreadVideoCacheSizeInBytes: number | null;
51
53
  }) => Promise<{
@@ -116,8 +118,8 @@ export declare const RenderInternals: {
116
118
  validPixelFormats: readonly ["yuv420p", "yuva420p", "yuv422p", "yuv444p", "yuv420p10le", "yuv422p10le", "yuv444p10le", "yuva444p10le"];
117
119
  DEFAULT_BROWSER: "chrome";
118
120
  validateFrameRange: (frameRange: import("./frame-range").FrameRange | null) => void;
119
- DEFAULT_OPENGL_RENDERER: "swangle" | "angle" | "egl" | "swiftshader" | null;
120
- validateOpenGlRenderer: (option: "swangle" | "angle" | "egl" | "swiftshader" | null) => "swangle" | "angle" | "egl" | "swiftshader" | null;
121
+ DEFAULT_OPENGL_RENDERER: "angle" | "swangle" | "egl" | "swiftshader" | null;
122
+ validateOpenGlRenderer: (option: "angle" | "swangle" | "egl" | "swiftshader" | null) => "angle" | "swangle" | "egl" | "swiftshader" | null;
121
123
  validCodecs: readonly ["h264", "h265", "vp8", "vp9", "mp3", "aac", "wav", "prores", "h264-mkv", "gif"];
122
124
  DEFAULT_PIXEL_FORMAT: "yuv420p" | "yuva420p" | "yuv422p" | "yuv444p" | "yuv420p10le" | "yuv422p10le" | "yuv444p10le" | "yuva444p10le";
123
125
  validateJpegQuality: (q: number | undefined) => void;
@@ -125,7 +127,7 @@ export declare const RenderInternals: {
125
127
  DEFAULT_CODEC: "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv" | "gif";
126
128
  isAudioCodec: (codec: "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv" | "gif" | undefined) => boolean;
127
129
  logLevels: readonly ["verbose", "info", "warn", "error"];
128
- isEqualOrBelowLogLevel: (currentLevel: "verbose" | "info" | "warn" | "error", level: "verbose" | "info" | "warn" | "error") => boolean;
130
+ isEqualOrBelowLogLevel: (currentLevel: "error" | "verbose" | "info" | "warn", level: "error" | "verbose" | "info" | "warn") => boolean;
129
131
  isValidLogLevel: (level: string) => boolean;
130
132
  perf: typeof perf;
131
133
  convertToPositiveFrameIndex: ({ frame, durationInFrames, }: {
@@ -305,8 +307,8 @@ export declare const RenderInternals: {
305
307
  };
306
308
  validStillImageFormats: readonly ["png", "jpeg", "pdf", "webp"];
307
309
  validVideoImageFormats: readonly ["png", "jpeg", "none"];
308
- DEFAULT_STILL_IMAGE_FORMAT: "png" | "jpeg" | "pdf" | "webp";
309
- DEFAULT_VIDEO_IMAGE_FORMAT: "png" | "jpeg" | "none";
310
+ DEFAULT_STILL_IMAGE_FORMAT: "jpeg" | "png" | "webp" | "pdf";
311
+ DEFAULT_VIDEO_IMAGE_FORMAT: "jpeg" | "png" | "none";
310
312
  DEFAULT_JPEG_QUALITY: number;
311
313
  chalk: {
312
314
  enabled: () => boolean;
@@ -362,30 +364,30 @@ export declare const RenderInternals: {
362
364
  verbose: (message?: any, ...optionalParams: any[]) => void;
363
365
  verboseAdvanced: (options: {
364
366
  indent: boolean;
365
- logLevel: "verbose" | "info" | "warn" | "error";
367
+ logLevel: "error" | "verbose" | "info" | "warn";
366
368
  } & {
367
369
  tag?: string | undefined;
368
370
  }, message?: any, ...optionalParams: any[]) => void;
369
371
  info: (message?: any, ...optionalParams: any[]) => void;
370
372
  infoAdvanced: (options: {
371
373
  indent: boolean;
372
- logLevel: "verbose" | "info" | "warn" | "error";
374
+ logLevel: "error" | "verbose" | "info" | "warn";
373
375
  }, message?: any, ...optionalParams: any[]) => void;
374
376
  warn: (message?: any, ...optionalParams: any[]) => void;
375
377
  warnAdvanced: (options: {
376
378
  indent: boolean;
377
- logLevel: "verbose" | "info" | "warn" | "error";
379
+ logLevel: "error" | "verbose" | "info" | "warn";
378
380
  }, message?: any, ...optionalParams: any[]) => void;
379
381
  error: (message?: any, ...optionalParams: any[]) => void;
380
382
  errorAdvanced: (options: {
381
383
  indent: boolean;
382
- logLevel: "verbose" | "info" | "warn" | "error";
384
+ logLevel: "error" | "verbose" | "info" | "warn";
383
385
  } & {
384
386
  tag?: string | undefined;
385
387
  }, message?: any, ...optionalParams: any[]) => void;
386
388
  };
387
- getLogLevel: () => "verbose" | "info" | "warn" | "error";
388
- setLogLevel: (newLogLevel: "verbose" | "info" | "warn" | "error") => void;
389
+ getLogLevel: () => "error" | "verbose" | "info" | "warn";
390
+ setLogLevel: (newLogLevel: "error" | "verbose" | "info" | "warn") => void;
389
391
  INDENT_TOKEN: string;
390
392
  isColorSupported: () => boolean;
391
393
  HeadlessBrowser: typeof HeadlessBrowser;
@@ -394,7 +396,7 @@ export declare const RenderInternals: {
394
396
  port: number | null;
395
397
  remotionRoot: string;
396
398
  concurrency: number;
397
- logLevel: "verbose" | "info" | "warn" | "error";
399
+ logLevel: "error" | "verbose" | "info" | "warn";
398
400
  indent: boolean;
399
401
  offthreadVideoCacheSizeInBytes: number | null;
400
402
  }) => Promise<import("./prepare-server").RemotionServer>;
@@ -403,7 +405,7 @@ export declare const RenderInternals: {
403
405
  port: number | null;
404
406
  remotionRoot: string;
405
407
  concurrency: number;
406
- logLevel: "verbose" | "info" | "warn" | "error";
408
+ logLevel: "error" | "verbose" | "info" | "warn";
407
409
  indent: boolean;
408
410
  offthreadVideoCacheSizeInBytes: number | null;
409
411
  }, { onDownload, onError, }: {
@@ -419,7 +421,7 @@ export declare const RenderInternals: {
419
421
  frame: number;
420
422
  serializedInputPropsWithCustomSchema: string;
421
423
  serializedResolvedPropsWithCustomSchema: string;
422
- imageFormat: "png" | "jpeg" | "pdf" | "webp";
424
+ imageFormat: "jpeg" | "png" | "webp" | "pdf";
423
425
  jpegQuality: number;
424
426
  puppeteerInstance: HeadlessBrowser | null;
425
427
  envVariables: Record<string, string>;
@@ -433,14 +435,14 @@ export declare const RenderInternals: {
433
435
  cancelSignal: import("./make-cancel-signal").CancelSignal | null;
434
436
  indent: boolean;
435
437
  server: import("./prepare-server").RemotionServer | undefined;
436
- logLevel: "verbose" | "info" | "warn" | "error";
438
+ logLevel: "error" | "verbose" | "info" | "warn";
437
439
  serveUrl: string;
438
440
  port: number | null;
439
441
  offthreadVideoCacheSizeInBytes: number | null;
440
442
  } & import("./options/option").ToOptions<readonly [{
441
443
  name: string;
442
444
  cliFlag: "offthreadvideo-cache-size-in-bytes";
443
- description: JSX.Element;
445
+ description: () => JSX.Element;
444
446
  ssrName: "offthreadVideoCacheSizeInBytes";
445
447
  docLink: string;
446
448
  type: number | null;
@@ -454,7 +456,7 @@ export declare const RenderInternals: {
454
456
  viewport: import("./browser/PuppeteerViewport").Viewport | null;
455
457
  indent: boolean;
456
458
  browser: "chrome";
457
- logLevel: "verbose" | "info" | "warn" | "error";
459
+ logLevel: "error" | "verbose" | "info" | "warn";
458
460
  }) => Promise<HeadlessBrowser>;
459
461
  internalSelectComposition: (options: {
460
462
  serializedInputPropsWithCustomSchema: string;
@@ -467,13 +469,13 @@ export declare const RenderInternals: {
467
469
  port: number | null;
468
470
  indent: boolean;
469
471
  server: import("./prepare-server").RemotionServer | undefined;
470
- logLevel: "verbose" | "info" | "warn" | "error";
472
+ logLevel: "error" | "verbose" | "info" | "warn";
471
473
  serveUrl: string;
472
474
  id: string;
473
475
  } & import("./options/option").ToOptions<readonly [{
474
476
  name: string;
475
477
  cliFlag: "offthreadvideo-cache-size-in-bytes";
476
- description: JSX.Element;
478
+ description: () => JSX.Element;
477
479
  ssrName: "offthreadVideoCacheSizeInBytes";
478
480
  docLink: string;
479
481
  type: number | null;
@@ -481,7 +483,7 @@ export declare const RenderInternals: {
481
483
  metadata: import("remotion").VideoConfig;
482
484
  propsSize: number;
483
485
  }>;
484
- internalGetCompositions: ({ browserExecutable, chromiumOptions, envVariables, indent, serializedInputPropsWithCustomSchema, onBrowserLog, port, puppeteerInstance, serveUrlOrWebpackUrl, server, timeoutInMilliseconds, logLevel, offthreadVideoCacheSizeInBytes, }: {
486
+ internalGetCompositions: (args_0: {
485
487
  serializedInputPropsWithCustomSchema: string;
486
488
  envVariables: Record<string, string>;
487
489
  puppeteerInstance: HeadlessBrowser | undefined;
@@ -492,21 +494,21 @@ export declare const RenderInternals: {
492
494
  port: number | null;
493
495
  server: import("./prepare-server").RemotionServer | undefined;
494
496
  indent: boolean;
495
- logLevel: "verbose" | "info" | "warn" | "error";
497
+ logLevel: "error" | "verbose" | "info" | "warn";
496
498
  serveUrlOrWebpackUrl: string;
497
499
  } & import("./options/option").ToOptions<readonly [{
498
500
  name: string;
499
501
  cliFlag: "offthreadvideo-cache-size-in-bytes";
500
- description: JSX.Element;
502
+ description: () => JSX.Element;
501
503
  ssrName: "offthreadVideoCacheSizeInBytes";
502
504
  docLink: string;
503
505
  type: number | null;
504
506
  }]>) => Promise<import("remotion").VideoConfig[]>;
505
- internalRenderFrames: ({ browserExecutable, cancelSignal, chromiumOptions, composition, concurrency, envVariables, everyNthFrame, frameRange, imageFormat, indent, jpegQuality, muted, onBrowserLog, onDownload, onFrameBuffer, onFrameUpdate, onStart, outputDir, port, puppeteerInstance, scale, server, timeoutInMilliseconds, logLevel, webpackBundleOrServeUrl, serializedInputPropsWithCustomSchema, serializedResolvedPropsWithCustomSchema, offthreadVideoCacheSizeInBytes, }: import("./render-frames").InternalRenderFramesOptions) => Promise<import("./types").RenderFramesOutput>;
506
- internalRenderMedia: ({ proResProfile, x264Preset, crf, composition, serializedInputPropsWithCustomSchema, pixelFormat, codec, envVariables, frameRange, puppeteerInstance, outputLocation, onProgress, overwrite, onDownload, onBrowserLog, onStart, timeoutInMilliseconds, chromiumOptions, scale, browserExecutable, port, cancelSignal, muted, enforceAudioTrack, ffmpegOverride, audioBitrate, videoBitrate, audioCodec, concurrency, disallowParallelEncoding, everyNthFrame, imageFormat: provisionalImageFormat, indent, jpegQuality, numberOfGifLoops, onCtrlCExit, preferLossless, serveUrl, server: reusedServer, logLevel, serializedResolvedPropsWithCustomSchema, offthreadVideoCacheSizeInBytes, }: import("./render-media").InternalRenderMediaOptions) => Promise<{
507
+ internalRenderFrames: (args_0: import("./render-frames").InternalRenderFramesOptions) => Promise<import("./types").RenderFramesOutput>;
508
+ internalRenderMedia: (args_0: import("./render-media").InternalRenderMediaOptions) => Promise<{
507
509
  buffer: Buffer | null;
508
510
  slowestFrames: import("./render-media").SlowFrame[];
509
511
  }>;
510
512
  validOpenGlRenderers: readonly ["swangle", "angle", "egl", "swiftshader"];
511
- copyImageToClipboard: (src: string, logLevel: "verbose" | "info" | "warn" | "error") => Promise<void>;
513
+ copyImageToClipboard: (src: string, logLevel: "error" | "verbose" | "info" | "warn") => Promise<void>;
512
514
  };
package/dist/logger.d.ts CHANGED
@@ -19,6 +19,6 @@ export declare const Log: {
19
19
  error: (message?: any, ...optionalParams: any[]) => void;
20
20
  errorAdvanced: (options: VerboseLogOptions, message?: any, ...optionalParams: any[]) => void;
21
21
  };
22
- export declare const getLogLevel: () => "verbose" | "info" | "warn" | "error";
22
+ export declare const getLogLevel: () => "error" | "verbose" | "info" | "warn";
23
23
  export declare const setLogLevel: (newLogLevel: LogLevel) => void;
24
24
  export {};
@@ -1,7 +1,8 @@
1
+ /// <reference types="react" />
1
2
  export declare const audioBitrateOption: {
2
3
  name: string;
3
4
  cliFlag: string;
4
- description: JSX.Element;
5
+ description: () => JSX.Element;
5
6
  ssrName: string;
6
7
  docLink: string;
7
8
  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,8 @@
1
+ /// <reference types="react" />
1
2
  export declare const crfOption: {
2
3
  name: string;
3
4
  cliFlag: string;
4
- description: JSX.Element;
5
+ description: () => JSX.Element;
5
6
  ssrName: string;
6
7
  docLink: string;
7
8
  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,8 @@
1
+ /// <reference types="react" />
1
2
  export declare const enforceAudioOption: {
2
3
  name: string;
3
4
  cliFlag: string;
4
- description: JSX.Element;
5
+ description: () => JSX.Element;
5
6
  ssrName: string;
6
7
  docLink: string;
7
8
  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,8 @@
1
+ /// <reference types="react" />
1
2
  export declare const jpegQualityOption: {
2
3
  name: string;
3
4
  cliFlag: string;
4
- description: JSX.Element;
5
+ description: () => JSX.Element;
5
6
  ssrName: string;
6
7
  docLink: string;
7
8
  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,8 @@
1
+ /// <reference types="react" />
1
2
  export declare const muteOption: {
2
3
  name: string;
3
4
  cliFlag: string;
4
- description: JSX.Element;
5
+ description: () => JSX.Element;
5
6
  ssrName: string;
6
7
  docLink: string;
7
8
  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,8 @@
1
+ /// <reference types="react" />
1
2
  export declare const offthreadVideoCacheSizeInBytesOption: {
2
3
  name: string;
3
4
  cliFlag: "offthreadvideo-cache-size-in-bytes";
4
- description: JSX.Element;
5
+ description: () => JSX.Element;
5
6
  ssrName: "offthreadVideoCacheSizeInBytes";
6
7
  docLink: string;
7
8
  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
  };