@remotion/cli
Version:
Control Remotion features using the `npx remotion` command
1,247 lines (1,246 loc) • 40.1 kB
TypeScript
import type { AudioCodec, StillImageFormat, VideoImageFormat } from '@remotion/renderer';
import type { TypeOfOption } from '@remotion/renderer/client';
declare const allowHtmlInCanvasOption: {
name: string;
cliFlag: "allow-html-in-canvas";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: null;
docLink: string;
type: boolean;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
value: boolean;
source: string;
};
setConfig(value: boolean): void;
id: "allow-html-in-canvas";
}, benchmarkConcurrenciesOption: {
name: string;
cliFlag: "concurrencies";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: null;
docLink: string;
type: string | null;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
value: string;
source: string;
} | {
value: null;
source: string;
};
setConfig: (value: string | null) => void;
id: "concurrencies";
}, beepOnFinishOption: {
name: string;
cliFlag: "beep-on-finish";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: null;
docLink: string;
type: boolean;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
value: boolean;
source: string;
};
setConfig(value: boolean): void;
id: "beep-on-finish";
}, colorSpaceOption: {
name: string;
cliFlag: "color-space";
description: () => import("react/jsx-runtime").JSX.Element;
docLink: string;
ssrName: string;
type: "bt2020-ncl" | "bt601" | "bt709" | "default" | null;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
source: string;
value: "bt2020-ncl" | "bt601" | "bt709" | "default";
};
setConfig: (value: "bt2020-ncl" | "bt601" | "bt709" | "default" | null) => void;
id: "color-space";
}, concurrencyOption: {
name: string;
cliFlag: "concurrency";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: "concurrency";
docLink: string;
type: import("@remotion/renderer").Concurrency;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
source: string;
value: import("@remotion/renderer").Concurrency;
};
setConfig: (value: import("@remotion/renderer").Concurrency) => void;
id: "concurrency";
}, disallowParallelEncodingOption: {
name: string;
cliFlag: "disallow-parallel-encoding";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: string;
docLink: string;
type: boolean;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
value: boolean;
source: string;
};
setConfig(value: boolean): void;
id: "disallow-parallel-encoding";
}, offthreadVideoCacheSizeInBytesOption: {
name: string;
cliFlag: "offthreadvideo-cache-size-in-bytes";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: "offthreadVideoCacheSizeInBytes";
docLink: string;
type: number | null;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
source: string;
value: number;
} | {
source: string;
value: null;
};
setConfig: (size: number | null) => void;
id: "offthreadvideo-cache-size-in-bytes";
}, encodingBufferSizeOption: {
name: string;
cliFlag: "buffer-size";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: "encodingBufferSize";
docLink: string;
type: string | null;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
value: string;
source: string;
} | {
value: null;
source: string;
};
setConfig: (bitrate: string | null) => void;
id: "buffer-size";
}, encodingMaxRateOption: {
name: string;
cliFlag: "max-rate";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: "encodingMaxRate";
docLink: string;
type: string | null;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
value: string;
source: string;
} | {
value: null;
source: string;
};
setConfig: (newMaxRate: string | null) => void;
id: "max-rate";
}, deleteAfterOption: {
name: string;
cliFlag: "delete-after";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: "deleteAfter";
docLink: string;
type: import("@remotion/renderer").DeleteAfter | null;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
source: string;
value: import("@remotion/renderer").DeleteAfter;
} | {
source: string;
value: null;
};
setConfig: (value: import("@remotion/renderer").DeleteAfter | null) => void;
id: "delete-after";
}, folderExpiryOption: {
name: string;
cliFlag: "enable-folder-expiry";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: "enableFolderExpiry";
docLink: string;
type: boolean | null;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
source: string;
value: boolean | null;
};
setConfig: (value: boolean | null) => void;
id: "enable-folder-expiry";
}, enableMultiprocessOnLinuxOption: {
name: string;
cliFlag: "enable-multiprocess-on-linux";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: string;
docLink: string;
type: boolean;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
source: string;
value: boolean;
};
setConfig: (value: boolean) => void;
id: "enable-multiprocess-on-linux";
}, numberOfGifLoopsOption: {
name: string;
cliFlag: "number-of-gif-loops";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: "numberOfGifLoops";
docLink: string;
type: number | null;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
value: number;
source: string;
} | {
value: null;
source: string;
};
setConfig: (newLoop: import("@remotion/renderer").NumberOfGifLoops) => void;
id: "number-of-gif-loops";
}, x264Option: {
name: string;
cliFlag: "x264-preset";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: "x264Preset";
docLink: string;
type: "fast" | "faster" | "medium" | "placebo" | "slow" | "slower" | "superfast" | "ultrafast" | "veryfast" | "veryslow" | null;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
value: "fast" | "faster" | "medium" | "placebo" | "slow" | "slower" | "superfast" | "ultrafast" | "veryfast" | "veryslow";
source: string;
} | {
value: null;
source: string;
};
setConfig: (profile: "fast" | "faster" | "medium" | "placebo" | "slow" | "slower" | "superfast" | "ultrafast" | "veryfast" | "veryslow" | null) => void;
id: "x264-preset";
}, enforceAudioOption: {
name: string;
cliFlag: "enforce-audio-track";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: string;
docLink: string;
type: boolean;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
source: string;
value: true;
} | {
source: string;
value: false;
};
setConfig: (value: boolean) => void;
id: "enforce-audio-track";
}, jpegQualityOption: {
name: string;
cliFlag: "jpeg-quality";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: string;
docLink: string;
type: number;
setConfig: (q: number | undefined) => void;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
source: string;
value: number;
};
id: "jpeg-quality";
}, audioBitrateOption: {
name: string;
cliFlag: "audio-bitrate";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: string;
docLink: string;
type: string;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
value: string;
source: string;
} | {
value: null;
source: string;
};
setConfig: (value: string | null) => void;
id: "audio-bitrate";
}, videoBitrateOption: {
name: string;
cliFlag: "video-bitrate";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: string;
docLink: string;
type: string | null;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
source: string;
value: string | null;
};
setConfig: (bitrate: string | null) => void;
id: "video-bitrate";
}, audioCodecOption: {
cliFlag: "audio-codec";
setConfig: (audioCodec: "aac" | "mp3" | "opus" | "pcm-16" | null) => void;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
source: string;
value: "aac" | "mp3" | "opus" | "pcm-16";
} | {
source: string;
value: null;
};
description: () => string;
docLink: string;
name: string;
ssrName: "audioCodec";
type: "aac" | "mp3" | "opus" | "pcm-16";
id: "audio-codec";
}, publicPathOption: {
name: string;
cliFlag: "public-path";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: "publicPath";
docLink: string;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
source: string;
value: string;
} | {
source: string;
value: null;
};
setConfig: (value: string | null) => void;
type: string | null;
id: "public-path";
}, audioLatencyHintOption: {
name: string;
cliFlag: "audio-latency-hint";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: "audioLatencyHint";
docLink: string;
type: AudioContextLatencyCategory;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
value: AudioContextLatencyCategory;
source: string;
} | {
value: null;
source: string;
};
setConfig: (profile: AudioContextLatencyCategory | null) => void;
id: "audio-latency-hint";
}, darkModeOption: {
name: string;
cliFlag: "dark-mode";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: string;
docLink: string;
type: boolean;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
source: string;
value: boolean;
};
setConfig: (value: boolean) => void;
id: "dark-mode";
}, publicLicenseKeyOption: {
name: string;
cliFlag: "public-license-key";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: "publicLicenseKey";
docLink: string;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
source: string;
value: string | null;
};
setConfig: (value: string | null) => void;
type: string | null;
id: "public-license-key";
}, forceNewStudioOption: {
name: string;
cliFlag: "force-new";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: null;
docLink: string;
type: boolean;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
value: boolean;
source: string;
};
setConfig(value: boolean): void;
id: "force-new";
}, numberOfSharedAudioTagsOption: {
name: string;
cliFlag: "number-of-shared-audio-tags";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: null;
docLink: string;
type: number;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
value: number;
source: string;
};
setConfig(value: number): void;
id: "number-of-shared-audio-tags";
}, ipv4Option: {
name: string;
cliFlag: "ipv4";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: null;
docLink: string;
type: boolean;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
value: boolean;
source: string;
};
setConfig(value: boolean): void;
id: "ipv4";
}, pixelFormatOption: {
name: string;
cliFlag: "pixel-format";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: "pixelFormat";
docLink: string;
type: "yuv420p" | "yuv420p10le" | "yuv422p" | "yuv422p10le" | "yuv444p" | "yuv444p10le" | "yuva420p" | "yuva444p10le";
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}, options?: {
uiPixelFormat: "yuv420p" | "yuv420p10le" | "yuv422p" | "yuv422p10le" | "yuv444p" | "yuv444p10le" | "yuva420p" | "yuva444p10le" | null;
compositionDefaultPixelFormat: "yuv420p" | "yuv420p10le" | "yuv422p" | "yuv422p10le" | "yuv444p" | "yuv444p10le" | "yuva420p" | "yuva444p10le" | null;
} | undefined) => {
source: string;
value: "yuv420p" | "yuv420p10le" | "yuv422p" | "yuv422p10le" | "yuv444p" | "yuv444p10le" | "yuva420p" | "yuva444p10le";
};
setConfig: (value: "yuv420p" | "yuv420p10le" | "yuv422p" | "yuv422p10le" | "yuv444p" | "yuv444p10le" | "yuva420p" | "yuva444p10le") => void;
id: "pixel-format";
}, browserExecutableOption: {
name: string;
cliFlag: "browser-executable";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: "browserExecutable";
docLink: string;
type: import("@remotion/renderer").BrowserExecutable;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
source: string;
value: import("@remotion/renderer").BrowserExecutable;
};
setConfig: (value: import("@remotion/renderer").BrowserExecutable) => void;
id: "browser-executable";
}, everyNthFrameOption: {
name: string;
cliFlag: "every-nth-frame";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: "everyNthFrame";
docLink: string;
type: number;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
source: string;
value: number;
};
setConfig: (value: number) => void;
id: "every-nth-frame";
}, proResProfileOption: {
name: string;
cliFlag: "prores-profile";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: "proResProfile";
docLink: string;
type: import("@remotion/renderer/client").ProResProfile | undefined;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}, options?: {
uiProResProfile: import("@remotion/renderer/client").ProResProfile | undefined;
compositionDefaultProResProfile: import("@remotion/renderer/client").ProResProfile | null;
} | undefined) => {
source: string;
value: import("@remotion/renderer/client").ProResProfile;
} | {
source: string;
value: undefined;
};
setConfig: (value: import("@remotion/renderer/client").ProResProfile | undefined) => void;
id: "prores-profile";
}, userAgentOption: {
name: string;
cliFlag: "user-agent";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: "userAgent";
docLink: string;
type: string | null;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
source: string;
value: string;
} | {
source: string;
value: null;
};
setConfig: (value: string | null) => void;
id: "user-agent";
}, disableWebSecurityOption: {
name: string;
cliFlag: "disable-web-security";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: "disableWebSecurity";
docLink: string;
type: boolean;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
source: string;
value: boolean;
};
setConfig: (value: boolean) => void;
id: "disable-web-security";
}, ignoreCertificateErrorsOption: {
name: string;
cliFlag: "ignore-certificate-errors";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: "ignoreCertificateErrors";
docLink: string;
type: boolean;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
source: string;
value: boolean;
};
setConfig: (value: boolean) => void;
id: "ignore-certificate-errors";
}, overrideHeightOption: {
name: string;
cliFlag: "height";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: null;
docLink: string;
type: number | null;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
source: string;
value: number;
} | {
source: string;
value: null;
};
setConfig: (height: number | null) => void;
id: "height";
}, overrideWidthOption: {
name: string;
cliFlag: "width";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: null;
docLink: string;
type: number | null;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
source: string;
value: number;
} | {
source: string;
value: null;
};
setConfig: (width: number | null) => void;
id: "width";
}, overrideFpsOption: {
name: string;
cliFlag: "fps";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: null;
docLink: string;
type: number | null;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
source: string;
value: number;
} | {
source: string;
value: null;
};
setConfig: (fps: number | null) => void;
id: "fps";
}, overrideDurationOption: {
name: string;
cliFlag: "duration";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: null;
docLink: string;
type: number | null;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
source: string;
value: number;
} | {
source: string;
value: null;
};
setConfig: (duration: number | null) => void;
id: "duration";
}, outDirOption: {
name: string;
cliFlag: "out-dir";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: "outDir";
docLink: string;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
source: string;
value: string;
} | {
source: string;
value: null;
};
setConfig: (value: string | null) => void;
type: string | null;
id: "out-dir";
}, packageManagerOption: {
name: string;
cliFlag: "package-manager";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: "packageManager";
docLink: string;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
source: string;
value: string;
} | {
source: string;
value: null;
};
setConfig: (value: string | null) => void;
type: string | null;
id: "package-manager";
}, webpackPollOption: {
name: string;
cliFlag: "webpack-poll";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: null;
docLink: string;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
source: string;
value: number;
} | {
source: string;
value: null;
};
setConfig: (value: number | null) => void;
type: number | null;
id: "webpack-poll";
}, keyboardShortcutsOption: {
name: string;
cliFlag: "disable-keyboard-shortcuts";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: null;
docLink: string;
type: boolean;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
value: boolean;
source: string;
};
setConfig(value: boolean): void;
id: "disable-keyboard-shortcuts";
}, experimentalClientSideRenderingOption: {
name: string;
cliFlag: "enable-experimental-client-side-rendering";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: null;
docLink: string;
type: boolean;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
value: boolean;
source: string;
};
setConfig(value: boolean): void;
id: "enable-experimental-client-side-rendering";
}, interactivityOption: {
name: string;
cliFlag: "disable-interactivity";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: null;
docLink: string;
type: boolean;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
value: boolean;
source: string;
};
setConfig(value: boolean): void;
id: "disable-interactivity";
}, imageSequencePatternOption: {
name: string;
cliFlag: "image-sequence-pattern";
ssrName: string;
description: () => import("react/jsx-runtime").JSX.Element;
docLink: null;
type: string | null;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
value: string;
source: string;
};
setConfig: (pattern: string | null) => void;
id: "image-sequence-pattern";
}, scaleOption: {
name: string;
cliFlag: "scale";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: string;
docLink: string;
type: number;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
source: string;
value: number;
};
setConfig: (scale: number) => void;
id: "scale";
}, overwriteOption: {
name: string;
cliFlag: "overwrite";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: string;
docLink: string;
type: boolean;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}, defaultValue: boolean) => {
source: string;
value: boolean;
};
setConfig: (value: boolean) => void;
id: "overwrite";
}, crfOption: {
name: string;
cliFlag: "crf";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: string;
docLink: string;
type: number;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
source: string;
value: import("@remotion/renderer").Crf;
};
setConfig: (crf: import("@remotion/renderer").Crf) => void;
id: "crf";
}, logLevelOption: {
cliFlag: "log";
name: string;
ssrName: string;
description: () => import("react/jsx-runtime").JSX.Element;
docLink: string;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
value: "error" | "info" | "trace" | "verbose" | "warn";
source: string;
};
setConfig: (newLogLevel: "error" | "info" | "trace" | "verbose" | "warn") => void;
type: "error" | "info" | "trace" | "verbose" | "warn";
id: "log";
}, videoCodecOption: {
name: string;
cliFlag: "codec";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: string;
docLink: string;
type: "aac" | "av1" | "gif" | "h264" | "h264-mkv" | "h264-ts" | "h265" | "mp3" | "prores" | "vp8" | "vp9" | "wav";
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}, { compositionCodec, configFile, downloadName, outName, uiCodec, }: {
outName: string | null;
downloadName: string | null;
configFile: "aac" | "av1" | "gif" | "h264" | "h264-mkv" | "h264-ts" | "h265" | "mp3" | "prores" | "vp8" | "vp9" | "wav" | null;
uiCodec: "aac" | "av1" | "gif" | "h264" | "h264-mkv" | "h264-ts" | "h265" | "mp3" | "prores" | "vp8" | "vp9" | "wav" | null;
compositionCodec: "aac" | "av1" | "gif" | "h264" | "h264-mkv" | "h264-ts" | "h265" | "mp3" | "prores" | "vp8" | "vp9" | "wav" | null;
}) => {
value: "aac" | "av1" | "gif" | "h264" | "h264-mkv" | "h264-ts" | "h265" | "mp3" | "prores" | "vp8" | "vp9" | "wav";
source: string;
};
setConfig: (newCodec: import("@remotion/renderer").CodecOrUndefined) => void;
id: "codec";
}, stillFrameOption: {
name: string;
cliFlag: "frame";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: "frame";
docLink: string;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
source: string;
value: number;
} | {
source: string;
value: null;
};
setConfig: (value: number | null) => void;
type: number | null;
id: "frame";
}, imageSequenceOption: {
name: string;
cliFlag: "sequence";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: null;
docLink: string;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
source: string;
value: boolean;
};
setConfig: (value: boolean) => void;
type: boolean;
id: "sequence";
}, versionFlagOption: {
name: string;
cliFlag: "version";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: null;
docLink: string;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
source: string;
value: string;
} | {
source: string;
value: null;
};
setConfig: () => never;
type: string | null;
id: "version";
}, bundleCacheOption: {
name: string;
cliFlag: "bundle-cache";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: null;
docLink: string;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
source: string;
value: boolean;
};
setConfig: (value: boolean) => void;
type: boolean;
id: "bundle-cache";
}, envFileOption: {
name: string;
cliFlag: "env-file";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: null;
docLink: string;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
source: string;
value: string;
} | {
source: string;
value: null;
};
setConfig: (value: string | null) => void;
type: string | null;
id: "env-file";
}, glOption: {
cliFlag: "gl";
docLink: string;
name: string;
type: "angle" | "angle-egl" | "egl" | "swangle" | "swiftshader" | "vulkan" | null;
ssrName: string;
description: () => import("react/jsx-runtime").JSX.Element;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
value: "angle" | "angle-egl" | "egl" | "swangle" | "swiftshader" | "vulkan";
source: string;
} | {
value: null;
source: string;
};
setConfig: (value: "angle" | "angle-egl" | "egl" | "swangle" | "swiftshader" | "vulkan" | null) => void;
id: "gl";
}, gopSizeOption: {
name: string;
cliFlag: "gop";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: string;
docLink: string;
type: number | null;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
value: number | null;
source: string;
};
setConfig: (value: number | null) => void;
id: "gop";
}, runsOption: {
name: string;
cliFlag: "runs";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: null;
docLink: string;
type: number;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
value: number;
source: string;
};
setConfig: (value: number) => void;
id: "runs";
}, reproOption: {
name: string;
cliFlag: "repro";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: string;
docLink: string;
type: boolean;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
value: boolean;
source: string;
};
setConfig: (should: boolean) => void;
id: "repro";
}, mutedOption: {
name: string;
cliFlag: "muted";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: string;
docLink: string;
type: boolean;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
source: string;
value: boolean;
};
setConfig: () => void;
id: "muted";
}, headlessOption: {
name: string;
cliFlag: "disable-headless";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: string;
docLink: string;
type: boolean;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
source: string;
value: boolean;
};
setConfig: (value: boolean) => void;
id: "disable-headless";
}, delayRenderTimeoutInMillisecondsOption: {
name: string;
cliFlag: "timeout";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: "timeoutInMilliseconds";
docLink: string;
type: number;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
source: string;
value: number;
};
setConfig: (value: number) => void;
id: "timeout";
}, framesOption: {
name: string;
cliFlag: "frames";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: "frameRange";
docLink: string;
type: import("@remotion/renderer").FrameRange | null;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
source: string;
value: import("@remotion/renderer").FrameRange | null;
};
setConfig: (value: import("@remotion/renderer").FrameRange | null) => void;
id: "frames";
}, isProductionOption: {
name: string;
cliFlag: "is-production";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: "isProduction";
docLink: string;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
source: string;
value: boolean | null;
};
setConfig: (value: boolean | null) => void;
type: boolean | null;
id: "is-production";
}, noOpenOption: {
name: string;
cliFlag: "no-open";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: null;
docLink: string;
type: boolean;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
value: true;
source: string;
} | {
value: false;
source: string;
};
setConfig: (shouldOpen: boolean) => void;
id: "no-open";
}, portOption: {
name: string;
cliFlag: "port";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: null;
docLink: string;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
source: string;
value: number;
} | {
source: string;
value: null;
};
setConfig: (value: number | null) => void;
type: number | null;
id: "port";
}, propsOption: {
name: string;
cliFlag: "props";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: null;
docLink: string;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
source: string;
value: string;
} | {
source: string;
value: null;
};
setConfig: () => never;
type: string | null;
id: "props";
}, configOption: {
name: string;
cliFlag: "config";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: null;
docLink: string;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
source: string;
value: string;
} | {
source: string;
value: null;
};
setConfig: () => never;
type: string | null;
id: "config";
}, browserOption: {
name: string;
cliFlag: "browser";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: null;
docLink: string;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
source: string;
value: string;
} | {
source: string;
value: null;
};
setConfig: () => never;
type: string | null;
id: "browser";
}, sampleRateOption: {
name: string;
cliFlag: "sample-rate";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: "sampleRate";
docLink: string;
type: number;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}, compositionSampleRate?: number | null | undefined) => {
value: number;
source: string;
};
setConfig: (value: number) => void;
id: "sample-rate";
}, previewSampleRateOption: {
name: string;
cliFlag: "preview-sample-rate";
description: () => import("react/jsx-runtime").JSX.Element;
ssrName: null;
docLink: string;
type: number | null;
getValue: ({ commandLine }: {
commandLine: Record<string, unknown>;
}) => {
value: number;
source: string;
} | {
value: null;
source: string;
};
setConfig: (value: number | null) => void;
id: "preview-sample-rate";
};
export type CommandLineOptions = {
[browserExecutableOption.cliFlag]: TypeOfOption<typeof browserExecutableOption>;
[pixelFormatOption.cliFlag]: TypeOfOption<typeof pixelFormatOption>;
['image-format']: VideoImageFormat | StillImageFormat;
[proResProfileOption.cliFlag]: TypeOfOption<typeof proResProfileOption>;
[x264Option.cliFlag]: TypeOfOption<typeof x264Option>;
[bundleCacheOption.cliFlag]: TypeOfOption<typeof bundleCacheOption>;
[envFileOption.cliFlag]: TypeOfOption<typeof envFileOption>;
[ignoreCertificateErrorsOption.cliFlag]: TypeOfOption<typeof ignoreCertificateErrorsOption> | null;
[darkModeOption.cliFlag]: TypeOfOption<typeof darkModeOption> | null;
[disableWebSecurityOption.cliFlag]: TypeOfOption<typeof disableWebSecurityOption> | null;
[everyNthFrameOption.cliFlag]: TypeOfOption<typeof everyNthFrameOption>;
[numberOfGifLoopsOption.cliFlag]: TypeOfOption<typeof numberOfGifLoopsOption>;
[numberOfSharedAudioTagsOption.cliFlag]: TypeOfOption<typeof numberOfSharedAudioTagsOption>;
[offthreadVideoCacheSizeInBytesOption.cliFlag]: TypeOfOption<typeof offthreadVideoCacheSizeInBytesOption>;
[colorSpaceOption.cliFlag]: TypeOfOption<typeof colorSpaceOption>;
[disallowParallelEncodingOption.cliFlag]: TypeOfOption<typeof disallowParallelEncodingOption> | null;
[beepOnFinishOption.cliFlag]: TypeOfOption<typeof beepOnFinishOption> | null;
[versionFlagOption.cliFlag]: TypeOfOption<typeof versionFlagOption>;
[videoCodecOption.cliFlag]: TypeOfOption<typeof videoCodecOption>;
[concurrencyOption.cliFlag]: TypeOfOption<typeof concurrencyOption>;
[delayRenderTimeoutInMillisecondsOption.cliFlag]: TypeOfOption<typeof delayRenderTimeoutInMillisecondsOption>;
[configOption.cliFlag]: TypeOfOption<typeof configOption>;
['public-dir']: string;
[audioBitrateOption.cliFlag]: TypeOfOption<typeof audioBitrateOption>;
[videoBitrateOption.cliFlag]: TypeOfOption<typeof videoBitrateOption>;
[encodingBufferSizeOption.cliFlag]: TypeOfOption<typeof encodingBufferSizeOption>;
[encodingMaxRateOption.cliFlag]: TypeOfOption<typeof encodingMaxRateOption>;
[audioCodecOption.cliFlag]: AudioCodec;
[publicPathOption.cliFlag]: string;
[crfOption.cliFlag]: TypeOfOption<typeof crfOption>;
[gopSizeOption.cliFlag]: TypeOfOption<typeof gopSizeOption>;
output: string | undefined;
[overwriteOption.cliFlag]: TypeOfOption<typeof overwriteOption> | null;
png: boolean;
[propsOption.cliFlag]: TypeOfOption<typeof propsOption>;
quality: number;
[jpegQualityOption.cliFlag]: TypeOfOption<typeof jpegQualityOption>;
[framesOption.cliFlag]: string | number;
[scaleOption.cliFlag]: TypeOfOption<typeof scaleOption>;
[imageSequenceOption.cliFlag]: TypeOfOption<typeof imageSequenceOption> | null;
quiet: boolean;
q: boolean;
[logLevelOption.cliFlag]: TypeOfOption<typeof logLevelOption>;
help: boolean;
[portOption.cliFlag]: TypeOfOption<typeof portOption>;
[stillFrameOption.cliFlag]: TypeOfOption<typeof stillFrameOption>;
[headlessOption.cliFlag]: TypeOfOption<typeof headlessOption> | null;
[keyboardShortcutsOption.cliFlag]: TypeOfOption<typeof keyboardShortcutsOption> | null;
[allowHtmlInCanvasOption.cliFlag]: TypeOfOption<typeof allowHtmlInCanvasOption>;
[experimentalClientSideRenderingOption.cliFlag]: TypeOfOption<typeof experimentalClientSideRenderingOption>;
[interactivityOption.cliFlag]: TypeOfOption<typeof interactivityOption> | null;
[mutedOption.cliFlag]: TypeOfOption<typeof mutedOption>;
[overrideHeightOption.cliFlag]: TypeOfOption<typeof overrideHeightOption>;
[overrideWidthOption.cliFlag]: TypeOfOption<typeof overrideWidthOption>;
[overrideFpsOption.cliFlag]: TypeOfOption<typeof overrideFpsOption>;
[overrideDurationOption.cliFlag]: TypeOfOption<typeof overrideDurationOption>;
[runsOption.cliFlag]: TypeOfOption<typeof runsOption>;
[benchmarkConcurrenciesOption.cliFlag]: TypeOfOption<typeof benchmarkConcurrenciesOption>;
[enforceAudioOption.cliFlag]: TypeOfOption<typeof enforceAudioOption>;
[glOption.cliFlag]: TypeOfOption<typeof glOption>;
[packageManagerOption.cliFlag]: TypeOfOption<typeof packageManagerOption>;
[webpackPollOption.cliFlag]: TypeOfOption<typeof webpackPollOption>;
[noOpenOption.cliFlag]: TypeOfOption<typeof noOpenOption>;
[browserOption.cliFlag]: TypeOfOption<typeof browserOption>;
['browser-args']: string;
[userAgentOption.cliFlag]: TypeOfOption<typeof userAgentOption>;
[outDirOption.cliFlag]: TypeOfOption<typeof outDirOption>;
[audioLatencyHintOption.cliFlag]: AudioContextLatencyCategory;
[ipv4Option.cliFlag]: TypeOfOption<typeof ipv4Option> | null;
[deleteAfterOption.cliFlag]: TypeOfOption<typeof deleteAfterOption>;
[folderExpiryOption.cliFlag]: TypeOfOption<typeof folderExpiryOption>;
[enableMultiprocessOnLinuxOption.cliFlag]: TypeOfOption<typeof enableMultiprocessOnLinuxOption>;
[reproOption.cliFlag]: TypeOfOption<typeof reproOption> | null;
[imageSequencePatternOption.cliFlag]: TypeOfOption<typeof imageSequencePatternOption>;
'license-key': string;
[publicLicenseKeyOption.cliFlag]: string;
[forceNewStudioOption.cliFlag]: TypeOfOption<typeof forceNewStudioOption> | null;
[sampleRateOption.cliFlag]: TypeOfOption<typeof sampleRateOption>;
[previewSampleRateOption.cliFlag]: TypeOfOption<typeof previewSampleRateOption>;
[isProductionOption.cliFlag]: TypeOfOption<typeof isProductionOption> | null;
};
export declare const BooleanFlags: string[];
export declare const parsedCli: CommandLineOptions & {
_: string[];
};
export declare const quietFlagProvided: () => boolean;
export {};