Tools reference
Compositions
Create, configure, duplicate, and manage compositions. Also covers guides and composition markers.
Composition tools
create_compCreate a new composition with specified name, dimensions, frame rate, duration, and pixel aspect ratio.
update_comp_settingsUpdate settings on an existing composition: name, size, frame rate, duration, or pixel aspect.
duplicate_compDuplicate a composition and optionally rename the copy.
delete_compPermanently delete a composition from the project.
list_compsReturn a list of all compositions in the project with their settings.
get_comp_infoGet detailed info about a specific composition: dimensions, fps, duration, layers, markers.
set_comp_work_areaSet the work area start and end time of a composition.
trim_comp_to_work_areaTrim the composition duration to match its current work area.
set_comp_bg_colorSet the background color of a composition (RGB values 0–1).
set_comp_rendererSet the renderer for a comp: Classic 3D, CINEMA 4D, or Advanced 3D.
add_guideAdd a horizontal or vertical ruler guide at a specified position.
list_guidesList all guides in a composition with their orientation and position.
clear_guidesRemove all guides from a composition.
add_comp_markerAdd a composition marker at a specific time with optional comment and duration.
list_comp_markersList all composition markers with their time, comment, and duration.
update_comp_markerUpdate an existing composition marker's time, comment, or duration.
remove_comp_markerRemove a composition marker by index.