Set Upstream Key DVE Settings
atem_set_usk_dveConfigure an upstream keyer's DVE properties—position, size, rotation, border, mask, and shadow—to create picture-in-picture overlays on an ATEM switcher.
Instructions
Set DVE (Digital Video Effects) properties for an upstream keyer — position, size, rotation, border, mask, shadow.
Use this for picture-in-picture overlays. First set the key type to DVE with atem_set_usk_type, then use this tool to position and size the DVE box.
All values are passed directly to the ATEM protocol (raw units):
sizeX, sizeY: 0 to 1.0 (fraction of full frame, e.g. 0.5 = half, 0.33 = third)
positionX: -1.0 to 1.0 (horizontal position, -1=left edge, 0=center, 1=right edge)
positionY: -1.0 to 1.0 (vertical position, -1=bottom, 0=center, 1=top)
rotation: 0-35999 (hundredths of degrees, e.g. 9000 = 90°)
crop: 0 to 1.0 (fraction of image to crop from each edge)
Args:
me (number, optional): Mix Effect bus (default: 0)
usk (number): Upstream keyer number (0-based)
sizeX (number, optional): Horizontal size 0-1.0
sizeY (number, optional): Vertical size 0-1.0
positionX (number, optional): Horizontal position -1.0 to 1.0
positionY (number, optional): Vertical position -1.0 to 1.0
rotation (number, optional): Rotation 0-35999 (hundredths of degrees)
borderEnabled (boolean, optional): Show border
borderOuterWidth (number, optional): Outer border width 0-1600
borderInnerWidth (number, optional): Inner border width 0-1600
borderHue (number, optional): Border hue 0-3599
borderSaturation (number, optional): Border saturation 0-1000
borderLuma (number, optional): Border luminance 0-1000
borderOpacity (number, optional): Border opacity 0-100
shadowEnabled (boolean, optional): Show drop shadow
maskEnabled (boolean, optional): Enable mask
maskTop (number, optional): Mask top 0-38000
maskBottom (number, optional): Mask bottom 0-38000
maskLeft (number, optional): Mask left 0-52000
maskRight (number, optional): Mask right 0-52000
Example — 3x2 grid element at top-left, 1/3 size: sizeX=0.33, sizeY=0.33, positionX=-0.33, positionY=0.25
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| me | No | Mix Effect bus | |
| usk | Yes | Upstream keyer number (0-based) | |
| sizeX | No | Horizontal size (0-1.0, raw ATEM units) | |
| sizeY | No | Vertical size (0-1.0, raw ATEM units) | |
| maskTop | No | Mask top edge | |
| maskLeft | No | Mask left edge | |
| rotation | No | Rotation in hundredths of degrees | |
| borderHue | No | Border hue | |
| maskRight | No | Mask right edge | |
| positionX | No | X position (raw ATEM units) | |
| positionY | No | Y position (raw ATEM units) | |
| borderLuma | No | Border luminance | |
| maskBottom | No | Mask bottom edge | |
| maskEnabled | No | Enable mask | |
| borderEnabled | No | Show border | |
| borderOpacity | No | Border opacity | |
| shadowEnabled | No | Show drop shadow | |
| borderInnerWidth | No | Inner border width | |
| borderOuterWidth | No | Outer border width | |
| borderSaturation | No | Border saturation |