Introdução

A API Chillin Render permite que você especifique o conteúdo de vídeo e os parâmetros a serem renderizados definindo uma estrutura JSON como a abaixo.

  • Acesse Render Console para obter créditos da API Render e gerar sua chave da API Render.

  • Envie uma solicitação POST para o endpoint da API Render com sua chave da API:

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

A API opera em modo assíncrono e retorna uma resposta como esta:

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

Conceitos Básicos

Todos os objetos JSON incluem um objeto de projeto de vídeo, especificando a largura composta do vídeo, a altura composta e a resolução.

O objeto do projeto contém os parâmetros básicos para renderizar o vídeo, como largura, altura, duração, cor de fundo e mais.

O projeto também inclui um ou mais elementos, onde cada elemento representa um componente de vídeo, como um vídeo, imagem, texto, forma, áudio ou efeito.

Cada elemento contém parâmetros específicos para o componente, como posição, tamanho, cor, conteúdo, e assim por diante.

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

Espaço 3D & Câmera

O mecanismo de renderização suporta tanto elementos 2D quanto 3D. Enquanto a tela é definida com largura e altura em pixels, o motor usa uma câmera de perspectiva para a renderização 3D:

  • Sistema de Coordenadas: As coordenadas x e y representam posições no plano da tela 2D. A coordenada z controla a profundidade no espaço 3D.
  • Projeção Perfeita em Pixels: Em z=0, uma unidade de mundo equivale a um pixel, mantendo a compatibilidade com fluxos de trabalho 2D.
  • Rotações 3D: Os elementos podem ser rotacionados em torno dos eixos X, Y e Z usando as propriedades rotationX, rotationY e rotation (eixo Z).

Esse design permite a mistura contínua de elementos 2D e 3D no mesmo projeto. Elementos 2D tradicionais (com z=0) renderizam exatamente como antes, enquanto elementos 3D podem ser posicionados e rotacionados no espaço tridimensional.

Exemplo de Elemento 3D

Aqui está um exemplo simples de um elemento cubo 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

Diferenças principais em relação aos elementos 2D:

  • type: "3D" identifica isso como um elemento 3D
  • z, rotationX, rotationY e scaleZ permitem transformações 3D
  • geometryType especifica a forma 3D (cubo, esfera, cilindro, etc.)
  • geometryColor define a cor base da geometria 3D

Para mais detalhes sobre elementos 3D, consulte a documentação Elemento 3D.

Esquema JSON

Seu JSON de solicitação deve aderir estritamente ao esquema JSON definido neste documento. Você pode testar e gerar o JSON de solicitação correspondente no Editor de Vídeo Chillin.