入门指南

Chillin Render API 允许您通过定义如下的 JSON 结构来指定要渲染的视频内容和参数。

  • 前往 渲染控制台 获取 Render API 积分并生成您的 Render API 密钥。

  • 使用您的 API 密钥向 Render API 端点发送 POST 请求:

curl-example.sh
request.json

API 以异步模式运行,并返回如下响应:

async_response.json

核心概念

所有 JSON 对象都包含一个视频项目对象,指定视频的合成宽度、合成高度和分辨率。

项目对象包含渲染视频的基本参数,例如宽度、高度、持续时间、背景颜色等。

项目还包括一个或多个元素,每个元素代表一个视频组件,例如视频、图像、文本、形状、音频或效果。

每个元素包含特定的组件参数,例如位置、大小、颜色、内容等。

project.json

3D 空间与相机

渲染引擎支持 2D 和 3D 元素。虽然画布的宽度和高度以像素为单位定义,但引擎使用透视相机进行 3D 渲染:

  • 坐标系统:x 和 y 坐标表示 2D 画布平面上的位置。z 坐标控制 3D 空间中的深度。
  • 像素完美投影:在 z=0 时,一个世界单位等于一个像素,保持与 2D 工作流的兼容性。
  • 3D 旋转:元素可以使用 rotationXrotationYrotation(Z轴)属性围绕 X、Y 和 Z 轴旋转。

这种设计允许在同一项目中无缝混合 2D 和 3D 元素。传统的 2D 元素(z=0)与之前完全相同,而 3D 元素可以在三维空间中定位和旋转。

3D 元素示例

以下是一个简单的 3D 立方体元素示例:

3d-cube-example.json

与 2D 元素的主要区别:

  • type: "3D" 将其标识为 3D 元素
  • zrotationXrotationYscaleZ 启用 3D 转换
  • geometryType 指定 3D 形状(立方体、球体、圆柱体等)
  • geometryColor 设置 3D 几何体的基础颜色

有关 3D 元素的更多详细信息,请参见 3D 元素 文档。

JSON 架构

您的请求 JSON 必须严格遵守本文件中定义的 JSON 架构。您可以在 Chillin 视频编辑器中测试并生成相应的请求 JSON。