render command produces a recording of a ractive as a static (traditional mp4/webm) video file.
The syntax is
To avoid passing command line options every time, you can create an
rp-master.config.js file. This should export an object with a
render key containing the options for this command. Here is an example:
You can specify a different location for the configuration file using the
Path to a Chrome/Chromium executable. If not specified and a suitable executable cannot be found, one will be downloaded during rendering.
How many threads to use. Defaults to half of the available CPUs.
Path to a configuration file to load options from. Defaults to
Path to audio file. If not specified, the video will not have audio.
Duration, specify as
[[hh:]mm:]ss[.ms]. Cannot be used with
End time, specify as
[[hh:]mm:]ss[.ms]. Defaults to
null, meaning the end of the video. Cannot be used with
Boolean flag to output an image sequence instead of a video. If set,
<outfile> will be interpreted as a directory (and created if it does not already exist). This is useful if you want to run
ffmpeg on the images yourself.
Start time, specify as
[[hh:]mm:]ss[.ms]. Defaults to 0, meaning the start of the video.
--end apply to both the audio file (if any) and the video. At this time, it is not possible to configure these separately.
Video height. Defaults to 800.
Image format for the frames, either
png. Defaults to
Value between 0 and 100 for quality of the frames. Only applies when
Video width. Defaults to 1280.
The exact command that we pass to
See the ffmpeg documentation for available options. The
-y flag (which tells ffmpeg to overwrite the output file without asking) cannot currently be overridden. If no audio file is specified, the third line will not be included.
Additional flags to pass to ffmpeg, applying to the audio file. If no audio file is specified, this has no effect.
Frames per second. Defaults to 30.
Pixel format for ffmpeg. Defaults to
outfile is an
mp4 video, formats other than 4:2:0 will not work reliably, c.f. Encoding for dumb players.
Additional flags to pass to ffmpeg, applying to the video outfile.