Skip to content

guanyang/open-agent-hub / skills/remotion

remotion-best-practices

Verified

Best practices and domain knowledge for building videos programmatically with Remotion (videos in React/TypeScript, rendered to MP4). Use whenever writing or editing Remotion code — scaffolding a video project, animating with interpolate/spring over useCurrentFrame(), sequencing scenes and transitions, captions/subtitles, audio, GIFs/Lottie/3D, charts, visual effects, dynamic duration via calculateMetadata, or rendering. Consult before reaching for a Remotion API, since its components and props evolve (e.g. @remotion/media).

FileKindSize
SKILL.mdskill md12.0 KB
rules/3d.mdmarkdown2.2 KB
rules/animations.mdmarkdown1.1 KB
rules/assets.mdmarkdown1.6 KB
rules/assets/charts-bar-chart.tsxother3.3 KB
rules/assets/text-animations-typewriter.tsxother2.1 KB
rules/assets/text-animations-word-highlight.tsxother2.3 KB
rules/audio-visualization.mdmarkdown4.8 KB
rules/audio.mdmarkdown3.5 KB
rules/calculate-metadata.mdmarkdown3.2 KB
rules/can-decode.mdmarkdown1.6 KB
rules/charts.mdmarkdown2.9 KB
rules/compositions.mdmarkdown3.3 KB
rules/display-captions.mdmarkdown5.3 KB
rules/effects.mdmarkdown7.9 KB
rules/extract-frames.mdmarkdown5.4 KB
rules/ffmpeg.mdmarkdown1.1 KB
rules/fonts.mdmarkdown3.4 KB
rules/get-audio-duration.mdmarkdown1.3 KB
rules/get-video-dimensions.mdmarkdown1.6 KB
rules/get-video-duration.mdmarkdown1.3 KB
rules/gifs.mdmarkdown3.6 KB
rules/google-fonts.mdmarkdown1.7 KB
rules/html-in-canvas.mdmarkdown3.5 KB
rules/images.mdmarkdown1.4 KB
rules/import-srt-captions.mdmarkdown2.2 KB
rules/light-leaks.mdmarkdown2.3 KB
rules/local-fonts.mdmarkdown1.5 KB
rules/lottie.mdmarkdown1.8 KB
rules/mapbox.mdmarkdown11.0 KB
rules/maplibre.mdmarkdown12.2 KB
rules/maps.mdmarkdown11.0 KB
rules/measuring-dom-nodes.mdmarkdown973 B
rules/measuring-text.mdmarkdown2.7 KB
rules/parameters.mdmarkdown2.3 KB
rules/sequencing.mdmarkdown3.2 KB
rules/sfx.mdmarkdown1.8 KB
rules/silence-detection.mdmarkdown2.5 KB
rules/subtitles.mdmarkdown922 B
rules/tailwind.mdmarkdown420 B
rules/text-animations.mdmarkdown700 B
rules/timing.mdmarkdown5.4 KB
rules/transcribe-captions.mdmarkdown1.9 KB
rules/transitions.mdmarkdown5.7 KB
rules/transparent-videos.mdmarkdown2.2 KB
rules/trimming.mdmarkdown1.2 KB
rules/video-layout.mdmarkdown4.0 KB
rules/videos.mdmarkdown3.4 KB
rules/voiceover.mdmarkdown3.2 KB

rules/calculate-metadata.md

View on GitHub
---
name: calculate-metadata
description: Dynamically set composition duration, dimensions, and props
metadata:
  tags: calculateMetadata, duration, dimensions, props, dynamic
---

# Using calculateMetadata

Use `calculateMetadata` on a `<Composition>` to dynamically set duration, dimensions, and transform props before rendering.

```tsx
<Composition
  id="MyComp"
  component={MyComponent}
  durationInFrames={300}
  fps={30}
  width={1920}
  height={1080}
  defaultProps={{ videoSrc: "https://remotion.media/video.mp4" }}
  calculateMetadata={calculateMetadata}
/>
```

## Setting duration based on a video

Use the [`getVideoDuration`](./get-video-duration.md) and [`getVideoDimensions`](./get-video-dimensions.md) skills to get the video duration and dimensions:

```tsx
import { CalculateMetadataFunction } from "remotion";
import { getVideoDuration } from "./get-video-duration";

const calculateMetadata: CalculateMetadataFunction<Props> = async ({
  props,
}) => {
  const durationInSeconds = await getVideoDuration(props.videoSrc);

  return {
    durationInFrames: Math.ceil(durationInSeconds * 30),
  };
};
```

## Matching dimensions of a video

Use the [`getVideoDimensions`](./get-video-dimensions.md) skill to get the video dimensions:

```tsx
import { CalculateMetadataFunction } from "remotion";
import { getVideoDuration } from "./get-video-duration";
import { getVideoDimensions } from "./get-video-dimensions";

const calculateMetadata: CalculateMetadataFunction<Props> = async ({
  props,
}) => {
  const dimensions = await getVideoDimensions(props.videoSrc);

  return {
    width: dimensions.width,
    height: dimensions.height,
  };
};
```

## Setting duration based on multiple videos

```tsx
const calculateMetadata: CalculateMetadataFunction<Props> = async ({
  props,
}) => {
  const metadataPromises = props.videos.map((video) =>
    getVideoDuration(video.src),
  );
  const allMetadata = await Promise.all(metadataPromises);

  const totalDuration = allMetadata.reduce(
    (sum, durationInSeconds) => sum + durationInSeconds,
    0,
  );

  return {
    durationInFrames: Math.ceil(totalDuration * 30),
  };
};
```

## Setting a default outName

Set the default output filename based on props:

```tsx
const calculateMetadata: CalculateMetadataFunction<Props> = async ({
  props,
}) => {
  return {
    defaultOutName: `video-${props.id}`, // .mp4 is added automatically
  };
};
```

## Transforming props

Fetch data or transform props before rendering:

```tsx
const calculateMetadata: CalculateMetadataFunction<Props> = async ({
  props,
  abortSignal,
}) => {
  const response = await fetch(props.dataUrl, { signal: abortSignal });
  const data = await response.json();

  return {
    props: {
      ...props,
      fetchedData: data,
    },
  };
};
```

The `abortSignal` cancels stale requests when props change in the Studio.

## Return value

All fields are optional. Returned values override the `<Composition>` props:

- `durationInFrames`: Number of frames
- `width`: Composition width in pixels
- `height`: Composition height in pixels
- `fps`: Frames per second
- `props`: Transformed props passed to the component
- `defaultOutName`: Default output filename
- `defaultCodec`: Default codec for rendering
brainstormingobra/superpowersYou MUST use this before any creative work - creating features, building components, adding functionality, modifying behavior, or planning anything new, in software or out of it (a talk, a business, a renovation).Stars: 322kUpdated Claude CodeCodexVerifiedInstall
brand-guidelinesanthropics/skillsApplies Anthropic's official brand colors and typography to any sort of artifact that may benefit from having Anthropic's look-and-feel. Use it when brand colors or style guidelines, visual formatting, or company design standards apply.Stars: 198kUpdated Claude CodeCodexVerifiedInstall
frontend-designanthropics/skillsGuidance for distinctive, intentional visual design when building new UI or reshaping an existing one. Helps with aesthetic direction, typography, and making choices that don't read as templated defaults.Stars: 198kUpdated Claude CodeCodexVerifiedInstall
mcp-builderanthropics/skillsGuide for creating high-quality MCP (Model Context Protocol) servers that enable LLMs to interact with external services through well-designed tools. Use when building MCP servers to integrate external APIs or services, whether in Python (FastMCP) or Node/TypeScript (MCP SDK).Stars: 198kUpdated Claude CodeCodexVerifiedInstall