npx remotion benchmark
available from v3.2.28
Measures render time by running a render multiple times, if desired with multiple compositions and concurrency values to compare against each other.
bash
npx remotion benchmark src/index.ts [composition-ids]
bash
npx remotion benchmark src/index.ts [composition-ids]
You can provide multiple composition IDs separated by comma, ex: npx remotion benchmark src/index.ts --codec=h264 Main,Canvas,CSS
If composition-ids
is not passed, Remotion will let you select compositions from a list.
Flags
--runs
optional. Default is 3
Specify how many times video must be rendered. Default value is 3.
--concurrencies
optional
You can specify which concurrency value should be used while rendering the video. Multiple concurrency values can be passed separated by comma. Learn more about concurrency
--codec
optional
Inherited from npx remotion render
--audio-codec
v3.3.42
optional
Set the format of the audio that is embedded in the video. Not all codec and audio codec combinations are supported and certain combinations require a certain file extension and container format. See the table in the docs to see possible combinations.--crf
optional
Inherited from npx remotion render
--frames
optional
Inherited from npx remotion render
--image-format
optional
Inherited from npx remotion render
--pixel-format
optional
Inherited from npx remotion render
--props
optional
Inherited from npx remotion render
--prores-profile
optional
Inherited from npx remotion render
--jpeg-quality
optional, available from v4.0.0
Inherited from npx remotion render
--quality
--quality
optional, removed in v4.0.0
Renamed to --jpeg-quality
.
--log
optional
Inherited from npx remotion render
--ignore-certificate-errors
optional
Inherited from npx remotion render
--disable-web-security
optional
Inherited from npx remotion render
--disable-headless?
--disable-headless?
optional
Deprecated - will be removed in 5.0.0. With the migration to Chrome Headless Shell, this option is not functional anymore.If disabled, the render will open an actual Chrome window where you can see the render happen. The default is headless mode.
--enable-multiprocess-on-linux
v4.0.42
Removes the --single-process
flag that gets passed to Chromium on Linux by default. This will make the render faster because multiple processes can be used, but may cause issues with some Linux distributions or if window server libraries are missing.Default:
false
until v4.0.136, then true
from v4.0.137 on because newer Chrome versions don't allow rendering with the --single-process
flag. This flag will be removed in Remotion v5.0.
--gl
optional
Inherited from npx remotion render
--timeout
optional
Inherited from npx remotion render
--scale
optional
Inherited from npx remotion render
--port
optional
Inherited from npx remotion render
--number-of-gif-loops
optional
Allows you to set the number of loops as follows:null
(or omitting in the CLI) plays the GIF indefinitely.0
disables looping1
loops the GIF once (plays twice in total)2
loops the GIF twice (plays three times in total) and so on.
--every-nth-frame
optional
Inherited from npx remotion render
--log
optional
Inherited from npx remotion render
--muted
optional
Inherited from npx remotion render
--enforce-audio-track
optional
Inherited from npx remotion render
--browser-executable
optional
Inherited from npx remotion render
--public-dir
optional
Inherited from npx remotion render
--config
optional
Inherited from npx remotion render
--bundle-cache
optional
Inherited from npx remotion render
--video-bitrate
optional
Inherited from npx remotion render
--audio-bitrate
optional
Inherited from npx remotion render
--color-space
v4.0.28
Color space to use for the video. Acceptable values: "default"
(default since 5.0), "bt709"
(since v4.0.28), "bt2020-ncl"
(since v4.0.88), "bt2020-cl"
(since v4.0.88), .For best color accuracy, it is recommended to also use
"png"
as the image format to have accurate color transformations throughout.Only since v4.0.83, colorspace conversion is actually performed, previously it would only tag the metadata of the video.
--hardware-acceleration
v4.0.228
One of
"disable", "if-possible", or "required"
. Default "disable". Encode using a hardware-accelerated encoder if
available. If set to "required" and no hardware-accelerated encoder is
available, then the render will fail.
--offthreadvideo-cache-size-in-bytes
v4.0.23
From v4.0, Remotion has a cache for <OffthreadVideo>
frames. The default is null
, corresponding to half of the system memory available when the render starts.This option allows to override the size of the cache. The higher it is, the faster the render will be, but the more memory will be used.
The used value will be printed when running in verbose mode.
Default:
null
--binaries-directory
v4.0.120
The directory where the platform-specific binaries and libraries that Remotion needs are located. Those include an ffmpeg
and ffprobe
binary, a Rust binary for various tasks, and various shared libraries. If the value is set to null
, which is the default, then the path of a platform-specific package located at node_modules/@remotion/compositor-*
is selected.This option is useful in environments where Remotion is not officially supported to run like bundled serverless functions or Electron.
--ffmpeg-executable
--ffmpeg-executable
optional, removed in v4.0
Inherited from npx remotion render
--ffprobe-executable
--ffprobe-executable
optional, removed in v4.0
Inherited from npx remotion render