@remotion/renderer 4.0.0-webhook.26 → 4.1.0-alpha1

package/dist/render-media.d.ts

@@ -1,22 +1,26 @@
 /// <reference types="node" />
-import type { SmallTCompMetadata } from 'remotion';
+import type { AnySmallCompMetadata } from 'remotion';
 import type { RenderMediaOnDownload } from './assets/download-and-map-assets-to-file';
-import type { DownloadMap } from './assets/download-map';
+import type { AudioCodec } from './audio-codec';
 import type { BrowserExecutable } from './browser-executable';
 import type { BrowserLog } from './browser-log';
-import type { Browser as PuppeteerBrowser } from './browser/Browser';
+import type { HeadlessBrowser } from './browser/Browser';
 import type { Codec } from './codec';
-import type { FfmpegExecutable } from './ffmpeg-executable';
 import type { FfmpegOverrideFn } from './ffmpeg-override';
 import type { FrameRange } from './frame-range';
-import type { ServeUrlOrWebpackBundle } from './legacy-webpack-config';
+import type { VideoImageFormat } from './image-format';
 import type { CancelSignal } from './make-cancel-signal';
 import type { ChromiumOptions } from './open-browser';
 import type { PixelFormat } from './pixel-format';
+import type { RemotionServer } from './prepare-server';
 import type { ProResProfile } from './prores-profile';
 import type { OnStartData } from './types';
-export declare type StitchingState = 'encoding' | 'muxing';
-export declare type RenderMediaOnProgress = (progress: {
+export type StitchingState = 'encoding' | 'muxing';
+export type SlowFrame = {
+    frame: number;
+    time: number;
+};
+export type RenderMediaOnProgress = (progress: {
     renderedFrames: number;
     encodedFrames: number;
     encodedDoneIn: number | null;
@@ -24,22 +28,66 @@ export declare type RenderMediaOnProgress = (progress: {
     progress: number;
     stitchStage: StitchingState;
 }) => void;
-export declare type RenderMediaOptions = {
+export type InternalRenderMediaOptions = {
+    outputLocation: string | null;
+    codec: Codec;
+    composition: AnySmallCompMetadata;
+    inputProps: Record<string, unknown>;
+    crf: number | null;
+    imageFormat: VideoImageFormat;
+    pixelFormat: PixelFormat;
+    envVariables: Record<string, string>;
+    jpegQuality: number;
+    frameRange: FrameRange | null;
+    everyNthFrame: number;
+    numberOfGifLoops: number | null;
+    puppeteerInstance: HeadlessBrowser | undefined;
+    overwrite: boolean;
+    onProgress: RenderMediaOnProgress;
+    onDownload: RenderMediaOnDownload;
+    proResProfile: ProResProfile | undefined;
+    dumpBrowserLogs: boolean;
+    onBrowserLog: ((log: BrowserLog) => void) | null;
+    onStart: (data: OnStartData) => void;
+    timeoutInMilliseconds: number;
+    chromiumOptions: ChromiumOptions;
+    scale: number;
+    port: number | null;
+    cancelSignal: CancelSignal | undefined;
+    browserExecutable: BrowserExecutable | null;
+    verbose: boolean;
+    onCtrlCExit: (fn: () => void) => void;
+    indent: boolean;
+    server: RemotionServer | undefined;
+    preferLossless: boolean;
+    muted: boolean;
+    enforceAudioTrack: boolean;
+    ffmpegOverride: FfmpegOverrideFn | undefined;
+    audioBitrate: string | null;
+    videoBitrate: string | null;
+    disallowParallelEncoding: boolean;
+    audioCodec: AudioCodec | null;
+    serveUrl: string;
+    concurrency: number | string | null;
+};
+export type RenderMediaOptions = {
     outputLocation?: string | null;
     codec: Codec;
-    composition: SmallTCompMetadata;
-    inputProps?: unknown;
+    composition: AnySmallCompMetadata;
+    inputProps?: Record<string, unknown>;
     crf?: number | null;
-    imageFormat?: 'png' | 'jpeg' | 'none';
-    ffmpegExecutable?: FfmpegExecutable;
-    ffprobeExecutable?: FfmpegExecutable;
+    imageFormat?: VideoImageFormat;
     pixelFormat?: PixelFormat;
     envVariables?: Record<string, string>;
-    quality?: number;
+    /**
+     * @deprecated Renamed to `jpegQuality`
+     */
+    quality?: never;
+    jpegQuality?: number;
     frameRange?: FrameRange | null;
     everyNthFrame?: number;
     numberOfGifLoops?: number | null;
-    puppeteerInstance?: PuppeteerBrowser;
+    puppeteerInstance?: HeadlessBrowser;
     overwrite?: boolean;
     onProgress?: RenderMediaOnProgress;
     onDownload?: RenderMediaOnDownload;
@@ -54,27 +102,26 @@ export declare type RenderMediaOptions = {
     cancelSignal?: CancelSignal;
     browserExecutable?: BrowserExecutable;
     verbose?: boolean;
-    /**
-     * @deprecated Only for Remotion internal usage
-     */
-    downloadMap?: DownloadMap;
+    preferLossless?: boolean;
     muted?: boolean;
     enforceAudioTrack?: boolean;
     ffmpegOverride?: FfmpegOverrideFn;
+    audioBitrate?: string | null;
+    videoBitrate?: string | null;
     disallowParallelEncoding?: boolean;
-} & ServeUrlOrWebpackBundle & ConcurrencyOrParallelism;
-declare type ConcurrencyOrParallelism = {
-    concurrency?: number | null;
-} | {
-    /**
-     * @deprecated This field has been renamed to `concurrency`
-     */
-    parallelism?: number | null;
+    audioCodec?: AudioCodec | null;
+    serveUrl: string;
+    concurrency?: number | string | null;
+};
+type RenderMediaResult = {
+    buffer: Buffer | null;
+    slowestFrames: SlowFrame[];
 };
+export declare const internalRenderMedia: ({ proResProfile, crf, composition, inputProps, pixelFormat, codec, envVariables, frameRange, puppeteerInstance, outputLocation, onProgress, overwrite, onDownload, dumpBrowserLogs, 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, verbose, }: InternalRenderMediaOptions) => Promise<RenderMediaResult>;
 /**
  *
  * @description Render a video from a composition
- * @link https://www.remotion.dev/docs/renderer/render-media
+ * @see [Documentation](https://www.remotion.dev/docs/renderer/render-media)
  */
-export declare const renderMedia: ({ proResProfile, crf, composition, ffmpegExecutable, ffprobeExecutable, inputProps, pixelFormat, codec, envVariables, frameRange, puppeteerInstance, outputLocation, onProgress, overwrite, onDownload, dumpBrowserLogs, onBrowserLog, onStart, timeoutInMilliseconds, chromiumOptions, scale, browserExecutable, port, cancelSignal, muted, enforceAudioTrack, ffmpegOverride, ...options }: RenderMediaOptions) => Promise<Buffer | null>;
+export declare const renderMedia: ({ proResProfile, crf, composition, inputProps, pixelFormat, codec, envVariables, frameRange, puppeteerInstance, outputLocation, onProgress, overwrite, onDownload, dumpBrowserLogs, onBrowserLog, onStart, timeoutInMilliseconds, chromiumOptions, scale, browserExecutable, port, cancelSignal, muted, enforceAudioTrack, ffmpegOverride, audioBitrate, videoBitrate, audioCodec, jpegQuality, concurrency, serveUrl, disallowParallelEncoding, everyNthFrame, imageFormat, numberOfGifLoops, preferLossless, verbose, quality, }: RenderMediaOptions) => Promise<RenderMediaResult>;
 export {};