Remotion Claude 技能文件
概述
Remotion Claude 技能 是一個全面的 TypeScript 模組,讓您可以直接在 Claude AI 中進行程式化影片創作與渲染。它提供了一個直觀的 API,用於使用 React 元件來建立、管理和渲染影片合成。
功能特色
- ✅ 建立影片合成 - 使用 React 元件定義影片專案
- ✅ 管理合成 - 註冊、擷取和組織影片合成
- ✅ 渲染佇列管理 - 將合成加入佇列以進行批次渲染
- ✅ 多種輸出格式 - 支援 h264、h265、VP8、VP9、ProRes、PNG 序列
- ✅ 模板系統 - 為常見影片模式提供預建模板
- ✅ 元件庫 - 即用型元件,如 TextOverlay 和動畫
- ✅ 型別安全 - 全面的 TypeScript 支援與完整的介面
安裝
# 複製 Remotion 儲存庫
git clone https://github.com/remotion-dev/remotion.git
cd remotion
# 安裝依賴
bun install
# 技能位於:
packages/skills-evals/remotion-claude-skill.ts
快速入門
1. 建立技能實例
import { createRemotionSkill } from './remotion-claude-skill';
const skill = createRemotionSkill({
projectName: 'my-video-project',
width: 1920,
height: 1080,
fps: 30,
durationInFrames: 150,
});
2. 建立 React 元件
import React from 'react';
export const MyVideo: React.FC<{ title: string }> = ({ title }) => {
return (
<div style={{
flex: 1,
backgroundColor: '#000',
display: 'flex',
justifyContent: 'center',
alignItems: 'center',
fontSize: 100,
color: '#fff',
fontWeight: 'bold',
}}>
{title}
</div>
);
};
3. 註冊合成
skill.createComposition(
'my-video',
'My Video Title',
MyVideo,
{
durationInFrames: 150,
fps: 30,
width: 1920,
height: 1080,
defaultProps: { title: 'Hello World' },
}
);
4. 加入渲染佇列
skill.queueForRender('my-video', {
codec: 'h264',
outputLocation: './output/my-video.mp4',
overwrite: true,
});
5. 取得後設資料
const metadata = skill.getMetadata();
console.log(metadata);
// {
// name: 'Remotion Claude Skill',
// version: '1.0.0',
// compositionsCount: 1,
// queueLength: 1,
// ...
// }
API 參考
RemotionClaudeSkill 類別
建構函式
constructor(config: RemotionSkillConfig)
使用提供的組態建立新的技能實例。
參數:
config:包含寬度、高度、FPS、durationInFrames、projectName 的組態物件
方法
createComposition(id, name, component, options?): CompositionDefinition
建立並註冊一個新的合成。
skill.createComposition(
'intro',
'Intro Sequence',
IntroComponent,
{
durationInFrames: 200,
fps: 60,
width: 1920,
height: 1080,
defaultProps: { subtitle: 'My Project' },
}
);
registerComposition(definition): void
註冊一個已定義的合成。
const composition: CompositionDefinition = {
id: 'outro',
name: 'Outro Sequence',
component: OutroComponent,
durationInFrames: 150,
fps: 30,
width: 1920,
height: 1080,
};
skill.registerComposition(composition);
getCompositions(): CompositionDefinition[]
回傳所有已註冊的合成。
const all = skill.getCompositions();
console.log(`Total compositions: ${all.length}`);
getComposition(id): CompositionDefinition | undefined
根據 ID 取得特定合成。
const intro = skill.getComposition('intro');
if (intro) {
console.log(`Found: ${intro.name}`);
}
queueForRender(compositionId, options): void
將合成加入渲染佇列。
skill.queueForRender('intro', {
codec: 'h264',
outputLocation: './videos/intro.mp4',
crf: 18,
concurrency: 4,
overwrite: true,
});
getRenderQueue(): RenderOptions[]
回傳所有已佇列的渲染工作。
const queue = skill.getRenderQueue();
console.log(`Queued jobs: ${queue.length}`);
clearRenderQueue(): void
清除所有已佇列的渲染工作。
skill.clearRenderQueue();
getMetadata(): object
回傳技能後設資料與統計資料。
const metadata = skill.getMetadata();
console.log(metadata.capabilities);
generateTemplate(type?): string
為影片元件產生模板。
// 選項:'intro' | 'animation' | 'slideshow'
const template = skill.generateTemplate('animation');
console.log(template);
介面
RemotionSkillConfig
interface RemotionSkillConfig {
projectName: string;
width: number;
height: number;
fps: number;
durationInFrames: number;
}
CompositionDefinition
interface CompositionDefinition {
id: string;
name: string;
component: React.ComponentType;
durationInFrames: number;
fps: number;
width: number;
height: number;
defaultProps?: Record<string, unknown>;
}
RenderOptions
interface RenderOptions {
codec: 'h264' | 'h265' | 'vp8' | 'vp9' | 'prores' | 'png';
pixelFormat?: 'yuv420p' | 'yuv422p' | 'yuv444p';
crf?: number;
audioBitrate?: string;
videoBitrate?: string;
outputLocation: string;
concurrency?: number;
overwrite?: boolean;
logFn?: (message: string) => void;
errorFn?: (error: Error) => void;
}
內建元件
TextOverlay
一個簡單的文字疊加元件。
import { TextOverlay } from './remotion-claude-skill';
export const MyVideo = () => (
<TextOverlay
text="Hello Claude!"
fontSize={80}
color="#fff"
backgroundColor="rgba(0,0,0,0.7)"
/>
);
動畫工具
createFadeInAnimation
產生淡入動畫的 CSS。
import { createFadeInAnimation } from './remotion-claude-skill';
const animation = createFadeInAnimation(150, 30);
// 回傳:"@keyframes fadeIn { ... }"
模板
片頭模板
const template = skill.generateTemplate('intro');
建立一個在黑色背景上顯示的簡單文字標題。
動畫模板
const template = skill.generateTemplate('animation');
展示彈簧動畫和縮放效果。
幻燈片模板
const template = skill.generateTemplate('slideshow');
展示如何建立多個序列以達到幻燈片效果。
完整範例
import React from 'react';
import { createRemotionSkill, TextOverlay } from './remotion-claude-skill';
import { useCurrentFrame, useVideoConfig } from 'remotion';
// 建立技能實例
const skill = createRemotionSkill({
projectName: 'demo',
width: 1920,
height: 1080,
fps: 30,
durationInFrames: 300,
});
// 定義元件
const DemoVideo: React.FC<{ message: string }> = ({ message }) => {
const frame = useCurrentFrame();
const { durationInFrames, fps } = useVideoConfig();
const progress = frame / durationInFrames;
const opacity = Math.min(progress * 2, 1);
return (
<div style={{
flex: 1,
backgroundColor: '#1a1a2e',
display: 'flex',
justifyContent: 'center',
alignItems: 'center',
opacity,
}}>
<TextOverlay
text={message}
fontSize={100}
color="#00d4ff"
backgroundColor="rgba(0,0,0,0.8)"
/>
</div>
);
};
// 註冊合成
skill.createComposition('demo', 'Demo Video', DemoVideo, {
durationInFrames: 300,
fps: 30,
width: 1920,
height: 1080,
defaultProps: { message: 'Welcome to Remotion + Claude' },
});
// 加入渲染佇列
skill.queueForRender('demo', {
codec: 'h264',
outputLocation: './output/demo.mp4',
crf: 18,
overwrite: true,
});
// 檢查後設資料
console.log(skill.getMetadata());
進階功能
多個合成
skill.createComposition('intro', 'Intro', IntroComponent, {...});
skill.createComposition('main', 'Main Content', MainComponent, {...});
skill.createComposition('outro', 'Outro', OutroComponent, {...});
// 將所有合成加入渲染佇列
for (const comp of skill.getCompositions()) {
skill.queueForRender(comp.id, {
codec: 'h264',
outputLocation: `./videos/${comp.id}.mp4`,
overwrite: true,
});
}
自訂屬性
interface VideoProps {
title: string;
subtitle: string;
duration: number;
}
const MyVideo: React.FC<VideoProps> = ({ title, subtitle, duration }) => {
// 元件程式碼
};
skill.createComposition('custom', 'Custom Video', MyVideo, {
defaultProps: {
title: 'My Title',
subtitle: 'My Subtitle',
duration: 5,
},
});
條件式渲染
const ConditionalVideo: React.FC<{ showSubtitle?: boolean }> = ({ showSubtitle }) => {
return (
<div>
<h1>Main Content</h1>
{showSubtitle && <h2>Subtitle</h2>}
</div>
);
};
最佳實務
- 使用 TypeScript - 充分利用元件和屬性的型別安全
- 建立可重複使用的元件 - 為常見模式建立元件庫
- 最佳化效能 - 對大量計算使用 memoization
- 批次渲染 - 將多個合成加入佇列以減少啟動開銷
- 處理錯誤 - 在 RenderOptions 中使用
errorFn進行錯誤處理 - 驗證屬性 - 始終驗證預設屬性和使用者輸入
疑難排解
找不到合成
try {
skill.queueForRender('nonexistent', {...});
} catch (error) {
console.error('Composition not found:', error.message);
}
渲染佇列管理
// 在加入新工作前清除佇列
skill.clearRenderQueue();
// 檢查佇列長度
console.log(`Pending renders: ${skill.getRenderQueue().length}`);
組態驗證
const config = skill.getMetadata();
console.log('Current Configuration:');
console.log(`- Resolution: ${config.config.width}x${config.config.height}`);
console.log(`- FPS: ${config.config.fps}`);
console.log(`- Duration: ${config.config.durationInFrames} frames`);
與 Claude 整合
在 Claude 對話中
- 參考此技能以互動式地建立影片
- 即時修改元件
- 將多個版本加入佇列以便比較
- 將組態匯出為 JSON
Claude 互動範例
使用者:"為我的播客建立一個片頭影片"
Claude:我將使用 Remotion Claude 技能為您建立一個片頭影片。
skill.createComposition('podcast-intro', 'Podcast Intro', PodcastIntro, {
durationInFrames: 180,
fps: 30,
width: 1920,
height: 1080,
defaultProps: {
podcastName: '您的播客名稱',
tagline: '重要的對話',
},
});
資源連結
授權條款
此技能遵循與 Remotion 相同的授權條款。詳情請參閱 LICENSE.md。
貢獻指南
若要為此技能貢獻改進:
- Fork 此儲存庫
- 建立一個功能分支
- 進行您的修改
- 提交 Pull Request
詳情請參閱 CONTRIBUTING.md。
支援
- 📖 文件
- 💬 Discord 社群
- 🐛 問題追蹤器
- 🌐 官方網站