Shapes and graphics

Feather the edge of a shape

Feathers the edge instead of cutting it, which is how a soft spotlight or a vignette is made rather than a hard-edged block.

Shown on A card beside a cup of coffee

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": "shape",
    "shape": "rect",
    "color": "#059669",
    "softness": 0.3
  },
  "transform": {
    "size": {
      "width": "26%",
      "height": "30%"
    },
    "position": {
      "x": "80%",
      "y": "40%"
    }
  }
}

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/coffee.mp4"
              },
              start: 0
            }
          ]
        },
        {
          clips: [
            {
              asset: {
                type: "shape",
                shape: "rect",
                color: "#059669",
                softness: 0.3
              },
              transform: {
                size: {
                  width: "26%",
                  height: "30%"
                },
                position: {
                  x: "80%",
                  y: "40%"
                }
              },
              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/coffee.mp4"},"start":0}]},{"clips":[{"asset":{"type":"shape","shape":"rect","color":"#059669","softness":0.3},"transform":{"size":{"width":"26%","height":"30%"},"position":{"x":"80%","y":"40%"}},"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 shape softness clip do in compose?

Feathers the edge instead of cutting it, which is how a soft spotlight or a vignette is made rather than a hard-edged block.

How do I add shape softness to a video with an API?

Send a compose job to the Rendobar API with this entry in the timeline: {"asset":{"type":"shape","shape":"rect","color":"#059669","softness":0.3},"transform":{"size":{"width":"26%","height":"30%"},"position":{"x":"80%","y":"40%"}}}. 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

More features

Shape kinds The kinds a shape can be. A circle takes one side of its box so it stays round on any frame, and a triangle points down until you turn it. Shape gradient Two colours instead of one makes the fill a gradient, running the way `gradient` names. Shape outline Leave the fill out and only the stroke draws, so what it surrounds is genuinely transparent and the footage shows through. Shape radius Rounds a rect's corners, 0 square through to 1 fully round, which is a pill on a wide box. Shape shadow A shadow behind the shape, so a card or a bar lifts off the footage instead of sitting flat on it. SVG path SVG path data straight out of a design tool, drawn as a clip. The viewBox is the space the path was written in.

See all 117 features →