Skip to main content

downloadMedia()

Downloads a rendered video, audio or still to your local disk.

ts
import { downloadMedia } from "@remotion/lambda";
 
const { outputPath, sizeInBytes } = await downloadMedia({
bucketName: "remotionlambda-r42fs9fk",
region: "us-east-1",
renderId: "8hfxlw",
outPath: "out.mp4",
onProgress: ({ totalSize, downloaded, progress }) => {
console.log(
`Download progress: ${totalSize}/${downloaded} bytes (${(
progress * 100
).toFixed(0)}%)`
);
},
});
 
console.log(outputPath); // "/Users/yourname/remotion-project/out.mp4"
console.log(sizeInBytes); // 21249541
ts
import { downloadMedia } from "@remotion/lambda";
 
const { outputPath, sizeInBytes } = await downloadMedia({
bucketName: "remotionlambda-r42fs9fk",
region: "us-east-1",
renderId: "8hfxlw",
outPath: "out.mp4",
onProgress: ({ totalSize, downloaded, progress }) => {
console.log(
`Download progress: ${totalSize}/${downloaded} bytes (${(
progress * 100
).toFixed(0)}%)`
);
},
});
 
console.log(outputPath); // "/Users/yourname/remotion-project/out.mp4"
console.log(sizeInBytes); // 21249541

Arguments

An object with the following properties:

region

The AWS region in which the render has performed.

bucketName

The bucket name in which you the render was stored. This should be the same variable you used for renderMediaOnLambda().

renderId

The ID of the render. You can retrieve this ID by calling renderMediaOnLambda() or renderStillOnLambda().

outPath

Where the video should be saved. Pass an absolute path, or it will be resolved relative to your current working directory.

Return value

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

outputPath

The absolute path of where the file got saved.

sizeInBytes

The size of the file in bytes.

onProgress

See also