Three independently ugly bugs that all fed the same log flood:
* Electron's `WebFrameMain.send` writes every "Render frame was disposed"
to stderr via `console.error`. When the worker fans a second
agent-event past a reloading renderer, we produced thousands of
identical lines and stalled the main loop on stderr I/O. Added a
`mainFrame.detached` guard so the send is short-circuited before
Electron's own catch block fires, and installed a targeted filter in
`suppress-warnings.ts` (now actually imported from the entry point)
so the specific `console.error("Error sending from webFrameMain:"…)`
noise never reaches the terminal. Any other payload still surfaces.
* `dispatchAgentMessage` accepted the human-reader sentinel as a wake
target when an agent replied to `__board__` — `wakeAgentIfPossible`
then called `db.getAgent("__board__")`, threw, and the dispatcher
kept repeating on every send. Strip `HUMAN_SENDER_ID` at
`resolveMessageWakeTargets`, and keep a defense-in-depth guard in the
heartbeat so a stray caller (future automation fan-out) cannot
reintroduce the crash.
* Pi's skills loader rejects any SKILL.md whose frontmatter `name`
diverges from its parent directory. The four bundled `my-writing-style`
copies declared `name: writing-style-skill`, so every install emitted
a warning and dropped the skill. They also lived as orphan gitlinks
(mode 160000 without .gitmodules), and the global `*.md` gitignore
hid every other SKILL.md from version control. Fixed the frontmatter
to match the dir, converted the dangling submodules to plain trees,
and allowlisted `builtin-skills/**/*.md` so a fresh clone carries the
catalogue instead of silently losing it.
155 lines
3.7 KiB
Markdown
155 lines
3.7 KiB
Markdown
---
|
|
name: compositions
|
|
description: Defining compositions, stills, folders, default props and dynamic metadata
|
|
metadata:
|
|
tags: composition, still, folder, props, metadata
|
|
---
|
|
|
|
A `<Composition>` defines the component, width, height, fps and duration of a renderable video.
|
|
|
|
It normally is placed in the `src/Root.tsx` file.
|
|
|
|
```tsx
|
|
import { Composition } from "remotion";
|
|
import { MyComposition } from "./MyComposition";
|
|
|
|
export const RemotionRoot = () => {
|
|
return (
|
|
<Composition
|
|
id="MyComposition"
|
|
component={MyComposition}
|
|
durationInFrames={100}
|
|
fps={30}
|
|
width={1080}
|
|
height={1080}
|
|
/>
|
|
);
|
|
};
|
|
```
|
|
|
|
## Default Props
|
|
|
|
Pass `defaultProps` to provide initial values for your component.
|
|
Values must be JSON-serializable (`Date`, `Map`, `Set`, and `staticFile()` are supported).
|
|
|
|
```tsx
|
|
import { Composition } from "remotion";
|
|
import { MyComposition, MyCompositionProps } from "./MyComposition";
|
|
|
|
export const RemotionRoot = () => {
|
|
return (
|
|
<Composition
|
|
id="MyComposition"
|
|
component={MyComposition}
|
|
durationInFrames={100}
|
|
fps={30}
|
|
width={1080}
|
|
height={1080}
|
|
defaultProps={
|
|
{
|
|
title: "Hello World",
|
|
color: "#ff0000",
|
|
} satisfies MyCompositionProps
|
|
}
|
|
/>
|
|
);
|
|
};
|
|
```
|
|
|
|
Use `type` declarations for props rather than `interface` to ensure `defaultProps` type safety.
|
|
|
|
## Folders
|
|
|
|
Use `<Folder>` to organize compositions in the sidebar.
|
|
Folder names can only contain letters, numbers, and hyphens.
|
|
|
|
```tsx
|
|
import { Composition, Folder } from "remotion";
|
|
|
|
export const RemotionRoot = () => {
|
|
return (
|
|
<>
|
|
<Folder name="Marketing">
|
|
<Composition id="Promo" /* ... */ />
|
|
<Composition id="Ad" /* ... */ />
|
|
</Folder>
|
|
<Folder name="Social">
|
|
<Folder name="Instagram">
|
|
<Composition id="Story" /* ... */ />
|
|
<Composition id="Reel" /* ... */ />
|
|
</Folder>
|
|
</Folder>
|
|
</>
|
|
);
|
|
};
|
|
```
|
|
|
|
## Stills
|
|
|
|
Use `<Still>` for single-frame images. It does not require `durationInFrames` or `fps`.
|
|
|
|
```tsx
|
|
import { Still } from "remotion";
|
|
import { Thumbnail } from "./Thumbnail";
|
|
|
|
export const RemotionRoot = () => {
|
|
return (
|
|
<Still id="Thumbnail" component={Thumbnail} width={1280} height={720} />
|
|
);
|
|
};
|
|
```
|
|
|
|
## Calculate Metadata
|
|
|
|
Use `calculateMetadata` to make dimensions, duration, or props dynamic based on data.
|
|
|
|
```tsx
|
|
import { Composition, CalculateMetadataFunction } from "remotion";
|
|
import { MyComposition, MyCompositionProps } from "./MyComposition";
|
|
|
|
const calculateMetadata: CalculateMetadataFunction<
|
|
MyCompositionProps
|
|
> = async ({ props, abortSignal }) => {
|
|
const data = await fetch(`https://api.example.com/video/${props.videoId}`, {
|
|
signal: abortSignal,
|
|
}).then((res) => res.json());
|
|
|
|
return {
|
|
durationInFrames: Math.ceil(data.duration * 30),
|
|
props: {
|
|
...props,
|
|
videoUrl: data.url,
|
|
},
|
|
};
|
|
};
|
|
|
|
export const RemotionRoot = () => {
|
|
return (
|
|
<Composition
|
|
id="MyComposition"
|
|
component={MyComposition}
|
|
durationInFrames={100} // Placeholder, will be overridden
|
|
fps={30}
|
|
width={1080}
|
|
height={1080}
|
|
defaultProps={{ videoId: "abc123" }}
|
|
calculateMetadata={calculateMetadata}
|
|
/>
|
|
);
|
|
};
|
|
```
|
|
|
|
The function can return `props`, `durationInFrames`, `width`, `height`, `fps`, and codec-related defaults. It runs once before rendering begins.
|
|
|
|
## Nesting compositions within another
|
|
|
|
To add a composition within another composition, you can use the `<Sequence>` component with a `width` and `height` prop to specify the size of the composition.
|
|
|
|
```tsx
|
|
<AbsoluteFill>
|
|
<Sequence width={COMPOSITION_WIDTH} height={COMPOSITION_HEIGHT}>
|
|
<CompositionComponent />
|
|
</Sequence>
|
|
</AbsoluteFill>
|
|
```
|