Skip to content

Commands

caption.set_style

Sets or clears the style override of one caption.

Last updated:

The given object replaces the whole override and is stored as given. null or {} clears it. The caption style of the track is not touched.

Arguments#

ArgumentTypeRequiredDescription
item_idstringyesA caption.
styleobject or nullyesA partial CaptionStyle replacing the override, or null or {} to clear it.

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": "caption.set_style",
  "args": {
    "item_id": "itm_s6t7v8w9x0",
    "style": {
      "highlight": "word",
      "size": 80
    }
  }
}

Errors#

E_VALIDATION, E_NOT_FOUND, E_TYPE_MISMATCH, E_FONT_UNKNOWN

Scope and phase#

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