@remotion/renderer 4.0.243 → 4.0.245

package/LICENSE.md

@@ -11,7 +11,7 @@ Depending on the type of your legal entity, you are granted permission to use Re
 
 ## Free license
 
-Copyright © 2024 [Remotion](https://www.remotion.dev)
+Copyright © 2025 [Remotion](https://www.remotion.dev)
 
 ### Eligibility
 

package/dist/client.d.ts

@@ -394,7 +394,7 @@ export declare const BrowserSafeApis: {
         webhookCustomDataOption: {
             name: string;
             cliFlag: "webhook-custom-data";
-            description: (type: "ssr" | "cli") => import("react/jsx-runtime").JSX.Element;
+            description: (type: "cli" | "ssr") => import("react/jsx-runtime").JSX.Element;
             ssrName: "customData";
             docLink: string;
             type: Record<string, unknown> | null;
@@ -807,7 +807,7 @@ export declare const BrowserSafeApis: {
         metadataOption: {
             name: string;
             cliFlag: "metadata";
-            description: (mode: "ssr" | "cli") => import("react/jsx-runtime").JSX.Element;
+            description: (mode: "cli" | "ssr") => import("react/jsx-runtime").JSX.Element;
             docLink: string;
             type: import("./options/metadata").Metadata;
             getValue: ({ commandLine }: {

package/dist/ensure-browser.d.ts

@@ -21,11 +21,5 @@ export type EnsureBrowserOptions = Partial<{
     browserExecutable: BrowserExecutable;
 } & ToOptions<typeof BrowserSafeApis.optionsMap.ensureBrowser>>;
 export declare const internalEnsureBrowser: (options: InternalEnsureBrowserOptions) => Promise<BrowserStatus>;
-/**
- * Ensures a browser is locally installed so a Remotion render can be executed. This function manages the browser's download or validates existing browser paths.
- * @see [Documentation](https://remotion.dev/docs/renderer/ensure-browser)
- * @param {EnsureBrowserOptions} [options] Configuration options which may include a `browserExecutable` path, `logLevel` settings, and `onBrowserDownload` function to manage download specifics and progression.
- * @returns {Promise<void>} A promise that resolves when the browser is prepared with no explicit return value.
- */
 export declare const ensureBrowser: (options?: EnsureBrowserOptions) => Promise<BrowserStatus>;
 export {};

package/dist/ensure-browser.js

@@ -40,11 +40,9 @@ const getBrowserStatus = (browserExecutable) => {
     }
     return { type: 'no-browser' };
 };
-/**
- * Ensures a browser is locally installed so a Remotion render can be executed. This function manages the browser's download or validates existing browser paths.
- * @see [Documentation](https://remotion.dev/docs/renderer/ensure-browser)
- * @param {EnsureBrowserOptions} [options] Configuration options which may include a `browserExecutable` path, `logLevel` settings, and `onBrowserDownload` function to manage download specifics and progression.
- * @returns {Promise<void>} A promise that resolves when the browser is prepared with no explicit return value.
+/*
+ * @description Ensures a browser is locally installed so a Remotion render can be executed.
+ * @see [Documentation](https://www.remotion.dev/docs/renderer/ensure-browser)
  */
 const ensureBrowser = (options) => {
     var _a, _b, _c, _d;

package/dist/extract-audio.d.ts

@@ -1,13 +1,4 @@
 import type { LogLevel } from './log-level';
-/**
- * @description Extracts the audio from a video source and saves it at the specified output path without changing the audio format.
- * @see [Documentation](https://remotion.dev/docs/renderer/extract-audio)
- * @param options.videoSource The path to the video source from which the audio will be extracted.
- * @param options.audioOutput The path where the extracted audio will be saved. Must use the correct file extension which matches the audio codec.
- * @param options.logLevel The level of logging desired (optional).
- * @param options.binariesDirectory The directory for binary dependencies (optional).
- * @returns {Promise<void>} Resolves once the audio extraction is complete.
- */
 export declare const extractAudio: (options: {
     videoSource: string;
     audioOutput: string;

package/dist/extract-audio.js

@@ -2,14 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.extractAudio = void 0;
 const compositor_1 = require("./compositor/compositor");
-/**
- * @description Extracts the audio from a video source and saves it at the specified output path without changing the audio format.
- * @see [Documentation](https://remotion.dev/docs/renderer/extract-audio)
- * @param options.videoSource The path to the video source from which the audio will be extracted.
- * @param options.audioOutput The path where the extracted audio will be saved. Must use the correct file extension which matches the audio codec.
- * @param options.logLevel The level of logging desired (optional).
- * @param options.binariesDirectory The directory for binary dependencies (optional).
- * @returns {Promise<void>} Resolves once the audio extraction is complete.
+/*
+ * @description Extracts the audio from a video source and saves it to the specified output path. It does not convert the audio to a different format.
+ * @see [Documentation](https://www.remotion.dev/docs/renderer/extract-audio)
  */
 const extractAudio = async (options) => {
     var _a, _b;

package/dist/get-codec-name.d.ts

@@ -9,7 +9,7 @@ export declare const hasSpecifiedUnsupportedHardwareQualifySettings: ({ encoding
     encodingMaxRate: string | null;
     encodingBufferSize: string | null;
     crf: unknown;
-}) => "crf" | "encodingBufferSize" | "encodingMaxRate" | null;
+}) => "encodingMaxRate" | "encodingBufferSize" | "crf" | null;
 export declare const getCodecName: ({ codec, encodingMaxRate, encodingBufferSize, crf, hardwareAcceleration, logLevel, indent, }: {
     codec: Codec;
     hardwareAcceleration: HardwareAccelerationOption;

package/dist/get-compositions.d.ts

@@ -28,12 +28,5 @@ export type GetCompositionsOptions = RequiredInputPropsInV5 & {
     port?: number | null;
 } & Partial<ToOptions<typeof optionsMap.getCompositions>>;
 export declare const internalGetCompositions: (args_0: InternalGetCompositionsOptions) => Promise<VideoConfig[]>;
-/**
- * @description Gets the compositions defined in a Remotion project based on a Webpack bundle.
- * @see [Documentation](https://remotion.dev/docs/get-compositions)
- * @param serveUrlOrWebpackUrl URL pointing to the Remotion Bundle.
- * @param {GetCompositionsOptions} [config] Optional configurations for getting composition details.
- * @returns {Promise<VideoConfig[]>} Returns a promise that resolves to an array of available compositions.
- */
 export declare const getCompositions: (serveUrlOrWebpackUrl: string, config?: GetCompositionsOptions) => Promise<VideoConfig[]>;
 export {};

package/dist/get-compositions.js

@@ -146,12 +146,9 @@ const internalGetCompositionsRaw = async ({ browserExecutable, chromiumOptions,
     });
 };
 exports.internalGetCompositions = (0, wrap_with_error_handling_1.wrapWithErrorHandling)(internalGetCompositionsRaw);
-/**
- * @description Gets the compositions defined in a Remotion project based on a Webpack bundle.
- * @see [Documentation](https://remotion.dev/docs/get-compositions)
- * @param serveUrlOrWebpackUrl URL pointing to the Remotion Bundle.
- * @param {GetCompositionsOptions} [config] Optional configurations for getting composition details.
- * @returns {Promise<VideoConfig[]>} Returns a promise that resolves to an array of available compositions.
+/*
+ * @description Gets a list of compositions defined in a Remotion project based on a Remotion Bundle by evaluating the Remotion Root.
+ * @see [Documentation](https://www.remotion.dev/docs/renderer/get-compositions)
  */
 const getCompositions = (serveUrlOrWebpackUrl, config) => {
     if (!serveUrlOrWebpackUrl) {

package/dist/get-silent-parts.d.ts

@@ -1,18 +1,6 @@
 import type { GetSilentPartsResponse, SilentPart } from './compositor/payloads';
 import type { LogLevel } from './log-level';
 export type { SilentPart };
-/**
- * Analyzes the silent parts of a video or audio file and returns both the silent and audible segments.
- * @description Uses thresholds defined for noise and duration to identify silent stretches in a media file.
- * @see [Documentation](https://remotion.dev/docs/renderer/get-silent-parts)
- * @param {Object} params Configuration parameters for determining silent parts
- * @param {string} params.src The path to the local video or audio file
- * @param {number} [params.noiseThresholdInDecibels=-20] The decibel level below which sound is considered silent
- * @param {number} [params.minDurationInSeconds=1] The minimum duration (in seconds) to consider a silence as significant
- * @param {string|null} [params.binariesDirectory] Optional directory path for external binaries
- * @param {LogLevel} [params.logLevel] The logging level to be used (debug, verbose, info, warn, error)
- * @returns {Promise<GetSilentPartsResponse>} An object containing arrays of silent and audible parts, along with the overall duration
- */
 export declare const getSilentParts: ({ src, noiseThresholdInDecibels: passedNoiseThresholdInDecibels, minDurationInSeconds: passedMinDuration, logLevel, binariesDirectory, }: {
     src: string;
     minDurationInSeconds?: number;

package/dist/get-silent-parts.js

@@ -2,17 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getSilentParts = void 0;
 const compositor_1 = require("./compositor/compositor");
-/**
- * Analyzes the silent parts of a video or audio file and returns both the silent and audible segments.
- * @description Uses thresholds defined for noise and duration to identify silent stretches in a media file.
- * @see [Documentation](https://remotion.dev/docs/renderer/get-silent-parts)
- * @param {Object} params Configuration parameters for determining silent parts
- * @param {string} params.src The path to the local video or audio file
- * @param {number} [params.noiseThresholdInDecibels=-20] The decibel level below which sound is considered silent
- * @param {number} [params.minDurationInSeconds=1] The minimum duration (in seconds) to consider a silence as significant
- * @param {string|null} [params.binariesDirectory] Optional directory path for external binaries
- * @param {LogLevel} [params.logLevel] The logging level to be used (debug, verbose, info, warn, error)
- * @returns {Promise<GetSilentPartsResponse>} An object containing arrays of silent and audible parts, along with the overall duration
+/*
+ * @description Gets the silent parts of a video or audio in Node.js. Useful for cutting out silence from a video.
+ * @see [Documentation](https://www.remotion.dev/docs/renderer/get-silent-parts)
  */
 const getSilentParts = async ({ src, noiseThresholdInDecibels: passedNoiseThresholdInDecibels, minDurationInSeconds: passedMinDuration, logLevel, binariesDirectory, }) => {
     const compositor = (0, compositor_1.startLongRunningCompositor)({

package/dist/index.d.ts

@@ -139,13 +139,13 @@ export declare const RenderInternals: {
     validPixelFormats: readonly ["yuv420p", "yuva420p", "yuv422p", "yuv444p", "yuv420p10le", "yuv422p10le", "yuv444p10le", "yuva444p10le"];
     DEFAULT_BROWSER: "chrome";
     validateFrameRange: (frameRange: import("./frame-range").FrameRange | null) => void;
-    DEFAULT_OPENGL_RENDERER: "swangle" | "angle" | "egl" | "swiftshader" | "vulkan" | "angle-egl" | null;
+    DEFAULT_OPENGL_RENDERER: "angle" | "swangle" | "egl" | "swiftshader" | "vulkan" | "angle-egl" | null;
     validateOpenGlRenderer: (option: unknown) => import("./options/gl").OpenGlRenderer | null;
     validCodecs: readonly ["h264", "h265", "vp8", "vp9", "mp3", "aac", "wav", "prores", "h264-mkv", "h264-ts", "gif"];
     DEFAULT_PIXEL_FORMAT: "yuv420p" | "yuva420p" | "yuv422p" | "yuv444p" | "yuv420p10le" | "yuv422p10le" | "yuv444p10le" | "yuva444p10le";
     validateJpegQuality: (q: unknown) => void;
     DEFAULT_TIMEOUT: number;
-    DEFAULT_CODEC: "aac" | "mp3" | "wav" | "h264" | "h265" | "vp8" | "vp9" | "prores" | "h264-mkv" | "h264-ts" | "gif";
+    DEFAULT_CODEC: "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv" | "h264-ts" | "gif";
     logLevels: readonly ["verbose", "info", "warn", "error"];
     isEqualOrBelowLogLevel: (currentLevel: import("./log-level").LogLevel, level: import("./log-level").LogLevel) => boolean;
     isValidLogLevel: (level: string) => boolean;
@@ -184,10 +184,10 @@ export declare const RenderInternals: {
         preferLossless: boolean;
     }) => AudioCodec | null;
     defaultFileExtensionMap: {
-        aac: {
+        h264: {
             default: import("./file-extensions").FileExtension;
             forAudioCodec: {
-                "pcm-16": {
+                mp3: {
                     possible: import("./file-extensions").FileExtension[];
                     default: import("./file-extensions").FileExtension;
                 };
@@ -195,94 +195,94 @@ export declare const RenderInternals: {
                     possible: import("./file-extensions").FileExtension[];
                     default: import("./file-extensions").FileExtension;
                 };
+                "pcm-16": {
+                    possible: import("./file-extensions").FileExtension[];
+                    default: import("./file-extensions").FileExtension;
+                };
             };
         };
-        mp3: {
+        h265: {
             default: import("./file-extensions").FileExtension;
             forAudioCodec: {
-                "pcm-16": {
+                aac: {
                     possible: import("./file-extensions").FileExtension[];
                     default: import("./file-extensions").FileExtension;
                 };
-                mp3: {
+                "pcm-16": {
                     possible: import("./file-extensions").FileExtension[];
                     default: import("./file-extensions").FileExtension;
                 };
             };
         };
-        wav: {
+        vp8: {
             default: import("./file-extensions").FileExtension;
             forAudioCodec: {
                 "pcm-16": {
                     possible: import("./file-extensions").FileExtension[];
                     default: import("./file-extensions").FileExtension;
                 };
+                opus: {
+                    possible: import("./file-extensions").FileExtension[];
+                    default: import("./file-extensions").FileExtension;
+                };
             };
         };
-        h264: {
+        vp9: {
             default: import("./file-extensions").FileExtension;
             forAudioCodec: {
                 "pcm-16": {
                     possible: import("./file-extensions").FileExtension[];
                     default: import("./file-extensions").FileExtension;
                 };
-                aac: {
-                    possible: import("./file-extensions").FileExtension[];
-                    default: import("./file-extensions").FileExtension;
-                };
-                mp3: {
+                opus: {
                     possible: import("./file-extensions").FileExtension[];
                     default: import("./file-extensions").FileExtension;
                 };
             };
         };
-        h265: {
+        mp3: {
             default: import("./file-extensions").FileExtension;
             forAudioCodec: {
-                "pcm-16": {
+                mp3: {
                     possible: import("./file-extensions").FileExtension[];
                     default: import("./file-extensions").FileExtension;
                 };
-                aac: {
+                "pcm-16": {
                     possible: import("./file-extensions").FileExtension[];
                     default: import("./file-extensions").FileExtension;
                 };
             };
         };
-        vp8: {
+        aac: {
             default: import("./file-extensions").FileExtension;
             forAudioCodec: {
-                "pcm-16": {
+                aac: {
                     possible: import("./file-extensions").FileExtension[];
                     default: import("./file-extensions").FileExtension;
                 };
-                opus: {
+                "pcm-16": {
                     possible: import("./file-extensions").FileExtension[];
                     default: import("./file-extensions").FileExtension;
                 };
             };
         };
-        vp9: {
+        wav: {
             default: import("./file-extensions").FileExtension;
             forAudioCodec: {
                 "pcm-16": {
                     possible: import("./file-extensions").FileExtension[];
                     default: import("./file-extensions").FileExtension;
                 };
-                opus: {
-                    possible: import("./file-extensions").FileExtension[];
-                    default: import("./file-extensions").FileExtension;
-                };
             };
         };
         prores: {
             default: import("./file-extensions").FileExtension;
             forAudioCodec: {
-                "pcm-16": {
+                aac: {
                     possible: import("./file-extensions").FileExtension[];
                     default: import("./file-extensions").FileExtension;
                 };
-                aac: {
+                "pcm-16": {
                     possible: import("./file-extensions").FileExtension[];
                     default: import("./file-extensions").FileExtension;
                 };
@@ -291,11 +291,11 @@ export declare const RenderInternals: {
         "h264-mkv": {
             default: import("./file-extensions").FileExtension;
             forAudioCodec: {
-                "pcm-16": {
+                mp3: {
                     possible: import("./file-extensions").FileExtension[];
                     default: import("./file-extensions").FileExtension;
                 };
-                mp3: {
+                "pcm-16": {
                     possible: import("./file-extensions").FileExtension[];
                     default: import("./file-extensions").FileExtension;
                 };
@@ -304,11 +304,11 @@ export declare const RenderInternals: {
         "h264-ts": {
             default: import("./file-extensions").FileExtension;
             forAudioCodec: {
-                "pcm-16": {
+                aac: {
                     possible: import("./file-extensions").FileExtension[];
                     default: import("./file-extensions").FileExtension;
                 };
-                aac: {
+                "pcm-16": {
                     possible: import("./file-extensions").FileExtension[];
                     default: import("./file-extensions").FileExtension;
                 };
@@ -333,8 +333,8 @@ export declare const RenderInternals: {
         readonly vp9: readonly ["opus", "pcm-16"];
         readonly wav: readonly ["pcm-16"];
     };
-    makeFileExtensionMap: () => Record<string, ("aac" | "mp3" | "wav" | "h264" | "h265" | "vp8" | "vp9" | "prores" | "h264-mkv" | "h264-ts" | "gif")[]>;
-    defaultCodecsForFileExtension: Record<import("./file-extensions").FileExtension, "aac" | "mp3" | "wav" | "h264" | "h265" | "vp8" | "vp9" | "prores" | "h264-mkv" | "h264-ts" | "gif">;
+    makeFileExtensionMap: () => Record<string, ("h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv" | "h264-ts" | "gif")[]>;
+    defaultCodecsForFileExtension: Record<import("./file-extensions").FileExtension, "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv" | "h264-ts" | "gif">;
     getExecutablePath: ({ indent, logLevel, type, binariesDirectory, }: {
         type: "compositor" | "ffmpeg" | "ffprobe";
         indent: boolean;
@@ -352,8 +352,8 @@ export declare const RenderInternals: {
     }) => execa.ExecaChildProcess<string>;
     validStillImageFormats: readonly ["png", "jpeg", "pdf", "webp"];
     validVideoImageFormats: readonly ["png", "jpeg", "none"];
-    DEFAULT_STILL_IMAGE_FORMAT: "png" | "jpeg" | "pdf" | "webp";
-    DEFAULT_VIDEO_IMAGE_FORMAT: "png" | "jpeg" | "none";
+    DEFAULT_STILL_IMAGE_FORMAT: "jpeg" | "png" | "webp" | "pdf";
+    DEFAULT_VIDEO_IMAGE_FORMAT: "jpeg" | "png" | "none";
     DEFAULT_JPEG_QUALITY: number;
     chalk: {
         enabled: () => boolean;
@@ -906,14 +906,14 @@ export declare const RenderInternals: {
         hostsToTry: string[];
     };
     makeDownloadMap: () => import("./assets/download-map").DownloadMap;
-    getExtensionFromAudioCodec: (audioCodec: AudioCodec) => "aac" | "mp3" | "opus" | "wav";
+    getExtensionFromAudioCodec: (audioCodec: AudioCodec) => "mp3" | "aac" | "wav" | "opus";
     makeFileExecutableIfItIsNot: (path: string) => void;
     resolveAudioCodec: ({ codec, setting, preferLossless, separateAudioTo, }: {
         setting: AudioCodec | null;
         codec: import("./codec").Codec;
         preferLossless: boolean;
         separateAudioTo: string | null;
-    }) => "pcm-16" | "aac" | "mp3" | "opus" | null;
+    }) => "mp3" | "aac" | "pcm-16" | "opus" | null;
     getShouldRenderAudio: ({ codec, assetsInfo, enforceAudioTrack, muted, }: {
         codec: import("./codec").Codec;
         assetsInfo: import("./assets/download-map").RenderAssetInfo | null;

package/dist/make-cancel-signal.d.ts

@@ -1,9 +1,5 @@
 type Callback = () => void;
 export type CancelSignal = (callback: Callback) => void;
-/**
- * @description Returns a signal and a cancel function that allows to you cancel a render triggered using renderMedia(), renderStill(), renderFrames() or stitchFramesToVideo().
- * @see [Documentation](https://www.remotion.dev/docs/renderer/make-cancel-signal)
- */
 export declare const makeCancelSignal: () => {
     cancelSignal: CancelSignal;
     cancel: () => void;

package/dist/make-cancel-signal.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isUserCancelledRender = exports.cancelErrorMessages = exports.makeCancelSignal = void 0;
-/**
+/*
  * @description Returns a signal and a cancel function that allows to you cancel a render triggered using renderMedia(), renderStill(), renderFrames() or stitchFramesToVideo().
  * @see [Documentation](https://www.remotion.dev/docs/renderer/make-cancel-signal)
  */

package/dist/open-browser.d.ts

@@ -42,9 +42,5 @@ export type OpenBrowserOptions = {
     forceDeviceScaleFactor?: number;
 } & LogOptions;
 export declare const internalOpenBrowser: ({ browser, browserExecutable, chromiumOptions, forceDeviceScaleFactor, indent, viewport, logLevel, onBrowserDownload, }: InternalOpenBrowserOptions) => Promise<HeadlessBrowser>;
-/**
- * @description Opens a Chrome or Chromium browser instance.
- * @see [Documentation](https://www.remotion.dev/docs/renderer/open-browser)
- */
 export declare const openBrowser: (browser: Browser, options?: OpenBrowserOptions) => Promise<HeadlessBrowser>;
 export {};

package/dist/open-browser.js

@@ -161,8 +161,8 @@ const internalOpenBrowser = async ({ browser, browserExecutable, chromiumOptions
     return browserInstance;
 };
 exports.internalOpenBrowser = internalOpenBrowser;
-/**
- * @description Opens a Chrome or Chromium browser instance.
+/*
+ * @description Opens a Chrome or Chromium browser instance. By reusing an instance across various rendering and compositional API calls, significant time can be saved by avoiding the repeated opening and closing of browsers.
  * @see [Documentation](https://www.remotion.dev/docs/renderer/open-browser)
  */
 const openBrowser = (browser, options) => {

package/dist/options/index.d.ts

@@ -171,7 +171,7 @@ export declare const allOptions: {
     webhookCustomDataOption: {
         name: string;
         cliFlag: "webhook-custom-data";
-        description: (type: "ssr" | "cli") => import("react/jsx-runtime").JSX.Element;
+        description: (type: "cli" | "ssr") => import("react/jsx-runtime").JSX.Element;
         ssrName: "customData";
         docLink: string;
         type: Record<string, unknown> | null;
@@ -584,7 +584,7 @@ export declare const allOptions: {
     metadataOption: {
         name: string;
         cliFlag: "metadata";
-        description: (mode: "ssr" | "cli") => import("react/jsx-runtime").JSX.Element;
+        description: (mode: "cli" | "ssr") => import("react/jsx-runtime").JSX.Element;
         docLink: string;
         type: import("./metadata").Metadata;
         getValue: ({ commandLine }: {

package/dist/options/metadata.d.ts

@@ -2,7 +2,7 @@ export type Metadata = Record<string, string>;
 export declare const metadataOption: {
     name: string;
     cliFlag: "metadata";
-    description: (mode: "ssr" | "cli") => import("react/jsx-runtime").JSX.Element;
+    description: (mode: "cli" | "ssr") => import("react/jsx-runtime").JSX.Element;
     docLink: string;
     type: Metadata;
     getValue: ({ commandLine }: {

package/dist/options/webhook-custom-data.d.ts

@@ -1,7 +1,7 @@
 export declare const webhookCustomDataOption: {
     name: string;
     cliFlag: "webhook-custom-data";
-    description: (type: "ssr" | "cli") => import("react/jsx-runtime").JSX.Element;
+    description: (type: "cli" | "ssr") => import("react/jsx-runtime").JSX.Element;
     ssrName: "customData";
     docLink: string;
     type: Record<string, unknown> | null;

package/dist/render-frames.d.ts

@@ -90,11 +90,5 @@ export type RenderFramesOptions = {
     serveUrl: string;
 } & Partial<ToOptions<typeof optionsMap.renderFrames>>;
 export declare const internalRenderFrames: (args_0: InternalRenderFramesOptions) => Promise<RenderFramesOutput>;
-/**
- * @description Renders a series of images using Puppeteer and computes information for mixing audio.
- * @see [Documentation](https://www.remotion.dev/docs/renderer/render-frames)
- * @param {RenderFramesOptions} options Configuration options for rendering frames.
- * @returns {Promise<RenderFramesOutput>} Information about the rendered frames and assets.
- */
 export declare const renderFrames: (options: RenderFramesOptions) => Promise<RenderFramesOutput>;
 export {};

package/dist/render-frames.js

@@ -550,11 +550,9 @@ const internalRenderFramesRaw = ({ browserExecutable, cancelSignal, chromiumOpti
     });
 };
 exports.internalRenderFrames = (0, wrap_with_error_handling_1.wrapWithErrorHandling)(internalRenderFramesRaw);
-/**
+/*
  * @description Renders a series of images using Puppeteer and computes information for mixing audio.
  * @see [Documentation](https://www.remotion.dev/docs/renderer/render-frames)
- * @param {RenderFramesOptions} options Configuration options for rendering frames.
- * @returns {Promise<RenderFramesOutput>} Information about the rendered frames and assets.
  */
 const renderFrames = (options) => {
     const { composition, inputProps, onFrameUpdate, onStart, outputDir, serveUrl, browserExecutable, cancelSignal, chromiumOptions, concurrency, dumpBrowserLogs, envVariables, everyNthFrame, frameRange, imageFormat, jpegQuality, muted, onBrowserLog, onDownload, onFrameBuffer, port, puppeteerInstance, scale, timeoutInMilliseconds, verbose, quality, logLevel: passedLogLevel, offthreadVideoCacheSizeInBytes, binariesDirectory, onBrowserDownload, onArtifact, } = options;

package/dist/render-media.d.ts

@@ -128,12 +128,5 @@ type RenderMediaResult = {
     slowestFrames: SlowFrame[];
 };
 export declare const internalRenderMedia: (args_0: InternalRenderMediaOptions) => Promise<RenderMediaResult>;
-/**
- * Render a video from a composition. You can specify various options such as the codec, output location, input properties, and more.
- * @see [Documentation](https://remotion.dev/docs/renderer/render-media)
- * @param {RenderMediaOptions} options Configuration options for rendering the media.
- * @returns {Promise<RenderMediaResult>} A promise that resolves to the rendering result, including a buffer and information about the slowest frames.
- *
- */
 export declare const renderMedia: ({ proResProfile, x264Preset, crf, composition, inputProps, pixelFormat, codec, envVariables, frameRange, puppeteerInstance, outputLocation, onProgress, overwrite, onDownload, onBrowserLog, onStart, timeoutInMilliseconds, chromiumOptions, scale, browserExecutable, port, cancelSignal, muted, enforceAudioTrack, ffmpegOverride, audioBitrate, videoBitrate, encodingMaxRate, encodingBufferSize, audioCodec, jpegQuality, concurrency, serveUrl, disallowParallelEncoding, everyNthFrame, imageFormat, numberOfGifLoops, dumpBrowserLogs, preferLossless, verbose, quality, logLevel: passedLogLevel, offthreadVideoCacheSizeInBytes, colorSpace, repro, binariesDirectory, separateAudioTo, forSeamlessAacConcatenation, onBrowserDownload, onArtifact, metadata, hardwareAcceleration, }: RenderMediaOptions) => Promise<RenderMediaResult>;
 export {};

package/dist/render-media.js

@@ -501,12 +501,9 @@ const internalRenderMediaRaw = ({ proResProfile, x264Preset, crf, composition, s
     });
 };
 exports.internalRenderMedia = (0, wrap_with_error_handling_1.wrapWithErrorHandling)(internalRenderMediaRaw);
-/**
- * Render a video from a composition. You can specify various options such as the codec, output location, input properties, and more.
- * @see [Documentation](https://remotion.dev/docs/renderer/render-media)
- * @param {RenderMediaOptions} options Configuration options for rendering the media.
- * @returns {Promise<RenderMediaResult>} A promise that resolves to the rendering result, including a buffer and information about the slowest frames.
- *
+/*
+ * @description Render a video or an audio programmatically.
+ * @see [Documentation](https://www.remotion.dev/docs/renderer/render-media)
  */
 const renderMedia = ({ proResProfile, x264Preset, crf, composition, inputProps, pixelFormat, codec, envVariables, frameRange, puppeteerInstance, outputLocation, onProgress, overwrite, onDownload, onBrowserLog, onStart, timeoutInMilliseconds, chromiumOptions, scale, browserExecutable, port, cancelSignal, muted, enforceAudioTrack, ffmpegOverride, audioBitrate, videoBitrate, encodingMaxRate, encodingBufferSize, audioCodec, jpegQuality, concurrency, serveUrl, disallowParallelEncoding, everyNthFrame, imageFormat, numberOfGifLoops, dumpBrowserLogs, preferLossless, verbose, quality, logLevel: passedLogLevel, offthreadVideoCacheSizeInBytes, colorSpace, repro, binariesDirectory, separateAudioTo, forSeamlessAacConcatenation, onBrowserDownload, onArtifact, metadata, hardwareAcceleration, }) => {
     var _a, _b;

package/dist/render-still.d.ts

@@ -69,11 +69,5 @@ type RenderStillReturnValue = {
     buffer: Buffer | null;
 };
 export declare const internalRenderStill: (options: InternalRenderStillOptions) => Promise<RenderStillReturnValue>;
-/**
- * @description Renders a single frame to an image and writes it to the specified output location.
- * @see [Documentation](https://remotion.dev/docs/renderer/render-still)
- * @param {RenderStillOptions} options Configuration options for rendering the still image
- * @returns {Promise<RenderStillReturnValue>} A promise that resolves to an object with a buffer key containing the image data if no output path is defined, otherwise null.
- */
 export declare const renderStill: (options: RenderStillOptions) => Promise<RenderStillReturnValue>;
 export {};

package/dist/render-still.js

@@ -264,11 +264,9 @@ const internalRenderStillRaw = (options) => {
     ]);
 };
 exports.internalRenderStill = (0, wrap_with_error_handling_1.wrapWithErrorHandling)(internalRenderStillRaw);
-/**
+/*
  * @description Renders a single frame to an image and writes it to the specified output location.
- * @see [Documentation](https://remotion.dev/docs/renderer/render-still)
- * @param {RenderStillOptions} options Configuration options for rendering the still image
- * @returns {Promise<RenderStillReturnValue>} A promise that resolves to an object with a buffer key containing the image data if no output path is defined, otherwise null.
+ * @see [Documentation](https://www.remotion.dev/docs/renderer/render-still)
  */
 const renderStill = (options) => {
     var _a, _b;

package/dist/select-composition.d.ts

@@ -41,9 +41,5 @@ type InternalReturnType = {
 };
 export declare const internalSelectCompositionRaw: (options: InternalSelectCompositionsConfig) => Promise<InternalReturnType>;
 export declare const internalSelectComposition: (options: InternalSelectCompositionsConfig) => Promise<InternalReturnType>;
-/**
- * @description Gets a composition defined in a Remotion project based on a Webpack bundle.
- * @see [Documentation](https://www.remotion.dev/docs/renderer/select-composition)
- */
 export declare const selectComposition: (options: SelectCompositionOptions) => Promise<VideoConfig>;
 export {};

package/dist/select-composition.js

@@ -172,8 +172,8 @@ const internalSelectCompositionRaw = async (options) => {
 };
 exports.internalSelectCompositionRaw = internalSelectCompositionRaw;
 exports.internalSelectComposition = (0, wrap_with_error_handling_1.wrapWithErrorHandling)(exports.internalSelectCompositionRaw);
-/**
- * @description Gets a composition defined in a Remotion project based on a Webpack bundle.
+/*
+ * @description Evaluates the list of compositions from a Remotion Bundle by evaluating the Remotion Root and evaluating `calculateMetadata()` on the specified composition.
  * @see [Documentation](https://www.remotion.dev/docs/renderer/select-composition)
  */
 const selectComposition = async (options) => {

package/dist/stitch-frames-to-video.d.ts

@@ -73,11 +73,5 @@ export type StitchFramesToVideoOptions = {
     metadata?: Record<string, string> | null;
 } & Partial<ToOptions<typeof optionsMap.stitchFramesToVideo>>;
 export declare const internalStitchFramesToVideo: (options: InternalStitchFramesToVideoOptions) => Promise<Buffer | null>;
-/**
- * Takes a series of images and audio information generated by renderFrames() and encodes it to a video.
- * @see [Documentation](https://www.remotion.dev/docs/renderer/stitch-frames-to-video)
- * @param {StitchFramesToVideoOptions} options The configuration options for stitching frames into a video
- * @returns {Promise<Buffer | null>} A promise that resolves with the video buffer or null if the output was written to a file
- */
 export declare const stitchFramesToVideo: ({ assetsInfo, force, fps, height, width, audioBitrate, audioCodec, cancelSignal, codec, crf, enforceAudioTrack, ffmpegOverride, muted, numberOfGifLoops, onDownload, onProgress, outputLocation, pixelFormat, proResProfile, verbose, videoBitrate, maxRate, bufferSize, x264Preset, colorSpace, binariesDirectory, separateAudioTo, metadata, hardwareAcceleration, }: StitchFramesToVideoOptions) => Promise<Buffer | null>;
 export {};

package/dist/stitch-frames-to-video.js

@@ -303,11 +303,9 @@ const internalStitchFramesToVideo = (options) => {
     ]);
 };
 exports.internalStitchFramesToVideo = internalStitchFramesToVideo;
-/**
- * Takes a series of images and audio information generated by renderFrames() and encodes it to a video.
+/*
+ * @description Takes a series of images and audio information generated by renderFrames() and encodes it to a video.
  * @see [Documentation](https://www.remotion.dev/docs/renderer/stitch-frames-to-video)
- * @param {StitchFramesToVideoOptions} options The configuration options for stitching frames into a video
- * @returns {Promise<Buffer | null>} A promise that resolves with the video buffer or null if the output was written to a file
  */
 const stitchFramesToVideo = ({ assetsInfo, force, fps, height, width, audioBitrate, audioCodec, cancelSignal, codec, crf, enforceAudioTrack, ffmpegOverride, muted, numberOfGifLoops, onDownload, onProgress, outputLocation, pixelFormat, proResProfile, verbose, videoBitrate, maxRate, bufferSize, x264Preset, colorSpace, binariesDirectory, separateAudioTo, metadata, hardwareAcceleration, }) => {
     return (0, exports.internalStitchFramesToVideo)({

package/package.json

@@ -3,7 +3,7 @@
     "url": "https://github.com/remotion-dev/remotion/tree/main/packages/renderer"
   },
   "name": "@remotion/renderer",
-  "version": "4.0.243",
+  "version": "4.0.245",
   "description": "Render Remotion videos using Node.js or Bun",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -18,8 +18,8 @@
     "extract-zip": "2.0.1",
     "source-map": "^0.8.0-beta.0",
     "ws": "8.17.1",
-    "remotion": "4.0.243",
-    "@remotion/streaming": "4.0.243"
+    "remotion": "4.0.245",
+    "@remotion/streaming": "4.0.245"
   },
   "peerDependencies": {
     "react": ">=16.8.0",
@@ -33,17 +33,17 @@
     "react-dom": "19.0.0",
     "@types/ws": "8.5.10",
     "eslint": "9.14.0",
-    "@remotion/example-videos": "4.0.243",
-    "@remotion/eslint-config-internal": "4.0.243"
+    "@remotion/example-videos": "4.0.245",
+    "@remotion/eslint-config-internal": "4.0.245"
   },
   "optionalDependencies": {
-    "@remotion/compositor-darwin-arm64": "4.0.243",
-    "@remotion/compositor-darwin-x64": "4.0.243",
-    "@remotion/compositor-linux-arm64-musl": "4.0.243",
-    "@remotion/compositor-linux-x64-gnu": "4.0.243",
-    "@remotion/compositor-linux-x64-musl": "4.0.243",
-    "@remotion/compositor-win32-x64-msvc": "4.0.243",
-    "@remotion/compositor-linux-arm64-gnu": "4.0.243"
+    "@remotion/compositor-darwin-arm64": "4.0.245",
+    "@remotion/compositor-darwin-x64": "4.0.245",
+    "@remotion/compositor-linux-arm64-musl": "4.0.245",
+    "@remotion/compositor-linux-arm64-gnu": "4.0.245",
+    "@remotion/compositor-linux-x64-musl": "4.0.245",
+    "@remotion/compositor-linux-x64-gnu": "4.0.245",
+    "@remotion/compositor-win32-x64-msvc": "4.0.245"
   },
   "keywords": [
     "remotion",