MANUAL / SCRIPTING & EXPRESSIONS

Effects (scripting)

Adding, finding, renaming and setting effects and their parameters from Brio Script.

Working with effects

  • layer.Effects or layer.property("Effects") is the Effects group.
  • Effects.property(effectName | index) returns an effect group; effect.property(paramName | index) returns its parameter.
  • Effects.addProperty(matchName | name) adds an effect and returns its group.
  • effect.name = "…" renames it. Expressions find effects by name — effect("Bounce")("Slider").
  • effect.remove() removes it.

Parameters of a just-added effect can be set in the same run only for the Expression Controls (Slider, Angle, Checkbox, Point, Color).

Parameter values: numbers as numbers, checkboxes as 1/0, points as [x, y], colours as [r, g, b, a] 0–1, menus as their 1-based choice. Only number parameters can be keyframed from a script.

AE matchNames that addProperty knows

AE matchNameBrio effect
ADBE Slider ControlSlider Control (param Slider)
ADBE Angle ControlAngle Control (Angle)
ADBE Checkbox ControlCheckbox Control (Checkbox)
ADBE Point ControlPoint Control (Point)
ADBE Color ControlColor Control (Color)
ADBE Gaussian Blur 2Gaussian Blur
ADBE Glo2Glow
ADBE Drop ShadowDrop Shadow
ADBE HUE SATURATIONHue/Saturation
ADBE Easy Levels2, ADBE Pro Levels2Levels
ADBE CurvesCustomCurves
ADBE Exposure2Exposure
ADBE InvertInvert
ADBE Fractal NoiseFractal Noise
ADBE Posterize TimeFrame Rate

Brio's own effect names work too (for example "Bloom", "Roughen Edges", "Bend"). Other AE effects are not available.

Example

var fx = layer.Effects.addProperty("ADBE Slider Control");
fx.name = "Bounce";
fx.property("Slider").setValue(40);
layer.transform.rotation.expression = 'effect("Bounce")("Slider")';