name: images description: Embedding images in Remotion using the component metadata:
<Img> componentAlways use the <Img> component from remotion to display images:
import { Img, staticFile } from "remotion";
export const MyComposition = () => {
return <Img src={staticFile("photo.png")} />;
};
You MUST use the <Img> component from remotion. Do not use:
<img> elements<Image> componentbackground-imageThe <Img> component ensures images are fully loaded before rendering, preventing flickering and blank frames during video export.
Place images in the public/ folder and use staticFile() to reference them:
my-video/ ├─ public/ │ ├─ logo.png │ ├─ avatar.jpg │ └─ icon.svg ├─ src/ ├─ package.json
import { Img, staticFile } from "remotion";
<Img src={staticFile("logo.png")} />;
Remote URLs can be used directly without staticFile():
<Img src="https://example.com/image.png" />
Ensure remote images have CORS enabled.
For animated GIFs, use the <Gif> component from @remotion/gif instead.
Use the style prop to control size and position:
<Img
src={staticFile("photo.png")}
style={{
width: 500,
height: 300,
position: "absolute",
top: 100,
left: 50,
objectFit: "cover",
}}
/>
Use template literals for dynamic file references:
import { Img, staticFile, useCurrentFrame } from "remotion";
const frame = useCurrentFrame();
// Image sequence
<Img src={staticFile(`frames/frame${frame}.png`)} />
// Selecting based on props
<Img src={staticFile(`avatars/${props.userId}.png`)} />
// Conditional images
<Img src={staticFile(`icons/${isActive ? "active" : "inactive"}.svg`)} />
This pattern is useful for:
Use getImageDimensions() to get the dimensions of an image:
import { getImageDimensions, staticFile } from "remotion";
const { width, height } = await getImageDimensions(staticFile("photo.png"));
This is useful for calculating aspect ratios or sizing compositions:
import {
getImageDimensions,
staticFile,
CalculateMetadataFunction,
} from "remotion";
const calculateMetadata: CalculateMetadataFunction = async () => {
const { width, height } = await getImageDimensions(staticFile("photo.png"));
return {
width,
height,
};
};