canvas
Read or change the project's canvas shape, which controls every frame size and render output. Set a custom widthxheight, reset to the footage-derived shape, or preview the effect before applying it.
Instructions
Read or change the shape this project renders at.
The canvas is project state and every frame size derives from it — the
MLT profile and the captions' reference canvas both read it, so a project
cannot quote caption sizes against one shape and render another. Call it
with no size to read what is in force plus the footage-derived shape it
would fall back to; reset drops the override and returns to that shape.
size is "WIDTHxHEIGHT", e.g. "1080x1920" for a vertical reel. Both
edges must be even.
Setting one has a routing consequence, reported as routes_through: an
overridden project renders through the MLT writer whatever its source
count, because auto-editor cannot be handed a canvas it will honour.
An override that changes the aspect crops to fill rather than
pillarboxing, so cropped names every clip that loses footage to it —
use reframe to see or change which part of each one is kept.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | No | The project directory to act on. Omit it — the usual case — when this server is bound to a project (started as `proofcut -C DIR mcp`, or inside a project; `ping` says which): it then resolves to that one bound project, a relative path resolves against it, and a path outside it is refused by name. Unbound, `path` is the whole address and omitting it refuses rather than guessing. | |
| plan | No | Resolve the whole call and report what it would do, writing nothing. Prefer it over doing the thing and undoing it. | |
| size | No | `WIDTHxHEIGHT`, e.g. `1080x1920` for a vertical reel. Both edges must be even. Omit it to read what is in force plus the footage-derived shape it would fall back to. | |
| reset | No | Drop the override and return to the footage-derived shape. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||