はじめに

Chillin Render APIを使用すると、以下のようなJSON構造を定義することで、レンダリングする動画コンテンツとパラメータを指定できます。

  • Render Consoleにアクセスして、Render APIクレジットを取得し、Render APIキーを生成します。

  • APIキーを使用して、Render APIエンドポイントにPOSTリクエストを送信します:

curl-example.sh
1curl -X POST https://render-api.chillin.online/render/v1 \ 2-H "Accept: application/json" \ 3-H "Content-Type: application/json" \ 4-H "Authorization: Bearer YOUR_API_KEY" \ 5-d @request.json
request.json
1{ 2"compositeWidth": 1920, 3"compositeHeight": 1080, 4"fps": 30, 5"projectData": { 6 "type": "", 7 "width": 1920, 8 "height": 1080, 9 "fill": "#000000", 10 "view": [ 11 { 12 "id": "bba95c7f-652b-4380-b166-6bece989f527", 13 "type": "Image", 14 "start": 0, 15 "duration": 5, 16 "trackIndex": 0, 17 "x": 0, 18 "y": 0, 19 "width": 3629, 20 "height": 5444, 21 "blendMode": "normal", 22 "anchorX": 1814.5, 23 "anchorY": 2722, 24 "rotation": 0, 25 "scaleX": 0.19838354151359294, 26 "scaleY": 0.19838354151359294, 27 "alpha": 1, 28 "skewX": 0, 29 "skewY": 0, 30 "hidden": false, 31 "locked": false, 32 "keyframes": [], 33 "externalUrl": "https://images.pexels.com/photos/33189512/pexels-photo-33189512.jpeg", 34 "ext": "jpeg" 35 } 36 ], 37 "audio": [], 38 "effect": [], 39 "transition": [], 40 "version": 0, 41 "duration": 5 42} 43}; 44

APIは非同期モードで動作し、次のようなレスポンスを返します:

async_response.json
1{ 2"code": 0, 3"data": { 4 "message": "Async render request submitted successfully", 5 "render_id": 100000, 6 "status": "processing" 7}, 8"msg": "success" 9} 10

コア概念

すべてのJSONオブジェクトには、動画の合成幅、合成高さ、および解像度を指定する動画プロジェクトオブジェクトが含まれています。

プロジェクトオブジェクトには、動画のレンダリングに必要な基本的なパラメータ(幅、高さ、長さ、背景色など)が含まれています。

プロジェクトには1つ以上の要素も含まれ、各要素は動画、画像、テキスト、形状、音声、またはエフェクトなどの動画コンポーネントを表します。

各要素には、位置、サイズ、色、コンテンツなど、コンポーネントに特有のパラメータが含まれています。

project.json
1{ 2"compositeWidth": 1920, 3"compositeHeight": 1080, 4"fps": 30, 5"projectData": { 6 "type": "", 7 "width": 1920, 8 "height": 1080, 9 "fill": "#000000", 10 "view": [ 11 { 12 "id": "8ecf7475-2c6c-47f9-827b-a09c7913f4c0", 13 "type": "Image", 14 "start": 0, 15 "duration": 5, 16 "trackIndex": 0, 17 "x": -570.0335392757963, 18 "y": -170.90659033307685, 19 "blendMode": "normal", 20 "anchorX": 1302, 21 "anchorY": 2312, 22 "rotation": 0, 23 "scaleX": 0.23356401384083045, 24 "scaleY": 0.23356401384083045, 25 "alpha": 1, 26 "skewX": 0, 27 "skewY": 0, 28 "keyframes": [], 29 "externalUrl": "https://images.pexels.com/photos/30465303/pexels-photo-30465303.jpeg", 30 "ext": "jpeg" 31 } 32 ], 33 "audio": [], 34 "effect": [], 35 "transition": [], 36 "version": 0, 37 "duration": 5 38} 39}; 40

3D空間とカメラ

レンダリングエンジンは2Dおよび3D要素の両方をサポートしています。キャンバスはピクセル単位でwidthheightで定義されますが、エンジンは3Dレンダリングのためにパースペクティブカメラを使用します:

  • 座標系: xおよびy座標は2Dキャンバス平面上の位置を表します。z座標は3D空間における深さを制御します。
  • ピクセルパーフェクトプロジェクション: z=0のとき、1ワールドユニットは1ピクセルに等しく、2Dワークフローとの互換性を維持します。
  • 3D回転: 要素は、rotationXrotationY、およびrotation(Z軸)プロパティを使用してX、Y、Z軸の周りに回転できます。

この設計により、同じプロジェクト内で2Dおよび3D要素をシームレスに混在させることができます。従来の2D要素(z=0)は以前と同様にレンダリングされ、3D要素は三次元空間内で位置決めおよび回転が可能です。

3D要素の例

以下は、3Dキューブ要素のシンプルな例です:

3d-cube-example.json
1{ 2"id": "3d-cube-001", 3"type": "3D", 4"start": 0, 5"duration": 5, 6"trackIndex": 0, 7"x": 960, 8"y": 540, 9"z": 0, 10"width": 200, 11"height": 200, 12"anchorX": 100, 13"anchorY": 100, 14"rotation": 0, 15"rotationX": 30, 16"rotationY": 45, 17"scaleX": 1, 18"scaleY": 1, 19"scaleZ": 1, 20"alpha": 1, 21"ext": "geometry", 22"geometryType": "cube", 23"nodeCategory": "basic", 24"geometryColor": "#4A90E2" 25} 26

2D要素との主な違い:

  • type: "3D"はこれを3D要素として識別します
  • zrotationXrotationY、およびscaleZは3D変換を可能にします
  • geometryTypeは3D形状(キューブ、球、円柱など)を指定します
  • geometryColorは3Dジオメトリの基本色を設定します

3D要素の詳細については、3D要素のドキュメントを参照してください。

JSONスキーマ

リクエストJSONは、このドキュメントで定義されたJSONスキーマに厳密に従う必要があります。Chillin Video Editorで対応するリクエストJSONをテストおよび生成できます。