Экспорт

Экспорт рендерит караоке или лирик-видео из проекта. Используйте client.exports.create(...) как основную точку входа. Выбирайте target: "local", когда хотите, чтобы SDK рендерил прямо на текущей машине; в противном случае по умолчанию используется облачный экспорт.

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

Выберите цель экспорта с помощью target: "cloud" | "local".

const cloud = await client.exports.create("prj_abc123", {
  resolution: "1080p",
  quality: "high",
});
// => ExportOperation

const local = await client.exports.create("prj_abc123", {
  target: "local",
  resolution: "1080p",
  quality: "high",
  outputPath: "./karaoke.mp4",
});
// => { outputPath, fileSize, duration, ... }

Используйте облако, когда нужен управляемый асинхронный экспорт. Используйте локальный режим, когда хотите рендерить напрямую на машине вызывающей стороны.

Общие поля

Field	Type	Description
`versionId`	`string`	Версия проекта. По умолчанию — основная версия.
`resolution`	`"540p" \| "720p" \| "1080p" \| "4k"`	Выходное разрешение.
`quality`	`"low" \| "average" \| "high"`	Качество кодирования.
`fps`	`25 \| 30 \| 60`	Кадров в секунду. По умолчанию `30`. Используйте `60` для более плавного движения.
`playbackRate`	`number`	Множитель скорости (например, `0.9`).
`toneFrequency`	`number`	Сдвиг высоты тона в полутонах.
`transparent`	`boolean`	Рендер с прозрачным фоном.
`presetId`	`string`	Применить пресет перед рендерингом.
`stemVolumes`	`Record<string, number>`	Переопределения громкости по стемам, ключ — id стема.
`settingsOverride`	`object`	Патч настроек проекта только для этого экспорта.

Используйте fps: 60 для более плавного движения. Облачные квоты применяют множитель кредитов 1.5x при 60 fps. Прозрачные облачные экспорты в 60 fps доступны, когда выбранная длительность и разрешение укладываются в облачные лимиты.

Пример с громкостью стемов

const result = await client.exports.create("prj_abc123", {
  resolution: "1080p",
  quality: "high",
  stemVolumes: {
    vocals: 0,
    instrumental: 1,
    backing: 0.5,
  },
});

Пример с переопределением настроек

const result = await client.exports.create("prj_abc123", {
  resolution: "1080p",
  settingsOverride: {
    trim: { startSeconds: 5, endSeconds: 180 },
    style: {
      background: { type: "color", color: "#101010" },
    },
  },
});

См. Справочник настроек рендера для полной формы settingsOverride.

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

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

const quote = await client.exports.quote("prj_abc123", {
  resolution: "1080p",
  quality: "high",
  transparent: false,
});

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

Локальный экспорт выполняется на машине вызывающей стороны и не расходует кредиты облачного экспорта, поэтому quote(...) предназначен только для облачных экспортов.

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

Список экспортов для проекта с пагинацией.

const exports = await client.exports.list("prj_abc123", {
  page: 1,
  pageSize: 50,
});

number

Номер страницы. По умолчанию на сервере — 1.

number

Размер страницы. По умолчанию — 100. Максимум 100.

`client.exports.get(exportId, options?)`

Получите экспорт только по ID, не зная родительский проект.

const exported = await client.exports.get("exp_xyz");

Локальный экспорт

const result = await client.exports.create("prj_abc123", {
  target: "local",
  resolution: "1080p",
  quality: "high",
  outputPath: "./karaoke.mp4",
  onProgress(progress) {
    console.log(progress.stage, progress.percent);
  },
});

console.log(result.outputPath);

Используйте onDependencyProgress, если хотите получать обновления во время установки или проверки локального инструментария рендера.

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

Возвращает подготовленный payload, необходимый для локального рендера экспорта. Используйте это при интеграции с @youka/remotion или другим локальным рендерером. Сервер возвращает входные данные композиции, URL ассетов и параметры рендера без постановки облачного рендера в очередь.

const payload = await client.exports.prepareLocal("prj_abc123", {
  resolution: "1080p",
  quality: "high",
});

// Hand payload off to your local renderer
await renderLocally(payload);

client.exports.prepareLocal(...) не запускает облачный рендер. Никакие платные вычисления на стороне Youka не потребляются.

Ожидание экспорта

Облачный экспорт — асинхронный. Используйте client.exports.wait(...):

const operation = await client.exports.create("prj_abc123", {
  resolution: "1080p",
});

const finalized = await client.exports.wait(operation, {
  pollIntervalMs: 3_000,
});
console.log("Download from", finalized.url);

Скачивание результата

Облачный экспорт завершается подписанным url. Используйте встроенный хелпер, чтобы потоково сохранить файл на диск. output может быть либо директорией, либо полным путём к файлу, а filename — необязательный:

await client.exports.download(finalized, {
  output: "./exports",
});

Что дальше

Tasks — хендлы операций и продвинутое опрашивание задач
Presets — переиспользуемые конфигурации рендера
Project settings — патч активных настроек проекта

Снимки версии и таймингов

Список версий: client.projects.versions.list(projectId). Передайте versionId в exports.create, exports.quote или exports.prepareLocal. Стилизация относится к этой версии, а выбранное выравнивание относится к проекту. Хендлы операций облачного экспорта и локальные payload’ы включают versionId, alignmentId и alignmentRevision. Эти поля идентифицируют тот же снимок таймингов, который использовался для построения композиции. Более поздняя подготовка или экспорт может увидеть более новые правки. Сохраните подготовленный payload, если внешнему рендереру нужно использовать именно этот снимок, и обновляйте истёкшие подписанные URL медиа. Чтобы заглушить каждый стем, соберите stemVolumes из stem ID проекта, установив все значения в ноль. Прозрачный локальный экспорт использует ProRes 4444 в контейнере MOV. Беззвучный результат всё равно может содержать аудиопоток. См. Automate lyric videos для полного примера экспорта.

Overview

How To

Customization

Audio

Settings

Exporting

Account

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

Общие поля

Пример с громкостью стемов

Пример с переопределением настроек

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

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

`client.exports.get(exportId, options?)`

Локальный экспорт

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

Ожидание экспорта

Скачивание результата

Что дальше

Снимки версии и таймингов

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

​Общие поля

​Пример с громкостью стемов

​Пример с переопределением настроек

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

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

​client.exports.get(exportId, options?)

​Локальный экспорт

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

​Ожидание экспорта

​Скачивание результата

​Что дальше

​Снимки версии и таймингов

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

Общие поля

Пример с громкостью стемов

Пример с переопределением настроек

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

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

`client.exports.get(exportId, options?)`

Локальный экспорт

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

Ожидание экспорта

Скачивание результата

Что дальше

Снимки версии и таймингов