Skip to main content
导出会从项目渲染出一个卡拉 OK 或歌词视频。使用 client.exports.create(...) 作为主要入口。当你希望 SDK 直接在当前机器上渲染时选择 target: "local";否则默认使用云端导出。

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

使用 target: "cloud" | "local" 选择导出目标。
当你需要托管的异步导出时使用云端。当你希望直接在调用方机器上渲染时使用本地。

通用字段

使用 fps: 60 可获得更顺滑的运动效果。云端报价在 60 fps 时会应用 1.5x 的积分倍率。当所选时长与分辨率满足云端限制时,可使用透明 60 fps 的云端导出。

带 stem 音量的示例

带设置覆盖的示例

查看 渲染设置参考 以获取完整的 settingsOverride 结构。

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

在不启动导出的情况下,估算云端导出所需的积分。
本地导出在调用方机器上运行,不会消耗云端导出积分,因此 quote(...) 仅用于云端导出。

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

列出某个项目的导出记录,并支持分页。
number
页码。服务端默认为 1。
number
每页数量。默认为 100。最大 100。

client.exports.get(exportId, options?)

仅通过导出 ID 获取导出信息,无需知道其所属项目。

本地导出

如果你希望在本地渲染工具链正在安装或校验时也能收到更新,请使用 onDependencyProgress。

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

返回在本地渲染导出所需的已准备 payload。与 @youka/remotion 或其他本地渲染器集成时使用。服务端会返回合成输入、资产 URL 与渲染参数,而不会排队云端渲染。
client.exports.prepareLocal(...) 不会启动云端渲染。Youka 侧不会消耗任何可计费的 compute。

等待导出完成

云端导出是异步的。使用 client.exports.wait(...):

下载结果

云端导出完成后会返回一个签名 url。使用内置 helper 将文件流式写入磁盘。output 可以是目录或完整文件路径,filename 可选:

下一步

  • 任务 — 操作句柄与高级任务轮询
  • 预设 — 可复用的渲染配置
  • 项目设置 — 对项目的当前生效设置打补丁

版本与时间轴快照

使用 client.projects.versions.list(projectId) 列出版本。将 versionId 传给 exports.create、exports.quote 或 exports.prepareLocal。样式归属于该版本,而所选对齐归属于项目。 云端导出操作句柄与本地 payload 都包含 versionId、alignmentId 和 alignmentRevision。这些字段标识用于构建合成的同一时间轴快照。后续的准备或导出可能会观察到更新的编辑。如果外部渲染器必须使用那个精确快照,请保存已准备的 payload,并刷新过期的已签名媒体 URL。 要将所有 stem 静音,请基于项目的 stem IDs 构建 stemVolumes,并将每个值都设为零。透明本地导出使用 MOV 容器中的 ProRes 4444。静音输出仍可能包含音频流。 查看 自动化歌词视频 以获取完整的导出示例。