@remotion/studio
Version:
APIs for interacting with the Remotion Studio
113 lines (112 loc) • 6.38 kB
TypeScript
import type { EnumPath, RecastCodemod, RenderJob, VisualControlChange } from '@remotion/studio-shared';
export declare const addStillRenderJob: ({ compositionId, outName, imageFormat, jpegQuality, frame, scale, logLevel, chromiumOptions, delayRenderTimeout, envVariables, inputProps, offthreadVideoCacheSizeInBytes, offthreadVideoThreads, multiProcessOnLinux, beepOnFinish, metadata, chromeMode, mediaCacheSizeInBytes, }: {
compositionId: string;
outName: string;
imageFormat: "jpeg" | "pdf" | "png" | "webp";
jpegQuality: number;
frame: number;
scale: number;
logLevel: "error" | "info" | "trace" | "verbose" | "warn";
chromiumOptions: Required<import("@remotion/renderer").ChromiumOptions>;
delayRenderTimeout: number;
envVariables: Record<string, string>;
inputProps: Record<string, unknown>;
offthreadVideoCacheSizeInBytes: number | null;
offthreadVideoThreads: number | null;
multiProcessOnLinux: boolean;
beepOnFinish: boolean;
metadata: Record<string, string> | null;
chromeMode: "chrome-for-testing" | "headless-shell";
mediaCacheSizeInBytes: number | null;
}) => Promise<undefined>;
export declare const addSequenceRenderJob: ({ compositionId, outName, imageFormat, startFrame, endFrame, scale, logLevel, chromiumOptions, delayRenderTimeout, envVariables, inputProps, concurrency, offthreadVideoCacheSizeInBytes, offthreadVideoThreads, jpegQuality, disallowParallelEncoding, multiProcessOnLinux, beepOnFinish, repro, metadata, chromeMode, mediaCacheSizeInBytes, }: {
compositionId: string;
outName: string;
imageFormat: "jpeg" | "none" | "png";
jpegQuality: number;
startFrame: number;
endFrame: number;
scale: number;
logLevel: "error" | "info" | "trace" | "verbose" | "warn";
chromiumOptions: Required<import("@remotion/renderer").ChromiumOptions>;
concurrency: number;
delayRenderTimeout: number;
envVariables: Record<string, string>;
inputProps: Record<string, unknown>;
offthreadVideoCacheSizeInBytes: number | null;
offthreadVideoThreads: number | null;
disallowParallelEncoding: boolean;
multiProcessOnLinux: boolean;
beepOnFinish: boolean;
repro: boolean;
metadata: Record<string, string> | null;
chromeMode: "chrome-for-testing" | "headless-shell";
mediaCacheSizeInBytes: number | null;
}) => Promise<undefined>;
export declare const addVideoRenderJob: ({ compositionId, outName, imageFormat, jpegQuality, scale, logLevel, codec, concurrency, crf, startFrame, endFrame, muted, enforceAudioTrack, proResProfile, x264Preset, pixelFormat, audioBitrate, videoBitrate, everyNthFrame, numberOfGifLoops, delayRenderTimeout, audioCodec, disallowParallelEncoding, chromiumOptions, envVariables, inputProps, offthreadVideoCacheSizeInBytes, offthreadVideoThreads, colorSpace, multiProcessOnLinux, encodingMaxRate, encodingBufferSize, beepOnFinish, repro, forSeamlessAacConcatenation, separateAudioTo, metadata, hardwareAcceleration, chromeMode, mediaCacheSizeInBytes, }: {
compositionId: string;
outName: string;
imageFormat: "jpeg" | "none" | "png";
jpegQuality: number | null;
scale: number;
logLevel: "error" | "info" | "trace" | "verbose" | "warn";
codec: "aac" | "av1" | "gif" | "h264" | "h264-mkv" | "h264-ts" | "h265" | "mp3" | "prores" | "vp8" | "vp9" | "wav";
concurrency: number;
crf: number | null;
startFrame: number;
endFrame: number;
muted: boolean;
enforceAudioTrack: boolean;
proResProfile: "4444" | "4444-xq" | "hq" | "light" | "proxy" | "standard" | null;
x264Preset: "fast" | "faster" | "medium" | "placebo" | "slow" | "slower" | "superfast" | "ultrafast" | "veryfast" | "veryslow" | null;
pixelFormat: "yuv420p" | "yuv420p10le" | "yuv422p" | "yuv422p10le" | "yuv444p" | "yuv444p10le" | "yuva420p" | "yuva444p10le";
audioBitrate: string | null;
videoBitrate: string | null;
everyNthFrame: number;
numberOfGifLoops: number | null;
delayRenderTimeout: number;
audioCodec: "aac" | "mp3" | "opus" | "pcm-16";
disallowParallelEncoding: boolean;
chromiumOptions: Required<import("@remotion/renderer").ChromiumOptions>;
envVariables: Record<string, string>;
inputProps: Record<string, unknown>;
offthreadVideoCacheSizeInBytes: number | null;
offthreadVideoThreads: number | null;
colorSpace: "bt2020-ncl" | "bt601" | "bt709" | "default";
multiProcessOnLinux: boolean;
encodingMaxRate: string | null;
encodingBufferSize: string | null;
beepOnFinish: boolean;
repro: boolean;
forSeamlessAacConcatenation: boolean;
separateAudioTo: string | null;
metadata: Record<string, string> | null;
hardwareAcceleration: "disable" | "if-possible" | "required";
chromeMode: "chrome-for-testing" | "headless-shell";
mediaCacheSizeInBytes: number | null;
}) => Promise<undefined>;
export declare const unsubscribeFromFileExistenceWatcher: ({ file, clientId, }: {
file: string;
clientId: string;
}) => Promise<undefined>;
export declare const subscribeToFileExistenceWatcher: ({ file, clientId, }: {
file: string;
clientId: string;
}) => Promise<boolean>;
export declare const openInFileExplorer: ({ directory }: {
directory: string;
}) => Promise<void>;
export declare const applyCodemod: ({ codemod, dryRun, signal, }: {
codemod: RecastCodemod;
dryRun: boolean;
signal: AbortSignal;
}) => Promise<import("@remotion/studio-shared").ApplyCodemodResponse>;
export declare const removeRenderJob: (job: RenderJob) => Promise<undefined>;
export declare const cancelRenderJob: (job: RenderJob) => Promise<import("@remotion/studio-shared").CancelRenderResponse>;
export declare const updateAvailable: (signal: AbortSignal) => Promise<import("@remotion/studio-shared").UpdateAvailableResponse>;
export declare const getProjectInfo: (signal: AbortSignal) => Promise<import("@remotion/studio-shared").ProjectInfoResponse>;
export declare const callUpdateDefaultPropsApi: (compositionId: string, defaultProps: Record<string, unknown>, enumPaths: EnumPath[]) => Promise<import("@remotion/studio-shared").UpdateDefaultPropsResponse>;
export declare const applyVisualControlChange: ({ fileName, changes, }: {
fileName: string;
changes: VisualControlChange[];
}) => Promise<import("@remotion/studio-shared").ApplyVisualControlResponse>;