Command · Track Object Mask

mask.propagate

Tracks an object mask's object through the clip (or In / Out) from its last clicked frame: after a selection made with "propagate": "none", or across a shot cut with acrossShots.

• v1
• Capability EditSequence
• Tool mask_propagate

Request

{
  "command": "mask.propagate",
  "params": {
    "clip": 42,
    "direction": "forward",
    "mask": 1
  }
}

Parameters

acrossShotsboolean

Keep tracking across shot cuts (default false: stop at the cuts around the frame).

clipinteger | object (1..)Required

A clip id, or {"track", "time"} for the clip there.

direction`none` | `forward` | `backward` | `both`

Default both.

effectinteger (1..)

The effect holding the mask; default the one that has it.

ininteger | string

Track no earlier than this (inside the clip). Timecode in the sequence's rate ("00:01:02:03") or ticks.

maskinteger (1..)Required

The object mask.

outinteger | string

Track no later than this. Timecode in the sequence's rate ("00:01:02:03") or ticks.

sequenceinteger (1..)

Sequence id; only needed when the project has several.

Discussion

Run it with wabcut-cli cmd <project> --json, from an MCP client as mask_propagate, or from an extension. See Edit commands for requests, references and results.