field | required | type | description |
params | optional | ​RenderParams​ | Render parmeters such as |
elements | required | Elements contained in the render such as |
Example Render Object{"params": {"dimensions": {"width": 1920,"height": 1080,},"background_color": "#00000","duration": 20000},"elements": [{"type": "video","params": {"source": {"url": "https://cdn.veed.dev/380rreVE_9uhiksitOGIW.mp4"},"duration": {"from": 0.0,"to": 10.0},"position": {"origin": "top left","x": 0,"y": 0}}},{"type": "image","params": {"source": {"asset_id": "28a510a8-6690-4cdc-b319-e0e02ebf1a2e"},"duration": {"from": 0.0,"to": 10.0},"position": {"origin": "top left","x": 0,"y": 0}}}]}
​
field | required | type | description |
dimensions | optional | object | width and height of resulting render |
background_color | optional | string | hex color value for the background color |
duration | optional | string | duration of render in miliseconds |
RenderParams{"dimensions": {"width": 1920,"height": 1080,},"background_color": "#00000","duration": 20000}
field | required | type | description |
type | required | string | One of |
params | required | object | Provide necessary parameters for each element type |
RenderElement{"type": "...","params": { ... }}
​
field | required | type | description |
source | required | object | Either |
trim | optional | object |
|
duration | optional | object |
|
crop | optional | object |
|
dimensions | optional | object |
|
position | optional | object |
|
z_index | optional | integer | Overrides the element order |
rotation | optional | float | Video rotation in degrees |
volume | optional | float | If video has audio, sets volume value inside render |
playback_rate | optional | float | Used to speed up or slow down video |
loop | optional | boolean | Loops video after playback finishes |
filters | optional | object |
|
effects | optional | enum | One of |
Video Element{"type": "video","params": {"source": {"asset_id": "28a510a8-6690-4cdc-b319-e0e02ebf1a2e"},"trim": {"from": 0.0,"to": 10.0},"duration": {"from": 0.0,"to": 10.0},"crop": {"x": 0,"y": 0,"width": 1920,"height": 1080},"dimensions": {"width": 1920,"height": 1080},"position": {"origin": "top left","x": 0,"y": 0},"z_index": 0,"rotation": 0.0,"volume": 1.0,"playback_rate": 1.0,"loop": false,"filters": {"brightness": 1.0,"contrat": 1.0,"saturation": 1.0,"exposure": 0.0},"effect": "vhs",}}
field | required | type | description |
source | required | object | Either |
trim | optional | object |
|
duration | optional | object |
|
volume | optional | float | If video has audio, sets volume value inside render |
playback_rate | optional | float | Used to speed up or slow down video |
loop | optional | boolean | Loops audio after playback finishes |
Audio Element{"type": "audio","params": {"source": {"asset_id": "dfa8b101-2587-45b6-ac83-fd6d9ce24dfa"},"trim": {"from": 0.0,"to": 10.0},"duration": {"from": 0.0,"to": 10.0},"volume": 1.0,"playback_rate": 1.0,"loop": false}}
field | required | type | description |
source | required | object | Either |
duration | optional | object |
|
crop | optional | object |
|
dimensions | optional | object | 'width' and 'height' pixel values |
position | optional | object |
|
z_index | optional | integer | Overrides the element order |
rotation | optional | float | Image rotation in degrees |
Image Element{"type": "image","params": {"source": {"asset_id": "28a510a8-6690-4cdc-b319-e0e02ebf1a2e"},"duration": {"from": 0.0,"to": 10.0},"crop": {"x": 0,"y": 0,"width": 1920,"height": 1080},"dimensions": {"width": 1920,"height": 1080},"position": {"origin": "top left","x": 0,"y": 0},"z_index": 0,"rotation": 0.0}}
field | required | type | description |
value | required | string | Text to display |
style | optional | object |
|
duration | optional | object |
|
position | optional | object |
|
z_index | optional | integer | Overrides the element order |
rotation | optional | float | Video rotation in degrees |
Text Element{"type": "text","params": {"value": "New Text","style": {"font": "Helvetica","size": 48.0,"display": "normal","color": "#000000","secondary_color": "#ffffff","align": "left","wrap": "wrap","wrap_width": 0.5,"line_height": 0.0,"letter_spacing": 0.0},"duration": {"from": 0.0,"to": 10.0},"position": {"origin": "top left","x": 0,"y": 0},"z_index": 0,"rotation": 0.0}}
field | required | type | description |
style | optional | object |
|
duration | optional | object |
|
dimensions | optional | object | 'width' and 'height' pixel values |
position | optional | object |
|
z_index | optional | integer | Overrides the element order |
rotation | optional | float | Video rotation in degrees |
Progress Bar Element{"type": "progress_bar","params": {"style": {"color": "#000000","secondary_color": "#ffffff","type": "normal"},"duration": {"from": 0.0,"to": 10.0},"dimensions": {"width": 1920,"height": 200},"position": {"origin": "top left","x": 0,"y": 0},"z_index": 0,"rotation": 0.0}}
field | required | type | description |
style | optional | object |
|
fft | optional | object |
|
duration | optional | object |
|
dimensions | optional | object | 'width' and 'height' pixel values |
position | optional | object |
|
z_index | optional | integer | Overrides the element order |
rotation | optional | float | Video rotation in degrees |
Audio Wave Element{"type": "audio_wave","params": {"style": {"color": "#000000","secondary_color": "#ffffff","type": "simi"},"fft": {"min_db": -10,"max_db": -120,}"duration": {"from": 0.0,"to": 10.0},"dimensions": {"width": 1920,"height": 200},"position": {"origin": "top left","x": 0,"y": 0},"z_index": 0,"rotation": 0.0}}
​