Picture effects

Every other video filter by name

Any other filter the engine has, by name. Here the cartoon filter at its own settings.

Shown on A woman on forest steps

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

The entry

Add it to a clip's effects list, with the filter's own name and parameters.

{
"type": "engine",
"filter": "cartoon"
}

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/steps.mp4"
},
start: 0,
effects: [
{
type: "engine",
filter: "cartoon"
}
]
}
]
}
]
}
},
});
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/steps.mp4"},"start":0,"effects":[{"type":"engine","filter":"cartoon"}]}]}]}}}'

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

Questions

What does the engine filters effect do in compose?

Any other filter the engine has, by name. Here the cartoon filter at its own settings.

How do I add engine filters to a video with an API?

Send a compose job to the Rendobar API with this entry in the timeline: {"type":"engine","filter":"cartoon"}. Add it to a clip's effects list, with the filter's own name and parameters. The request on this page is complete and renders as shown.

Footage and sound