render_frames
Render frames through a Nuke Write node: preview with confirm false, then run with confirm true; async returns task_id for polling, or set synchronous to block.
Instructions
Render frames through a Write node.
By default this returns immediately with a task_id and
runs the render in the background; poll tasks_get(task_id)
for progress, tasks_cancel to interrupt, or wait for the
terminal state notification.
Pass synchronous=True to keep the pre-B2 blocking shape
(returns the full RenderResult once the render finishes).
That path is wire-compatible with existing callers.
Args:
write_node: name of Write node. uses first Write in script if omitted.
first_frame: start frame. uses script range if omitted.
last_frame: end frame. uses script range if omitted.
confirm: must be True to render. call with False to preview.
synchronous: block until done and return RenderResult
(B2 back-compat). Defaults to False -- use the async
Task flow.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| confirm | No | must be True to render. call with False to preview. | |
| last_frame | No | end frame. uses script range if omitted. | |
| write_node | No | name of Write node. uses first Write in script if omitted. | |
| first_frame | No | start frame. uses script range if omitted. | |
| synchronous | No | block until done and return ``RenderResult`` (B2 back-compat). Defaults to False -- use the async Task flow. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| errors | No | ||
| rendered | No | ||
| average_fps | No | ||
| frames_written | No | ||
| duration_seconds | No |