@remotion/cli
Version:
Control Remotion features using the `npx remotion` command
73 lines (72 loc) • 4.2 kB
TypeScript
import type { BrowserExecutable, CancelSignal, ChromiumOptions, Crf, FfmpegOverrideFn, FrameRange, NumberOfGifLoops } from '@remotion/renderer';
import type { JobProgressCallback } from '@remotion/studio-server';
export declare const renderVideoFlow: ({ remotionRoot, fullEntryPoint, indent, logLevel, browserExecutable, browser, chromiumOptions, scale, shouldOutputImageSequence, publicDir, envVariables, puppeteerTimeout, port, height, width, fps, durationInFrames, remainingArgs, compositionIdFromUi, entryPointReason, overwrite, quiet, concurrency, frameRange, everyNthFrame, outputLocationFromUI, jpegQuality, onProgress, addCleanupCallback, cancelSignal, crf, gopSize, uiCodec, uiImageFormat, ffmpegOverride, audioBitrate, muted, enforceAudioTrack, proResProfile, x264Preset, pixelFormat, videoBitrate, encodingMaxRate, encodingBufferSize, numberOfGifLoops, audioCodec, serializedInputPropsWithCustomSchema, disallowParallelEncoding, offthreadVideoCacheSizeInBytes, offthreadVideoThreads, colorSpace, repro, binariesDirectory, forSeamlessAacConcatenation, separateAudioTo, publicPath, metadata, hardwareAcceleration, chromeMode, audioLatencyHint, imageSequencePattern, mediaCacheSizeInBytes, rspack, askAIEnabled, experimentalClientSideRenderingEnabled, keyboardShortcutsEnabled, shouldCache, sampleRate, }: {
remotionRoot: string;
fullEntryPoint: string;
entryPointReason: string;
browserExecutable: BrowserExecutable;
chromiumOptions: ChromiumOptions;
logLevel: "error" | "info" | "trace" | "verbose" | "warn";
browser: "chrome";
scale: number;
indent: boolean;
shouldOutputImageSequence: boolean;
publicDir: string | null;
serializedInputPropsWithCustomSchema: string;
envVariables: Record<string, string>;
puppeteerTimeout: number;
port: number | null;
height: number | null;
width: number | null;
fps: number | null;
durationInFrames: number | null;
remainingArgs: (string | number)[];
compositionIdFromUi: string | null;
outputLocationFromUI: string | null;
overwrite: boolean;
quiet: boolean;
concurrency: string | number | null;
frameRange: FrameRange | null;
everyNthFrame: number;
jpegQuality: number | undefined;
onProgress: JobProgressCallback;
addCleanupCallback: (label: string, cb: () => void) => void;
crf: Crf | null;
gopSize: number | null;
cancelSignal: CancelSignal | null;
uiCodec: "aac" | "av1" | "gif" | "h264" | "h264-mkv" | "h264-ts" | "h265" | "mp3" | "prores" | "vp8" | "vp9" | "wav" | null;
uiImageFormat: "jpeg" | "none" | "png" | null;
ffmpegOverride: FfmpegOverrideFn;
audioBitrate: string | null;
videoBitrate: string | null;
encodingMaxRate: string | null;
encodingBufferSize: string | null;
muted: boolean;
enforceAudioTrack: boolean;
proResProfile: "4444" | "4444-xq" | "hq" | "light" | "proxy" | "standard" | undefined;
x264Preset: "fast" | "faster" | "medium" | "placebo" | "slow" | "slower" | "superfast" | "ultrafast" | "veryfast" | "veryslow" | null;
pixelFormat: "yuv420p" | "yuv420p10le" | "yuv422p" | "yuv422p10le" | "yuv444p" | "yuv444p10le" | "yuva420p" | "yuva444p10le" | null;
numberOfGifLoops: NumberOfGifLoops;
audioCodec: "aac" | "mp3" | "opus" | "pcm-16" | null;
disallowParallelEncoding: boolean;
offthreadVideoCacheSizeInBytes: number | null;
offthreadVideoThreads: number | null;
colorSpace: "bt2020-ncl" | "bt601" | "bt709" | "default" | null;
repro: boolean;
binariesDirectory: string | null;
forSeamlessAacConcatenation: boolean;
separateAudioTo: string | null;
publicPath: string | null;
metadata: Record<string, string> | null;
hardwareAcceleration: "disable" | "if-possible" | "required";
chromeMode: "chrome-for-testing" | "headless-shell";
audioLatencyHint: AudioContextLatencyCategory | null;
imageSequencePattern: string | null;
mediaCacheSizeInBytes: number | null;
rspack: boolean;
askAIEnabled: boolean;
experimentalClientSideRenderingEnabled: boolean;
keyboardShortcutsEnabled: boolean;
shouldCache: boolean;
sampleRate: number;
}) => Promise<void>;