Este é um guia para escrever marcação React do Remotion. Se isso não for relevante, carregue as Melhores Práticas do Remotion.
Preservar alterações do usuário
Os usuários podem fazer edições no código fora da conversa.
Se você detectar uma mudança surpreendente feita nesse meio tempo, não a substitua, presuma que foi intencional ou peça confirmação.
Regras gerais
Direcione as animações usando useCurrentFrame() e interpolate().
transition ou animation do CSS não serão renderizados corretamente; eles precisam ser refatorados.
Classes de animação do Tailwind não serão renderizadas corretamente; elas precisam ser refatoradas.
Use Easing.bezier() e Easing.spring() para personalizar o tempo.
Estruture sua marcação de acordo com as Melhores Práticas de Interatividade do Remotion.
Prefira Interactive.withSchema({wrapInSequence: true}) para componentes visuais personalizados
com props editáveis, e registre cenas reutilizáveis como composições conectadas.
Coloque a temporização diretamente nos componentes que a suportam; evite wrappers redundantes de <Sequence>.
Dê a cada componente temporizado que suporte premountFor um segundo de pré-montagem:
premountFor={fps}, onde fps vem de useVideoConfig(). Aplique isso a
mídia, componentes interativos, <Sequence>, <Series.Sequence>,
<TransitionSeries.Sequence>, e <TransitionSeries.Overlay>, incluindo
componentes temporizados aninhados dentro de cenas. Pré-monte o item da linha do tempo pai também
quando um item aninhado precisar montar antes do pai começar. Um componente sem
premountFor, como <TransitionSeries.Transition>, não precisa de substituto.
O Studio edita o nó JSX de origem que criou um item. Crie cada registro de composição, clipe, cena, camada e sequência que devam ser editáveis independentemente como seu próprio nó JSX, com suas props editáveis inline. Loops programáticos são adequados quando as instâncias geradas são intencionalmente controladas como um modelo de origem, não quando os usuários precisam editar as instâncias separadamente.
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),
}),
}}
>
Hello World!
</Interactive.Div>
);
};
Mantenha a chamada interpolate() inline na prop style.
Use as propriedades CSS scale, translate, rotate em vez de transform.
// 👍 Keyframes inline editáveis e atalhos de transformação
style={{
scale: interpolate(frame, [0, 100], [0, 1], {
extrapolateLeft: 'clamp',
extrapolateRight: 'clamp',
easing: Easing.spring({damping: 200}),
output: 'perceptual-scale' // Para animações de `scale`, use "output: 'perceptual-scale'"
}),
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}),
}),
}}
// 👎 Valores não inline e strings de transformação se tornam mais difíceis de editar no Studio
const scale = interpolate(frame, [0, 100], [0, 1]);
style={{
transform: `scale(${scale})`,
}}
Assets
Coloque os assets na pasta public/ na raiz do seu projeto.
Use staticFile() para referenciar arquivos da pasta public/.
Componentes de mídia
Adicione vídeo e áudio usando <Video> e <Audio> de @remotion/media.
Adicione imagens usando o componente <CanvasImage>.
Adicione imagens GIF animadas, APNG, WebP ou AVIF usando <AnimatedImage>, use @remotion/gif se não estiver usando Chrome.
Use staticFile() para arquivos em public/ ou passe uma URL remota diretamente:
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} />
</>
);
};
Se a composição for principalmente uma linha do tempo de clipes de vídeo ou áudio, leia video-editing.md antes de escolher sua estrutura de origem.
Exemplo de cena
Um vídeo de fundo com um terço inferior.
O terço inferior é um componente interativo com sua própria linha do tempo, registrado como uma composição conectada.
Seu texto é passado como children e accentColor é uma prop editável.
A entrada em fade é animada inline no local da chamada.
// 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),
}),
}}
>
Jane Doe, Product Designer
</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: "Cor de destaque",
},
} 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: "Jane Doe, Product Designer",
accentColor: "#0b84f3",
}}
/>
</>
);
};
Atrasar, cortar
Coloque a temporização diretamente nos componentes que a suportam. Consulte Propriedades de tempo para as props suportadas, exemplos e ordem de operações.
Mapas
Consulte Mapas do Remotion se quiser incluir mapas no vídeo.
Destaques e anotações de texto
Consulte text-highlights.md para destaques de texto (marcadores de destaque), círculos, sublinhados, tachados, texto riscado, caixas.
Vídeos com várias cenas
Consulte multi-scene-video.md se planeja fazer um vídeo com várias cenas subsequentes.
Composições conectadas
Quando uma cena ou grupo de camadas merece sua própria linha do tempo editável, siga connected-compositions.md. Prefira esta estrutura para cenas substanciais em um vídeo com várias cenas.
Ação de pré-composição
Para uma solicitação do Studio como Pré-compor Brilho Ambiente (src/BarChart.tsx:134), encontre a marcação da sequência selecionada no local determinado. Crie uma composição conectada, seguindo connected-compositions.md: extraia a marcação para um componente nomeado, de preferência torne-o interativo com Interactive.withSchema({wrapInSequence: true}), e registre a mesma referência de componente exportada com uma <Composition> única na raiz. Renderize o componente interativo diretamente com suas props de tempo, ou como o único filho de uma sequência quando esse wrapper tiver um propósito. Se o nó selecionado já for uma sequência, mantenha suas props e extraia seus filhos. O registro precisa de dimensões, fps, duração e defaultProps equivalentes ao uso do pai. Uma extração de componente sem uma composição registrada não completa uma solicitação de pré-composição.
Narração
Consulte voiceover.md para adicionar uma narração gerada por IA às composições do Remotion usando ElevenLabs TTS.
Incorporação de vídeos
Consulte embedding-videos.md para conhecimento avançado sobre incorporação de vídeos - corte, volume, velocidade, loop, pitch.
Incorporação de áudio
Consulte audio.md para recursos avançados de áudio como corte, volume, velocidade, pitch.
Corte
Consulte cropping.md se precisar cortar o retângulo visível de um componente.
Transições
Consulte transitions.md para padrões de transição de cena.
Motion blur
Ao adicionar motion blur ou um rastro de movimento, leia motion-blur.md para a abordagem preferida de HTML-em-canvas, requisitos de pré-visualização e alternativas.
Efeitos visuais e de pixel
Ao criar um efeito visual, considere se é viável usando CSS e HTML, ou se um shader é necessário. Ordem de preferência:
- HTML + CSS regulares ou outras técnicas web
- Um efeito aplicado diretamente ao elemento (
<Video>,<Img>), ou envolvendo o conteúdo em<HtmlInCanvas>, que também aceitaeffects:
- Um efeito listado via effects.md
- Um
createEffect()personalizado via effects.md quando nenhum preset estiver disponível.
Conteúdo 3D
Consulte ./3d.md para conteúdo 3D no Remotion usando Three.js e React Three Fiber.
Efeitos sonoros
Ao precisar usar efeitos sonoros, carregue o arquivo ./sfx.md para mais informações.
Visualização de áudio
Ao precisar visualizar áudio (barras de espectro, formas de onda, efeitos reativos a graves), carregue o arquivo ./audio-visualization.md para mais informações.
Mapas
Para mapas estáticos, rotas animadas e marcadores, explicadores geográficos, Mapbox, MapLibre, MapTiler, GeoJSON, ou sobrevoos geográficos 3D, carregue Mapas do Remotion.
Legendas
Ao lidar com legendas ou subtítulos, carregue a habilidade de Legendas do Remotion para mais informações.
Google Fonts
É a maneira recomendada de carregar fontes no Remotion. Consulte google-fonts.md para saber como carregar Google Fonts.
Fontes locais
Consulte local-fonts.md para saber como carregar fontes locais.
GIFs
Consulte gifs.md para saber como exibir GIFs sincronizados com a linha do tempo do Remotion.
Imagens avançadas
Consulte images.md para dimensionar e posicionar imagens, caminhos de imagem dinâmicos e obter dimensões de imagem.
Animações Lottie
Consulte lottie.md para incorporar animações Lottie no Remotion.
Temporização
Consulte timing.md para mais técnicas de temporização para interpolate().
Vídeos parametrizados
Consulte parameters.md para tornar uma composição parametrizável adicionando um esquema Zod.
Medição de nós DOM
Consulte measuring-dom-nodes.md para medir dimensões de elementos DOM no Remotion.
Medição de texto
Consulte measuring-text.md para medir dimensões de texto, ajustar texto a contêineres e verificar estouro.
Usando FFmpeg
Para algumas operações de vídeo, como cortar vídeos ou detectar silêncio, o FFmpeg deve ser usado. Carregue o arquivo ./ffmpeg.md para mais informações.
Detecção de silêncio
Ao precisar detectar e cortar segmentos silenciosos de arquivos de vídeo ou áudio, carregue o arquivo ./silence-detection.md.
Duração, dimensões e dados dinâmicos
Consulte calculate-metadata.md para definir dinamicamente a duração da composição, dimensões e props.
Composições e stills
Antes de registrar elementos <Composition> ou <Still>, leia compositions.md para registros editáveis na origem, pastas, props padrão e aninhamento. Para navegação do Studio na linha do tempo de uma cena, use composições conectadas.
Sequenciamento avançado
Consulte sequencing.md para mais padrões de sequenciamento - atraso, corte, limite de duração de itens.
Instalar módulos
Use npx remotion add para adicionar novos pacotes com a versão correta:
npx remotion add @rem
... (truncado para tradução)