@remotion/renderer
The @remotion/renderer package provides APIs for rendering video server-side.
The package is also internally used by the Remotion CLI and Remotion Lambda.
warning
The configuration file has no effect when using these APIs.
Installation
- npm
- yarn
- pnpm
- bun
npm i --save-exact @remotion/renderer@4.0.228
npm i --save-exact @remotion/renderer@4.0.228
pnpm i @remotion/renderer@4.0.228
pnpm i @remotion/renderer@4.0.228
bun i @remotion/renderer@4.0.228
bun i @remotion/renderer@4.0.228
yarn --exact add @remotion/renderer@4.0.228
yarn --exact add @remotion/renderer@4.0.228
Also update
remotion and all `@remotion/*` packages to the same version.Remove all
^ character in front of the version numbers of it as it can lead to a version conflict.Server-side rendering examples
See the Server-side rendering for some examples of how to use server-side rendering.
Available functions
The following APIs are available in the @remotion/renderer package:
getCompositions()
List available compositions
selectComposition()
Get a composition
renderMedia()
Render a video or audio
renderFrames()
Render a series of images
renderStill()
Render a single image
stitchFramesToVideo()
Turn images into a video
openBrowser()
Open a Chrome browser to reuse across renders
ensureBrowser()
Open a Chrome browser to reuse across renders
makeCancelSignal()
Create token to later cancel a render
getVideoMetadata()
Get metadata from a video file in Node.js
getSilentParts()
Obtain silent portions of a video or audio
ensureFfmpeg()
Check for ffmpeg binary and install if not existing
ensureFfprobe()
Check for ffprobe binary and install if not existing
getCanExtractFramesFast()
Probes for fast extraction for <OffthreadVideo>
What's the difference between renderMedia() and renderFrames()?
In Remotion 3.0, we added the renderMedia() API which combines renderFrames() and stitchFramesToVideo() into one simplified step and performs the render faster. Prefer renderMedia() if you can.