Timeline

Set the timeline background colour

The colour behind every clip, wherever nothing else is drawn. Here a wide shot in a tall box leaves bars, and the background decides what colour they are.

Shown on A boxed clip over the timeline background

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

The entry

Put it on the clip itself, beside its asset.

{
"background": "#059669"
}

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/ride.mp4"
},
start: 0,
transform: {
size: {
width: "46%",
height: "100%"
}
}
}
]
}
],
background: "#059669"
}
},
});
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/ride.mp4"},"start":0,"transform":{"size":{"width":"46%","height":"100%"}}}]}],"background":"#059669"}}}'

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

Questions

What does the background effect do in compose?

The colour behind every clip, wherever nothing else is drawn. Here a wide shot in a tall box leaves bars, and the background decides what colour they are.

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

Send a compose job to the Rendobar API with this entry in the timeline: {"background":"#059669"}. Put it on the clip itself, beside its asset. The request on this page is complete and renders as shown.

Footage and sound