Preset là một cấu hình render có thể tái sử dụng — nền, kiểu phụ đề, bố cục — mà bạn có thể áp dụng cho bất kỳ project hoặc export nào. Hãy dùng preset khi bạn muốn có giao diện nhất quán trên nhiều track.
Xem Render settings reference để biết đầy đủ
hình dạng preset và mọi tùy chọn được hỗ trợ bởi enum.
client.presets.list(options?)
Liệt kê mọi preset thuộc về tài khoản đã xác thực.
const presets = await client.presets.list();
presets.forEach((p) => console.log(p.id, p.name, p.isDefault));
client.presets.get(presetId, options?)
Lấy một preset duy nhất.
const preset = await client.presets.get("preset_abc123");
client.presets.create(body, options?)
Tạo một preset mới.
const preset = await client.presets.create({
name: "Neon Night",
preset: {
background: {
type: "gradient",
colors: ["#12001f", "#2f0a57"],
angle: 90,
},
singerTextStyles: {
0: {
fontFamily: "Inter",
textColor: "#00f5ff",
effectColor: "#ff4fd8",
},
},
},
isDefault: false,
});
Tên hiển thị trong UI của Youka.
Toàn bộ nội dung preset. Dùng Render settings reference để xem bản đồ trường dễ đọc cho con người,
hoặc KaraokePresetSchema.toJSONSchema() để lấy schema dễ đọc cho máy. Đặt preset mới làm mặc định cho tài khoản. Mỗi lần chỉ có thể có một preset
là mặc định.
const preset = await client.presets.create(body, {
idempotencyKey: "create-neon-night-v1",
});
client.presets.update(presetId, body, options?)
Patch một preset hiện có. Truyền bất kỳ tập con nào của name, preset, và isDefault.
const updated = await client.presets.update("preset_abc123", {
name: "Neon Night v2",
preset: {
singerTextStyles: {
0: { textColor: "#ff2a2a" },
},
},
});
client.presets.delete(presetId, options?)
Xóa một preset.
await client.presets.delete("preset_abc123", {
idempotencyKey: "delete-preset_abc123",
});
Việc xóa một preset không xóa các project hoặc export đã từng được render bằng preset đó. Các export trong tương lai tham chiếu đến preset đã bị xóa sẽ thất bại.
client.presets.setDefault(presetId, options?)
Đặt một preset làm mặc định cho các project mới. Đây là một wrapper tiện lợi quanh client.presets.update(presetId, { isDefault: true }).
await client.presets.setDefault("preset_abc123");
Khám phá các trường hợp lệ
SDK export Zod schema dùng để validate nội dung preset. Hãy chuyển nó sang JSON Schema khi chạy để phục vụ agents và trình dựng form:
import { KaraokePresetSchema } from "@youka/sdk";
const jsonSchema = KaraokePresetSchema.toJSONSchema();
console.log(jsonSchema);
Tác giả agent: hãy gọi schema này trước khi mutate preset để model biết chính xác tên trường và kiểu giá trị.
Áp dụng một preset
Bạn có thể áp dụng preset tại ba thời điểm:
Khi tạo project
Trong cài đặt project
Khi export
await client.projects.create({
source: { type: "path", path: "./song.mp3" },
presetId: "preset_abc123",
});
await client.projects.updateSettings("prj_abc123", {
presetId: "preset_abc123",
});
await client.exports.create("prj_abc123", {
presetId: "preset_abc123",
resolution: "1080p",
});
Tiếp theo
