Scripting reference

Every command a script or MCP can run, with its arguments. A script also runs one as lumit.command("layer.add", { ... }).

A time is a frame on the comp’s rate, or exact seconds as { "num": 1001, "den": 24000 }.

project.info

Where the project is saved, how much it holds, and whether undo and redo have anything to do.

Script: lumit.project.info(). MCP tool: project_info.

No arguments.

project.save

Save the project, where it was last saved or to a new path.

Script: lumit.project.save({ ... }). MCP tool: project_save.

Argument	Type	Required	Meaning
path	string

undo

Undo the last step.

MCP tool: undo. A script cannot run it.

No arguments.

redo

Redo the last undone step.

MCP tool: redo. A script cannot run it.

No arguments.

comp.list

Every comp in the project, with its settings.

Script: lumit.comp.list(). MCP tool: comp_list.

No arguments.

comp.get

One comp’s settings and its layers.

Script: lumit.comp.get({ ... }). MCP tool: comp_get.

Argument	Type	Required	Meaning
comp	string	yes	The comp’s id or name

comp.new

Make a comp, 1920x1080 at 60 fps for 30 seconds unless told otherwise.

Script: lumit.comp.new({ ... }). MCP tool: comp_new.

Argument	Type	Required	Meaning
name	string
width	integer (16 to 16384)
height	integer (16 to 16384)
frame_rate	integer (1 to 999) or {num, den}		1 to 999 frames a second
duration	integer or {num, den}		At most 3 hours
background	list of 4 numbers		Scene-linear RGBA
folder	string or null		The folder to file it in, by id or name, or null for the top of the panel. Left out, it goes in the Compositions folder

comp.set

Change a comp’s name, size, frame rate, duration or background.

Script: lumit.comp.set({ ... }). MCP tool: comp_set.

Argument	Type	Required	Meaning
comp	string	yes	The comp’s id or name
name	string
width	integer (16 to 16384)
height	integer (16 to 16384)
frame_rate	integer (1 to 999) or {num, den}		1 to 999 frames a second
duration	integer or {num, den}		At most 3 hours
background	list of 4 numbers		Scene-linear RGBA

comp.precompose

Move layers into a new comp, and put that comp in their place as one layer.

Script: lumit.comp.precompose({ ... }). MCP tool: comp_precompose.

Argument	Type	Required	Meaning
comp	string	yes	The comp’s id or name
layers	list of strings	yes	The layers’ ids, or their names in the comp
name	string		The new comp’s name. Pre-comp and a number if left out
leave_attributes	boolean		For one layer: leave its transform, effects and masks on the new layer, and move only its source

comp.open

Show a comp in the Viewer.

Script: lumit.comp.open({ ... }). MCP tool: comp_open.

Argument	Type	Required	Meaning
comp	string	yes	The comp’s id or name

comp.active

The comp open in the Viewer, if there is one.

Script: lumit.comp.active(). MCP tool: comp_active.

No arguments.

comp.frame

Render a frame of a comp to a PNG, and answer its path, width and height.

Script: lumit.comp.frame({ ... }). MCP tool: comp_frame.

Argument	Type	Required	Meaning
comp	string	yes	The comp’s id or name
time	integer or {num, den}		The frame, 0 when left out
scale	number (over 0, at most 1)		Of the comp’s size, 1 when left out
out	string		The .png file to write. Without it, a numbered file beside the project

item.list

Every item in the project panel: comps, footage, folders and solids, with the folder each is in, and the size, rate and length of footage and solids.

Script: lumit.item.list(). MCP tool: item_list.

No arguments.

item.set

Rename an item, file it in a folder, set the rate a footage item plays at, or set its comment.

Script: lumit.item.set({ ... }). MCP tool: item_set.

Argument	Type	Required	Meaning
item	string	yes	The item’s id or name
name	string
folder	string or null		The folder’s id or name, or null for none
frame_rate	integer (1 to 999) or {num, den} or null		1 to 999 frames a second, or a video’s own rate
comment	string		Empty for none

folder.new

Make a folder in the project panel.

Script: lumit.folder.new({ ... }). MCP tool: folder_new.

Argument	Type	Required	Meaning
name	string
parent	string		The folder to make it in, by id or name

layer.add

Add a null, camera, solid, footage or precomp layer to a comp.

Script: lumit.layer.add({ ... }). MCP tool: layer_add.

Argument	Type	Required	Meaning
comp	string	yes	The comp’s id or name
kind	"null", "camera", "solid", "footage", "precomp"	yes
item	string		For footage: the footage item’s id or name. For a precomp: the comp’s
name	string
index	integer (at least 0)		Where in the stack, 0 is the top
colour	list of 3 numbers (0 to 1)		For a solid: its colour as a colour picker shows it, 0 to 1. White if left out
width	integer (1 to 16384)		For a solid, the comp’s if left out
height	integer (1 to 16384)

shape.add

Add a shape layer drawn from paths, each item in the form a .lum file keeps it: path, fill, stroke, stroke_width, opacity, gradient and the rest.

Script: lumit.shape.add({ ... }). MCP tool: shape_add.

Argument	Type	Required	Meaning
comp	string	yes	The comp’s id or name
name	string
index	integer (at least 0)		Where in the stack, 0 is the top
items	list of object	yes	The shape items as a .lum file keeps them. Each path is {vertices:[{pos:[x,y],tan_in:[x,y],tan_out:[x,y]}],closed}, in comp pixels with tangents relative to their vertex. Colours are linear-light RGBA. An id and a name are made for any item without one

layer.composite

Set how a layer meets the layers below: its blend mode, and a track matte from another layer of its comp.

Script: lumit.layer.composite({ ... }). MCP tool: layer_composite.

Argument	Type	Required	Meaning
comp	string	yes	The comp’s id or name
layer	string	yes	The layer’s id, or its name in the comp
blend	string		A blend mode as a .lum file names it: Normal, Add, Screen, Multiply, Overlay, SoftLight and the rest
matte	string or null		The matte layer’s id or name, or null for none
luma	boolean		Matte by brightness rather than alpha
inverted	boolean

layer.get

One layer: its span, parent, switches and transform.

Script: lumit.layer.get({ ... }). MCP tool: layer_get.

Argument	Type	Required	Meaning
comp	string	yes	The comp’s id or name
layer	string	yes	The layer’s id, or its name in the comp

layer.set

Change a layer’s name, parent, span, switches, 3D switch, rotation order or place in the stack.

Script: lumit.layer.set({ ... }). MCP tool: layer_set.

Argument	Type	Required	Meaning
comp	string	yes	The comp’s id or name
layer	string	yes	The layer’s id, or its name in the comp
name	string
parent	string or null		The parent’s id or name, or null for none. The layer stays where it is at the comp’s start
jump	boolean		With parent: leave the transform as it is, so the layer moves with its new parent
in	integer or {num, den}		A frame on the comp’s rate, or exact seconds
out	integer or {num, den}		A frame on the comp’s rate, or exact seconds
start_offset	integer or {num, den}		A frame on the comp’s rate, or exact seconds
three_d	boolean
index	integer (at least 0)		Where in the stack, 0 is the top
two_node	boolean		For a camera, whether it aims at its point of interest
after_effects_order	boolean		Turn X, Y and Z Rotation in After Effects’ order rather than Lumit’s. The rotations are rewritten so the layer keeps its pose
switches	object
switches.visible	boolean
switches.audible	boolean
switches.solo	boolean
switches.locked	boolean
switches.shy	boolean
switches.guide	boolean
switches.motion_blur	boolean
switches.fx	boolean
switches.accepts_lights	boolean

layer.delete

Delete a layer.

Script: lumit.layer.delete({ ... }). MCP tool: layer_delete.

Argument	Type	Required	Meaning
comp	string	yes	The comp’s id or name
layer	string	yes	The layer’s id, or its name in the comp

layer.keys

Set one transform or camera property’s whole animation: a value, a list of keys, or an expression.

Rotation turns about Z.

Script: lumit.layer.keys({ ... }). MCP tool: layer_keys.

Argument	Type	Required	Meaning
comp	string	yes	The comp’s id or name
layer	string	yes	The layer’s id, or its name in the comp
property	"rotation", "rotation_x", "rotation_y", "opacity", "zoom", "focus_distance", "aperture", "anchor", "scale", "position", "point_of_interest", "orientation"	yes
value	number or list of 2 numbers or list of 2 to 3 numbers or list of 3 numbers		Z is left as it is when there are two; X, Y and Z, in After Effects’ order
keys	list
keys[].time	integer or {num, den}	yes	A frame on the comp’s rate, or exact seconds
keys[].value	number or list of 2 numbers or list of 2 to 3 numbers or list of 3 numbers	yes	Z is left as it is when there are two; X, Y and Z, in After Effects’ order
keys[].interp	"linear", "hold"
keys[].in	"linear", "hold", "auto", "clamped" or {speed, influence} or list of {speed, influence}		Linear, hold, auto or clamped, or an ease, or a list with an ease for each value
keys[].in.speed	number		Units a second
keys[].in.influence	number (0.1 to 100)		Per cent of the span
keys[].out	"linear", "hold", "auto", "clamped" or {speed, influence} or list of {speed, influence}		Linear, hold, auto or clamped, or an ease, or a list with an ease for each value
keys[].out.speed	number		Units a second
keys[].out.influence	number (0.1 to 100)		Per cent of the span
expression	string		A JavaScript expression, as After Effects writes them

Needs one of value, keys or expression.

markers.set

Replace a comp’s markers, or a layer’s when a layer is named.

Script: lumit.markers.set({ ... }). MCP tool: markers_set.

Argument	Type	Required	Meaning
comp	string	yes	The comp’s id or name
layer	string		The layer’s id, or its name in the comp
markers	list	yes
markers[].id	string		An existing marker’s id, to keep what it was
markers[].time	integer or {num, den}	yes	A frame on the comp’s rate, or exact seconds
markers[].label	string
markers[].colour	integer (0 to 255)
markers[].duration	integer		Frames it spans
markers[].chapter	boolean		Whether it starts a chapter

effect.list

The effects on a layer, top first, with their controls.

Script: lumit.effect.list({ ... }). MCP tool: effect_list.

Argument	Type	Required	Meaning
comp	string	yes	The comp’s id or name
layer	string	yes	The layer’s id, or its name in the comp

effect.get

One effect on a layer, with every control it has.

Script: lumit.effect.get({ ... }). MCP tool: effect_get.

Argument	Type	Required	Meaning
comp	string	yes	The comp’s id or name
layer	string	yes	The layer’s id, or its name in the comp
effect	string or integer (at least 0)	yes	The effect’s id or name, or its place in the stack, 0 the top

effect.add

Add an effect to the bottom of a layer’s stack, by Lumit’s name for it or After Effects’.

Script: lumit.effect.add({ ... }). MCP tool: effect_add.

Argument	Type	Required	Meaning
comp	string	yes	The comp’s id or name
layer	string	yes	The layer’s id, or its name in the comp
effect	string	yes	Lumit’s id or name for the effect, or After Effects’ match name or name, such as ADBE Gaussian Blur 2
name	string		The name it shows

effect.set

Switch an effect on or off, rename it, or set one of its controls: a value, a list of keys, or an expression.

Script: lumit.effect.set({ ... }). MCP tool: effect_set.

Argument	Type	Required	Meaning
comp	string	yes	The comp’s id or name
layer	string	yes	The layer’s id, or its name in the comp
effect	string or integer (at least 0)	yes	The effect’s id or name, or its place in the stack, 0 the top
enabled	boolean
name	string or null		The name it shows, or null for the effect’s own
param	string		A control’s id or name. After Effects’ match name for one, such as ADBE Gaussian Blur 2-0001, takes After Effects’ values and converts them as importing does
value	any		A number, a list for a point or a colour, true or false for a switch, or an option’s number
keys	list
keys[].time	integer or {num, den}	yes	A frame on the comp’s rate, or exact seconds
keys[].value	number or list of 1 to 4 numbers	yes
keys[].interp	"linear", "hold"
keys[].in	"linear", "hold", "auto", "clamped" or {speed, influence} or list of {speed, influence}		Linear, hold, auto or clamped, or an ease, or a list with an ease for each value
keys[].in.speed	number		Units a second
keys[].in.influence	number (0.1 to 100)		Per cent of the span
keys[].out	"linear", "hold", "auto", "clamped" or {speed, influence} or list of {speed, influence}		Linear, hold, auto or clamped, or an ease, or a list with an ease for each value
keys[].out.speed	number		Units a second
keys[].out.influence	number (0.1 to 100)		Per cent of the span
expression	string		A JavaScript expression, as After Effects writes them

footage.import

Import files as footage items.

Script: lumit.footage.import({ ... }). MCP tool: footage_import.

Argument	Type	Required	Meaning
paths	list of strings	yes

export.start

Start exporting a comp.

Script: lumit.export.start({ ... }). MCP tool: export_start.

Argument	Type	Required	Meaning
comp	string	yes	The comp’s id or name
out	string		The file to write

export.status

How an export is going.

Script: lumit.export.status({ ... }). MCP tool: export_status.

Argument	Type	Required	Meaning
job	integer (at least 0)	yes

export.cancel

Stop an export.

Script: lumit.export.cancel({ ... }). MCP tool: export_cancel.

Argument	Type	Required	Meaning
job	integer (at least 0)	yes