Skip to content

Commands

slot.mark

Marks an item as a template slot.

Last updated:

Makes a clip, audio, text or caption item a slot named name; the slot kind follows from the item type (clip and audio give media). Marking the same item again with the same name updates the slot.

Arguments#

ArgumentTypeRequiredDescription
descriptionstringnoUp to 200 characters.
duration_policyfit, stretch_timelinenoMedia slots only. Default fit.
item_idstringyesA clip, audio, text or caption item.
namestringyesMatches [a-z][a-z0-9_]{0,39}; unique among the slots.
requiredbooleannoDefault true.

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": "slot.mark",
  "args": {
    "description": "Headline",
    "item_id": "itm_s6t7v8w9x0",
    "name": "title"
  }
}

Errors#

E_VALIDATION, E_NOT_FOUND, E_TYPE_MISMATCH, E_SLOT, E_INVALID_STATE

Scope and phase#

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