@remotion/renderer 4.0.143 → 4.0.144

package/LICENSE.md

@@ -1,5 +1,9 @@
 # Remotion License
 
+In Remotion 5.0, the license will slightly change. [View the changes here](https://github.com/remotion-dev/remotion/pull/3750).
+
+---
+
 Depending on the type of your legal entity, you are granted permission to use Remotion for your project. Individuals and small companies are allowed to use Remotion to create videos for free (even commercial), while a company license is required for for-profit organizations of a certain size. This two-tier system was designed to ensure funding for this project while still allowing the source code to be available and the program to be free for most. Read below for the exact terms of use.
 
 - [Free license](#free-license)

package/dist/create-ffmpeg-complex-filter.d.ts

@@ -4,9 +4,6 @@ export declare const createFfmpegComplexFilter: ({ filters, downloadMap, }: {
     filters: PreprocessedAudioTrack[];
     downloadMap: DownloadMap;
 }) => Promise<{
-    complexFilterFlag: [
-        string,
-        string
-    ] | null;
+    complexFilterFlag: [string, string] | null;
     cleanup: () => void;
 }>;

package/dist/ensure-browser.d.ts

@@ -21,5 +21,11 @@ export type EnsureBrowserOptions = Partial<{
     browserExecutable: BrowserExecutable;
 } & ToOptions<typeof BrowserSafeApis.optionsMap.ensureBrowser>>;
 export declare const internalEnsureBrowser: ({ indent, logLevel, browserExecutable, onBrowserDownload, }: 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

@@ -35,6 +35,12 @@ 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.
+ */
 const ensureBrowser = (options) => {
     var _a, _b, _c, _d;
     const indent = false;

package/dist/extract-audio.d.ts

@@ -1,4 +1,13 @@
 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,6 +2,15 @@
 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.
+ */
 const extractAudio = async (options) => {
     var _a, _b;
     const compositor = (0, compositor_1.startLongRunningCompositor)({

package/dist/get-compositions.d.ts

@@ -30,7 +30,10 @@ export type GetCompositionsOptions = RequiredInputPropsInV5 & {
 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://www.remotion.dev/docs/renderer/get-compositions)
+ * @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

@@ -148,7 +148,10 @@ 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://www.remotion.dev/docs/renderer/get-compositions)
+ * @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.
  */
 const getCompositions = (serveUrlOrWebpackUrl, config) => {
     if (!serveUrlOrWebpackUrl) {

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

@@ -1,6 +1,18 @@
 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 | undefined;

package/dist/get-silent-parts.js

@@ -2,6 +2,18 @@
 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
+ */
 const getSilentParts = async ({ src, noiseThresholdInDecibels: passedNoiseThresholdInDecibels, minDurationInSeconds: passedMinDuration, logLevel, binariesDirectory, }) => {
     const compositor = (0, compositor_1.startLongRunningCompositor)({
         maximumFrameCacheItemsInBytes: null,

package/dist/port-config.d.ts

@@ -1,11 +1,11 @@
 /// <reference types="node" />
-/// <reference types="node" />
 /// <reference types="bun-types" />
 /// <reference types="node" />
 /// <reference types="node" />
 /// <reference types="node" />
 /// <reference types="bun-types" />
 /// <reference types="bun-types" />
+/// <reference types="node" />
 import type { NetworkInterfaceInfo } from 'os';
 import os from 'os';
 type PortConfig = {

package/dist/render-frames.d.ts

@@ -86,5 +86,7 @@ export declare const internalRenderFrames: (args_0: InternalRenderFramesOptions)
 /**
  * @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>;

package/dist/render-frames.js

@@ -518,6 +518,8 @@ exports.internalRenderFrames = (0, wrap_with_error_handling_1.wrapWithErrorHandl
 /**
  * @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, } = options;

package/dist/render-media.d.ts

@@ -125,9 +125,11 @@ type RenderMediaResult = {
 };
 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.
  *
- * @description Render a video from a composition
- * @see [Documentation](https://www.remotion.dev/docs/renderer/render-media)
  */
 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, }: RenderMediaOptions) => Promise<RenderMediaResult>;
 export {};

package/dist/render-media.js

@@ -482,9 +482,11 @@ 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 from a composition
- * @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, }) => {
     var _a, _b;

package/dist/render-still.d.ts

@@ -68,9 +68,10 @@ type RenderStillReturnValue = {
 };
 export declare const internalRenderStill: (options: InternalRenderStillOptions) => Promise<RenderStillReturnValue>;
 /**
- *
- * @description Render a still frame from a composition
- * @see [Documentation](https://www.remotion.dev/docs/renderer/render-still)
+ * @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

@@ -256,9 +256,10 @@ const internalRenderStillRaw = (options) => {
 };
 exports.internalRenderStill = (0, wrap_with_error_handling_1.wrapWithErrorHandling)(internalRenderStillRaw);
 /**
- *
- * @description Render a still frame from a composition
- * @see [Documentation](https://www.remotion.dev/docs/renderer/render-still)
+ * @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.
  */
 const renderStill = (options) => {
     var _a, _b;

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

@@ -73,8 +73,10 @@ export type StitchFramesToVideoOptions = {
 } & Partial<ToOptions<typeof optionsMap.stitchFramesToVideo>>;
 export declare const internalStitchFramesToVideo: (options: InternalStitchFramesToVideoOptions) => Promise<Buffer | null>;
 /**
- * @description Takes a series of images and audio information generated by renderFrames() and encodes it to a video.
+ * 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, encodingMaxRate, encodingBufferSize, x264Preset, colorSpace, binariesDirectory, separateAudioTo, }: StitchFramesToVideoOptions) => Promise<Buffer | null>;
 export {};

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

@@ -292,8 +292,10 @@ const internalStitchFramesToVideo = async (options) => {
 };
 exports.internalStitchFramesToVideo = internalStitchFramesToVideo;
 /**
- * @description Takes a series of images and audio information generated by renderFrames() and encodes it to a video.
+ * 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, encodingMaxRate, encodingBufferSize, x264Preset, colorSpace, binariesDirectory, separateAudioTo, }) => {
     return (0, exports.internalStitchFramesToVideo)({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remotion/renderer",
-  "version": "4.0.143",
+  "version": "4.0.144",
   "description": "Renderer for Remotion",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -18,7 +18,7 @@
     "extract-zip": "2.0.1",
     "source-map": "^0.8.0-beta.0",
     "ws": "8.7.0",
-    "remotion": "4.0.143"
+    "remotion": "4.0.144"
   },
   "peerDependencies": {
     "react": ">=16.8.0",
@@ -43,13 +43,13 @@
     "@types/ws": "8.5.10"
   },
   "optionalDependencies": {
-    "@remotion/compositor-darwin-arm64": "4.0.143",
-    "@remotion/compositor-darwin-x64": "4.0.143",
-    "@remotion/compositor-linux-arm64-gnu": "4.0.143",
-    "@remotion/compositor-linux-arm64-musl": "4.0.143",
-    "@remotion/compositor-linux-x64-gnu": "4.0.143",
-    "@remotion/compositor-linux-x64-musl": "4.0.143",
-    "@remotion/compositor-win32-x64-msvc": "4.0.143"
+    "@remotion/compositor-darwin-arm64": "4.0.144",
+    "@remotion/compositor-darwin-x64": "4.0.144",
+    "@remotion/compositor-linux-arm64-gnu": "4.0.144",
+    "@remotion/compositor-linux-arm64-musl": "4.0.144",
+    "@remotion/compositor-linux-x64-gnu": "4.0.144",
+    "@remotion/compositor-linux-x64-musl": "4.0.144",
+    "@remotion/compositor-win32-x64-msvc": "4.0.144"
   },
   "keywords": [
     "remotion",