Layers

Blur part of a video

Blur one part of the picture and leave the rest sharp: a face, a number plate, a logo, a screen.

Shown on A laptop in a living room

Before · the same request without it
After · Hide one part of the picture and leave the rest sharp: here what is on a laptop screen.

The entry

Add it to a clip's effects list. Entries run in the order you write them.

{
"type": "blurRegion",
"shape": "rect",
"x": "54%",
"y": "43%",
"width": "16%",
"height": "22%",
"radius": 34
}

Settings

NameAcceptsDefaultWhat it does
xpixels, or a percent of the widthrequiredCentre of the region, measured from the left edge.
ypixels, or a percent of the heightrequiredCentre of the region, measured from the top edge.
widthpixels, or a percent of the widthrequiredWidth of the region.
heightpixels, or a percent of the heightrequiredHeight of the region.
shapeellipse, rectellipseellipse suits a face, rect a plate or a screen.
radius0 px or moreor keyframes40How far the blur spreads inside the region, in pixels. 40 makes a face unrecognisable at 1080p.

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: "image",
src: "https://cdn.rendobar.com/compose/showcase/media/laptop.jpg"
},
start: 0,
length: 5,
effects: [
{
type: "blurRegion",
shape: "rect",
x: "54%",
y: "43%",
width: "16%",
height: "22%",
radius: 34
}
]
}
]
}
]
}
},
});
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":"image","src":"https://cdn.rendobar.com/compose/showcase/media/laptop.jpg"},"start":0,"length":5,"effects":[{"type":"blurRegion","shape":"rect","x":"54%","y":"43%","width":"16%","height":"22%","radius":34}]}]}]}}}'

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

Questions

What does the blurRegion effect do in compose?

Blur one part of the picture and leave the rest sharp: a face, a number plate, a logo, a screen. Hide one part of the picture and leave the rest sharp: here what is on a laptop screen.

How do I add region blur to a video with an API?

Send a compose job to the Rendobar API with this entry in the timeline: {"type":"blurRegion","shape":"rect","x":"54%","y":"43%","width":"16%","height":"22%","radius":34}. Add it to a clip's effects list. Entries run in the order you write them. The request on this page is complete and renders as shown.

What are the default settings for region blur?

Set x, y, width, and height. The rest have defaults: shape ellipse and radius 40.

Footage and sound