Timeline

Group clips into one clip

A whole timeline used as one clip, so a group of layers moves, scales and fades together instead of one at a time.

Shown on A titled card scaled down as one clip

Before · the same request without it
After · rendered from the request below

The entry

Use it as a clip's asset, on a track above the footage.

{
"asset": {
"type": "composition",
"timeline": {
"tracks": []
}
}
}

Every setting and default is in the docs

Run it

The whole request behind the render above. Paste it as it is, or swap the file for your own.

job.ts
import { createClient, outputUrl } from "@rendobar/sdk";
const rb = createClient({ apiKey: process.env.RENDOBAR_API_KEY });
const job = await rb.jobs.run({
type: "compose",
params: {
schemaVersion: 1,
output: {
format: "mp4",
resolution: {
width: 960,
height: 540
}
},
timeline: {
tracks: [
{
clips: [
{
asset: {
type: "video",
src: "https://cdn.rendobar.com/compose/showcase/media/city.mp4"
},
start: 0
}
]
},
{
clips: [
{
asset: {
type: "composition",
timeline: {
tracks: [
{
clips: [
{
asset: {
type: "video",
src: "https://cdn.rendobar.com/compose/showcase/media/coast-b.mp4"
},
start: 0,
length: 6
}
]
},
{
clips: [
{
asset: {
type: "text",
text: "OPEN WATER",
style: {
font: "Bebas Neue",
size: 84,
color: "#FFFFFF",
shadow: {}
}
},
start: 0,
length: 6
}
]
}
]
}
},
transform: {
scale: 0.52,
rotate: -5
},
start: 0,
length: 6
}
]
}
]
}
},
});
console.log(outputUrl(job));

Install with npm i @rendobar/sdk. jobs.run() submits and waits, so it returns the finished job in one call.

terminal
curl https://api.rendobar.com/jobs \
-H "Authorization: Bearer $RENDOBAR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"type":"compose","params":{"schemaVersion":1,"output":{"format":"mp4","resolution":{"width":960,"height":540}},"timeline":{"tracks":[{"clips":[{"asset":{"type":"video","src":"https://cdn.rendobar.com/compose/showcase/media/city.mp4"},"start":0}]},{"clips":[{"asset":{"type":"composition","timeline":{"tracks":[{"clips":[{"asset":{"type":"video","src":"https://cdn.rendobar.com/compose/showcase/media/coast-b.mp4"},"start":0,"length":6}]},{"clips":[{"asset":{"type":"text","text":"OPEN WATER","style":{"font":"Bebas Neue","size":84,"color":"#FFFFFF","shadow":{}}},"start":0,"length":6}]}]}},"transform":{"scale":0.52,"rotate":-5},"start":0,"length":6}]}]}}}'

Returns immediately with a job id. Poll GET /jobs/{id} or register a webhook rather than blocking on the request.

Questions

What does the composition clip do in compose?

A whole timeline used as one clip, so a group of layers moves, scales and fades together instead of one at a time.

How do I add composition to a video with an API?

Send a compose job to the Rendobar API with this entry in the timeline: {"asset":{"type":"composition","timeline":{"tracks":[]}}}. Use it as a clip's asset, on a track above the footage. The request on this page is complete and renders as shown.

Footage and sound