@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

bash
npm i @remotion/renderer

bash
npm i @remotion/renderer

yarn

bash
pnpm i @remotion/renderer

bash
pnpm i @remotion/renderer

pnpm

bash
yarn add @remotion/renderer

bash
yarn add @remotion/renderer

Also update all the other Remotion packages to have the same version: remotion, @remotion/cli and others.

note

Make sure no package version number has a ^ character in front 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() - Get a list of available compositions from a Remotion project.
• renderMedia() - Render a video or audio
• renderFrames() - Render an image sequence
• renderStill() - Render a still image
• stitchFramesToVideo() - Encode a video based on an image sequence
• openBrowser() - Share a browser instance across function calls for even better performance.
• makeCancelSignal() - Returns a token that allows a render to be cancelled.

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.