Cài đặt dự án

Mỗi dự án đều có các cài đặt đang hoạt động — trim, background, kiểu phụ đề, bố cục — quyết định cách các bản xuất được render. Hãy dùng cài đặt dự án khi bạn muốn các ghi đè cục bộ theo dự án mà không đáng để đóng gói vào một preset dùng chung. Xem Render settings reference để biết bản đồ các trường dùng chung cho preset, settings.style, và settingsOverride.

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

Lấy các cài đặt đang hoạt động của một dự án.

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

Patch các cài đặt dự án đang hoạt động. Bạn có thể áp dụng một preset, truyền các cài đặt thô, hoặc cả hai (preset được áp dụng trước, sau đó các ghi đè settings được merge chồng lên).

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

Fields

presetId

string

Áp dụng một preset có thể tái sử dụng. Bỏ qua để giữ nguyên preset hiện tại.

settings

object

Patch được áp dụng chồng lên preset. Dùng style cho các ghi đè theo cấu trúc của preset, cùng với các trường cục bộ theo dự án như displayLanguages, chordSettings, và duetSingerFilter.

Tìm các trường hợp lệ

Chuyển đổi schema cập nhật sang JSON Schema tại runtime để khám phá mọi trường hợp lệ:

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

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

Agents nên gọi bước này trước khi thay đổi cài đặt dự án để luôn nắm được cấu trúc hiện tại.

Các mẫu thường gặp

Trim
Màu nền
Ngôn ngữ hiển thị
Áp dụng 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",
});