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#
| Argument | Type | Required | Description |
|---|---|---|---|
breaks | array of integer | yes | Indexes of the words that start a new line, strictly increasing; [] clears. |
item_id | string | yes | A 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):
{
"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.