Exporte

Exporte rendern ein Karaoke- oder Lyric-Video aus einem Projekt. Verwende client.exports.create(...) als zentralen Einstiegspunkt. Wähle target: "local", wenn das SDK direkt auf der aktuellen Maschine rendern soll; andernfalls ist Cloud-Export der Standard.

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

Wähle das Export-Ziel mit 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, ... }

Nutze Cloud, wenn du einen verwalteten asynchronen Export möchtest. Nutze lokal, wenn du direkt auf der Maschine des Aufrufers rendern willst.

Gemeinsame Felder

Field	Type	Description
`versionId`	`string`	Projektversion. Standardmäßig die primäre Version.
`resolution`	`"540p" \| "720p" \| "1080p" \| "4k"`	Ausgabeauflösung.
`quality`	`"low" \| "average" \| "high"`	Kodierqualität.
`fps`	`25 \| 30 \| 60`	Bilder pro Sekunde. Standardmäßig `30`. Verwende `60` für flüssigere Bewegungen.
`playbackRate`	`number`	Geschwindigkeitsmultiplikator (z. B. `0.9`).
`toneFrequency`	`number`	Tonhöhenverschiebung in Halbtönen.
`transparent`	`boolean`	Mit transparentem Hintergrund rendern.
`presetId`	`string`	Vor dem Rendern ein Preset anwenden.
`stemVolumes`	`Record<string, number>`	Lautstärke-Überschreibungen pro Stem, indiziert nach Stem-ID.
`settingsOverride`	`object`	Projekt-Einstellungen nur für diesen Export patchen.

Verwende fps: 60 für flüssigere Bewegungen. Cloud-Quotes wenden bei 60 fps einen 1.5x-Kredit-Multiplikator an. Transparente 60 fps-Cloud-Exporte sind verfügbar, wenn die ausgewählte Dauer und Auflösung in die Cloud-Limits passen.

Beispiel mit Stem-Lautstärken

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

Beispiel mit Settings-Override

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

Siehe Render settings reference für die vollständige settingsOverride-Struktur.

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

Ermittle die Credits, die für einen Cloud-Export benötigt werden, ohne den Export zu starten.

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

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

Lokale Exporte laufen auf der Maschine des Aufrufers und verwenden keine Cloud-Export-Credits, daher ist quote(...) nur für Cloud-Exporte.

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

Liste Exporte für ein Projekt, mit Paginierung.

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

number

Seitennummer. Standardmäßig 1 auf dem Server.

number

Seitengröße. Standardmäßig 100. Maximum 100.

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

Einen Export nur anhand der ID abrufen, ohne das übergeordnete Projekt zu kennen.

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

Lokaler Export

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);

Verwende onDependencyProgress, wenn du Updates möchtest, während die lokale Render-Toolchain installiert oder verifiziert wird.

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

Gibt die vorbereitete Payload zurück, die benötigt wird, um einen Export lokal zu rendern. Verwende dies bei der Integration mit @youka/remotion oder einem anderen lokalen Renderer. Der Server liefert die Composition-Inputs, Asset-URLs und Render-Parameter zurück, ohne ein Cloud-Rendern in die Warteschlange zu stellen.

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(...) startet kein Cloud-Rendern. Es wird keine abrechenbare Compute auf der Youka-Seite verbraucht.

Auf einen Export warten

Cloud-Exporte sind asynchron. Verwende 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);

Ergebnis herunterladen

Cloud-Exporte enden mit einer signierten url. Verwende den integrierten Helper, um die Datei auf die Festplatte zu streamen. output kann entweder ein Verzeichnis oder ein vollständiger Dateipfad sein, und filename ist optional:

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

Was als Nächstes

Tasks — Operation-Handles und erweitertes Task-Polling
Presets — wiederverwendbare Render-Konfigurationen
Project settings — die aktiven Einstellungen eines Projekts patchen

Versions- und Timing-Snapshots

Liste Versionen mit client.projects.versions.list(projectId). Übergib versionId an exports.create, exports.quote oder exports.prepareLocal. Styling gehört zu dieser Version, während das ausgewählte Alignment zum Projekt gehört. Cloud-Export-Operation-Handles und lokale Payloads enthalten versionId, alignmentId und alignmentRevision. Diese Felder identifizieren denselben Timing-Snapshot, der zum Erstellen der Composition verwendet wurde. Eine spätere Vorbereitung oder ein späterer Export kann neuere Änderungen berücksichtigen. Speichere die vorbereitete Payload, wenn ein externer Renderer genau diesen Snapshot verwenden muss, und erneuere abgelaufene signierte Media-URLs. Um jeden Stem stummzuschalten, baue stemVolumes aus den Stem-IDs des Projekts auf, wobei jeder Wert auf null gesetzt ist. Transparenter lokaler Export verwendet ProRes 4444 in einem MOV-Container. Eine stumme Ausgabe kann dennoch einen Audio-Stream enthalten. Siehe Automate lyric videos für das vollständige Export-Beispiel.

Overview

How To

Customization

Audio

Settings

Exporting

Account

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

Gemeinsame Felder

Beispiel mit Stem-Lautstärken

Beispiel mit Settings-Override

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

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

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

Lokaler Export

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

Auf einen Export warten

Ergebnis herunterladen

Was als Nächstes

Versions- und Timing-Snapshots

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

​Gemeinsame Felder

​Beispiel mit Stem-Lautstärken

​Beispiel mit Settings-Override

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

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

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

​Lokaler Export

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

​Auf einen Export warten

​Ergebnis herunterladen

​Was als Nächstes

​Versions- und Timing-Snapshots

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

Gemeinsame Felder

Beispiel mit Stem-Lautstärken

Beispiel mit Settings-Override

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

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

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

Lokaler Export

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

Auf einen Export warten

Ergebnis herunterladen

Was als Nächstes

Versions- und Timing-Snapshots