Configurações do projeto

Todo projeto tem configurações ativas — trim, background, estilo de legenda, layout — que controlam como as exportações são renderizadas. Use as configurações do projeto quando você quiser substituições locais do projeto que não valem a pena agrupar em um preset compartilhado. Veja Render settings reference para o mapa de campos compartilhados de preset, settings.style e settingsOverride.

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

Busque as configurações ativas de um projeto.

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?)`

Faça patch das configurações ativas do projeto. Você pode aplicar um preset, passar configurações brutas, ou ambos (o preset é aplicado primeiro e, em seguida, as substituições de settings são mescladas por cima).

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

Campos

presetId

string

Aplique um preset reutilizável. Omita para manter o preset atual inalterado.

settings

object

Patch aplicado por cima do preset. Use style para substituições no formato de preset, além de campos locais do projeto como displayLanguages, chordSettings e duetSingerFilter.

Descobrindo campos válidos

Converta o schema de update para JSON Schema em tempo de execução para descobrir todos os campos válidos:

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

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

Agentes devem chamar isso antes de modificar as configurações do projeto para que sempre conheçam o formato atual.

Padrões comuns

Trim
Cor de fundo
Idiomas de exibição
Aplicar 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",
});