Skip to main content

renderStillOnLambda()

Renders a still image inside a lambda function and writes it to the specified output location.

If you want to render a video or audio instead, use renderMediaOnLambda() instead.

If you want to render a still locally instead, use renderStill() instead.

Example​

tsx
import { renderStillOnLambda } from "@remotion/lambda/client";
 
const { estimatedPrice, url, sizeInBytes } = await renderStillOnLambda({
  region: "us-east-1",
  functionName: "remotion-render-bds9aab",
  serveUrl:
    "https://remotionlambda-qg35eyp1s1.s3.eu-central-1.amazonaws.com/sites/bf2jrbfkw",
  composition: "MyVideo",
  inputProps: {},
  imageFormat: "png",
  maxRetries: 1,
  privacy: "public",
  envVariables: {},
  frame: 10,
});
tsx
import { renderStillOnLambda } from "@remotion/lambda/client";
 
const { estimatedPrice, url, sizeInBytes } = await renderStillOnLambda({
  region: "us-east-1",
  functionName: "remotion-render-bds9aab",
  serveUrl:
    "https://remotionlambda-qg35eyp1s1.s3.eu-central-1.amazonaws.com/sites/bf2jrbfkw",
  composition: "MyVideo",
  inputProps: {},
  imageFormat: "png",
  maxRetries: 1,
  privacy: "public",
  envVariables: {},
  frame: 10,
});
note

Preferrably import this function from @remotion/lambda/client to avoid problems inside serverless functions.

Arguments​

An object with the following properties:

region​

In which region your Lambda function is deployed. It's highly recommended that your Remotion site is also in the same region.

functionName​

The name of the deployed Lambda function. Use deployFunction() to create a new function and getFunctions() to obtain currently deployed Lambdas.

serveUrl​

A URL pointing to a Remotion project. Use deploySite() to deploy a Remotion project.

composition​

The id of the composition you want to render..

inputProps​

React props that are passed to your composition. You define the shape of the props that the component accepts.

privacy​

One of:

  • "public" (default): The rendered still is publicly accessible under the S3 URL.
  • "private": The rendered still is not publicly available, but signed links can be created using presignUrl().
  • "no-acl" (available from v.3.1.7): The ACL option is not being set at all, this option is useful if you are writing to another bucket that does not support ACL using outName.

frame​

optional - default 0

Which frame of the composition should be rendered. Frames are zero-indexed.

From v3.2.27, negative values are allowed, with -1 being the last frame.

imageFormat?​

optional - default "png"

The image format that you want - either "png" or "jpeg".

quality?​

optional

Sets the quality of the generated JPEG images. Must be an integer between 0 and 100. Default is to leave it up to the browser, current default is 80.

Only applies if imageFormat is "jpeg", otherwise this option is invalid.

maxRetries?​

optional - default 1

How often a frame render may be retried until it fails.

envVariables?​

optional - default {}

See renderMedia() -> envVariables.

forceHeight​

optional, available from v3.2.40

Overrides the default composition height.

forceWidth​

optional, available from v3.2.40

Overrides the default composition width.

scale​

optional

Scales the output dimensions by a factor. See Scaling to learn more about this feature.

outName​

optional

It can either be:

  • undefined - it will default to out plus the appropriate file extension, for example: renders/${renderId}/out.mp4.
  • A string - it will get saved to the same S3 bucket as your site under the key renders/{renderId}/{outName}.
  • An object if you want to render to a different bucket or cloud provider - see here for detailed instructions

timeoutInMilliseconds?​

A number describing how long the render may take to resolve all delayRender() calls before it times out. Default: 30000

downloadBehavior​

optional, available since v3.1.5

How the output file should behave when accessed through the S3 output link in the browser.
Either:

  • {"type": "play-in-browser"} - the default. The video will play in the browser.
  • {"type": "download", fileName: null} or {"type": "download", fileName: "download.mp4"} - a Content-Disposition header will be added which makes the browser download the file. You can optionally override the filename.

chromiumOptions?​

Allows you to set certain Chromium / Google Chrome flags. See: Chromium flags.

disableWebSecurity​

boolean - default false

This will most notably disable CORS among other security features.

ignoreCertificateErrors​

boolean - default false

Results in invalid SSL certificates, such as self-signed ones, being ignored.

gl​

string

Select the OpenGL renderer backend for Chromium. Accepted values:

  • "angle",
  • "egl",
  • "swiftshader"
  • "swangle"
  • null - Chromiums default
note

The default for Lambda is "swangle", but null elsewhere.

userAgent v3.3.83​

Lets you set a custom user agent that the headless Chrome browser assumes.

forceBucketName?​

optional

Specify a specific bucket name to be used. This is not recommended, instead let Remotion discover the right bucket automatically.

logLevel?​

One of verbose, info, warn, error. Determines how much is being logged inside the Lambda function. Logs can be read through the CloudWatch URL that this function returns.

If the logLevel is set to verbose, the dumpBrowserLogs flag will also be enabled.

dumpBrowserLogs? v3.3.83​

If set to true, all console statements from the headless browser will be forwarded to the CloudWatch logs.

Return value​

Returns a promise resolving to an object with the following properties:

bucketName​

The S3 bucket in which the video was saved.

output​

An AWS S3 URL where the output is available.

estimatedPrice​

Object containing roughly estimated information about how expensive this operation was.

sizeInBytes​

The size of the output image in bytes.

renderId​

A unique alphanumeric identifier for this render. Useful for obtaining status and finding the relevant files in the S3 bucket.

cloudWatchLogs​

Available from v3.2.10

A link to CloudWatch (if you haven't disabled it) that you can visit to see the logs for the render.

See also​