Skip to content

Commands

keyframe.set

Adds or replaces a keyframe of one animated property of an item.

Last updated:

Sets the value of x, y, scale, rotation, opacity or (clips and audio) volume at an absolute position inside the item, from its start to its end inclusive. When the property had no keyframe and at is after the start, its current static value becomes the first keyframe. The easing applies from this keyframe to the next. At most 100 keyframes per property.

Arguments#

ArgumentTypeRequiredDescription
atstringyesAbsolute position inside the item, inclusive of its end.
easinglinear, ease_in, ease_out, ease_in_out, holdnoFrom this keyframe to the next. Default linear.
item_idstringyes
propertyx, y, scale, rotation, opacity, volumeyes
valuenumberyesValid for the property: scale above 0 up to 20, opacity 0 to 1, volume 0 to 4.

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": "keyframe.set",
  "args": {
    "at": "2s",
    "easing": "ease_out",
    "item_id": "itm_s6t7v8w9x0",
    "property": "scale",
    "value": 1.2
  }
}

Errors#

E_VALIDATION, E_INVALID_TIME, E_NOT_FOUND, E_TYPE_MISMATCH, E_LIMIT

Scope and phase#

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