> ## Documentation Index
> Fetch the complete documentation index at: https://rendobar.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Keep the API key in an env var (RENDOBAR_API_KEY), never in chat or committed code.
> Job types change, so fetch the live catalog from GET https://api.rendobar.com/jobs/types rather than relying on memory.
> The full integration prompt for coding agents is at https://rendobar.com/prompts/integrate.md.

# Effect reference

> Read every compose effect and each one of its parameters, grouped by colour, stylise, layers and sound.

Every entry of an `effects` list. An effect goes on a clip, on a track, or on the timeline itself, and the list runs in the order you write it. Any entry takes `start` and `length` to run for part of its clip, and a parameter marked animatable takes [keyframes](/docs/docs/jobs/compose/motion).

## Color

### `color`

Grade the picture by hand. Every parameter is optional, and one left out leaves that quality unchanged.

| Parameter | Type | What it does |
| - | - | - |
| `brightness` | number | -1 to 1, 0 = unchanged. Small moves (0.05 to 0.15) read as exposure lifts. min -1, max 1, animatable. |
| `contrast` | number | 0 to 4, 1 = unchanged. 1.1 to 1.4 adds punch, above 2 crushes. min 0, max 4, animatable. |
| `saturation` | number | 0 to 3, 1 = unchanged. 0 is black and white, 1.2 to 1.4 is a vivid social look. min 0, max 3, animatable. |
| `gamma` | number | 0.1 to 10, 1 = unchanged. Above 1 lifts midtones and shadows. min 0.1, max 10, animatable. |
| `hue` | number | Hue rotation in degrees, 0 = unchanged. min -180, max 180, in deg. |
| `temperature` | number | Colour temperature in kelvin, about 6500 is neutral. Lower is warm and orange, higher is cool and blue. min 1000, max 40000, in K. |

### `look`

A one-word look: greyscale, boost (vivid social pop), muted (desaturated, cinematic), lighten and darken (exposure), contrast, negative, sepia (brown archive tone), oldFilm (sepia with grain, dust, scratches, projector flicker and a vignette).

| Parameter | Type | What it does |
| - | - | - |
| `name` | `"greyscale"` \| `"negative"` \| `"boost"` \| `"muted"` \| `"lighten"` \| `"darken"` \| `"contrast"` \| `"sepia"` \| `"oldFilm"` | Which look. |

### `blur`

Soften the picture. 5 to 15 makes a backdrop that keeps text over it readable.

| Parameter | Type | What it does |
| - | - | - |
| `radius` | number | How far the blur spreads, in pixels. 0 is no blur. min 0, in px, animatable. |

### `sharpen`

Crisp up soft footage.

| Parameter | Type | What it does |
| - | - | - |
| `amount` | number | 0 to 1. 0.2 to 0.6 is subtle, 1 is as sharp as it goes. default `0.4`, min 0, max 1, animatable. |

### `denoise`

Clean the grain a small sensor adds in low light. Works across neighbouring frames as well as inside each one.

| Parameter | Type | What it does |
| - | - | - |
| `amount` | number | 0 to 1. 0.3 to 0.6 cleans a dark phone clip, higher starts to smear fine detail. default `0.55`, min 0, max 1, animatable. |

### `glow`

Make the bright parts of the picture bloom. Best on lights against a dark frame: a city at night, a stage, a candle.

| Parameter | Type | What it does |
| - | - | - |
| `amount` | number | 0 to 1, how far the bloom spreads. default `0.45`, min 0, max 1, animatable. |

### `grain`

A layer of film grain, so digital footage feels less clinical.

| Parameter | Type | What it does |
| - | - | - |
| `amount` | number | 0 to 1. 0.2 to 0.35 is a light film stock, above 0.6 is heavy and deliberate. default `0.28`, min 0, max 1, animatable. |

### `lut`

Grade the picture with a 3D LUT, the .cube file a colourist or a grading app exports.

| Parameter | Type | What it does |
| - | - | - |
| `src` | file | URL of the LUT: a 3D .cube file, the kind DaVinci Resolve, Premiere and most LUT packs export. |

### `vignette`

Darken the corners to pull the eye to the middle of the frame.

| Parameter | Type | What it does |
| - | - | - |
| `amount` | number | 0 to 1, how dark the corners get. 1 is black. default `0.6`, min 0, max 1, animatable. |
| `radius` | number | 0 to 1, how much of the frame stays clear. Smaller closes in on the centre. default `0.5`, min 0, max 1, animatable. |

## Layers

### `chromaKey`

Remove a solid background colour (green screen). Put the keyed clip on an UPPER track, and the removed area shows the track below.

| Parameter | Type | What it does |
| - | - | - |
| `color` | color | The background colour to remove, hex like "#00FF00" for green screen. |
| `similarity` | number | How close a pixel must be to the key colour to become transparent. Raise toward 0.3 to 0.4 for uneven lighting. default `0.2`, min 0, max 1. |

### `blurRegion`

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

| Parameter | Type | What it does |
| - | - | - |
| `x` | length | Centre of the region, measured from the left edge. |
| `y` | length | Centre of the region, measured from the top edge. |
| `width` | length | Width of the region. |
| `height` | length | Height of the region. |
| `shape` | `"ellipse"` \| `"rect"` | ellipse suits a face, rect a plate or a screen. default `"ellipse"`. |
| `radius` | number | How far the blur spreads inside the region, in pixels. 40 makes a face unrecognisable at 1080p. default `40`, min 0, in px, animatable. |

### `mask`

Show the clip only where an image says: white or opaque keeps it, black or clear cuts it away, grey fades it. A picture seen through a logo, or any shape you can draw.

| Parameter | Type | What it does |
| - | - | - |
| `src` | file | URL of the mask image, png or jpg. It is stretched over the clip's picture, so draw it at the same shape. |
| `channel` | `"luma"` \| `"alpha"` | What of the image decides: luma reads its brightness, for a black and white matte; alpha reads its transparency, for a png cut-out like a logo. default `"luma"`. |

### `outline`

A stroke round the edge of a layer that has transparency: a keyed subject, a picture in picture, a logo. With dropShadow it is the sticker look. Does nothing on a clip that fills the frame. Text and shapes have their own stroke.

| Parameter | Type | What it does |
| - | - | - |
| `color` | color | Stroke colour, hex like "#FFFFFF". default `"#FFFFFF"`. |
| `width` | number | Stroke width in pixels. The engine draws up to 20. default `8`, min 0, max 20, in px, animatable. |

### `dropShadow`

A soft shadow under a layer that has transparency, so a logo, a cut-out or a picture in picture lifts off what is behind it. Does nothing on a clip that fills the frame.

| Parameter | Type | What it does |
| - | - | - |
| `color` | color | Shadow colour, hex. default `"#000000"`. |
| `opacity` | number | 0 to 1, how dark the shadow is. default `0.6`, min 0, max 1. |
| `blur` | number | How soft the shadow's edge is, in pixels. default `16`, min 0, max 100, in px, animatable. |
| `offsetX` | number | How far right the shadow falls, in pixels. Negative is left. default `0`, min -100, max 100, in px, animatable. |
| `offsetY` | number | How far down the shadow falls, in pixels. Negative is up. default `8`, min -100, max 100, in px, animatable. |

## Sound

### `visualizer`

Draw the sound over the picture: the audiogram look. In the TIMELINE's effects it draws the final mix, which is the usual place. On a track or a clip it draws that track's or that clip's own sound.

| Parameter | Type | What it does |
| - | - | - |
| `kind` | `"waveform"` \| `"spectrum"` | waveform is a moving line, spectrum is frequency bars that jump with the sound. default `"waveform"`. |
| `color` | color | Colour of the drawing, hex. default `"#FFFFFF"`. |
| `x` | length | Centre of the drawing, measured from the left edge. default `"50%"`. |
| `y` | length | Centre of the drawing, measured from the top edge. The default sits it in the lower third. default `"77%"`. |
| `width` | length | Width of the drawing. default `"88%"`. |
| `height` | length | Height of the drawing. default `"38%"`. |

### `eq`

Three-band tone control. More bass and treble on a music bed, or less boom on a voice.

| Parameter | Type | What it does |
| - | - | - |
| `bass` | number | Low end, a shelf from about 150 Hz down, in decibels. 0 is unchanged, 3 to 6 warms a music bed, negative thins a boomy voice. min -70, max 6, in dB. |
| `mid` | number | Middle, two octaves around 1 kHz, in decibels. 0 is unchanged. A few decibels down softens a harsh voice. min -70, max 6, in dB. |
| `treble` | number | Top end, a shelf from about 6 kHz up, in decibels. 0 is unchanged, 3 to 5 adds sparkle and presence. min -70, max 6, in dB. |

### `compressor`

Even out a voice, so quiet words and loud words sit at one level. The defaults suit speech.

| Parameter | Type | What it does |
| - | - | - |
| `threshold` | number | The level above which it starts to turn the sound down, in decibels. default `-22`, min -30, max 0, in dB. |
| `ratio` | number | How hard it turns down what is over the threshold. 2 to 4 is natural on speech, above 10 is a limiter. default `4`, min 1, max 20. |
| `makeup` | number | Gain added back afterwards, in decibels, so the evened-out sound is as loud as before. default `9`, min 0, max 24, in dB. |

### `limiter`

Stop peaks from clipping. Add gain to make a track louder with no distortion, or leave gain at 0 as a safety net on the final mix.

| Parameter | Type | What it does |
| - | - | - |
| `gain` | number | Gain going in, in decibels. 6 to 9 makes music clearly louder. default `0`, min -20, max 20, in dB. |
| `ceiling` | number | The level nothing is allowed over, in decibels. default `-1`, min -20, max 0, in dB. |

### `gate`

Close the microphone between phrases, so room noise drops away in the pauses.

| Parameter | Type | What it does |
| - | - | - |
| `threshold` | number | Sound quieter than this is turned down, in decibels. Set it just above the noise. default `-30`, min -70, max 20, in dB. |

### `highPass`

Cut everything below a frequency. Wind, traffic and handling noise live under the voice.

| Parameter | Type | What it does |
| - | - | - |
| `cutoff` | number | Frequencies below this are removed, in hertz. 80 to 120 cleans speech, 200 and up is drastic. default `100`, min 5, max 21600, in Hz. |

### `lowPass`

Cut everything above a frequency. Music from the next room, or a voice on the phone.

| Parameter | Type | What it does |
| - | - | - |
| `cutoff` | number | Frequencies above this are removed, in hertz. default `700`, min 5, max 21600, in Hz. |

### `loudness`

Bring sound to a standard loudness, riding the level as it goes. -16 suits online video and podcasts, -23 is broadcast.

| Parameter | Type | What it does |
| - | - | - |
| `target` | number | The loudness to aim for, in LUFS. default `-16`, min -50, max -10, in LUFS. |

### `pitch`

Raise or lower the pitch without changing the speed.

| Parameter | Type | What it does |
| - | - | - |
| `semitones` | number | How far to shift. 12 is an octave up, -3 deepens a voice. min -36, max 36, in semitones. |

### `echo`

A repeat behind the sound.

| Parameter | Type | What it does |
| - | - | - |
| `delay` | number | Time before the repeat, in seconds. The engine starts at 0.1. default `0.28`, min 0.1, max 10, in s. |
| `amount` | number | 0 to 1, how loud the repeat is against the original. default `0.4`, min 0, max 1. |

### `reverb`

Place a dry voice in a hall.

| Parameter | Type | What it does |
| - | - | - |
| `amount` | number | 0 to 1, how much room you hear. 0.3 is a touch of air, 0.8 is a cathedral. default `0.5`, min 0, max 1. |

### `voiceDenoise`

Remove steady background noise from under speech: a river, a fan, a street. Trained on voices, so keep it off music.

| Parameter | Type | What it does |
| - | - | - |
| `amount` | number | 0 to 1, how much of the noise is removed. default `1`, min 0, max 1. |

## Stylize

### `shake`

Handheld camera energy on a steady shot. The picture is zoomed in slightly so its edges never show.

| Parameter | Type | What it does |
| - | - | - |
| `amount` | number | 0 to 1, how far the frame moves. 0.2 to 0.4 is handheld, 1 is an earthquake. default `0.3`, min 0, max 1, animatable. |
| `speed` | number | 0 to 1, how fast it moves. default `0.3`, min 0, max 1, animatable. |

### `glitch`

Digital break-up: blocks of the picture jump sideways and the colours tear. For a beat or a scene change, so give it a short length.

| Parameter | Type | What it does |
| - | - | - |
| `amount` | number | 0 to 1, how often the picture breaks. default `0.55`, min 0, max 1, animatable. |

### `pixelate`

Large square pixels over the whole picture.

| Parameter | Type | What it does |
| - | - | - |
| `size` | number | The side of one block, in pixels. default `24`, min 1, in px, animatable. |

### `posterize`

Flatten the picture into a few steps of each colour, like a screen print.

| Parameter | Type | What it does |
| - | - | - |
| `levels` | number | How many steps each colour channel keeps. 2 to 6 is a poster, above 16 is barely visible. default `4`, min 2, max 48, animatable. |

### `rgbShift`

Pull the red and blue channels apart sideways, for a chromatic, analogue-video edge.

| Parameter | Type | What it does |
| - | - | - |
| `distance` | number | How far each channel moves, in pixels. The engine stops at a sixteenth of the frame's width. default `10`, min 0, in px, animatable. |

### `scanLines`

The dark horizontal lines of a CRT monitor.

*No parameters.*

### `sketch`

Turn the picture into a pencil drawing.

| Parameter | Type | What it does |
| - | - | - |
| `amount` | number | 0 to 1. 1 is a pure pencil drawing on white, lower lets the original colours wash back in behind the lines. default `1`, min 0, max 1, animatable. |

### `trails`

Blend the last moments of the clip together, so moving lights and people leave streaks.

| Parameter | Type | What it does |
| - | - | - |
| `duration` | number | How long a streak lasts, in seconds. default `0.9`, min 0, in s. |

## Easings

Any keyframe takes one of 33: `step`, `linear`, `smooth`, `easeInSine`, `easeOutSine`, `easeInOutSine`, `easeInQuad`, `easeOutQuad`, `easeInOutQuad`, `easeInCubic`, `easeOutCubic`, `easeInOutCubic`, `easeInQuart`, `easeOutQuart`, `easeInOutQuart`, `easeInQuint`, `easeOutQuint`, `easeInOutQuint`, `easeInExpo`, `easeOutExpo`, `easeInOutExpo`, `easeInCirc`, `easeOutCirc`, `easeInOutCirc`, `easeInBack`, `easeOutBack`, `easeInOutBack`, `easeInElastic`, `easeOutElastic`, `easeInOutElastic`, `easeInBounce`, `easeOutBounce`, `easeInOutBounce`.

Fields marked `*` are required. Every table on this page is generated from the schema the API validates with, so it cannot drift from what a render accepts.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.