Skip to content

Commands

shape.set

Changes the shape, size, colours, stroke or radius of a shape item.

Last updated:

Sets the given fields; a value equal to its default clears the stored field. Changing the shape to rect or ellipse removes a stored radius. Position and transform are set with item.set_transform.

Arguments#

ArgumentTypeRequiredDescription
fillstringnoA colour.
heightnumbernoPixels before scale, above 0.
item_idstringyesA shape item.
radiusnumbernoPixels, 0 or more; rounded_rect only.
shaperect, rounded_rect, ellipseno
stroke_colorstringnoA colour.
stroke_widthnumbernoPixels, 0 or more.
widthnumbernoPixels before scale, above 0.

Example#

As one operation of an edit batch (the edit tool of MCP, vukem-video edit --ops, or POST /api/v1/projects/{id}/edit):

JSON
{
  "op": "shape.set",
  "args": {
    "item_id": "itm_s6t7v8w9x0",
    "radius": 24,
    "shape": "rounded_rect",
    "width": 600
  }
}

Errors#

E_VALIDATION, E_NOT_FOUND, E_TYPE_MISMATCH

Scope and phase#

Scope edit, phase alpha. Run vukem-video command:help shape.set for the same description from the binary.