Dies ist eine Anleitung zum Schreiben von Remotion React Markup. Falls dies nicht relevant ist, laden Sie stattdessen die Remotion Best Practices.
Änderungen des Benutzers bewahren
Benutzer können außerhalb des Gesprächs Code-Änderungen vornehmen.
Wenn Sie zwischenzeitlich eine überraschende Änderung entdecken, überschreiben Sie diese nicht. Gehen Sie davon aus, dass sie beabsichtigt ist, oder fragen Sie nach einer Bestätigung.
Allgemeine Regeln
Steuern Sie Animationen mit useCurrentFrame() und interpolate().
CSS transition oder animation werden nicht korrekt gerendert und müssen umgestellt werden.
Tailwind-Animationsklassen werden nicht korrekt gerendert und müssen umgestellt werden.
Verwenden Sie Easing.bezier() und Easing.spring(), um das Timing anzupassen.
Strukturieren Sie Ihr Markup gemäß den Remotion Interactivity Best Practices.
Bevorzugen Sie Interactive.withSchema({wrapInSequence: true}) für benutzerdefinierte visuelle Komponenten
mit bearbeitbaren Props und registrieren Sie wiederverwendbare Szenen als Connected Compositions.
Setzen Sie Timing direkt auf Komponenten, die es unterstützen; vermeiden Sie redundante <Sequence>-Wrapper.
Geben Sie jeder zeitgesteuerten Komponente, die premountFor unterstützt, eine Sekunde Vorladezeit:
premountFor={fps}, wobei fps von useVideoConfig() stammt. Wenden Sie dies an auf
Medien, interaktive Komponenten, <Sequence>, <Series.Sequence>,
<TransitionSeries.Sequence> und <TransitionSeries.Overlay>, inklusive
zeitgesteuerte Komponenten, die in Szenen verschachtelt sind. Laden Sie auch das übergeordnete Timeline-Element vor,
wenn ein verschachteltes Element montiert werden muss, bevor die übergeordnete Komponente startet. Eine Komponente ohne
premountFor, wie z.B. <TransitionSeries.Transition>, benötigt keinen Ersatz.
Das Studio bearbeitet den JSX-Quellknoten, der ein Element erstellt hat. Schreiben Sie jede Compositon-Registrierung, jeden Clip, jede Szene, jede Ebene und jede Sequenz, die unabhängig bearbeitbar sein soll, als eigenen JSX-Knoten mit seinen bearbeitbaren Props inline. Programmatische Schleifen sind geeignet, wenn die generierten Instanzen absichtlich als eine Quellvorlage gesteuert werden, nicht wenn Benutzer die Instanzen separat bearbeiten müssen.
import { useCurrentFrame, useVideoConfig, Easing, interpolate, Interactive } from "remotion";
export const FadeIn = () => {
const frame = useCurrentFrame();
const {fps} = useVideoConfig();
return (
<Interactive.Div
name="Title"
premountFor={fps}
style={{
opacity: interpolate(frame, [0, 2 * fps], [0, 1], {
extrapolateRight: "clamp",
extrapolateLeft: "clamp",
easing: Easing.bezier(0.16, 1, 0.3, 1),
}),
}}
>
Hallo Welt!
</Interactive.Div>
);
};
Halten Sie den interpolate()-Aufruf inline in der style-Prop.
Verwenden Sie scale, translate, rotate CSS-Eigenschaften anstelle von transform.
// 👍 Inline bearbeitbare Keyframes und Transform-Kurzschreibweisen
style={{
scale: interpolate(frame, [0, 100], [0, 1], {
extrapolateLeft: 'clamp',
extrapolateRight: 'clamp',
easing: Easing.spring({damping: 200}),
output: 'perceptual-scale' // Für `scale`-Animationen "output: 'perceptual-scale'" verwenden
}),
translate: interpolate(frame, [0, 100], ["0px 0px", "100px 100px"], {
extrapolateLeft: 'clamp',
extrapolateRight: 'clamp',
easing: Easing.spring({damping: 200}),
}),
rotate: interpolate(frame, [0, 100], ["20deg", "90deg"], {
extrapolateLeft: 'clamp',
extrapolateRight: 'clamp',
easing: Easing.spring({damping: 200}),
}),
}}
// 👎 Nicht-Inline-Werte und Transform-Strings sind im Studio schwerer zu bearbeiten
const scale = interpolate(frame, [0, 100], [0, 1]);
style={{
transform: `scale(${scale})`,
}}
Assets
Platzieren Sie Assets im public/-Verzeichnis im Stammverzeichnis Ihres Projekts.
Verwenden Sie staticFile(), um Dateien aus dem public/-Verzeichnis zu referenzieren.
Medienkomponenten
Fügen Sie Video und Audio mit <Video> und <Audio> von @remotion/media hinzu.
Fügen Sie Bilder mit der <CanvasImage>-Komponente hinzu.
Fügen Sie animierte GIFs, APNG-, WebP- oder AVIF-Bilder mit <AnimatedImage> hinzu. Verwenden Sie @remotion/gif, falls nicht in Chrome.
Verwenden Sie staticFile() für Dateien in public/ oder übergeben Sie eine entfernte URL direkt:
import { Audio, Video } from "@remotion/media";
import { staticFile, CanvasImage, AnimatedImage, useVideoConfig } from "remotion";
export const MyComposition = () => {
const {fps} = useVideoConfig();
return (
<>
<Video src={staticFile("video.mp4")} premountFor={fps} style={{ opacity: 0.5 }} />
<Audio src={staticFile("audio.mp3")} premountFor={fps} />
<CanvasImage
src={staticFile("logo.png")}
premountFor={fps}
style={{ width: 100, height: 100 }}
/>
<Video src="https://remotion.media/video.mp4" premountFor={fps} />
<AnimatedImage src={staticFile('nyancat.gif')} premountFor={fps} />
</>
);
};
Wenn die Komposition hauptsächlich eine Timeline von Video- oder Audioclips ist, lesen Sie video-editing.md, bevor Sie ihre Quellstruktur wählen.
Beispiel-Szene
Ein Hintergrundvideo mit einer Einblendung unten.
Die Einblendung ist eine interaktive Komponente mit eigener Timeline, registriert als Connected Composition.
Ihr Text wird als children übergeben und accentColor ist eine bearbeitbare Prop.
Die Einblendung ist inline am Aufrufort keyframed.
// MyScene.tsx
import { Video } from "@remotion/media";
import { Easing, interpolate, useCurrentFrame, useVideoConfig } from "remotion";
import { LowerThird } from "./LowerThird";
export const MyScene = () => {
const { fps } = useVideoConfig();
const frame = useCurrentFrame();
return (
<>
<Video
name="Background"
src="https://remotion.media/video.mp4"
premountFor={fps}
objectFit="cover"
style={{
position: "absolute",
width: "100%",
height: "100%",
}}
/>
<LowerThird
name="Lower third"
from={1 * fps}
premountFor={fps}
accentColor="#0b84f3"
style={{
opacity: interpolate(frame, [1 * fps, 2 * fps], [0, 1], {
extrapolateRight: "clamp",
extrapolateLeft: "clamp",
easing: Easing.bezier(0.16, 1, 0.3, 1),
}),
}}
>
Hans Mustermann, Produktdesigner
</LowerThird>
</>
);
};
// LowerThird.tsx
import type React from "react";
import { Interactive, type InteractivitySchema } from "remotion";
type LowerThirdProps = {
readonly children: string;
readonly accentColor: string;
readonly style?: React.CSSProperties;
};
const LowerThirdInner: React.FC<LowerThirdProps> = ({
children,
accentColor,
style,
}) => {
return (
<Interactive.Div
style={{
position: "absolute",
left: 80,
bottom: 80,
display: "flex",
alignItems: "center",
gap: 20,
backgroundColor: "white",
borderRadius: 16,
padding: "20px 32px",
color: "black",
fontFamily: "Helvetica, Arial, sans-serif",
fontSize: 48,
fontWeight: 600,
...style,
}}
>
<div
style={{
width: 8,
alignSelf: "stretch",
borderRadius: 4,
backgroundColor: accentColor,
}}
/>
{children}
</Interactive.Div>
);
};
const lowerThirdSchema = {
children: { type: "text-content", default: "", description: "Text" },
accentColor: {
type: "color",
default: "#0b84f3",
description: "Akzentfarbe",
},
} as const satisfies InteractivitySchema;
export const LowerThird = Interactive.withSchema({
Component: LowerThirdInner,
componentName: "<LowerThird>",
schema: lowerThirdSchema,
wrapInSequence: true,
});
// Root.tsx
import { Composition } from "remotion";
import { LowerThird } from "./LowerThird";
import { MyScene } from "./MyScene";
export const RemotionRoot: React.FC = () => {
return (
<>
<Composition
id="MyScene"
component={MyScene}
durationInFrames={60}
fps={30}
width={1280}
height={720}
/>
<Composition
id="LowerThird"
component={LowerThird}
durationInFrames={30}
fps={30}
width={1280}
height={720}
defaultProps={{
children: "Hans Mustermann, Produktdesigner",
accentColor: "#0b84f3",
}}
/>
</>
);
};
Verzögern, Trimming
Setzen Sie Timing direkt auf Komponenten, die es unterstützen. Siehe Timing-Props für die unterstützten Props, Beispiele und die Reihenfolge der Operationen.
Karten
Siehe Remotion Maps, wenn Sie Karten in das Video einbinden möchten.
Text-Hervorhebungen und Annotationen
Siehe text-highlights.md für Text-Hervorhebungen (Hervorhebungsmarkierungen), Kreise, Unterstreichungen, Durchstreichungen, durchgestrichenen Text, Boxen.
Multi-Szenen-Videos
Siehe multi-scene-video.md, wenn Sie ein Video mit mehreren aufeinanderfolgenden Szenen planen.
Connected Compositions
Wenn eine Szene oder eine Gruppe von Ebenen eine eigene bearbeitbare Timeline verdient, folgen Sie connected-compositions.md. Bevorzugen Sie diese Struktur für umfangreiche Szenen in einem Multi-Szenen-Video.
Pre-Compose-Aktion
Für eine Studio-Anfrage wie "Pre-compose Ambient glow (src/BarChart.tsx:134)", finden Sie das ausgewählte Sequenz-Markup an der angegebenen Stelle. Erstellen Sie eine Connected Composition gemäß connected-compositions.md: Extrahieren Sie das Markup in eine benannte Komponente, machen Sie sie vorzugsweise interaktiv mit Interactive.withSchema({wrapInSequence: true}), und registrieren Sie dieselbe exportierte Komponentenreferenz mit einem eindeutigen <Composition> im Stammverzeichnis. Rendern Sie die interaktive Komponente direkt mit ihren Timing-Props oder als einziges Kind einer Sequenz, wenn dieser Wrapper einen Zweck hat. Wenn der ausgewählte Knoten bereits eine Sequenz ist, behalten Sie seine Props und extrahieren Sie seine Kinder. Die Registrierung benötigt Abmessungen, fps, Dauer und defaultProps, die der übergeordneten Verwendung entsprechen. Eine Komponentenextraktion ohne registrierte Composition schließt eine Pre-Compose-Anfrage nicht ab.
Voiceover
Siehe voiceover.md für das Hinzufügen eines KI-generierten Voiceovers zu Remotion-Kompositionen mit ElevenLabs TTS.
Videos einbetten
Siehe embedding-videos.md für fortgeschrittenes Wissen zum Einbetten von Videos – Trimming, Lautstärke, Geschwindigkeit, Schleifen, Tonhöhe.
Audio einbetten
Siehe audio.md für erweiterte Audiofunktionen wie Trimming, Lautstärke, Geschwindigkeit, Tonhöhe.
Zuschneiden
Siehe cropping.md, wenn Sie das sichtbare Rechteck einer Komponente zuschneiden müssen.
Übergänge
Siehe transitions.md für Szenenübergangsmuster.
Bewegungsunschärfe
Wenn Sie Bewegungsunschärfe oder eine Bewegungsspur hinzufügen, lesen Sie motion-blur.md für den bevorzugten HTML-im-Canvas-Ansatz, Vorschauanforderungen und Alternativen.
Visuelle und Pixeleffekte
Wenn Sie einen visuellen Effekt erstellen, überlegen Sie, ob er mit CSS und HTML machbar ist oder ob ein Shader benötigt wird. Reihenfolge der Präferenz:
- Normales HTML + CSS oder andere Web-Techniken
- Ein Effekt, der direkt auf das Element angewendet wird (
<Video>,<Img>), oder indem der Inhalt in<HtmlInCanvas>gewickelt wird, was aucheffectsakzeptiert:
- Einen aufgelisteten Effekt über effects.md
- Einen benutzerdefinierten
createEffect()über effects.md, wenn kein voreingestellter Effekt verfügbar ist.
3D-Inhalte
Siehe ./3d.md für 3D-Inhalte in Remotion mit Three.js und React Three Fiber.
Soundeffekte
Wenn Sie Soundeffekte verwenden müssen, laden Sie die Datei ./sfx.md für weitere Informationen.
Audio-Visualisierung
Wenn Sie Audio visualisieren müssen (Spektrumbalken, Wellenformen, bassreaktive Effekte), laden Sie die Datei ./audio-visualization.md für weitere Informationen.
Karten
Für statische Karten, animierte Routen und Marker, geografische Erklärungen, Mapbox, MapLibre, MapTiler, GeoJSON oder 3D-geografische Überflüge laden Sie Remotion Maps.
Untertitel
Falls Sie mit Untertiteln arbeiten, laden Sie die Remotion Captions Skill für weitere Informationen.
Google Fonts
Ist die empfohlene Methode zum Laden von Schriftarten in Remotion. Siehe google-fonts.md für die Anleitung zum Laden von Google Fonts.
Lokale Schriftarten
Siehe local-fonts.md für die Anleitung zum Laden lokaler Schriftarten.
GIFs
Siehe gifs.md für die Anleitung zum Anzeigen von GIFs, die mit Remotions Timeline synchronisiert sind.
Erweiterte Bilder
Siehe images.md für die Größenanpassung und Positionierung von Bildern, dynamische Bildpfade und das Abrufen von Bildabmessungen.
Lottie-Animationen
Siehe lottie.md zum Einbetten von Lottie-Animationen in Remotion.
Timing
Siehe timing.md für weitere Timing-Techniken für interpolate().
Parametrisierte Videos
Siehe parameters.md zum Parametrisieren einer Composition durch Hinzufügen eines Zod-Schemas.
DOM-Knoten messen
Siehe measuring-dom-nodes.md zum Messen von DOM-Elementabmessungen in Remotion.
Text messen
Siehe measuring-text.md zum Messen von Textabmessungen, Anpassen von Text an Container und Überprüfen auf Überlauf.
FFmpeg verwenden
Für einige Video-Operationen, wie das Trimming von Videos oder die Erkennung von Stille, sollte FFmpeg verwendet werden. Laden Sie die Datei ./ffmpeg.md für weitere Informationen.
Stille-Erkennung
Wenn Sie stille Abschnitte in Video- oder Audiodateien erkennen und herausschneiden müssen, laden Sie die Datei ./silence-detection.md.
Dynamische Dauer, Abmessungen und Daten
Siehe calculate-metadata.md für dynamisch gesetzte Compositon-Dauer, -Abmessungen und -Props.
Composions und Stills
Bevor Sie <Composition>- oder <Still>-Elemente registrieren, lesen Sie compositions.md für quellbearbeitbare Registrierungen, Ordner, Standard-Props und Schachtelung. Für die Studio-Navigation in die eigene Timeline einer Szene verwenden Sie Connected Compositions.
Erweiterte Sequenzierung
Siehe sequencing.md für weitere Sequenzierungsmuster – Verzögerung, Trimming, Begrenzung der Elementdauer.
Module installieren
Verwenden Sie npx remotion add, um neue Pakete mit der richtigen Version hinzuzufügen:
npx remotion add @remotion/lottie
npx remotion add @remotion/gif
npx remotion add @remotion/player
npx remotion add @remotion/three
npx remotion add @remotion/cloudrun
npx remotion add @remotion/zod-types
npx remotion add @remotion/measure
npx remotion add @remotion/captions