Dự án

Một dự án chứa media nguồn, lời bài hát, cài đặt render và các bản xuất cho một video karaoke hoặc video lời bài hát. Các dự án karaoke cũng chứa các stem đã được tách.

`project create`

Tạo một dự án mới từ một tệp cục bộ hoặc một URL.

youka project create <source> [options]

string

required

Một đường dẫn tệp cục bộ (./song.mp3) hoặc một URL HTTP/HTTPS (https://example.com/song.mp4).

Options

Option	Description
`--kind <kind>`	`karaoke` hoặc `lyric-video`. Mặc định là `karaoke`.
`--title <title>`	Tiêu đề dự án
`--mode <mode>`	`none`, `transcribe`, hoặc `align`
`--lyrics <text>`	Văn bản lời bài hát
`--lang <code>`	Mã ngôn ngữ
`--sync-model <model>`	Mô hình đồng bộ lời bài hát
`--split-model <model>`	Mô hình tách stem
`--max-video-quality <quality>`	Chất lượng video tối đa cho nguồn URL: `720p`, `1080p`, `4k`, hoặc `best`
`--preset <presetId>`	Áp dụng một preset khi tạo dự án
`--export`	Tạo một export sau khi dự án sẵn sàng
`--download`	Tạo một export, chờ hoàn tất và tải xuống
`--output <path>`	Đường dẫn đầu ra cho `--download`

Examples

youka project create ./song.mp3 \
  --title "My Song" \
  --mode transcribe \
  --lang en \
  --wait \
  --json

youka project create "https://example.com/song.mp4" \
  --max-video-quality 4k \
  --download \
  --output ./karaoke.mp4 \
  --json

youka project create ./song.mp3 \
  --mode align \
  --lyrics "$(cat lyrics.txt)" \
  --sync-model audioshake-alignment \
  --wait \
  --json

Quy tắc:

Nếu bạn truyền lyrics và bỏ qua --mode, CLI mặc định là align
align yêu cầu phải có lyrics
transcribe chấp nhận lyrics tham chiếu (không bắt buộc). Mô hình có thể trả về văn bản khác.
none không chấp nhận lyrics
--kind lyric-video dùng audio gốc mà không tách stem và từ chối --split-model. Nếu bỏ qua --kind thì giữ hành vi karaoke.
--download ngụ ý --export
--max-video-quality chỉ áp dụng cho nguồn URL HTTP/HTTPS. Mặc định là 1080p, dùng chất lượng tốt nhất có sẵn nhưng không vượt quá giới hạn đó, và sẽ chuyển sang định dạng tốt nhất có sẵn khi nền tảng không cung cấp stream bị giới hạn.

`project list`

Liệt kê tất cả dự án của tài khoản đã xác thực.

youka project list
youka project list --json

`project quote`

Ước tính số credit cần để tạo một dự án mà không tạo dự án.

youka project quote <source> [options]

source chấp nhận cùng dạng đường dẫn tệp cục bộ hoặc URL HTTP/HTTPS như project create. Nếu không có --duration, CLI tải lên nguồn để máy chủ đo chính xác media, nhưng sẽ không tạo dự án.

Options

Option	Description
`--kind <kind>`	`karaoke` hoặc `lyric-video`. Mặc định là `karaoke`.
`--title <title>`	Tiêu đề dự án
`--mode <mode>`	`none`, `transcribe`, hoặc `align`
`--lyrics <text>`	Văn bản bắt buộc cho `align`, hướng dẫn tùy chọn cho `transcribe`
`--lang <code>`	Mã ngôn ngữ
`--sync-model <model>`	Mô hình đồng bộ lời bài hát
`--split-model <model>`	Mô hình tách stem
`--max-video-quality <quality>`	Chất lượng video tối đa cho nguồn URL: `720p`, `1080p`, `4k`, hoặc `best`
`--duration <seconds>`	Báo giá từ thời lượng đã biết mà không cần tải lên nguồn

Examples:

youka project quote ./song.mp3 --mode transcribe --json
youka project quote https://example.com/song.mp4 --max-video-quality 4k --mode transcribe --json
youka project quote ./song.mp3 --duration 210 --mode none --json

`project show`

Lấy trạng thái dự án hiện tại, bao gồm state đã chuẩn hóa, pendingOperation, stem, cài đặt và export.

youka project show <projectId>

string

required

ID dự án được trả về bởi project create.

`project wait`

Thăm dò một dự án cho đến khi nó đạt trạng thái kết thúc.

youka project wait <projectId> --json

`project delete`

Xóa một dự án và tất cả stem, lời bài hát và export liên quan.

youka project delete <projectId> --idempotency-key delete-<projectId>

Việc xóa là vĩnh viễn. Truyền --idempotency-key để việc thử lại được an toàn.

`project sync`

Chạy lại việc phiên âm (transcription) hoặc căn chỉnh (alignment) lời bài hát trên một dự án hiện có.

youka project sync <projectId> [options]

Option	Description
`--mode <mode>`	`transcribe` hoặc `align`
`--text <text>`	Văn bản lời bài hát
`--lang <code>`	Mã ngôn ngữ
`--sync-model <model>`	Mô hình đồng bộ lời bài hát

Example:

youka project sync $PROJECT_ID \
  --mode align \
  --text "$(cat lyrics.txt)" \
  --wait \
  --json

`project separate`

Chạy lại việc tách stem trên một dự án hiện có.

youka project separate <projectId> [--split-model <model>]

Example:

youka project separate $PROJECT_ID --split-model audioshakeai --wait --json

`project settings`

Đọc hoặc cập nhật cài đặt dự án đang hoạt động.

youka project settings <projectId>
youka project settings <projectId> --preset <presetId> --body ./settings.json

Nếu không có --preset lẫn --body, lệnh sẽ trả về cài đặt hiện tại. Nếu có một trong hai, lệnh sẽ thực hiện cập nhật. Examples:

youka project settings $PROJECT_ID --json

youka project settings $PROJECT_ID \
  --preset preset_abc123 \
  --body ./project-settings.json \
  --json

`project stem list`

Liệt kê các stem của một dự án.

youka project stem list <projectId>
youka project stem list <projectId> --json

`project stem download`

Tải một hoặc nhiều tệp stem xuống ổ đĩa. Stem được tải về theo đúng định dạng được lưu trữ ban đầu; CLI không chuyển mã (transcode) chúng.

youka project stem download <projectId> <stemId> --output ./stems
youka project stem download <projectId> --type instrumental --output ./stems
youka project stem download <projectId> --type original --type backing-vocals --type vocals --output ./stems
youka project stem download <projectId> --all --output ./stems

Các giá trị --type được hỗ trợ là original, instrumental, vocals, và backing_vocals. CLI cũng chấp nhận backing-vocals, backingVocals, và backingvocals như các alias.

What’s next

Exports - render bản karaoke hoàn chỉnh
Presets - quản lý các cấu hình render có thể tái sử dụng
Render settings reference - các trường preset và settings dùng chung

Capabilities, versions, and timings

youka capabilities --json trả về ID mô hình, các workflow được hỗ trợ, cách xử lý văn bản, hỗ trợ ngôn ngữ và điều kiện đủ của tài khoản. Wav2Vec2 là một mô hình alignment. ElevenLabs Scribe là một mô hình transcription. Các mô hình yêu cầu vocals đã được cô lập cần một workflow karaoke với một mô hình separation tạo ra vocals.

youka capabilities --json
youka project create ./song.wav --kind lyric-video --mode transcribe --sync-model elevenlabs-transcription --json
youka project quote ./song.wav --kind lyric-video --mode transcribe --sync-model elevenlabs-transcription --json
youka project versions proj_example --json
youka project settings proj_example --version-id ver_example --json
youka project timings list proj_example --json
youka project timings get proj_example aln_example --json
youka project timings import proj_example aln_example --body corrected-request.json --json
youka project timings select proj_example aln_example --expected-revision "$ALIGNMENT_REVISION" --expected-selection-revision "$SELECTION_REVISION" --json

project settings --version-id đọc hoặc cập nhật phiên bản đã chọn. Bỏ qua cờ này sẽ dùng phiên bản chính. Việc import timing sẽ thay thế toàn bộ alignment mà không cần một job xử lý hoặc giữ credit. JSON body chứa alignment và expectedRevision. Lưu-và-chọn theo kiểu nguyên tử (atomic save-and-select) cũng cần select: true và expectedSelectionRevision. Token cũ sẽ trả về HTTP 409. Hãy lấy và so sánh các giá trị hiện tại trước khi thử chỉnh sửa lần nữa. Xem Automate lyric videos để biết request file, kiểm tra hợp lệ timing và xử lý catalogue có thể tiếp tục (resumable).

Overview

How To

Customization

Audio

Settings

Exporting

Account

`project create`

Options

Examples

`project list`

`project quote`

Options

`project show`

`project wait`

`project delete`

`project sync`

`project separate`

`project settings`

`project stem list`

`project stem download`

What’s next

Capabilities, versions, and timings

​project create

​Options

​Examples

​project list

​project quote

​Options

​project show

​project wait

​project delete

​project sync

​project separate

​project settings

​project stem list

​project stem download

​What’s next

​Capabilities, versions, and timings

`project create`

Options

Examples

`project list`

`project quote`

Options

`project show`

`project wait`

`project delete`

`project sync`

`project separate`

`project settings`

`project stem list`

`project stem download`

What’s next

Capabilities, versions, and timings