Exportaciones

Las exportaciones renderizan un vídeo de karaoke o de letras a partir de un proyecto. Usa client.exports.create(...) como punto de entrada principal. Elige target: "local" cuando quieras que el SDK renderice directamente en la máquina actual; de lo contrario, la exportación en la nube es la opción predeterminada.

`client.exports.create(projectId, input, options?)`

Elige el destino de exportación con target: "cloud" | "local".

const cloud = await client.exports.create("prj_abc123", {
  resolution: "1080p",
  quality: "high",
});
// => ExportOperation

const local = await client.exports.create("prj_abc123", {
  target: "local",
  resolution: "1080p",
  quality: "high",
  outputPath: "./karaoke.mp4",
});
// => { outputPath, fileSize, duration, ... }

Usa la nube cuando quieras una exportación asíncrona administrada. Usa local cuando quieras renderizar directamente en la máquina del llamador.

Campos comunes

Campo	Tipo	Descripción
`versionId`	`string`	Versión del proyecto. Por defecto, la versión principal.
`resolution`	`"540p" \| "720p" \| "1080p" \| "4k"`	Resolución de salida.
`quality`	`"low" \| "average" \| "high"`	Calidad de codificación.
`fps`	`25 \| 30 \| 60`	Cuadros por segundo. Por defecto `30`. Usa `60` para un movimiento más fluido.
`playbackRate`	`number`	Multiplicador de velocidad (p. ej., `0.9`).
`toneFrequency`	`number`	Cambio de tono en semitonos.
`transparent`	`boolean`	Renderiza con fondo transparente.
`presetId`	`string`	Aplica un preset antes de renderizar.
`stemVolumes`	`Record<string, number>`	Sobrescrituras de volumen por pista (stem) indexadas por id de stem.
`settingsOverride`	`object`	Aplica un patch a la configuración del proyecto solo para esta exportación.

Usa fps: 60 para un movimiento más fluido. Las cotizaciones en la nube aplican un multiplicador de créditos 1.5x a 60 fps. Las exportaciones en la nube a 60 fps con transparencia están disponibles cuando la duración y la resolución seleccionadas se ajustan a los límites de la nube.

Ejemplo con volúmenes de stems

const result = await client.exports.create("prj_abc123", {
  resolution: "1080p",
  quality: "high",
  stemVolumes: {
    vocals: 0,
    instrumental: 1,
    backing: 0.5,
  },
});

Ejemplo con sobrescritura de configuración

const result = await client.exports.create("prj_abc123", {
  resolution: "1080p",
  settingsOverride: {
    trim: { startSeconds: 5, endSeconds: 180 },
    style: {
      background: { type: "color", color: "#101010" },
    },
  },
});

Consulta la Referencia de configuración de render para ver la forma completa de settingsOverride.

`client.exports.quote(projectId, input, options?)`

Cotiza los créditos necesarios para una exportación en la nube sin iniciar la exportación.

const quote = await client.exports.quote("prj_abc123", {
  resolution: "1080p",
  quality: "high",
  transparent: false,
});

console.log(quote.creditsRequired, quote.sufficientBalance);

Las exportaciones locales se ejecutan en la máquina del llamador y no usan créditos de exportación en la nube, por lo que quote(...) es solo para exportaciones en la nube.

`client.exports.list(projectId, input?, options?)`

Lista las exportaciones de un proyecto, con paginación.

const exports = await client.exports.list("prj_abc123", {
  page: 1,
  pageSize: 50,
});

number

Número de página. Por defecto 1 en el servidor.

number

Tamaño de página. Por defecto 100. Máximo 100.

`client.exports.get(exportId, options?)`

Obtén una exportación solo por ID, sin conocer el proyecto padre.

const exported = await client.exports.get("exp_xyz");

Exportación local

const result = await client.exports.create("prj_abc123", {
  target: "local",
  resolution: "1080p",
  quality: "high",
  outputPath: "./karaoke.mp4",
  onProgress(progress) {
    console.log(progress.stage, progress.percent);
  },
});

console.log(result.outputPath);

Usa onDependencyProgress si quieres actualizaciones mientras se instala o verifica la cadena de herramientas de render local.

`client.exports.prepareLocal(projectId, body, options?)`

Devuelve el payload preparado necesario para renderizar una exportación localmente. Úsalo al integrar con @youka/remotion u otro renderizador local. El servidor devuelve las entradas de composición, las URLs de assets y los parámetros de render sin encolar un render en la nube.

const payload = await client.exports.prepareLocal("prj_abc123", {
  resolution: "1080p",
  quality: "high",
});

// Hand payload off to your local renderer
await renderLocally(payload);

client.exports.prepareLocal(...) no inicia un render en la nube. No se consume cómputo facturable del lado de Youka.

Esperar a que termine una exportación

Las exportaciones en la nube son asíncronas. Usa client.exports.wait(...):

const operation = await client.exports.create("prj_abc123", {
  resolution: "1080p",
});

const finalized = await client.exports.wait(operation, {
  pollIntervalMs: 3_000,
});
console.log("Download from", finalized.url);

Descargar el resultado

Las exportaciones en la nube finalizan con una url firmada. Usa el helper integrado para transmitir el archivo al disco. output puede ser un directorio o una ruta completa de archivo, y filename es opcional:

await client.exports.download(finalized, {
  output: "./exports",
});

Qué sigue

Tareas — handles de operación y sondeo avanzado de tareas
Presets — configuraciones de render reutilizables
Configuración del proyecto — aplicar un patch a la configuración activa de un proyecto

Snapshots de versión y temporización

Lista versiones con client.projects.versions.list(projectId). Pasa versionId a exports.create, exports.quote o exports.prepareLocal. El estilo pertenece a esa versión, mientras que la alineación seleccionada pertenece al proyecto. Los handles de operación de exportación en la nube y los payloads locales incluyen versionId, alignmentId y alignmentRevision. Estos campos identifican el mismo snapshot de temporización usado para construir la composición. Una preparación o exportación posterior puede observar ediciones más recientes. Guarda el payload preparado si un renderizador externo debe usar exactamente ese snapshot, y renueva las URLs firmadas de medios que hayan expirado. Para silenciar todos los stems, construye stemVolumes a partir de los IDs de stems del proyecto con todos los valores en cero. La exportación local transparente usa ProRes 4444 en un contenedor MOV. Una salida silenciosa aún puede tener un stream de audio. Consulta Automate lyric videos para ver el ejemplo completo de exportación.

Overview

How To

Customization

Audio

Settings

Exporting

Account

`client.exports.create(projectId, input, options?)`

Campos comunes

Ejemplo con volúmenes de stems

Ejemplo con sobrescritura de configuración

`client.exports.quote(projectId, input, options?)`

`client.exports.list(projectId, input?, options?)`

`client.exports.get(exportId, options?)`

Exportación local

`client.exports.prepareLocal(projectId, body, options?)`

Esperar a que termine una exportación

Descargar el resultado

Qué sigue

Snapshots de versión y temporización

​client.exports.create(projectId, input, options?)

​Campos comunes

​Ejemplo con volúmenes de stems

​Ejemplo con sobrescritura de configuración

​client.exports.quote(projectId, input, options?)

​client.exports.list(projectId, input?, options?)

​client.exports.get(exportId, options?)

​Exportación local

​client.exports.prepareLocal(projectId, body, options?)

​Esperar a que termine una exportación

​Descargar el resultado

​Qué sigue

​Snapshots de versión y temporización

`client.exports.create(projectId, input, options?)`

Campos comunes

Ejemplo con volúmenes de stems

Ejemplo con sobrescritura de configuración

`client.exports.quote(projectId, input, options?)`

`client.exports.list(projectId, input?, options?)`

`client.exports.get(exportId, options?)`

Exportación local

`client.exports.prepareLocal(projectId, body, options?)`

Esperar a que termine una exportación

Descargar el resultado

Qué sigue

Snapshots de versión y temporización