Groups the transcript words of the visible range of the clip into captions of at most max_words words and max_chars characters, split at pauses longer than max_gap, and links them to the clip. With replace (the default) the captions already linked to the clip on that track are removed first. The transcript is supplied by the service in resolved; the command never starts a job.
Arguments#
| Argument | Type | Required | Description |
|---|---|---|---|
clip_item_id | string | yes | A clip of a video asset with audio. |
max_chars | integer | no | Characters per caption, default 28. min 1; max 500 |
max_gap | string | no | A length, may be 0; a longer pause starts a caption. Default "0.6s". |
max_words | integer | no | Words per caption, default 5. min 1; max 60 |
new_ids | array of string | no | Ids for the created captions, in order. |
replace | boolean | no | Remove the captions linked to this clip on this track first. Default true. |
resolved | object | no | Filled by the service from the transcript of the asset; never sent by a caller. |
track_id | string | yes | A visual track that receives the captions. |
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.from_transcript",
"args": {
"clip_item_id": "itm_m1n2p3q4r5",
"max_words": 5,
"track_id": "trk_a1b2c3d4e5"
}
}Errors#
E_VALIDATION, E_INVALID_TIME, E_NOT_FOUND, E_TYPE_MISMATCH, E_INVALID_STATE, E_ID_EXISTS, E_LIMIT, E_OVERLAP
Scope and phase#
Scope edit, phase alpha. Run vukem-video command:help caption.from_transcript for the same description from the binary.