Emanuel Almeida
2cb3210962
Plugins: automacao, crm-ops, design-media, dev-tools, gestao, infraestrutura, marketing, negocio, perfex-dev, project-manager, wordpress + hello-plugin (existente). Totais: 83 skills, 44 agents, 12 datasets.json Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
131 lines
2.7 KiB
Markdown
131 lines
2.7 KiB
Markdown
---
|
|
name: images
|
|
description: Embedding images in Remotion using the <Img> component
|
|
metadata:
|
|
tags: images, img, staticFile, png, jpg, svg, webp
|
|
---
|
|
|
|
# Using images in Remotion
|
|
|
|
## The `<Img>` component
|
|
|
|
Always use the `<Img>` component from `remotion` to display images:
|
|
|
|
```tsx
|
|
import { Img, staticFile } from "remotion";
|
|
|
|
export const MyComposition = () => {
|
|
return <Img src={staticFile("photo.png")} />;
|
|
};
|
|
```
|
|
|
|
## Important restrictions
|
|
|
|
**You MUST use the `<Img>` component from `remotion`.** Do not use:
|
|
|
|
- Native HTML `<img>` elements
|
|
- Next.js `<Image>` component
|
|
- CSS `background-image`
|
|
|
|
The `<Img>` component ensures images are fully loaded before rendering, preventing flickering and blank frames during video export.
|
|
|
|
## Local images with staticFile()
|
|
|
|
Place images in the `public/` folder and use `staticFile()` to reference them:
|
|
|
|
```
|
|
my-video/
|
|
├─ public/
|
|
│ ├─ logo.png
|
|
│ ├─ avatar.jpg
|
|
│ └─ icon.svg
|
|
├─ src/
|
|
├─ package.json
|
|
```
|
|
|
|
```tsx
|
|
import { Img, staticFile } from "remotion";
|
|
|
|
<Img src={staticFile("logo.png")} />
|
|
```
|
|
|
|
## Remote images
|
|
|
|
Remote URLs can be used directly without `staticFile()`:
|
|
|
|
```tsx
|
|
<Img src="https://example.com/image.png" />
|
|
```
|
|
|
|
Ensure remote images have CORS enabled.
|
|
|
|
For animated GIFs, use the `<Gif>` component from `@remotion/gif` instead.
|
|
|
|
## Sizing and positioning
|
|
|
|
Use the `style` prop to control size and position:
|
|
|
|
```tsx
|
|
<Img
|
|
src={staticFile("photo.png")}
|
|
style={{
|
|
width: 500,
|
|
height: 300,
|
|
position: "absolute",
|
|
top: 100,
|
|
left: 50,
|
|
objectFit: "cover",
|
|
}}
|
|
/>
|
|
```
|
|
|
|
## Dynamic image paths
|
|
|
|
Use template literals for dynamic file references:
|
|
|
|
```tsx
|
|
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:
|
|
|
|
- Image sequences (frame-by-frame animations)
|
|
- User-specific avatars or profile images
|
|
- Theme-based icons
|
|
- State-dependent graphics
|
|
|
|
## Getting image dimensions
|
|
|
|
Use `getImageDimensions()` to get the dimensions of an image:
|
|
|
|
```tsx
|
|
import { getImageDimensions, staticFile } from "remotion";
|
|
|
|
const { width, height } = await getImageDimensions(staticFile("photo.png"));
|
|
```
|
|
|
|
This is useful for calculating aspect ratios or sizing compositions:
|
|
|
|
```tsx
|
|
import { getImageDimensions, staticFile, CalculateMetadataFunction } from "remotion";
|
|
|
|
const calculateMetadata: CalculateMetadataFunction = async () => {
|
|
const { width, height } = await getImageDimensions(staticFile("photo.png"));
|
|
return {
|
|
width,
|
|
height,
|
|
};
|
|
};
|
|
```
|