@remotion/renderer

@remotion/renderer 包提供用于服务器端渲染视频的 API。该包还在内部被 Remotion CLI 和 Remotion Lambda 使用。

🌐 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

使用这些 API 时，配置文件不起作用。

安装

🌐 Installation

Remotion CLI

npx remotion add @remotion/renderer

npm

npm i --save-exact @remotion/renderer@4.0.431

This assumes you are currently using v4.0.431 of Remotion.
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.

bun

pnpm i @remotion/renderer@4.0.431

This assumes you are currently using v4.0.431 of Remotion.
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.

pnpm

bun i @remotion/renderer@4.0.431

This assumes you are currently using v4.0.431 of Remotion.
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.

yarn

yarn --exact add @remotion/renderer@4.0.431

This assumes you are currently using v4.0.431 of Remotion.
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

在 @remotion/renderer 包中提供以下 API：

🌐 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

combineChunks()

Combine chunks of partial renders

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>

renderMedia() 和 renderFrames() 有什么区别？

🌐 What's the difference between renderMedia() and renderFrames()?

在 Remotion 3.0 中，我们添加了 renderMedia() API，它将 renderFrames() 和 stitchFramesToVideo() 合并为一个简化步骤，并加快了渲染速度。如果可以的话，优先使用 renderMedia()。

🌐 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.