@remotion/lambda
- npm
- yarn
- pnpm
bash
npm i @remotion/lambda
bash
npm i @remotion/lambda
bash
pnpm i @remotion/lambda
bash
pnpm i @remotion/lambda
bash
yarn add @remotion/lambda
bash
yarn add @remotion/lambda
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.
See the setup guide for complete instructions on how to get started.
APIs
The following Node.JS are available:
estimatePrice()
Estimate the price of a render
deployFunction()
Create a new function in AWS Lambda
deleteFunction()
Delete a function in AWS Lambda
getFunctionInfo()
Gets information about a function
getFunctions()
Lists available Remotion Lambda functions
getCompositionsOnLambda()
Gets list of compositions inside a Lambda function
deleteSite()
Delete a bundle from S3
deploySite()
Bundle and upload a site to S3
getAwsClient()
Access the AWS SDK directly
getRegions()
Get all available regions
getSites()
Get all available sites
downloadMedia()
Download a render artifact from S3
getUserPolicy()
Get the policy JSON for your AWS user
getRolePolicy()
Get the policy JSON for your AWS role
getOrCreateBucket()
Ensure a Remotion S3 bucket exists
getRenderProgress()
Query the progress of a render
presignUrl()
Make a private file public to those with the link
renderMediaOnLambda()
Trigger a video or audio render
renderStillOnLambda()
Trigger a still render
simulatePermissions()
Ensure permissions are correctly set up
speculateFunctionName()
Get the lambda function name based on its configuration
validateWebhookSignature()
Validate an incoming webhook request is authentic
CLI
See here for a list of CLI commands.