Set Upstream Keyer Mask
atem_set_usk_maskSets an upstream keyer's screen-space mask to clip a DVE overlay to a specific output-frame region, hiding everything outside the defined rectangle.
Instructions
Set the screen-space mask (clip region) for an upstream keyer. This defines an absolute rectangle on the output frame — anything outside is hidden.
Use this to clip a DVE overlay to a specific region of the screen (e.g., one cell of a grid layout).
The coordinate system:
Left/Right: -16000 to +16000 (left edge to right edge of frame)
Top/Bottom: -9000 to +9000 (bottom edge to top edge of frame)
Default (full frame): maskLeft=-16000, maskRight=16000, maskTop=9000, maskBottom=-9000
Example — clip to left-third, top-half of frame: maskEnabled=true, maskLeft=-16000, maskRight=-5333, maskTop=9000, maskBottom=0
Args:
me (number, optional): Mix Effect bus (default: 0)
usk (number): Upstream keyer number (0-based)
maskEnabled (boolean, optional): Enable/disable the mask
maskTop (number, optional): Top edge (-9000 to 9000)
maskBottom (number, optional): Bottom edge (-9000 to 9000)
maskLeft (number, optional): Left edge (-16000 to 16000)
maskRight (number, optional): Right edge (-16000 to 16000)
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| me | No | Mix Effect bus | |
| usk | Yes | Upstream keyer number (0-based) | |
| maskTop | No | Top edge of visible region | |
| maskLeft | No | Left edge of visible region | |
| maskRight | No | Right edge of visible region | |
| maskBottom | No | Bottom edge of visible region | |
| maskEnabled | No | Enable mask clipping |