Connect to a Blackmagic ATEM video switcher on the network.

Args:

• host (string): IP address of the ATEM switcher (e.g., "192.168.1.100")

• port (number, optional): Port number (default: 9910)

Returns: Connection confirmation with ATEM model info.

Disconnect from the currently connected ATEM switcher.

Get current ATEM switcher status including model info, current program/preview inputs, and connection state.

Returns: JSON object with model, firmware version, current program input, current preview input, and available inputs.

Set the program (live/on-air) input on the ATEM switcher.

Args:

• input (number): Input source number (e.g., 1=Input 1, 2=Input 2, 1000=Color Bars, 2001=Color 1, 3010=Media Player 1, 3020=Media Player 2, 6000=Super Source, 10010=Black)

• me (number, optional): Mix Effect bus number (default: 0 for ME1)

Common input IDs: 1-20 = physical inputs, 1000 = color bars, 2001/2002 = color generators, 3010/3020 = media players, 6000 = super source, 10010 = black.

Set the preview (next) input on the ATEM switcher.

Args:

• input (number): Input source number (same IDs as atem_set_program)

• me (number, optional): Mix Effect bus number (default: 0 for ME1)

Perform a hard cut transition — instantly switches preview to program.

Args:

• me (number, optional): Mix Effect bus number (default: 0 for ME1)

Trigger an auto transition (dissolve, wipe, etc.) from preview to program using the current transition settings.

Args:

• me (number, optional): Mix Effect bus number (default: 0 for ME1)

Toggle Fade to Black (FTB). If currently live, fades to black. If already in FTB, fades back up.

Args:

• me (number, optional): Mix Effect bus number (default: 0 for ME1)

Convenience tool: sets a preview input then immediately triggers an auto transition to bring it on air. Equivalent to selecting a source and pressing AUTO.

Args:

• input (number): Input source number to transition to

• me (number, optional): Mix Effect bus number (default: 0 for ME1)

Set the transition style (mix, dip, wipe, DVE, stinger) for auto transitions.

Args:

• style (string): Transition type — "mix", "dip", "wipe", "dve", or "stinger"

• me (number, optional): Mix Effect bus number (default: 0 for ME1)

Set the transition duration/rate in frames for a specific transition type.

Args:

• style (string): Which transition to set the rate for — "mix", "dip", "wipe", "dve", or "stinger"

• rate (number): Duration in frames (e.g., 30 = 1 second at 30fps, 60 = 2 seconds)

• me (number, optional): Mix Effect bus number (default: 0 for ME1)

Manually set the transition position, like moving the T-bar. Useful for manual fades.

Args:

• position (number): Position from 0.0 (preview) to 1.0 (program). 0 = fully on current program, 1 = fully transitioned to preview.

• me (number, optional): Mix Effect bus number (default: 0 for ME1)

Get current transition settings for a Mix Effect bus including style, rates, and in-transition status.

Args:

• me (number, optional): Mix Effect bus number (default: 0 for ME1)

Returns: JSON with current transition style, rates per type, and whether a transition is currently in progress.

Route an input source to an auxiliary output.

Args:

• aux (number): Aux output number (0-based, so aux 0 = Aux 1 on the switcher)

• input (number): Input source number to route to this aux

Common uses: sending a clean feed to a recorder, routing a specific camera to a confidence monitor, etc.

Get the current source routing for all auxiliary outputs.

Returns: JSON object mapping each aux output to its current source input.

Put a downstream keyer on or off air. DSKs overlay graphics (logos, lower thirds, etc.) on top of the program output.

Args:

• dsk (number): Downstream keyer number (0-based, 0 = DSK1, 1 = DSK2)

• onAir (boolean): true to put on air, false to take off air

Trigger an auto transition for a downstream keyer (mix on/off air).

Args:

• dsk (number): Downstream keyer number (0-based)

Set the fill and/or key (cut) sources for a downstream keyer.

Args:

• dsk (number): Downstream keyer number (0-based)

• fillSource (number, optional): Input to use as fill source

• cutSource (number, optional): Input to use as key/cut source

Put an upstream keyer on or off air on a specific ME bus. USKs are used for picture-in-picture, chroma key, luma key, DVE effects, etc.

Args:

• me (number, optional): Mix Effect bus (default: 0 for ME1)

• usk (number): Upstream keyer number (0-based, 0 = Key 1)

• onAir (boolean): true to put on air, false to take off air

Set the fill and/or cut sources for an upstream keyer.

Args:

• me (number, optional): Mix Effect bus (default: 0 for ME1)

• usk (number): Upstream keyer number (0-based)

• fillSource (number, optional): Input to use as fill

• cutSource (number, optional): Input to use as key/cut

Run an ATEM macro by index number.

Args:

• index (number): Macro slot number (0-based, so macro 0 = first macro slot)

Stop the currently running macro.

Continue a paused macro.

List all defined macros on the ATEM switcher.

Returns: JSON array of macros with their index, name, and whether they are valid/used.

Start recording on the ATEM (requires USB storage connected to the switcher). Available on models with recording capability.

Stop recording on the ATEM.

Start streaming on the ATEM (requires streaming to be configured in ATEM Software Control). Available on models with streaming capability.

Stop streaming on the ATEM.

Get the current recording and streaming status from the ATEM.

Configure an audio input on the ATEM's built-in audio mixer. Set gain, balance, and whether the input is on, off, or in audio-follow-video mode.

Args:

• input (number): Audio input number (matches video input numbers)

• mixOption (string, optional): "on" (always on), "off" (muted), or "afv" (audio-follow-video — audio is live only when this input is on program)

• gain (number, optional): Gain in dB (-60 to +6)

• balance (number, optional): Stereo balance (-1.0 = full left, 0 = center, 1.0 = full right)

Configure the master audio output level.

Args:

• gain (number, optional): Master output gain in dB (-60 to +6)

• followFadeToBlack (boolean, optional): Whether master audio follows Fade to Black

Get the current audio mixer state including all input levels, mix options, and master output settings.

Returns: JSON object with master output settings and per-input audio state.