Referencia de elementos

Elemento de subtítulos

1. Estructura

type SubtitleSource =
  | SubtitleWord[]
  | { $ref: string }
  | { src: string };

interface SubtitleClip extends BaseClip {
  type: "subtitle";
  words: SubtitleSource;
  config?: SubtitleConfig;
}

También admite:

  • opacity
  • animations
  • keyframes
  • transition
  • transform
  • zIndex

2. SubtitleWord

interface SubtitleWord {
  word: string;
  punctuated_word: string;
  start: number;
  end: number;
  confidence?: number;
}

3. Fuentes de subtítulos compatibles

Array inline

{
  "words": [
    {
      "word": "hello",
      "punctuated_word": "Hello",
      "start": 0,
      "end": 0.4
    }
  ]
}

Recurso de subtítulos mediante $ref

{
  "words": { "$ref": "subtitle-main" }
}

URL externa

{
  "words": { "src": "https://example.com/subtitle.json" }
}

4. Reglas para URL externas de subtítulos

El endpoint remoto debe devolver JSON con una de estas formas:

  • SubtitleWord[]
  • { "words": SubtitleWord[] }

Comportamiento público:

  • El flujo de preview acepta words: { "src": "..." }
  • La reproducción en preview normaliza los datos de subtítulos antes de reproducir
  • Si envías { src } directamente a un renderer de nivel inferior, los datos de subtítulos no se descargan automáticamente

5. SubtitleConfig

interface SubtitleConfig {
  mode?: "batch" | "stream";
  wordsPerBatch?: number;
  fontSize?: number;
  fontFamily?: string;
  fontWeight?: number | string;
  textAlign?: "left" | "center" | "right";
  textBoxWidth?: number | string;
  textColor?: string;
  highlightColor?: string;
  backgroundColor?: string;
  shadowColor?: string;
  shadowBlur?: number;
  borderColor?: string;
  borderWidth?: number;
  fadeInAnimation?: boolean;
  position?: "bottom" | "top" | "center";
  paddingBottom?: number;
}

6. Campos de configuración implementados actualmente

  • mode
  • wordsPerBatch
  • fontSize
  • fontFamily
  • fontWeight
  • textAlign
  • textBoxWidth
  • textColor
  • highlightColor
  • backgroundColor
  • shadowColor
  • shadowBlur
  • borderColor
  • borderWidth
  • fadeInAnimation
  • position
  • paddingBottom

7. Comportamiento de los modos

batch

  • Muestra subtítulos por bloques
  • Resalta la palabra que se está pronunciando en ese momento

stream

  • Revela las palabras una por una

8. Comportamiento de animación del bloque completo

La animación a nivel de contenedor se aplica al bloque completo de subtítulos, no a la lógica de resaltado palabra por palabra.

Diferencia importante:

  • config.fadeInAnimation controla el comportamiento de fade dentro de los lotes de subtítulos
  • animations / keyframes / transition controlan el contenedor completo de subtítulos

Eso significa que puedes animar el bloque de subtítulos con fade, slide o movimiento sin cambiar la lógica interna de resaltado de palabras.

9. Ejemplo

{
  "type": "subtitle",
  "start": 0,
  "duration": 8,
  "words": { "$ref": "sub-main" },
  "animations": [
    { "type": "slideIn", "duration": 0.4, "direction": "up" }
  ],
  "config": {
    "position": "bottom",
    "fontSize": 60,
    "highlightColor": "#22d3ee",
    "backgroundColor": "rgba(0,0,0,0.4)"
  }
}