octane_save_preview
Queue a render-ready preview image save with configurable quality, sample count, and time limit. Optionally generate an early low-spp progressive preview.
Instructions
Queue a render-ready preview image save command.
Convergence ceiling: pass quality to pick a preset tier
(standard=30s, high=60s, ultra=120s, final=unlimited). Either the
Octane film maxRenderTime or the Lua timeout_seconds poll acts
as the cap; the render stops at whichever is hit first and the frame is
saved (best-effort on timeout). Raw samples/min_samples/
timeout_seconds/max_render_time override the tier when given.
Set progressive=True to also emit an early low-spp frame at
preview_progressive.png before the final frame (bridge C1).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | No | ||
| width | No | ||
| height | No | ||
| quality | No | ||
| samples | No | ||
| min_samples | No | ||
| progressive | No | ||
| max_render_time | No | ||
| timeout_seconds | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |