项目设置

每个项目都有一组生效设置——裁剪、背景、字幕样式、布局——用于控制导出的渲染方式。当你需要仅在该项目内生效的覆盖项，而这些覆盖又不值得打包成共享预设时，请使用项目设置。共享的 preset、settings.style 和 settingsOverride 字段映射请参见渲染设置参考。

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

获取项目当前生效的设置。

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

以补丁方式更新项目的生效设置。你可以应用一个预设、传入原始设置，或两者同时使用（会先应用预设，然后再把设置覆盖项合并到其上）。

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

字段

string

应用一个可复用的预设。省略则保持当前预设不变。

object

应用于预设之上的补丁。使用 style 来进行与预设形状一致的覆盖，以及项目本地字段，例如 displayLanguages、chordSettings 和 duetSingerFilter。

发现可用字段

在运行时将更新 schema 转为 JSON Schema，以发现每一个可用字段：

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

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

Agent 在修改项目设置之前应先调用此方法，以便始终了解当前的结构形状。

常见模式

裁剪
背景颜色
显示语言
应用预设

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",
});

项目设置 vs 预设

问题	使用
需要在多个项目中保持相同外观？	预设
只在单个项目上做一次性的裁剪或颜色微调？	项目设置
基础外观 + 少量项目特定覆盖？	预设 + 项目设置

接下来

渲染设置参考 — 所有共享字段路径与枚举值
预设 — 可复用配置
媒体 — 上传背景与 logo
API 项目设置 — 通过原始 HTTP 实现相同流程
CLI 项目 — 在终端中实现相同流程
导出 — 使用 settingsOverride 进行仅导出时的微调

选择一个版本

const versions = await client.projects.versions.list("prj_abc123");
const versionId = versions[0]!.id;
const settings = await client.projects.getSettings("prj_abc123", { versionId });
await client.projects.updateSettings("prj_abc123", {
  versionId,
  settings: { trim: { startSeconds: 5, endSeconds: 180 } },
});

省略 versionId 会读取或更新主版本。响应会包含版本 ID。对齐（alignment）选择在项目内共享，而不是按版本分别存储。

Overview

How To

Customization

Audio

Settings

Exporting

Account

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

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

字段

发现可用字段

常见模式

项目设置 vs 预设

接下来

选择一个版本

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

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

​字段

​发现可用字段

​常见模式

​项目设置 vs 预设

​接下来

​选择一个版本

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

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

字段

发现可用字段

常见模式

项目设置 vs 预设

接下来

选择一个版本