Sets the given settings. When the size changes, the explicit x and y of every visual item, and the values of its x and y keyframes, are scaled by the ratio of new to old size on each axis; scale and text size are untouched and items at the default position stay centred.
Arguments#
| Argument | Type | Required | Description |
|---|---|---|---|
background | string | no | A hex colour, or $name from template.colors. |
height | integer | no | Frame height in pixels; even. min 16; max 4096 |
loudness_target | number | no | Integrated loudness target in LUFS. min -30; max -5 |
width | integer | no | Frame width in pixels; even. min 16; max 4096 |
Example#
As one operation of an edit batch (the edit tool of MCP, vukem-video edit --ops, or POST /api/v1/projects/{id}/edit):
{
"op": "settings.set",
"args": {
"height": 1280,
"width": 720
}
}Errors#
Scope and phase#
Scope edit, phase prototype. Run vukem-video command:help settings.set for the same description from the binary.