Projects

Projects — это ресурс верхнего уровня в Youka. Каждый проект владеет своим исходным файлом, текстами, экспортами и настройками проекта. Проекты караоке также содержат разделённые stems.

Создание проекта

В большинстве случаев используйте client.projects.create() — он сам обрабатывает загрузки.

const operation = await client.projects.create({
  source: { type: "path", path: "./song.mp3" },
  lyricsSource: { type: "transcribe" },
});
// => ProjectOperation

Типы source

path
bytes
url

Читает файл с диска.

source: {
  type: "path",
  path: "./song.mp3",
  contentType: "audio/mpeg", // optional, inferred if omitted
}

Blob, File, ArrayBuffer или Uint8Array в памяти.

source: {
  type: "bytes",
  data: fileBuffer,
  filename: "song.mp3",
  contentType: "audio/mpeg", // optional
}

Удалённый URL по HTTP или HTTPS.Список поддерживаемых хостинговых страниц зависит от yt-dlp. См. список поддерживаемых URL.

source: {
  type: "url",
  url: "https://example.com/song.mp4",
  maxVideoQuality: "1080p", // optional: "720p", "1080p", "4k", or "best"
}

maxVideoQuality управляет максимальным качеством скачиваемого видео для URL источников. По умолчанию 1080p. SDK использует лучшее доступное качество до этого лимита и откатывается к лучшему доступному формату, если платформа не предоставляет поток с ограничением. Используйте best, чтобы снять ограничение.

В Node.js и Bun SDK при первом использовании автоматически обеспечивает наличие необходимых бинарников зависимостей для URL (ffmpeg, ffprobe, yt-dlp). Эквивалент в CLI: youka deps ensure --for url.

Другие поля

string

Заголовок проекта. По умолчанию равен имени файла источника.

karaoke | lyric-video

Рабочий процесс. По умолчанию karaoke. lyric-video использует исходный аудиотрек без разделения на стемы.

SplitModel

Модель разделения на стемы для karaoke. По умолчанию mdx23c. Отклоняется для lyric-video. См. справочник моделей разделения.

string

Применить переиспользуемый пресет при создании.

LyricsSource

Настроить синхронизацию текста. См. ниже.

Источники lyrics

// Transcribe lyrics from the audio
lyricsSource: {
  type: "transcribe",
  syncModel: "audioshake-transcription", // optional
  language: "en",                        // optional
}

// Align exact lyrics to the audio
lyricsSource: {
  type: "align",
  lyrics: "First line\nSecond line\n...",
  syncModel: "audioshake-alignment",
}

`client.projects.create(input, options?)`

client.projects.create() также принимает низкоуровневый источник inputFile, когда у вас уже есть загруженный inputFileId.

const upload = await client.uploads.create({
  filename: "song.mp3",
  contentType: "audio/mpeg",
  contentLength: buffer.byteLength,
});

await client.uploads.upload(upload.uploadUrl, buffer, {
  contentType: "audio/mpeg",
});

const operation = await client.projects.create({
  source: {
    type: "inputFile",
    inputFileId: upload.inputFileId,
    filename: "song.mp3",
  },
  title: "My Song",
});

`client.projects.quote(input, options?)`

Оцените кредиты, необходимые для создания проекта, не создавая его.

const quote = await client.projects.quote({
  source: { type: "path", path: "./song.mp3" },
  lyricsSource: { type: "transcribe", language: "en" },
  splitModel: "mdx23c",
});

console.log(quote.creditsRequired, quote.sufficientBalance);

client.projects.quote(...) принимает те же формы source, что и client.projects.create(...), включая URL maxVideoQuality. Если вы уже знаете длительность медиа и не хотите загружать файл только ради оценки, передайте низкоуровневую REST-форму:

const quote = await client.projects.quote({
  durationSeconds: 210,
  lyricsSource: null,
  splitModel: "mdx23c",
});

`client.uploads.create(body, options?)`

Выделите слот для загрузки и получите подписанный URL.

const upload = await client.uploads.create({
  filename: "song.mp3",
  contentType: "audio/mpeg",
  contentLength: 4_521_344,
});
// => { inputFileId, uploadUrl }

`client.uploads.upload(uploadUrl, body, options?)`

Выполните PUT байтов файла на подписанный URL.

await client.uploads.upload(upload.uploadUrl, fileBuffer, {
  contentType: "audio/mpeg",
  signal: abortController.signal,
});

FetchBody

required

Любое тело, совместимое с fetch: Blob, File, ArrayBuffer, Uint8Array, ReadableStream или string.

Выбрасывает YoukaRequestError с кодом UPLOAD_FAILED, если загрузка возвращает статус не из диапазона 2xx.

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

Получите полное состояние проекта, включая стемы, текст и экспорты.

const project = await client.projects.get("prj_abc123");
console.log(project.title, project.stems, project.lyrics);

`client.projects.update(projectId, body, options?)`

Частично обновите метаданные проекта.

const project = await client.projects.update("prj_abc123", {
  title: "Updated title",
  artists: ["Artist name"],
});

Передайте как минимум одно из title или artists.

`client.projects.list(options?)`

Перечислите все проекты, принадлежащие аутентифицированному аккаунту.

const projects = await client.projects.list();
projects.forEach((p) => console.log(p.id, p.title));

Возвращает массив элементов списка проектов (более «лёгкая» форма, чем getProject).

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

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

await client.projects.delete("prj_abc123", {
  idempotencyKey: "delete-prj_abc123",
});

Удаление необратимо. Используйте вместе с ключом идемпотентности, чтобы повторные попытки были безопасны.

Что дальше

Stems — повторно запустить разделение на стемы
Lyrics sync — повторно синхронизировать текст
Exports — рендерить готовые видео
Tasks — ожидать завершения операций проекта через client.projects.wait

Создание lyric-video и обнаружение моделей

const capabilities = await client.capabilities.get();
const operation = await client.projects.create({
  kind: "lyric-video",
  source: { type: "path", path: "./song.wav" },
  lyricsSource: {
    type: "transcribe",
    syncModel: "elevenlabs-transcription",
    lyrics: "Optional reference lyrics",
  },
});
const { project } = await client.projects.wait(operation);
const versions = await client.projects.versions.list(project.id);

Те же выборы kind и обработки текста работают и с projects.quote. Оценка для lyric-video списывает ноль кредитов за разделение. Оценка и создание валидируют одни и те же требования к модели, языку, аккаунту и источнику. Оценки не резервируют кредиты или мощность. Используйте lyricsSource: null, чтобы пропустить обработку текста. Справочный текст при транскрибации — это подсказка и может отличаться от результата. Модели, которым нужны изолированные вокалы, не могут обрабатывать lyric-video без разделения. См. Automate lyric videos про возможности, точные обновления таймингов и контрольные точки каталога.

Overview

How To

Customization

Audio

Settings

Exporting

Account

Создание проекта

Типы source

Другие поля

Источники lyrics

`client.projects.create(input, options?)`

`client.projects.quote(input, options?)`

`client.uploads.create(body, options?)`

`client.uploads.upload(uploadUrl, body, options?)`

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

`client.projects.update(projectId, body, options?)`

`client.projects.list(options?)`

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

Что дальше

Создание lyric-video и обнаружение моделей

​Создание проекта

​Типы source

​Другие поля

​Источники lyrics

​client.projects.create(input, options?)

​client.projects.quote(input, options?)

​client.uploads.create(body, options?)

​client.uploads.upload(uploadUrl, body, options?)

​client.projects.get(projectId, options?)

​client.projects.update(projectId, body, options?)

​client.projects.list(options?)

​client.projects.delete(projectId, options?)

​Что дальше

​Создание lyric-video и обнаружение моделей

Создание проекта

Типы source

Другие поля

Источники lyrics

`client.projects.create(input, options?)`

`client.projects.quote(input, options?)`

`client.uploads.create(body, options?)`

`client.uploads.upload(uploadUrl, body, options?)`

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

`client.projects.update(projectId, body, options?)`

`client.projects.list(options?)`

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

Что дальше

Создание lyric-video и обнаружение моделей