Skip to main content

deployFunction()

在您的 AWS 帐户中创建一个 AWS Lambda 函数，该函数可以在云中渲染视频。

如果具有相同版本、内存大小和超时时间的函数已经存在，则会返回该函数，而不会创建新函数。这意味着此函数可以被视为幂等。

示例​

ts
import { deployFunction } from "@remotion/lambda";
 
const { functionName } = await deployFunction({
  region: "us-east-1",
  timeoutInSeconds: 120,
  memorySizeInMb: 2048,
  createCloudWatchLogGroup: true,
  diskSizeInMb: 2048,
});
console.log(functionName);
ts
import { deployFunction } from "@remotion/lambda";
 
const { functionName } = await deployFunction({
  region: "us-east-1",
  timeoutInSeconds: 120,
  memorySizeInMb: 2048,
  createCloudWatchLogGroup: true,
  diskSizeInMb: 2048,
});
console.log(functionName);

参数​

一个具有以下属性的对象：

region​

您要将 Lambda 函数部署到的 AWS 区域。它必须与您的 Lambda Layer 所在的区域相同。

timeoutInSeconds​

Lambda 函数在被终止之前可以运行的时间长度。必须低于 900 秒。 我们建议将超时设置为 120 秒或更短 - 请记住，如果您使用高并发度进行渲染，Remotion Lambda 是最快的。如果您的视频渲染时间较长，应增加并发度而不是超时时间。

memorySizeInMb​

Lambda 函数应具有的 RAM 大小（以兆字节为单位）。默认情况下，我们建议设置为 2048MB。您可以根据视频消耗的内存量增加或减少此值。允许的最小数字为 512，允许的最大数字为 10240。由于 Remotion Lambda 的成本与 RAM 的数量成正比，我们建议尽可能将此数量保持较低。

createCloudWatchLogGroup?​

是否应将日志保存到 CloudWatch。我们建议启用此选项。

cloudWatchLogRetentionPeriodInDays?​

CloudWatch 日志的保留期。默认值：14 天。

diskSizeInMb?​

设置 Lambda 函数中可用的磁盘存储量。必须介于 512MB 和 10240MB（10GB）之间。如果要渲染较长的视频，请将此值设置得更高。另请参阅：磁盘大小

Remotion 版本默认值
<5.0.02048MB
>=5.0.010240MB

customRoleArn?​

使用自定义角色来代替默认角色 (arn:aws:iam::[aws-account-id]:role/remotion-lambda-role)

enableLambdaInsights?v4.0.61​

Enable Lambda Insights in AWS CloudWatch. For this to work, you may have to update your role permission.

enableV5Runtime?v4.0.148​

启用即将推出的 v5 运行时，提前使用更新的 Chrome 和 Node 版本。

runtimePreference?v4.0.205​

其中之一：

  • default: 当前解析为 prefer-cjk
  • prefer-apple-emojis: 使用苹果表情符号而不是谷歌表情符号。CJK 字符将被移除。
  • prefer-cjk: 包括 CJK（中文、日文、韩文）字符和谷歌表情符号。苹果表情符号将被移除。
note

苹果表情符号是 Apple Inc. 的知识产权。
您对在项目中使用苹果表情符号负责。

返回值​

一个包含以下值的对象：

  • functionName（字符串）：刚创建的函数的名称。
  • alreadyExisted:（布尔值）：是否因为函数已经存在而跳过了创建。

参见​