Skip to main content
Xuất (Exports) dùng để render một video karaoke hoặc video lời bài hát từ một dự án. Dùng client.exports.create(...) làm điểm vào chính. Chọn target: "local" khi bạn muốn SDK render trực tiếp trên máy hiện tại; nếu không, xuất trên đám mây là mặc định.

client.exports.create(projectId, input, options?)

Chọn đích xuất với target: "cloud" | "local".
Dùng cloud khi bạn muốn một quy trình xuất bất đồng bộ được quản lý. Dùng local khi bạn muốn kết xuất trực tiếp trên máy của bên gọi.

Các trường dùng chung

Dùng fps: 60 để chuyển động mượt hơn. Báo giá cloud áp dụng hệ số tín dụng 1.5x ở 60 fps. Xuất cloud 60 fps trong suốt khả dụng khi thời lượng và độ phân giải đã chọn phù hợp với giới hạn cloud.

Ví dụ với âm lượng stem

Ví dụ với ghi đè cài đặt

Xem Tài liệu tham chiếu cài đặt kết xuất để biết đầy đủ dạng (shape) của settingsOverride.

client.exports.quote(projectId, input, options?)

Báo giá số tín dụng cần thiết cho một lần xuất cloud mà không bắt đầu xuất.
Xuất local chạy trên máy của bên gọi và không dùng tín dụng xuất cloud, vì vậy quote(...) chỉ dành cho xuất cloud.

client.exports.list(projectId, input?, options?)

Liệt kê các lần xuất cho một dự án, kèm phân trang.
number
Số trang. Mặc định là 1 trên server.
number
Kích thước trang. Mặc định 100. Tối đa 100.

client.exports.get(exportId, options?)

Lấy một export theo riêng ID, không cần biết dự án cha.

Xuất cục bộ

Dùng onDependencyProgress nếu bạn muốn cập nhật trong lúc bộ công cụ kết xuất cục bộ đang được cài đặt hoặc xác minh.

client.exports.prepareLocal(projectId, body, options?)

Trả về payload đã chuẩn bị cần thiết để kết xuất một export cục bộ. Dùng cái này khi tích hợp với @youka/remotion hoặc một renderer cục bộ khác. Server trả về đầu vào composition, URL asset và tham số kết xuất mà không xếp hàng (queue) một lần kết xuất cloud.
client.exports.prepareLocal(...) không bắt đầu một lần kết xuất cloud. Không có compute tính phí nào được tiêu thụ ở phía Youka.

Chờ một lần xuất

Xuất cloud là bất đồng bộ. Dùng client.exports.wait(...):

Tải xuống kết quả

Xuất cloud hoàn tất với một url đã ký. Dùng helper tích hợp sẵn để stream tệp xuống đĩa. output có thể là thư mục hoặc đường dẫn tệp đầy đủ, và filename là tùy chọn:

Tiếp theo

  • Tasks — handle thao tác và polling tác vụ nâng cao
  • Presets — cấu hình kết xuất có thể tái sử dụng
  • Project settings — vá cài đặt đang hoạt động của dự án

Snapshot phiên bản và timing

Liệt kê các phiên bản với client.projects.versions.list(projectId). Truyền versionId vào exports.create, exports.quote, hoặc exports.prepareLocal. Styling thuộc về phiên bản đó, trong khi alignment được chọn thuộc về dự án. Handle thao tác xuất cloud và payload cục bộ bao gồm versionId, alignmentId, và alignmentRevision. Các trường này xác định cùng một snapshot timing được dùng để dựng composition. Một lần chuẩn bị hoặc xuất về sau có thể quan sát các chỉnh sửa mới hơn. Hãy lưu payload đã chuẩn bị nếu một renderer bên ngoài phải dùng đúng snapshot đó, và làm mới các URL media đã ký bị hết hạn. Để tắt tiếng mọi stem, hãy xây stemVolumes từ các stem ID của dự án với mọi giá trị đặt về 0. Xuất local trong suốt dùng ProRes 4444 trong container MOV. Một đầu ra im lặng vẫn có thể có một audio stream. Xem Automate lyric videos để có ví dụ xuất đầy đủ.