Paramètres du projet

Chaque projet possède des paramètres actifs — trim, background, style de sous-titres, layout — qui contrôlent la façon dont les exports sont rendus. Utilisez les paramètres du projet lorsque vous voulez des surcharges locales au projet qui ne valent pas la peine d’être regroupées dans un preset partagé. Voir Render settings reference pour la cartographie des champs partagés preset, settings.style et settingsOverride.

`client.projects.getSettings(projectId, options?)`

Récupère les paramètres actifs d’un projet.

const config = await client.projects.getSettings("prj_abc123");
console.log(
  config.settings.trim,
  config.settings.style?.background,
  config.settings.displayLanguages,
);

`client.projects.updateSettings(projectId, body, options?)`

Applique un patch aux paramètres actifs du projet. Vous pouvez appliquer un preset, passer des paramètres bruts, ou les deux (le preset est appliqué en premier, puis les surcharges de paramètres sont fusionnées par-dessus).

const updated = await client.projects.updateSettings("prj_abc123", {
  presetId: "preset_abc123",
  settings: {
    trim: { startSeconds: 5, endSeconds: 180 },
  },
});

Champs

string

Applique un preset réutilisable. Omettez-le pour laisser le preset actuel inchangé.

object

Patch appliqué par-dessus le preset. Utilisez style pour des surcharges au format du preset, ainsi que des champs locaux au projet comme displayLanguages, chordSettings et duetSingerFilter.

Découvrir les champs valides

Convertissez le schéma de mise à jour en JSON Schema à l’exécution pour découvrir chaque champ valide :

import { RestUpdateProjectSettingsRequestSchema } from "@youka/sdk";

const schema = RestUpdateProjectSettingsRequestSchema.toJSONSchema();
console.log(JSON.stringify(schema, null, 2));

Les agents devraient appeler ceci avant de modifier les paramètres du projet afin de toujours connaître la structure actuelle.

Modèles courants

Trim
Couleur d’arrière-plan
Langues d’affichage
Appliquer un preset

await client.projects.updateSettings("prj_abc123", {
  settings: {
    trim: { startSeconds: 5.0, endSeconds: 180.0 },
  },
});

await client.projects.updateSettings("prj_abc123", {
  settings: {
    style: {
      background: { type: "color", color: "#101010" },
    },
  },
});

await client.projects.updateSettings("prj_abc123", {
  settings: {
    displayLanguages: ["en", "es"],
  },
});

await client.projects.updateSettings("prj_abc123", {
  presetId: "preset_abc123",
});