Skip to main content

Faster progress polling

By default, each getRenderProgress() call invokes the render function, which reads the render progress from S3.

Set skipLambdaInvocation to true to read the progress directly from S3 instead. This reduces the latency and avoids a Lambda invocation for each progress poll. It does not make the render itself faster.

poll-progress.ts
import {getRenderProgress, speculateFunctionName} from '@remotion/lambda/client';

const functionName = speculateFunctionName({
  memorySizeInMb: 2048,
  diskSizeInMb: 2048,
  timeoutInSeconds: 120,
});

const progress = await getRenderProgress({
  renderId: 'd7nlc2y',
  bucketName: 'remotionlambda-useast1-abcdefgh',
  functionName,
  region: 'us-east-1',
  skipLambdaInvocation: true,
});

Requirements​

  • The AWS credentials calling getRenderProgress() must have s3:GetObject permission for the Remotion bucket. The policy returned by getUserPolicy() includes this permission.

If this permission is not available, leave skipLambdaInvocation unset.

From v4.0.540, the function name does not need to follow the Remotion naming convention for fast progress polling. Earlier versions require it. The client and deployed function must use the same Remotion version.

See also​