Skip to content

Commands

caption.set_breaks

Sets the forced line breaks of a caption.

Last updated:

Each break is the index of the word that starts a new line, from 1 to the word count minus 1, strictly increasing. An empty array clears the breaks.

Arguments#

ArgumentTypeRequiredDescription
breaksarray of integeryesIndexes of the words that start a new line, strictly increasing; [] clears.
item_idstringyesA caption.

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_breaks",
  "args": {
    "breaks": [
      2
    ],
    "item_id": "itm_s6t7v8w9x0"
  }
}

Errors#

E_VALIDATION, E_NOT_FOUND, E_TYPE_MISMATCH

Scope and phase#

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