Render elements are an essential part of the the render object that define the elements(video, image, audio, text et.c) involved in a render along with the various configurations to be applied to them.

Field	Required	Type	Description
type	required	string	One of video , audio , image , text , progress_bar, audio_wave .
params	optional	object	Provide necessary parameters for respective element type

{
  "type": "...",
  "params": { ... }
}

Video Element

Field	Required	Type	Description	Default
source	required	object	Either `url` or `asset_id`
trim	optional	object	`from` and `to` time values in seconds	no trimming `{ "from": 0, "to": video length }`
duration	optional	object	`from` and `to` time values in seconds	`{ "from": 0, "to": video length }`
crop	optional	object	`x`, `y`, `width` and `height` coordinate values	no cropping `{ "x": 0, "y": 0, "width": video width, "height": video height }`
dimensions	optional	object	`width` and 'height' pixel values	`{ "width": video width, "height": video height }`
position	optional	object	`origin`, `x`and `y` coordinates	`{ "origin": "top left", "x": 0, "y": 0 }`
z_index	optional	number (positive integer)	Element layer order in the render	index in elements array
rotation	optional	number (float)	Video rotation in degrees	`0.0`
volume	optional	number (float)	If video has audio, sets volume value inside render	`1.0`
playback_rate	optional	number (float)	Used to speed up or slow down video	`1.0`
loop	optional	boolean	Loops video after playback finishes (ignores duration.to value)	`false`
filters	optional	object	`brightness`, `contrast`, `saturation` and `exposure` float values	`{ "brightness": 1.0, "contrat": 1.0, "saturation": 1.0, "exposure": 0.0 }`
effects	optional	string	One of `vhs`, `glitch`, `old`	`""`

{
  "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": ""
  }
}

Audio Element

Field	Required	Type	Description	Default
source	required	object	Either `url` or `asset_id`
trim	optional	object	`from` and `to` time values in seconds	no trimming `{ "from": 0, "to": audio length }`
duration	optional	object	`from` and `to` time values in seconds	`{ "from": 0, "to": audi length }`
volume	optional	number (float)	Sets volume value inside render	`1.0`
playback_rate	optional	number (float)	Used to speed up or slow down audi	`1.0`
loop	optional	boolean	Loops audi after playback finishes (ignores duration.to value)	`false`

{
  "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
  }
}

Image Element

Field	Required	Type	Description	Default
source	required	object	Either `url` or `asset_id`
duration	optional	object	`from` and `to` time values in seconds	`{ "from": 0, "to": video length }`
crop	optional	object	`x`, `y`, `width` and `height` coordinate values	no cropping `{ "x": 0, "y": 0, "width": element width, "height": element height }`
dimensions	optional	object	`width` and 'height' pixel values	`{ "width": element width, "height": element height }`
position	optional	object	`origin`, `x`and `y` coordinates	`{ "origin": "top left", "x": 0, "y": 0 }`
z_index	optional	number (positive integer)	Element layer order in the render	index in elements array
rotation	optional	number (float)	Element rotation in degrees	`0.0`

{
  "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
  }
}

Text Element

Field	Required	Type	Description	Default
value	required	string	Text to display
style	optional	object	`font`, `size`, `display`, `color`, `secondary_color`, `align`, `emphasis`, `wrap`, `wrap_width`, `line_height` and `letter_spacing`	`{ "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	optional	object	`from` and `to` time values in seconds	`{ "from": 0, "to": render length }`
position	optional	object	`origin`, `x`and `y` coordinates	`{ "origin": "top left", "x": 0, "y": 0 }`
z_index	optional	number (positive integer)	Element layer order in the render	index in elements array
rotation	optional	number (float)	Element rotation in degrees	`0.0`

{
  "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
  }
}

Progress Bar Element

Field	Required	Type	Description	Default
style	optional	object	`color`, `secondary_color` and `type`	`{ "color": "#000000", "secondary_color": "#ffffff", "type": "normal" }`
duration	optional	object	`from` and `to` time values in seconds	`{ "from": 0, "to": render length }`
dimensions	optional	object	`width` and 'height' pixel values	`{ "width": "100%", "height": "10%" }`
position	optional	object	`origin`, `x`and `y` coordinates	`{ "origin": "top center", "x": "50%", "y": 0 }`
z_index	optional	number (positive integer)	Element layer order in the render	index in elements array
rotation	optional	number (float)	Element rotation in degrees	`0.0`

{
  "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
  }
}

Audio Wave Element

Field	Required	Type	Description	Default
style	optional	object	`color`, `secondary_color` and `type`	`{ "color": "#000000", "secondary_color": "#ffffff", "type": "simi" }`
ftt	optional	object	`min_db` and `max_db`	`{ "min_db": -10, "max_db": -120 }`
duration	optional	object	`from` and `to` time values in seconds	`{ "from": 0, "to": render length }`
dimensions	optional	object	`width` and 'height' pixel values	`{ "width": "80%", "height": "10%" }`
position	optional	object	`origin`, `x`and `y` coordinates	`{ "origin": "bottom center", "x": "50%", "y": 95% }`
z_index	optional	number (positive integer)	Element layer order in the render	index in elements array
rotation	optional	number (float)	Element rotation in degrees	`0.0`

{
  "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
  }
}