Command · New Title
title.add
Adds a text title as a clip on a video track: a title media item holding the text and font, and the clip's "wabcut.title.style" effect holding size, fill and stroke colours, stroke width, shadow, alignment, line spacing and tracking.
- v1
- Capability EditSequence
- Tool
title_add
Request
{
"command": "title.add",
"params": {
"at": "00:00:10:00",
"style": {
"size": 120
},
"text": "Chapter One",
"track": "V2"
}
}Parameters
atinteger | stringRequired- Where the title starts. Timecode in the sequence's rate ("00:01:02:03") or ticks.
durationinteger | string- How long it lasts. Default 5 seconds. Timecode in the sequence's rate ("00:01:02:03") or ticks.
fontFamilystring- Font family. Default "Arial".
fontStylestring- Font style. Default "Regular".
placement`targeted` | `freeTrackAtOrAbove` | `newTrack`- "targeted": on "track", overwriting what is there (the default when "track" is given). "freeTrackAtOrAbove": the first unlocked video track from "track" (or the targeted one) upwards with nothing in the title's time range, a new top track when none is free (the default without "track"). "newTrack": a new video track on top.
sequenceinteger (1..)- Sequence id; only needed when the project has several.
styleobject- Style values by parameter key ("wabcut.title.style"); others take their defaults. Animate them later with clip.addKeyframe on the style effect.
style.alignmentnumber (0.0..2.0)- Alignment (amount, default 1).
style.fill.alphanumber (0.0..1.0)- Fill Opacity (fraction, default 1).
style.fill.bluenumber (0.0..1.0)- Fill Blue (fraction, default 1).
style.fill.greennumber (0.0..1.0)- Fill Green (fraction, default 1).
style.fill.rednumber (0.0..1.0)- Fill Red (fraction, default 1).
style.lineSpacingnumber (0.1..10.0)- Line Spacing (factor, default 1).
style.shadow.anglenumber (-3600.0..3600.0)- Shadow Angle (deg, default 135).
style.shadow.bluenumber (0.0..1.0)- Shadow Blue (fraction, default 0).
style.shadow.distancenumber (0.0..4000.0)- Shadow Distance (px, default 10).
style.shadow.greennumber (0.0..1.0)- Shadow Green (fraction, default 0).
style.shadow.opacitynumber (0.0..1.0)- Shadow Opacity (fraction, default 0).
style.shadow.rednumber (0.0..1.0)- Shadow Red (fraction, default 0).
style.shadow.softnessnumber (0.0..1000.0)- Shadow Softness (px, default 10).
style.sizenumber (1.0..2000.0)- Font Size (px, default 100).
style.stroke.alphanumber (0.0..1.0)- Stroke Opacity (fraction, default 1).
style.stroke.bluenumber (0.0..1.0)- Stroke Blue (fraction, default 0).
style.stroke.greennumber (0.0..1.0)- Stroke Green (fraction, default 0).
style.stroke.rednumber (0.0..1.0)- Stroke Red (fraction, default 0).
style.stroke.widthnumber (0.0..500.0)- Stroke Width (px, default 0).
style.trackingnumber (-1000.0..10000.0)- Tracking (amount, default 0).
textstringRequired- The text (UTF-8; a newline starts a new line).
trackstring | integer (1..)- A video track. Default: the first targeted unlocked video track. "V1" (bottom video track), "A2", ... or a track id.
Discussion
Adds a text title as a clip on a video track: a title media item holding the text and font, and the clip's "wabcut.title.style" effect holding size, fill and stroke colours, stroke width, shadow, alignment, line spacing and tracking. Place, scale and rotate it with the clip's Transform (clip.setParam motion.*). "placement" chooses the track: the named one (overwriting; the default when "track" is given), the first free one at or above the named or targeted one (the default without "track": nothing under the title is overwritten), or a new track on top. createdIds: the clip, the style effect, the title media.
Run it with wabcut-cli cmd <project> --json, from an MCP client as title_add, or from an extension. See Edit commands for requests, references and results.
See also
title.*
- title.setFont
Set Title Font. Changes a title's font family and/or style.
- title.setText
Edit Title Text. Replaces a title's text.