remotion
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
Chinese@json-render/remotion
@json-render/remotion
Remotion renderer that converts JSON timeline specs into video compositions.
可将JSON时间线规范转换为视频合成内容的Remotion渲染器。
Quick Start
快速开始
typescript
import { Player } from "@remotion/player";
import { Renderer, type TimelineSpec } from "@json-render/remotion";
function VideoPlayer({ spec }: { spec: TimelineSpec }) {
return (
<Player
component={Renderer}
inputProps={{ spec }}
durationInFrames={spec.composition.durationInFrames}
fps={spec.composition.fps}
compositionWidth={spec.composition.width}
compositionHeight={spec.composition.height}
controls
/>
);
}typescript
import { Player } from "@remotion/player";
import { Renderer, type TimelineSpec } from "@json-render/remotion";
function VideoPlayer({ spec }: { spec: TimelineSpec }) {
return (
<Player
component={Renderer}
inputProps={{ spec }}
durationInFrames={spec.composition.durationInFrames}
fps={spec.composition.fps}
compositionWidth={spec.composition.width}
compositionHeight={spec.composition.height}
controls
/>
);
}Using Standard Components
使用标准组件
typescript
import { defineCatalog } from "@json-render/core";
import {
schema,
standardComponentDefinitions,
standardTransitionDefinitions,
standardEffectDefinitions,
} from "@json-render/remotion";
export const videoCatalog = defineCatalog(schema, {
components: standardComponentDefinitions,
transitions: standardTransitionDefinitions,
effects: standardEffectDefinitions,
});typescript
import { defineCatalog } from "@json-render/core";
import {
schema,
standardComponentDefinitions,
standardTransitionDefinitions,
standardEffectDefinitions,
} from "@json-render/remotion";
export const videoCatalog = defineCatalog(schema, {
components: standardComponentDefinitions,
transitions: standardTransitionDefinitions,
effects: standardEffectDefinitions,
});Adding Custom Components
添加自定义组件
typescript
import { z } from "zod";
const catalog = defineCatalog(schema, {
components: {
...standardComponentDefinitions,
MyCustomClip: {
props: z.object({ text: z.string() }),
type: "scene",
defaultDuration: 90,
description: "My custom video clip",
},
},
});
// Pass custom component to Renderer
<Player
component={Renderer}
inputProps={{
spec,
components: { MyCustomClip: MyCustomComponent },
}}
/>typescript
import { z } from "zod";
const catalog = defineCatalog(schema, {
components: {
...standardComponentDefinitions,
MyCustomClip: {
props: z.object({ text: z.string() }),
type: "scene",
defaultDuration: 90,
description: "My custom video clip",
},
},
});
// Pass custom component to Renderer
<Player
component={Renderer}
inputProps={{
spec,
components: { MyCustomClip: MyCustomComponent },
}}
/>Timeline Spec Structure
时间线规范结构
json
{
"composition": { "id": "video", "fps": 30, "width": 1920, "height": 1080, "durationInFrames": 300 },
"tracks": [{ "id": "main", "name": "Main", "type": "video", "enabled": true }],
"clips": [
{ "id": "clip-1", "trackId": "main", "component": "TitleCard", "props": { "title": "Hello" }, "from": 0, "durationInFrames": 90 }
],
"audio": { "tracks": [] }
}json
{
"composition": { "id": "video", "fps": 30, "width": 1920, "height": 1080, "durationInFrames": 300 },
"tracks": [{ "id": "main", "name": "Main", "type": "video", "enabled": true }],
"clips": [
{ "id": "clip-1", "trackId": "main", "component": "TitleCard", "props": { "title": "Hello" }, "from": 0, "durationInFrames": 90 }
],
"audio": { "tracks": [] }
}Standard Components
标准组件
| Component | Type | Description |
|---|---|---|
| scene | Full-screen title with subtitle |
| scene | Terminal-style typing animation |
| image | Full-screen image display |
| scene | Two-panel comparison |
| scene | Quote with attribution |
| scene | Animated statistic display |
| overlay | Text overlay |
| overlay | Name/title overlay |
| 组件 | 类型 | 描述 |
|---|---|---|
| scene | 全屏标题加副标题 |
| scene | 终端风格打字动画 |
| image | 全屏图片展示 |
| scene | 双面板对比 |
| scene | 带署名的引语 |
| scene | 动效统计数据展示 |
| overlay | 文字浮层 |
| overlay | 姓名/头衔浮层 |
Key Exports
核心导出
| Export | Purpose |
|---|---|
| Render spec to Remotion composition |
| Timeline schema |
| Pre-built component registry |
| Catalog definitions |
| Transition animation hook |
| Wrap clips with transitions |
| 导出项 | 用途 |
|---|---|
| 将规范渲染为Remotion合成内容 |
| 时间线Schema |
| 预置组件注册表 |
| 目录定义 |
| 转场动画Hook |
| 为片段添加转场包裹 |