Tools reference
Render Queue
Manage the render queue end-to-end: add comps, apply templates, set output paths, start and monitor renders.
Queue management
add_to_render_queueAdd a single composition to the render queue.
add_comps_to_render_queueAdd multiple compositions to the render queue in one call.
list_render_queueList all items currently in the render queue with their status and settings.
set_render_settingsApply render settings to a render queue item: quality, resolution, frame rate, time range.
set_output_moduleSet the output module on a render queue item: format, codec, channels, color depth.
set_render_queue_outputSet the output file path for a render queue item.
apply_render_templateApply a saved render settings template to a render queue item.
list_render_templatesList all available render settings templates in the project.
list_output_modulesList all available output module templates.
duplicate_render_itemDuplicate a render queue item (useful for setting multiple output paths).
remove_render_queue_itemRemove an item from the render queue.
clear_render_queueRemove all items from the render queue.
set_rq_item_enabledEnable or disable a render queue item without removing it.
Rendering
render_compAdd a comp to the render queue and immediately start rendering it.
render_comp_rangeRender a composition over a specific time range.
render_project_queueStart rendering all queued and enabled items in the render queue.
cancel_renderCancel an in-progress render.
get_render_statusGet the current render status: progress percentage, elapsed time, remaining estimate.
validate_render_outputCheck whether a render queue item's output path and settings are valid before rendering.
export_frameExport a single frame from a composition to an image file.