🎥 Make videos programmatically with React
import type {VideoConfig} from 'remotion/no-react';
import type {RenderMediaOnDownload} from './assets/download-and-map-assets-to-file';
import type {DownloadMap} from './assets/download-map';
import type {Page} from './browser/BrowserPage';
import type {CountType} from './get-frame-padded-index';
import type {VideoImageFormat} from './image-format';
import type {LogLevel} from './log-level';
import type {CancelSignal} from './make-cancel-signal';
import type {
CapturedFrame,
RemotionSharedMemoryCapture,
} from './remotion-shared-memory';
import {renderFrameWithOptionToReject} from './render-frame-with-option-to-reject';
import type {AssetIndex, FrameAndAssets, OnArtifact} from './render-frames';
export const renderFrame = ({
attempt,
binariesDirectory,
cancelSignal,
imageFormat,
indent,
logLevel,
assets,
assetIndex,
countType,
downloadMap,
frameDir,
framesToRender,
jpegQuality,
onArtifact,
onDownload,
scale,
composition,
onError,
outputDir,
stoppedSignal,
timeoutInMilliseconds,
lastFrame,
onFrameBuffer,
onFrame,
remotionSharedMemory,
onFrameUpdate,
framesRenderedObj,
frame,
page,
imageSequencePattern,
trimLeftOffset,
trimRightOffset,
allFramesAndExtraFrames,
}: {
attempt: number;
indent: boolean;
logLevel: LogLevel;
imageFormat: VideoImageFormat;
cancelSignal: CancelSignal | undefined;
binariesDirectory: string | null;
jpegQuality: number;
frameDir: string;
scale: number;
countType: CountType;
assets: FrameAndAssets[];
assetIndex: AssetIndex;
framesToRender: number[];
onArtifact: OnArtifact | null;
onDownload: RenderMediaOnDownload | null;
downloadMap: DownloadMap;
composition: Omit<VideoConfig, 'defaultProps' | 'props'>;
onError: (err: Error) => void;
stoppedSignal: {stopped: boolean};
timeoutInMilliseconds: number;
outputDir: string | null;
onFrameBuffer:
| null
| ((buffer: Buffer, frame: number) => void | Promise<void>)
| undefined;
onFrame:
| null
| ((frame: CapturedFrame, frameNumber: number) => void | Promise<void>);
remotionSharedMemory: RemotionSharedMemoryCapture | null;
lastFrame: number;
onFrameUpdate:
| null
| ((
framesRendered: number,
frameIndex: number,
timeToRenderInMilliseconds: number,
) => void);
framesRenderedObj: {count: number};
frame: number;
page: Page;
imageSequencePattern: string | null;
trimLeftOffset: number;
trimRightOffset: number;
allFramesAndExtraFrames: number[];
}) => {
return new Promise<void>((resolve, reject) => {
renderFrameWithOptionToReject({
reject,
width: composition.width,
height: composition.height,
compId: composition.id,
attempt,
indent,
logLevel,
stoppedSignal,
timeoutInMilliseconds,
imageFormat,
onFrameBuffer,
onFrame,
remotionSharedMemory,
outputDir,
assets,
assetIndex,
binariesDirectory,
cancelSignal,
countType,
downloadMap,
frameDir,
framesToRender,
jpegQuality,
lastFrame,
onArtifact,
onDownload,
onError,
scale,
framesRenderedObj,
onFrameUpdate,
frame,
page,
imageSequencePattern,
fps: composition.fps,
trimLeftOffset,
trimRightOffset,
allFramesAndExtraFrames,
})
.then(() => {
resolve();
})
.catch((err) => {
reject(err);
});
});
};