🎥 Make videos programmatically with React
import type {
AudioCodec,
ChromeMode,
Codec,
ColorSpace,
LogLevel,
makeCancelSignal,
PixelFormat,
StillImageFormat,
StitchingState,
VideoImageFormat,
X264Preset,
} from '@remotion/renderer';
type BaseRenderProgress = {
message: string;
value: number;
};
export type RenderingProgressInput = {
frames: number;
totalFrames: number;
doneIn: number | null;
timeRemainingInMilliseconds: number | null;
};
export type StitchingProgressInput = {
frames: number;
totalFrames: number;
doneIn: number | null;
stage: StitchingState;
codec: Codec;
};
export type DownloadProgress = {
name: string;
id: number;
progress: number | null;
totalBytes: number | null;
downloaded: number;
};
export type CopyingState = {
bytes: number;
doneIn: number | null;
};
export type BundlingState = {
progress: number;
doneIn: number | null;
};
export type BrowserDownloadState = {
progress: number;
doneIn: number | null;
alreadyAvailable: boolean;
error?: boolean;
};
export type BrowserProgressLog = {
logLevel: LogLevel;
previewString: string;
tag: string | null;
};
export type AggregateRenderProgress = {
rendering: RenderingProgressInput | null;
stitching: StitchingProgressInput | null;
downloads: DownloadProgress[];
bundling: BundlingState | null;
browser: BrowserDownloadState;
copyingState: CopyingState;
artifactState: ArtifactProgress;
logs: BrowserProgressLog[];
};
export type ReceivedArtifact = {
filename: string;
absoluteOutputDestination: string;
relativeOutputDestination: string;
sizeInBytes: number;
alreadyExisted: boolean;
};
export type ArtifactProgress = {
received: ReceivedArtifact[];
};
export type JobProgressCallback = (
options: BaseRenderProgress & AggregateRenderProgress,
) => void;
type RenderJobDynamicStatus =
| {
status: 'done';
progress: BaseRenderProgress & AggregateRenderProgress;
}
| {
status: 'running';
progress: BaseRenderProgress & AggregateRenderProgress;
}
| {
status: 'idle';
}
| {
status: 'failed';
error: {
message: string;
stack: string | undefined;
};
};
type RenderJobDynamicFields =
| ({
type: 'still';
imageFormat: StillImageFormat;
jpegQuality: number;
frame: number;
scale: number;
offthreadVideoCacheSizeInBytes: number | null;
mediaCacheSizeInBytes: number | null;
offthreadVideoThreads: number | null;
licenseKey: string | null;
} & RenderJobDynamicStatus)
| ({
type: 'sequence';
imageFormat: VideoImageFormat;
jpegQuality: number | null;
scale: number;
concurrency: number;
startFrame: number;
endFrame: number;
offthreadVideoCacheSizeInBytes: number | null;
mediaCacheSizeInBytes: number | null;
offthreadVideoThreads: number | null;
} & RenderJobDynamicStatus)
| ({
type: 'video';
imageFormat: VideoImageFormat;
jpegQuality: number | null;
scale: number;
codec: Codec;
audioCodec: AudioCodec;
concurrency: number;
crf: number | null;
gopSize: number | null;
startFrame: number;
endFrame: number;
muted: boolean;
enforceAudioTrack: boolean;
proResProfile: _InternalTypes['ProResProfile'] | null;
x264Preset: X264Preset | null;
pixelFormat: PixelFormat;
audioBitrate: string | null;
videoBitrate: string | null;
encodingBufferSize: string | null;
encodingMaxRate: string | null;
everyNthFrame: number;
numberOfGifLoops: number | null;
disallowParallelEncoding: boolean;
offthreadVideoCacheSizeInBytes: number | null;
mediaCacheSizeInBytes: number | null;
offthreadVideoThreads: number | null;
colorSpace: ColorSpace;
forSeamlessAacConcatenation: boolean;
separateAudioTo: string | null;
hardwareAcceleration: HardwareAccelerationOption;
sampleRate: number;
licenseKey: string | null;
} & RenderJobDynamicStatus);
import type {ChromiumOptions, OpenGlRenderer} from '@remotion/renderer';
import type {HardwareAccelerationOption} from '@remotion/renderer/client';
import type {_InternalTypes} from 'remotion';
export type RequiredChromiumOptions = Required<ChromiumOptions>;
export type UiOpenGlOptions = OpenGlRenderer | 'default';
export type RenderJob = {
startedAt: number;
compositionId: string;
id: string;
outName: string;
deletedOutputLocation: boolean;
logLevel: LogLevel;
delayRenderTimeout: number;
cancelToken: ReturnType<typeof makeCancelSignal>;
chromiumOptions: RequiredChromiumOptions;
envVariables: Record<string, string>;
serializedInputPropsWithCustomSchema: string;
multiProcessOnLinux: boolean;
beepOnFinish: boolean;
repro: boolean;
binariesDirectory: string | null;
metadata: Record<string, string> | null;
chromeMode: ChromeMode;
} & RenderJobDynamicFields;
export type RenderJobWithCleanup = RenderJob & {
cleanup: (() => void)[];
};
export type CompletedClientRender = {
id: string;
type: 'client-video' | 'client-still';
compositionId: string;
outName: string;
startedAt: number;
deletedOutputLocation: boolean;
metadata: {
width: number;
height: number;
sizeInBytes: number;
};
};