Проекты

Проект — это ресурс «в процессе работы» для одного караоке-трека. Он содержит исходное медиа, синхронизированный текст, разделённые стемы, настройки рендера и экспорты, созданные на его основе.

`project create`

Создать новый проект из локального файла или URL.

youka project create <source> [options]

string

required

Путь к локальному файлу (./song.mp3) или HTTP/HTTPS URL (https://example.com/song.mp4).

Options

Option	Description
`--title <title>`	Название проекта
`--mode <mode>`	`none`, `transcribe` или `align`
`--lyrics <text>`	Текст lyrics
`--lang <code>`	Код языка
`--sync-model <model>`	Модель синхронизации lyrics
`--split-model <model>`	Модель разделения стемов
`--max-video-quality <quality>`	Максимальное качество видео для URL-источников: `720p`, `1080p`, `4k` или `best`
`--preset <presetId>`	Применить пресет при создании проекта
`--export`	Создать экспорт после того, как проект будет готов
`--download`	Создать экспорт, дождаться его готовности и скачать
`--output <path>`	Путь вывода для `--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

Правила:

Если вы передаёте lyrics и не указываете --mode, CLI по умолчанию использует align
align требует lyrics
transcribe и none не принимают lyrics
--download подразумевает --export
--max-video-quality применяется только к HTTP/HTTPS URL-источникам. По умолчанию это 1080p, используется лучшее доступное качество в пределах этого лимита, а когда платформа не предоставляет поток с ограничением, используется лучший доступный формат.

`project list`

Показать список всех проектов для аутентифицированного аккаунта.

youka project list
youka project list --json

`project quote`

Рассчитать количество кредитов, необходимых для создания проекта, не создавая проект.

youka project quote <source> [options]

source принимает те же формы локального пути к файлу или HTTP/HTTPS URL, что и project create. Без --duration CLI загружает источник, чтобы сервер мог точно измерить длительность медиа, но проект не создаёт.

Options

Option	Description
`--title <title>`	Название проекта
`--mode <mode>`	`none`, `transcribe` или `align`
`--lyrics <text>`	Текст lyrics для `align`
`--lang <code>`	Код языка
`--sync-model <model>`	Модель синхронизации lyrics
`--split-model <model>`	Модель разделения стемов
`--max-video-quality <quality>`	Максимальное качество видео для URL-источников: `720p`, `1080p`, `4k` или `best`
`--duration <seconds>`	Рассчитать по известной длительности без загрузки источника

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`

Получить текущее состояние проекта, включая нормализованные state, pendingOperation, стемы, настройки и экспорты.

youka project show <projectId>

string

required

ID проекта, возвращаемый командой project create.

`project wait`

Опрашивать проект до тех пор, пока он не достигнет терминального состояния.

youka project wait <projectId> --json

`project delete`

Удалить проект и все связанные с ним стемы, lyrics и экспорты.

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

Удаление необратимо. Передайте --idempotency-key, чтобы повторы запроса были безопасными.

`project sync`

Повторно запустить транскрибацию или выравнивание lyrics для существующего проекта.

youka project sync <projectId> [options]

Option	Description
`--mode <mode>`	`transcribe` или `align`
`--text <text>`	Текст lyrics
`--lang <code>`	Код языка
`--sync-model <model>`	Модель синхронизации lyrics

Example:

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

`project separate`

Повторно запустить разделение стемов для существующего проекта.

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

Example:

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

`project settings`

Прочитать или обновить активные настройки проекта.

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

Если ни --preset, ни --body не указаны, команда возвращает текущие настройки. Если указан хотя бы один из них, выполняется обновление. Examples:

youka project settings $PROJECT_ID --json

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

`project stem list`

Показать список стемов проекта.

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

`project stem download`

Скачать один или несколько стем-файлов на диск. Стемы скачиваются в исходном сохранённом формате; CLI не выполняет их транскодирование.

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

Поддерживаемые значения --type: original, instrumental, vocals и backing_vocals. CLI также принимает backing-vocals, backingVocals и backingvocals как алиасы.

Что дальше

Exports — отрендерить готовое караоке
Presets — управлять переиспользуемыми конфигурациями рендера
Render settings reference — общие поля пресетов и настроек

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`

Что дальше

​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

​Что дальше

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

Что дальше