Chapter 473: getRenderProgress()

Core Idea

Gets the current status of a render initiated via renderMediaOnLambda(). By default, calling this function results in a Lambda invocation.

Key Concepts

• Example
• API
• renderId
• bucketName
• region
• functionName
• customCredentials?<AvailableFrom v="3.2.23" />
• forcePathStyle?<AvailableFrom v="4.0.202" />

Code Examples

const progress = await getRenderProgress({
  renderId: 'd7nlc2y',
  bucketName: 'remotionlambda-d9mafgx',
  functionName: 'remotion-render-la8ffw',
  region: 'us-east-1',
});

• What it demonstrates: Usage pattern for getRenderProgress() from the official docs.

Key Takeaways

1. Understand example when working with getRenderProgress().
2. Understand api when working with getRenderProgress().
3. Understand renderid when working with getRenderProgress().
4. Understand bucketname when working with getRenderProgress().
5. Understand region when working with getRenderProgress().

Connects To

• api: related page in the Lambda (@remotion/lambda) section.
• Approuterwebhook: related page in the Lambda (@remotion/lambda) section.
• Authentication: related page in the Lambda (@remotion/lambda) section.