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
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
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,
});

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 name 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

Whether the output in the S3 bucket should be public or private. Either "private" or "public".

frame

optional - default 0

Which frame of the composition should be rendered.

imageFormat?

optional - default "png"

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

quality?

optional

Sets the quality of the generate 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.

outName

optional

The file name of the media output.

It can either be:

  • undefined - it will default to out plus the appropriate file extension, for example: renders/${renderId}/out.mp4. The outName must match /^([0-9a-zA-Z-!_.*'()/]+)$/g.
  • A string - it will get saved to the same S3 bucket as your site under the key renders/{renderId}/{outName}.
  • An object of shape { key: string; bucketName: string }. This will save the render to an arbitrary bucket with an arbitrary key. Note the following restrictions:
    • You must extend the default Remotion policy to allow read and write access to that bucket.
    • The bucket must be in the same region.
    • When calling APIs such as downloadMedia() or getRenderProgress(), you must pass the bucket name where the site resides in, not the bucket where the video gets saved.
    • The key must match /^([0-9a-zA-Z-!_.*'()]+)$/g and the bucketName must match /^(?=^.{3,63}$)(?!^(\d+\.)+\d+$)(^(([a-z0-9]|[a-z0-9][a-z0-9-]*[a-z0-9])\.)*([a-z0-9]|[a-z0-9][a-z0-9-]*[a-z0-9])$)/.

timeoutInMilliseconds?

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

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.

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.

See also