remotion
Version:
Render videos in React
112 lines • 4.97 kB
TypeScript
import { Browser } from './browser';
import { BrowserExecutable } from './browser-executable';
import { Codec } from './codec';
import { Concurrency } from './concurrency';
import { FrameRange } from './frame-range';
import { ImageFormat } from './image-format';
import { LogLevel } from './log';
import { WebpackConfiguration, WebpackOverrideFn } from './override-webpack';
import { PixelFormat } from './pixel-format';
export declare const Config: {
readonly Bundling: {
/**
* Pass in a function which takes the current Webpack config
* and return a modified Webpack configuration.
* Docs: http://remotion.dev/docs/webpack
*/
readonly overrideWebpackConfig: (fn: WebpackOverrideFn) => void;
/**
* Whether Webpack bundles should be cached to make
* subsequent renders faster. Default: true
*/
readonly setCachingEnabled: (flag: boolean) => void;
/**
* Define on which port Remotion should start it's HTTP servers during preview and rendering.
* By default, Remotion will try to find a free port.
* If you specify a port, but it's not available, Remotion will throw an error.
*/
readonly setPort: (port: number | undefined) => void;
};
readonly Log: {
/**
* Set the log level.
* Acceptable values: 'error' | 'warning' | 'info' | 'verbose'
* Default value: 'info'
*
* Set this to 'verbose' to get browser logs and other IO.
*/
readonly setLevel: (newLogLevel: "error" | "verbose" | "info" | "warn") => void;
};
readonly Puppeteer: {
/**
* Specify executable path for the browser to use.
* Default: null, which will make Remotion find or download a version of said browser.
*/
readonly setBrowserExecutable: (newBrowserExecutablePath: string | null) => void;
};
readonly Rendering: {
/**
* Set a custom location for a .env file.
* Default: `.env`
*/
readonly setDotEnvLocation: (file: string) => void;
/**
* Sets how many Puppeteer instances will work on rendering your video in parallel.
* Default: `null`, meaning half of the threads available on your CPU.
*/
readonly setConcurrency: (newConcurrency: number | null) => void;
/**
* Set the JPEG quality for the frames.
* Must be between 0 and 100.
* Must be between 0 and 100.
* Default: 80
*/
readonly setQuality: (q: number | undefined) => void;
/** Decide in which image format to render. Can be either 'jpeg' or 'png'.
* PNG is slower, but supports transparency.
*/
readonly setImageFormat: (format: "png" | "jpeg" | "none") => void;
/**
* Render only a subset of a video.
* Pass in a tuple [20, 30] to only render frames 20-30 into a video.
* Pass in a single number `20` to only render a single frame as an image.
* The frame count starts at 0.
*/
readonly setFrameRange: (newFrameRange: number | [number, number] | null) => void;
};
readonly Output: {
/**
* If the video file already exists, should Remotion overwrite
* the output? Default: true
*/
readonly setOverwriteOutput: (newOverwrite: boolean) => void;
/**
* Sets the pixel format in FFMPEG.
* See https://trac.ffmpeg.org/wiki/Chroma%20Subsampling for an explanation.
* You can override this using the `--pixel-format` Cli flag.
*/
readonly setPixelFormat: (format: "yuv420p" | "yuva420p" | "yuv422p" | "yuv444p" | "yuv420p10le" | "yuv422p10le" | "yuv444p10le") => void;
/**
* @deprecated Use setCodec() and setImageSequence() instead.
* Specify what kind of output you, either `mp4` or `png-sequence`.
*/
readonly setOutputFormat: (newLegacyFormat: "mp4" | "png-sequence") => void;
/**
* Specify the codec for stitching the frames into a video.
* Can be `h264` (default), `h265`, `vp8` or `vp9`
*/
readonly setCodec: (newCodec: import("./codec").CodecOrUndefined) => void;
/**
* Set the Constant Rate Factor to pass to FFMPEG.
* Lower values mean better quality, but be aware that the ranges of
* possible values greatly differs between codecs.
*/
readonly setCrf: (newCrf: number | undefined) => void;
/**
* Set to true if don't want a video but an image sequence as the output.
*/
readonly setImageSequence: (newImageSequence: boolean) => void;
};
};
export type { PixelFormat, Concurrency, WebpackConfiguration, WebpackOverrideFn, BrowserExecutable, ImageFormat, Codec, Browser, FrameRange, LogLevel, };
//# sourceMappingURL=index.d.ts.map