Render object

VEED
Search…
Introduction to VEED API
Getting Started
API Reference
Objects
A render object is a set of instructions that describes which edits should be applied to your file.
Render
field
required
type
description
params
optional
​RenderParams​
Render parmeters such as dimensions ,background_color etc.
elements
required
[RenderElement]
Elements contained in the render such as video, image , audio etc.
Example Render Object
1
  {
2
    "params": {
3
      "dimensions": {
4
        "width": 1920,
5
        "height": 1080,
6
      },
7
      "background_color": "#00000",
8
      "duration": 20000
9
    },
10
    "elements": [
11
      {
12
        "type": "video",
13
        "params": {
14
          "source": {
15
            "url": "https://cdn.veed.dev/380rreVE_9uhiksitOGIW.mp4" 
16
          },
17
          "duration": {
18
            "from": 0.0,
19
            "to": 10.0
20
          },
21
          "position": {
22
            "origin": "top left",
23
            "x": 0,
24
            "y": 0
25
          }
26
        }
27
      },
28
      {
29
        "type": "image",
30
        "params": {
31
          "source": {
32
            "asset_id": "28a510a8-6690-4cdc-b319-e0e02ebf1a2e" 
33
          },
34
          "duration": {
35
            "from": 0.0,
36
            "to": 10.0
37
          },
38
          "position": {
39
            "origin": "top left",
40
            "x": 0,
41
            "y": 0
42
          }
43
        }
44
      }
45
    ]
46
  }
Copied!
​
RenderParams
field
required
type
description
dimensions
optional
object
width and height of resulting render
background_color
optional
string
hex color value for the background color default: #000000
duration
optional
string
duration of render in milisecondsdefaults to end of last element to be displayed
RenderParams
1
  {
2
    "dimensions": {
3
      "width": 1920,
4
      "height": 1080,
5
    },
6
    "background_color": "#00000",
7
    "duration": 20000
8
  }
Copied!
​
RenderElement
field
required
type
description
type
required
string
One of video ,audio ,image ,progress_bar ,audio_wave​
params
required
object
Provide necessary parameters for each element type
RenderElement
1
  {
2
    "type": "...",
3
    "params": { ... }
4
  }
Copied!
​
Element types
Video
field
required
type
description
source
required
object
Either url or asset_id
trim
optional
object
from and to time values defaults to no trim
duration
optional
object
from and to time values defaults to { from: 0, to: video length }
crop
optional
object
x, y, width and height coordinate values defaults to no crop
dimensions
optional
object
width and 'height' pixel values defaults to source video width & height
position
optional
object
origin,xand y coordinates defaults to { origin: "top left", x: 0, y: 0 }
z_index
optional
integer
Overrides the element order defaults to index in elements array
rotation
optional
float
Video rotation in degrees min 0 max 360, defaults to 0
volume
optional
float
If video has audio, sets volume value inside rendermin 0 max 1, defaults to 1
playback_rate
optional
float
Used to speed up or slow down video default to 1
loop
optional
boolean
Loops video after playback finishesdefaults to false
filters
optional
object
brightness, contrast, saturation and exposure float values
effects
optional
enum
One of vhs, glitch, old
Video Element
1
{
2
    "type": "video",
3
    "params": {
4
      "source": {
5
        "asset_id": "28a510a8-6690-4cdc-b319-e0e02ebf1a2e" 
6
      },
7
      "trim": {
8
        "from": 0.0,
9
        "to": 10.0
10
      },
11
      "duration": {
12
        "from": 0.0,
13
        "to": 10.0
14
      },
15
      "crop": {
16
        "x": 0,
17
        "y": 0,
18
        "width": 1920,
19
        "height": 1080
20
      },
21
      "dimensions": {
22
        "width": 1920,
23
        "height": 1080
24
      },
25
      "position": {
26
        "origin": "top left",
27
        "x": 0,
28
        "y": 0
29
      },
30
      "z_index": 0,
31
      "rotation": 0.0,
32
      "volume": 1.0,
33
      "playback_rate": 1.0,
34
      "loop": false,
35
      "filters": {
36
        "brightness": 1.0,
37
        "contrat": 1.0,
38
        "saturation": 1.0,
39
        "exposure": 0.0
40
      },
41
      "effect": "vhs",
42
    }
43
  }
Copied!
​
Audio
field
required
type
description
source
required
object
Either url or asset_id
trim
optional
object
from and to time values defaults to no trim
duration
optional
object
from and to time values defaults to { from: 0, to: audio length }
volume
optional
float
If video has audio, sets volume value inside rendermin 0 max 1, defaults to 1
playback_rate
optional
float
Used to speed up or slow down video default to 1
loop
optional
boolean
Loops audio after playback finishes defaults to false
Audio Element
1
  {
2
    "type": "audio",
3
    "params": {
4
      "source": {
5
        "asset_id": "dfa8b101-2587-45b6-ac83-fd6d9ce24dfa" 
6
      },
7
      "trim": {
8
        "from": 0.0,
9
        "to": 10.0
10
      },
11
      "duration": {
12
        "from": 0.0,
13
        "to": 10.0
14
      },
15
      "volume": 1.0,
16
      "playback_rate": 1.0,
17
      "loop": false
18
    }
19
  }
Copied!
​
Image
field
required
type
description
source
required
object
Either url or asset_id
duration
optional
object
from and to time values defaults to { from: 0, to: render length }
crop
optional
object
x, y, width and height coordinate values defaults to no crop
dimensions
optional
object
'width' and 'height' pixel values defaults to source image width & height
position
optional
object
origin,xand y coordinates defaults to { origin: "top left", x: 0, y: 0 }
z_index
optional
integer
Overrides the element order defaults to index in elements array
rotation
optional
float
Image rotation in degrees min 0 max 360, defaults to 0
Image Element
1
  {
2
    "type": "image",
3
    "params": {
4
      "source": {
5
        "asset_id": "28a510a8-6690-4cdc-b319-e0e02ebf1a2e" 
6
      },
7
      "duration": {
8
        "from": 0.0,
9
        "to": 10.0
10
      },
11
      "crop": {
12
        "x": 0,
13
        "y": 0,
14
        "width": 1920,
15
        "height": 1080
16
      },
17
      "dimensions": {
18
        "width": 1920,
19
        "height": 1080
20
      },
21
      "position": {
22
        "origin": "top left",
23
        "x": 0,
24
        "y": 0
25
      },
26
      "z_index": 0,
27
      "rotation": 0.0
28
    }
29
  }
Copied!
​
Text
field
required
type
description
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
duration
optional
object
from and to time values defaults to { from: 0, to: video length }
position
optional
object
origin,xand y coordinates defaults to { origin: "top left", x: 0, y: 0 }
z_index
optional
integer
Overrides the element order defaults to index in elements array
rotation
optional
float
Video rotation in degrees min 0 max 360, defaults to 0
Text Element
1
  {
2
    "type": "text",
3
    "params": {
4
      "value": "New Text",
5
      "style": {
6
        "font": "Helvetica",
7
        "size": 48.0,
8
        "display": "normal",
9
        "color": "#000000",
10
        "secondary_color": "#ffffff",
11
        "align": "left",
12
        "wrap": "wrap",
13
        "wrap_width": 0.5,
14
        "line_height": 0.0,
15
        "letter_spacing": 0.0
16
      },
17
      "duration": {
18
        "from": 0.0,
19
        "to": 10.0
20
      },
21
      "position": {
22
        "origin": "top left",
23
        "x": 0,
24
        "y": 0
25
      },
26
      "z_index": 0,
27
      "rotation": 0.0
28
    }
29
  }
Copied!
​
Progress Bar
field
required
type
description
style
optional
object
color, secondary_color and type
duration
optional
object
from and to time values defaults to { from: 0, to: video length }
dimensions
optional
object
'width' and 'height' pixel values defaults to source video width & height
position
optional
object
origin,xand y coordinates defaults to { origin: "top left", x: 0, y: 0 }
z_index
optional
integer
Overrides the element order defaults to index in elements array
rotation
optional
float
Video rotation in degrees min 0 max 360, defaults to 0
Progress Bar Element
1
  {
2
    "type": "progress_bar",
3
    "params": {
4
      "style": {
5
        "color": "#000000",
6
        "secondary_color": "#ffffff",
7
        "type": "normal"
8
      },
9
      "duration": {
10
        "from": 0.0,
11
        "to": 10.0
12
      },
13
      "dimensions": {
14
        "width": 1920,
15
        "height": 200
16
      },
17
      "position": {
18
        "origin": "top left",
19
        "x": 0,
20
        "y": 0
21
      },
22
      "z_index": 0,
23
      "rotation": 0.0
24
    }
25
  }
Copied!
​
Audio Wave
field
required
type
description
style
optional
object
color, secondary_color and type
fft
optional
object
min_db and max_db
duration
optional
object
from and to time values defaults to { from: 0, to: video length }
dimensions
optional
object
'width' and 'height' pixel values defaults to source video width & height
position
optional
object
origin,xand y coordinates defaults to { origin: "top left", x: 0, y: 0 }
z_index
optional
integer
Overrides the element order defaults to index in elements array
rotation
optional
float
Video rotation in degrees min 0 max 360, defaults to 0
Audio Wave Element
1
  {
2
    "type": "audio_wave",
3
    "params": {
4
      "style": {
5
        "color": "#000000",
6
        "secondary_color": "#ffffff",
7
        "type": "simi"
8
      },
9
      "fft": {
10
        "min_db": -10,
11
        "max_db": -120,
12
      }
13
      "duration": {
14
        "from": 0.0,
15
        "to": 10.0
16
      },
17
      "dimensions": {
18
        "width": 1920,
19
        "height": 200
20
      },
21
      "position": {
22
        "origin": "top left",
23
        "x": 0,
24
        "y": 0
25
      },
26
      "z_index": 0,
27
      "rotation": 0.0
28
    }
29
  }
Copied!
​