Exports

Les exports rendent une vidéo de karaoké ou de paroles à partir d’un projet. Utilisez client.exports.create(...) comme point d’entrée principal. Choisissez target: "local" lorsque vous voulez que le SDK rende directement sur la machine courante ; sinon, l’export cloud est utilisé par défaut.

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

Choisissez la cible d’export avec 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, ... }

Utilisez le cloud lorsque vous voulez un export asynchrone géré. Utilisez le local lorsque vous voulez effectuer le rendu directement sur la machine de l’appelant.

Champs communs

Champ	Type	Description
`versionId`	`string`	Version du projet. Par défaut, la version principale.
`resolution`	`"540p" \| "720p" \| "1080p" \| "4k"`	Résolution de sortie.
`quality`	`"low" \| "average" \| "high"`	Qualité d’encodage.
`fps`	`25 \| 30 \| 60`	Images par seconde. Par défaut `30`. Utilisez `60` pour un mouvement plus fluide.
`playbackRate`	`number`	Multiplicateur de vitesse (par ex. `0.9`).
`toneFrequency`	`number`	Transposition en demi-tons.
`transparent`	`boolean`	Rendu avec un arrière-plan transparent.
`presetId`	`string`	Appliquer un preset avant le rendu.
`stemVolumes`	`Record<string, number>`	Remplacements de volume par stem, indexés par l’id du stem.
`settingsOverride`	`object`	Appliquer un patch des paramètres du projet uniquement pour cet export.

Utilisez fps: 60 pour un mouvement plus fluide. Les devis cloud appliquent un multiplicateur de crédits de 1.5x à 60 fps. Les exports cloud transparents en 60 fps sont disponibles lorsque la durée et la résolution sélectionnées respectent les limites du cloud.

Exemple avec volumes de stems

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

Exemple avec override des paramètres

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

Voir Render settings reference pour la forme complète de settingsOverride.

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

Estimer les crédits requis pour un export cloud sans démarrer l’export.

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

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

Les exports locaux s’exécutent sur la machine de l’appelant et n’utilisent pas de crédits d’export cloud ; ainsi, quote(...) ne concerne que les exports cloud.

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

Lister les exports d’un projet, avec pagination.

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

number

Numéro de page. Par défaut 1 côté serveur.

number

Taille de page. Par défaut 100. Maximum 100.

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

Récupérer un export par son ID uniquement, sans connaître le projet parent.

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

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

Utilisez onDependencyProgress si vous voulez des mises à jour pendant l’installation ou la vérification de la chaîne d’outils de rendu local.

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

Renvoie la charge utile préparée nécessaire pour rendre un export en local. Utilisez ceci lors d’une intégration avec @youka/remotion ou un autre moteur de rendu local. Le serveur renvoie les entrées de composition, les URL des assets et les paramètres de rendu sans mettre en file d’attente un rendu cloud.

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(...) ne démarre pas de rendu cloud. Aucun calcul facturable n’est consommé côté Youka.

Attendre un export

Les exports cloud sont asynchrones. Utilisez 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);

Télécharger le résultat

Les exports cloud se terminent avec une url signée. Utilisez l’assistant intégré pour streamer le fichier sur le disque. output peut être soit un répertoire, soit un chemin complet de fichier, et filename est optionnel :

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

Et ensuite

Tasks — handles d’opération et polling avancé des tâches
Presets — configurations de rendu réutilisables
Project settings — appliquer un patch aux paramètres actifs d’un projet

Snapshots de version et de timing

Listez les versions avec client.projects.versions.list(projectId). Passez versionId à exports.create, exports.quote ou exports.prepareLocal. Le style appartient à cette version, tandis que l’alignement sélectionné appartient au projet. Les handles d’opération d’export cloud et les charges utiles locales incluent versionId, alignmentId et alignmentRevision. Ces champs identifient le même snapshot de timing utilisé pour construire la composition. Une préparation ou un export ultérieur peut observer des modifications plus récentes. Sauvegardez la charge utile préparée si un moteur de rendu externe doit utiliser exactement ce snapshot, et rafraîchissez les URL signées de médias expirées. Pour rendre tous les stems muets, construisez stemVolumes à partir des IDs de stems du projet avec chaque valeur définie à zéro. L’export local transparent utilise ProRes 4444 dans un conteneur MOV. Une sortie muette peut tout de même contenir un flux audio. Voir Automate lyric videos pour l’exemple d’export complet.

Overview

How To

Customization

Audio

Settings

Exporting

Account

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

Champs communs

Exemple avec volumes de stems

Exemple avec override des paramètres

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

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

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

Export local

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

Attendre un export

Télécharger le résultat

Et ensuite

Snapshots de version et de timing

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

​Champs communs

​Exemple avec volumes de stems

​Exemple avec override des paramètres

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

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

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

​Export local

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

​Attendre un export

​Télécharger le résultat

​Et ensuite

​Snapshots de version et de timing

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

Champs communs

Exemple avec volumes de stems

Exemple avec override des paramètres

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

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

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

Export local

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

Attendre un export

Télécharger le résultat

Et ensuite

Snapshots de version et de timing