iamhuynq/video-remotion

Ao escrever a marcação Remotion de uma forma específica, o Remotion Studio é capaz de reconhecer a estrutura do código e torná-la interativa:

• Permitindo que itens sejam selecionados clicando neles
• Permitindo arrastar e soltar, redimensionar e rotacionar
• Editando os estilos CSS
• Tornando keyframes e easing editáveis

Se a marcação for muito complexa para o Studio torná-la interativa, os valores ficarão acinzentados.

Prefira componentes interativos com suas próprias linhas do tempo

Construa novas composições com Track, composições conectadas e Interactive.create().

Defina layout explicitamente como 'absolute-fill' para cenas ou 'none' para elementos delimitados. Registre os mesmos componentes de cena exportados e elementos reutilizáveis com Composition.

Comece com o exemplo completo de Track + composições conectadas. Ele inclui o elemento, cena, linha do tempo pai e registros raiz.

import {Track, useVideoConfig} from 'remotion';
import {Chapter} from './Chapter';

export const MyVideo = () => {
  const {fps} = useVideoConfig();

  return (
    <Track name="Chapters">
      <Chapter
        name="Opening"
        durationInFrames={3 * fps}
        title="Introduction"
      />
      <Chapter
        name="Feature"
        from={3 * fps}
        durationInFrames={4 * fps}
        title="New features"
      />
    </Track>
  );
};

Coloque estilos de fundo e alinhamento em cada instância de cena, conforme mostrado no exemplo completo. Mantenha contêineres apenas de layout como HTML simples.

Escolha campos de esquema

Cada chave no esquema é uma prop que o Studio pode ler e editar no local da chamada. Props que não estão no esquema ainda funcionam, mas não são editáveis no Studio. Chaves podem usar notação de ponto, como style.color.

Tipo	Use para	Keyframable
string	Strings, como título, prompt ou trecho de código	Não
number	Números, com min, max, step, integer opcionais	Sim
boolean	Interruptores liga/desliga	Sim (segurar)
color	Strings de cor CSS	Sim
enum	Uma escolha entre variants, cada uma com seu próprio esquema aninhado	Opcional (segurar)
array	Listas de números, cores, enums e mais	Não
asset	Fontes de mídia, com assetType opcional	Não
font-family	Família de fonte CSS	Não
font-weight	Peso da fonte	Sim
translate, scale, rotation-css, rotation-degrees, transform-origin	Transformações	Sim
uv-coordinate	Um ponto [x, y] normalizado no elemento	Sim
svg-path	Dados de caminho SVG	Sim
remotion-captions	Dados Caption[]	Não
hidden	Um valor mantido fora dos controles	—

Cada campo precisa de um default e deve ter uma description, que o Studio mostra como rótulo. Defina keyframable: false para mostrar um controle estático.

Exponha conteúdo e aparência por instância, como o texto e uma cor de destaque. Não adicione campos para style.translate, style.scale, style.rotate, style.transformOrigin e style.opacity: Interactive.create() os adiciona automaticamente.

Para tornar as propriedades CSS da raiz editáveis por instância, espalhe os fragmentos de esquema integrados:

const cardSchema = {
  ...Interactive.textSchema, // style.color, style.fontSize, style.fontWeight, ...
  ...Interactive.backgroundSchema, // style.backgroundColor
  ...Interactive.borderRadiusSchema, // style.borderRadius, ...
} as const satisfies InteractivitySchema;

Também disponíveis: Interactive.borderSchema e Interactive.captionsSchema para componentes que aceitam legendas. Para componentes que aceitam filhos React.ReactNode, adicione ...Interactive.childrenSchema. Ele fornece controles para conteúdo filho e pode evoluir para suportar conteúdo mais rico. Atualmente, usa um campo string rotulado como "Texto" com um padrão de ''. Se um componente requer filhos apenas de string, declare um campo children explícito com type: 'string'. Interactive.textSchema controla estilos tipográficos; childrenSchema controla conteúdo. O fragmento de filhos não está incluído em baseSchema nem adicionado automaticamente a componentes personalizados. Marcação aninhada e filhos computados são atualmente somente leitura. text-content é um alias obsoleto para o tipo de campo string. Veja InteractivitySchema para todas as opções.

Registre componentes reutilizáveis como composições conectadas

Registre cenas e elementos reutilizáveis como composições independentes. O Studio chama estas de composições conectadas: elas podem ser abertas em sua própria linha do tempo enquanto compartilham a mesma implementação de componente com o vídeo pai.

Defina estilos necessários e carregue fontes dentro do componente para que funcione sem seu pai. Veja independência do pai.

Registre a mesma referência de componente exportada que o pai renderiza. Para o exemplo acima, use component={Chapter}, não ChapterInner ou um wrapper inline. Interactive.create() fornece a sequência, então nenhum <Sequence> extra é necessário para a conexão.

import {Composition} from 'remotion';
import {Chapter} from './Chapter';

export const RemotionRoot = () => (
  <Composition
    id="Chapter"
    component={Chapter}
    width={1280}
    height={720}
    fps={30}
    durationInFrames={90}
    defaultProps={{
      title: 'A new perspective',
      style: {
        backgroundColor: '#111111',
        justifyContent: 'center',
        alignItems: 'center',
      },
    }}
  />
);

Escolha um ID único, padrões inline representativos e dimensões, fps e duração adequados para pré-visualizar o componente. Os padrões de registro não copiam automaticamente props de uma instância pai. Veja composições conectadas para detalhes de registro e extração.

Coloque o timing diretamente no componente

Evite um <Sequence> separado em torno de um componente que já aceita props de timing. Componentes interativos integrados e componentes personalizados feitos com Interactive.create() podem receber name, from, durationInFrames, trimBefore e playbackRate diretamente.

<Chapter
  name="Opening scene"
  from={30}
  durationInFrames={90}
  style={{opacity: 0.9}}
  title="A new perspective"
/>

Para timing de cena compartilhada, agrupe o conteúdo em um componente feito com Interactive.create() e temporize essa instância. Raízes gerenciadas também aceitam width e height para useVideoConfig().

Use <Track> para colocar itens na mesma linha da linha do tempo do Studio. Use <TransitionSeries> quando as cenas são sequenciais.

Dê a cada item editável independentemente seu próprio nó JSX

O Studio edita o nó fonte JSX que criou um item. Se vários itens em tempo de execução vêm do mesmo nó JSX, eles compartilham um único alvo de edição de fonte.

Para cada registro de composição, clipe, cena, camada ou sequência que deva ser editável por conta própria, escreva um nó JSX separado e mantenha suas props editáveis nesse nó. Isso se aplica a <Composition>, <Still>, componentes de mídia integrados, <Sequence>, <TransitionSeries.Sequence> e componentes personalizados.

Por exemplo, crie uma linha do tempo editável assim:

import { Track } from "remotion";

<Track name="Scenes">
  <Introduction name="Introduction" durationInFrames={90} />
  <Demo name="Demo" from={90} durationInFrames={150} />
</Track>

Um .map() ou outro loop programático criaria vários itens em tempo de execução a partir de um nó JSX fonte. Isso é apropriado para saída repetida que é intencionalmente controlada como um modelo único, como barras de visualização ou partículas. Não é apropriado quando as instâncias precisam de IDs ou nomes independentes, props, metadados, timing, ordenação, exclusão ou duplicação no Studio.

Torne um elemento HTML interativo usando Interactive

Cada elemento HTML e SVG (exceto <Img>, que já é interativo) como <div> pode ser transformado em interativo usando Interactive:

<Interactive.Div
  name="Greeting card"
  style={{fontSize: 80, padding: 24}}
>
  Hello
</Interactive.Div>

Isso permite que estilos e keyframes sejam definidos no Studio. Seja sensato: se um componente tem muitos elementos, a linha do tempo pode ficar confusa.

Prefira texto inline

Se o texto é fixo e usado apenas uma vez, escreva-o diretamente dentro do elemento interativo em vez de extraí-lo para uma constante.

// 👍 Cópia fixa permanece editável
<Interactive.Div name="Title">
  Remotion Best Practices
</Interactive.Div>

Use uma prop ou variável apenas quando o texto é dinâmico ou reutilizado.

Dê nomes descritivos aos elementos interativos

Adicione uma prop name aos elementos para torná-los facilmente identificáveis. Evite nomes computados; codifique-os.

<>
  <Interactive.Div name="Hero title" style={{fontSize: 80}}>
    Launch day
  </Interactive.Div>
  <Img name="Avatar" src="https://remotion.media/image.jpeg" />
  <Video name="Background" src="https://remotion.media/video.mp4" />
  <Interactive.Div name="Title">
    Launch day
  </Interactive.Div>
</>

Mantenha todos os estilos CSS inline

A melhor forma é apenas passar um objeto simples para style - sem referenciar constantes, sem espalhamento de objetos, sem matemática.

<Interactive.Div
  style={{
    fontSize: 80,
    color: 'red',
  }}
>
  Hello World!
</Interactive.Div>

const baseStyle = useMemo(() => {
  return {
    fontSize: 12 // ❌ Estilos não inline não são suportados
  }
}, []);

<Interactive.Div
  style={{
    ...baseStyle, // ❌ Espalhamento não é suportado
    color: RED, // ❌ Referenciar constantes não é suportado
    scale: frame * 10 // ❌ Matemática não é suportada
  }}
>
  Hello World!
</Interactive.Div>

Anime usando interpolate()

Escreva animações como chamadas interpolate() inline na propriedade que muda. O intervalo de saída, easing, extrapolação e a propriedade output devem usar valores codificados.

O intervalo de entrada pode usar adicionalmente durationInFrames, fps, width e height desestruturados diretamente de useVideoConfig(). Identificadores simples como durationInFrames, multiplicação por um número como 2 * fps ou fps * 2, e subtração de um número como durationInFrames - 1 são suportados.

const {fps, durationInFrames} = useVideoConfig();

// 👍 Valores inline podem ser padronizados e keyframed
<Interactive.Div
  name="Product card"
  style={{
    color: 'white',
    fontSize: 80,
    scale: interpolate(frame, [0, fps], [0, 1], {
      easing: Easing.spring({damping: 200}),
      output: 'perceptual-scale',
      extrapolateLeft: 'clamp',
      extrapolateRight: 'clamp'
    }),
    rotate: interpolate(frame, [0, 1 * fps], ['0deg', '20deg'], {
      easing: Easing.spring({damping: 200}),
      extrapolateLeft: 'clamp',
      extrapolateRight: 'clamp'
    }),
    translate: interpolate(
      frame,
      [durationInFrames - 30, durationInFrames],
      ['0px 0px', '0px 120px'],
      {
        easing: Easing.spring({damping: 200}),
        output: 'perceptual-scale',
        extrapolateLeft: 'clamp',
        extrapolateRight: 'clamp'
      }
    ),
  }}
/>

const translateY = interpolate(frame, [0, 30], [0, 120]); // ❌ Matemática deve estar diretamente na marcação

<Interactive.Div
  name="Product card"
  style={{
    translate: translateY, // ❌ Apenas chamadas inline interpolate() são suportadas,
    rotate: interpolate(frame, [start, start + 10], [0, Math.PI]), // ❌ Não pode usar matemática com variáveis arbitrárias, não pode usar constantes
    scale: interpolate(anyVariable, [0, 30], [0, 1]) // ❌ Só pode interpretar a variável `frame`.
  }}
/>

Mantenha caminhos SVG editáveis com Interactive.Path

Use <Interactive.Path> de remotion em vez de <path> dentro de um SVG para tornar o caminho visualmente editável.

Instale @remotion/paths para interpolação de caminhos e keyframes de caminho no Studio:

bunx remotion add @remotion/paths

Se a geometria é destinada a ser estática, coloque a string do caminho diretamente na prop d. Não a extraia para uma constante.

import {Interactive} from 'remotion';

<Interactive.Svg width={300} height={300} viewBox="0 0 300 300">
  <Interactive.Path
    name="Triangle"
    d="M 40 40 L 260 40 L 150 260 Z"
    fill="#0b84f3"
  />
</Interactive.Svg>

Morph paths usando inline...

[truncado para tradução]