Skip to main content

getFunctions()

检索 Remotion 部署到 AWS Lambda 的函数列表在特定区域。

参数 compatibleOnly 确定是否仅返回与已安装版本的 Remotion Lambda 兼容的函数。

note

Lambda 函数是有版本的,函数的版本必须与 @remotion/lambda 包的版本匹配。因此,如果您升级 Remotion,您应该部署一个新函数,否则您可能会从此函数中获得一个空数组。

要仅获取有关单个函数的信息,请使用 getFunctionInfo()

如果您确信函数存在,还可以使用 speculateFunctionName() 猜测其名称,并节省一次对 Lambda 的 API 调用。

示例

ts
import { getFunctions } from "@remotion/lambda/client";
 
const info = await getFunctions({
region: "eu-central-1",
compatibleOnly: true,
});
 
for (const fn of info) {
console.log(fn.functionName); // "remotion-render-d8a03x"
console.log(fn.memorySizeInMb); // 1536
console.log(fn.timeoutInSeconds); // 120
console.log(fn.diskSizeInMb); // 2048
console.log(fn.version); // "2021-07-25"
}
ts
import { getFunctions } from "@remotion/lambda/client";
 
const info = await getFunctions({
region: "eu-central-1",
compatibleOnly: true,
});
 
for (const fn of info) {
console.log(fn.functionName); // "remotion-render-d8a03x"
console.log(fn.memorySizeInMb); // 1536
console.log(fn.timeoutInSeconds); // 120
console.log(fn.diskSizeInMb); // 2048
console.log(fn.version); // "2021-07-25"
}
note

最好从 @remotion/lambda/client 导入此函数,以避免 在无服务器函数内部 出现问题。

参数

包含以下属性的对象:

region

您想要查询的 AWS 区域

logLevel?v4.0.115

One of verbose, info, warn, error.
Determines how much is being logged to the console.
verbose will also log console.log's from the browser.
Default info.

compatibleOnly

如果为 true,则仅返回与当前 Remotion Lambda 包版本匹配的函数。如果为 false,则返回所有函数。

返回值

解析为具有以下属性的对象数组的 Promise:

functionName

函数的名称。

memorySizeInMb

分配给函数的内存量。

diskSizeInMb

分配给函数的临时磁盘存储量。

version

函数的版本。Remotion 对 Lambda 函数进行版本控制,只能从与函数版本匹配的 @remotion/lambda 版本触发渲染。

timeoutInSeconds

Lambda函数被分配的超时时间。

另请参阅