MixEffect Documentation

MixEffect

MixEffect Newsletter

MixEffect Community

OSC

Control MixEffect using devices capable of sending OSC messages, such as an Elgato Stream Deck running Companion.


Getting Started with OSC in MixEffect

Activating OSC support is a three-step process.

  1. Enable OSC support in MixEffect.
  2. Configuring the OSC server for each switcher in MixEffect.
  3. Setting up your OSC-capable device to communicate with MixEffect.

Enable OSC Support

This turns on OSC support throughout all of MixEffect.

  1. Tap Settings (gear icon) from the MixEffect Home.
  2. Tap Automations.
  3. Tap Enable OSC.

Enable OSC Server and Port for a Switcher

Each switcher connection can have its own OSC server. For instance, if you use MixEffect with an ATEM Mini Pro and an ATEM Extreme, you can have both respond to OSC calls when running MixEffect in Split View on an iPad.

IMPORTANT: If you plan to run MixEffect with multiple switchers at the same time, it is recommended to specify a unique port number for each switcher.

  1. From the MixEffect Home, tap on a switcher.
  2. Tap Edit.
  3. Change the OSC Port number. Choose a number over 40000 and less than 65535 to ensure no conflicts with other ports. The default is 49990.
  4. Tap Save.
  5. Tap Enable OSC Server to start the server.

The OSC server is now configured and active for your switcher.

Enabling OSC


Determining your iOS Device’s IP address

Next, you will get your iOS device’s IP address, do the following:

  1. Go to the Home screen.
  2. Tap Settings.
  3. Tap either Wi-Fi or Ethernet, depending on which network your device and the ATEM switcher are connected to.
  4. Tap the i button.
  5. Copy the IP Address and enter it into your OSC client like Companion.

iOS IP Address

OSC commands will be interpreted only when MixEffect is in the foreground of your iOS device.

MixEffect OSC server listens on the port you specified for your switcher. Make sure you have configured your OSC clients to send commands to MixEffect on the correct port.

NOTE: If the OSC server does not appear to respond, try disabling and enabling the server from the Switcher Detail page.


Configuring Companion

If you plan to use MixEffect with a Stream Deck, you’ll want to download the free Companion application from Bitfocus.io.

Next, configure the Companion app to communicate with MixEffect. There are currently two ways to control MixEffect from Companion:


Native MixEffect Companion Module

A native Companion module is actively being developed for MixEffect. Watch the announce video and interview with the developer.

Visit this page for links to the current beta build of Companion that includes the MixEffect module.

32 Button Companion Profile for ATEM Mini Extreme

If you are using an ATEM Mini Extreme or ATEM Mini Extreme ISO, you can purchase a pre-made 32 button Companion profile for the MixEffect Native Companion Module. This profile features 72 pages of buttons to control nearly every aspect of your ATEM Mini Extreme switcher.

MixEffect 32 Button Companion Profile for ATEM Mini Extreme

NOTE: This profile currently works with the 1.1.0 and higher release of the MixEffect Native Companion Module.


Generic OSC Module

  1. Open the web admin interface to Companion Running on your computer.
  2. Tap Instances.
  3. Enter OSC generic in the search field to add a new module.
  4. Tap Add.
  5. Give your module a name like MixEffect Extreme or Extreme (MixEffect).
  6. Set the port number to the correct port you entered for your switcher in MixEffect.
  7. Tap Apply Changes.

Generic OSC

Setting up the generic OSC instance in Companion


Sample Companion Configuration Files

Download these sample MixEffect Companion configuration files that work with the generic OSC module. These sample files are designed to work with MixEffect 1.2.3 and higher.

Sample MixEffect Presets Companion Config File


Adding a Button

This section covers adding a button to Companion. It assumes that you are familiar with how Companion works.

  1. Tap the Buttons tab.
  2. Navigate to the page where you want to add a MixEffect button.
  3. Click on a button.
  4. Set the button type to Regular button.
  5. Enter the name for your button.
  6. Click Add key down/on action.
  7. In the list that appears, choose the appropriate action from the list below:

    • MixEffect Extreme: Send message without arguments
    • MixEffect Extreme: Send integer
    • MixEffect Extreme: Send float
    • MixEffect Extreme: Send string
    • MixEffect Extreme: Send message with multiple arguments

Which option you choose depends on the message you are planning to send. Review the next section to determine what kind of message to use.

  1. Enter the OSC Path corresponding to the message you want to send. For instance: /mixeffect/ssrc/preset will instruct MixEffect to run a SuperSource preset.
  2. Enter the name of the preset in the Value field. For instance: Four Grid.
  3. Tap Test actions to see MixEffect run the preset.

If nothing happens, check the following:

  1. Enable OSC is enabled in MixEffect Settings.
  2. Enable OSC Server is enabled in your Switcher Detail page.
  3. The port number you specified for your switcher is the same one you entered in Companion.

Messages

The following OSC messages are supported:

Mix Effect

Auxiliary/Output

Color Generators

Downstream Keyers

Fairlight Audio

Macros

Mix Effect Bus

Media Players

Multiview

Output

SuperSource

Switcher

Transitions

Upstream Keyers


MixEffect

Connect

Closes the current switcher connection and tries to connect to the selected switcher.

Message Description Arguments
/mixeffect/connect Closes the current switcher connection and tries to connect to the selected switcher. String
Argument Type Description
Switcher Connection Name String The exact name for the switcher to connect to.

Configuring a connect to switcher button in Companion


Remote Webview

Toggles the Remote Webview window in MixEffect.

Message Description Arguments
/mixeffect/remote-webview Toggles the Remote Webview window in MixEffect. None

NOTE: Tap the ellipsis icon and tap Edit to configure the Remote Webview if nothing appears in the Remote Webview window.


Run Shortcut

Opens the Shortcuts app and runs the selected shortcut.

Message Description Arguments
/shortcut Opens the Shortcuts app and runs the selected shortcut. Multiple
Argument Type Description
Shortcut Name String The exact name of the shortcut to run
Input String Optional input to pass to the shortcut

Note: If the shortcut does not exist, Shortcuts will raise an error that you will have to dismiss manually.


Run Shortcut and Return

Opens the Shortcuts app, runs the selected shortcut, and tries to return back to MixEffect

Message Description Arguments
/shortcut/return Opens the Shortcuts app, runs the selected shortcut, and tries to return back to MixEffect Multiple
Argument Type Description
Shortcut Name String The exact name of the shortcut to run
Input String Optional input to pass to the shortcut

Configuring a shortcut button in Companion

In the screenshot above, we will be running the shortcut named “Speak Text” with the input parameter, “Hello, World”.

If the shortcut does not exist, Shortcuts will raise an error that you will have to dismiss manually.

After running, the shortcut will try to return back to MixEffect.


Switcher Page

Moves to the next or previous Switcher Page for the current switcher.

Message Description Arguments
/mixeffect/page Moves to the next or previous Switcher Page for the current switcher. String
Argument Type Description
Command or Name String The exact switcher page name or next for the next page or previous for the previous page.

MixEffect will cycle through your pages if you reach the end or beginning of your pages when using the next and previous commands.

The switcher page command is case-insensitive.

Configuring a Switcher Page button in Companion.


Switcher Section

Switches to the following section in MixEffect for the current switcher.

Message Description Arguments
/mixeffect/section Switches to the following section in MixEffect for the current switcher. String
Argument Type Description
Section String audio
auxiliary
camera-control
color-generators
downstream-keyers
hyperdecks
macros
media
output
settings
supersource
switcher
transitions
upstream-keyers
view-all

Video Follows Audio

Turns on, off, or toggles the Video Follows Audio feature. Automatically switches to the Audio section in MixEffect.

Message Description Arguments
/mixeffect/vfa Turns on, off, or toggles the Video Follows Audio feature. Automatically switches to the Audio section in MixEffect. Integer or String
Argument Type Description
VFA String 0 = Off
1 = On
2 = Toggle

off = Off
on = On
toggle = Toggle

Your switcher must support Fairlight Audio for Video Follows Audio to work.


View Only Mode

Turns on View Only Mode for the connected switcher.

Message Description Arguments
/mixeffect/vom Turns on View Only Mode for the connected switcher. None

Configuring a View Only Mode button in Companion.


Auxiliary/Output

Messages that operate on the auxiliary outputs in a switcher.

Aux/Output Source

Sets the source for an auxiliary output.

Message Description Arguments
/mixeffect/aux/source Sets the source for an auxiliary output. Multiple
Argument Type Description
Video Source ID Integer The video source ID.
Aux Integer One-based index that is the Auxiliary output ID. Default is 1.

Note that Aux sources can have other values than just the video sources, including SuperSource, Program, Preview, Multiview, and Camera 1 direct (only for Aux1) and Camera 2 direct (only for Aux2). Some of these values are dependent on the switcher.

public enum Base: UInt16 {
		case black = 0
		case input = 1
		case colorBars = 1000
		case color = 2001-2002
		case mediaPlayer = 3010-3040
		case mediaPlayerKey = 3011-3041
		case keyMask = 4010-4040
		case downStreamKeyMask = 5010-5040
		case superSource = 6000-6001
		case cleanFeed = 7001-700x
		case auxiliary = 8001-80xx
		case multiview = 9001-9004
		case program = 10_010-10_040
		case preview = 10_011-10_041
		case inputDirect = 11_001-11_0xx
}

Color Generators

Set Color Generator

Set the color of a color generator.

Message Description Arguments
/mixeffect/color-generator Set the color of a color generator. Multiple
Argument Type Description
Hue Float Value from 0-360.0.
Saturation Float Value from 0-100.0
Luminance Float Value from 0-100.0
Color Generator Index Integer One-based index of the color generator. Default is 1.

Color Generator Parameter Adjust

Adjusts a single parameter for a color generator.

Message Description Arguments
/mixeffect/color-generator/parameter/adjust Adjusts a single parameter for a color generator. Multiple
Argument Type Description
Parameter Integer 0 = Hue
1 = Saturation
2 = Luminance
Adjustment Value Float -X to decrement the current parameter or Y to increment the current parameter by the adjustment value.
Color Generator Index Integer One-based index of the color generator. Default is 1.

Color Generator Parameter Set

Sets a single parameter for a color generator.

Message Description Arguments
/mixeffect/color-generator/parameter/set Sets a single parameter for a color generator. Multiple
Argument Type Description
Parameter Integer 0 = Hue
1 = Saturation
2 = Luminance
New Value Float The new value.
Color Generator Index Integer One-based index of the color generator. Default is 1.

Downstream Keyers

DSK Auto

Performs an auto transition with the selected downstream keyer.

Message Description Arguments
/mixeffect/dsk/auto Performs an auto transition with the selected downstream keyer. Integer
Argument Type Description
DSK Index Integer One-based index of the downstream keyer. Default is 1.

DSK Key

Sets all of the key settings for the downstream keyer.

Message Description Arguments
/mixeffect/dsk/key Sets all of the key settings for the downstream keyer. Multiple
Argument Type Description
Pre Multiplied Integer 0 = Off
1 = On
2 = Toggle
Clip Float Value from 0-100.0.
Gain Float Value from 0-100.0
Invert Key Integer 0 = Off
1 = On
2 = Toggle
DSK Index Integer One-based index of the downstream keyer. Default is 1.

DSK Key Clip Adjust

Adjusts the Clip setting for the downstream keyer.

Message Description Arguments
/mixeffect/dsk/key/clip/adjust Adjusts the Clip setting for the downstream keyer. Multiple
Argument Type Description
Adjustment Value Float -X to decrease the value by a certain amount or Y to increase the value by a certain amount.
DSK Index Integer One-based index of the downstream keyer. Default is 1.

DSK Key Clip Set

Set the Clip setting for the downstream keyer.

Message Description Arguments
/mixeffect/dsk/key/clip/set Set the Clip setting for the downstream keyer. Multiple
Argument Type Description
Adjustment Value Float The new value.
DSK Index Integer One-based index of the downstream keyer. Default is 1.

DSK Key Clip Gain

Sets the Clip and Gain settings for the downstream keyer.

Message Description Arguments
/mixeffect/dsk/key/clip-gain Sets the Clip and Gain settings for the downstream keyer. Multiple
Argument Type Description
Clip Float Value from 0-100.0.
Gain Float Value from 0-100.0
DSK Index Integer One-based index of the downstream keyer. Default is 1.

DSK Key Gain Adjust

Adjusts the Gain setting for the downstream keyer.

Message Description Arguments
/mixeffect/dsk/key/gain/adjust Adjusts the Gain setting for the downstream keyer. Multiple
Argument Type Description
Adjustment Value Float -X to decrease the value by a certain amount or Y to increase the value by a certain amount
DSK Index Integer One-based index of the downstream keyer. Default is 1.

DSK Key Gain Set

Set the Gain setting for the downstream keyer.

Message Description Arguments
/mixeffect/dsk/key/gain/adjust Sets the Gain setting for the downstream keyer. Multiple
Argument Type Description
Adjustment Value Float The new value.
DSK Index Integer One-based index of the downstream keyer. Default is 1.

DSK Key Invert

Sets the Invert Key setting for the downstream keyer.

Message Description Arguments
/mixeffect/dsk/key/invert Sets the Invert Key setting for the downstream keyer. Multiple
Argument Type Description
Invert Key Integer 0 = Off
1 = On
2 = Toggle
DSK Index Integer One-based index of the downstream keyer. Default is 1.

DSK Key Pre Multiplied

Sets the Pre Multiplied settings for the downstream keyer.

Message Description Arguments
/mixeffect/dsk/key/pre-multiplied Sets the Pre Multiplied settings for the downstream keyer. Multiple
Argument Type Description
Enable Pre Multiplied Integer 0 = Off
1 = On
2 = Toggle
DSK Index Integer One-based index of the downstream keyer. Default is 1.

DSK Inputs

Sets the fill and key sources for the downstream keyer.

Message Description Arguments
/mixeffect/dsk/inputs Sets the fill and key sources for the downstream keyer. Multiple
Argument Type Description
Fill Source ID Integer Integer that is the fill video source ID.
Key Source ID Integer Integer that is the key video source ID.
DSK Index Integer One-based index of the downstream keyer. Default is 1.

DSK Mask Adjust

Adjusts a single mask parameter for a downstream keyer.

Message Description Arguments
/mixeffect/dsk/mask/adjust Adjusts a single mask parameter for a downstream keyer. Multiple
Argument Type Description
Mask Parameter String top
bottom
left
right
Adjustment Value Float -X to reduce the current mask parameter setting by a certain amount or Y to increase the mask parameter setting by a certain amount
DSK Index Integer One-based index of the downstream keyer. Default is 1.

DSK Mask Enable

Sets the enable mask settings for the downstream keyer.

Message Description Arguments
/mixeffect/dsk/mask/enable Sets the enable mask settings for the downstream keyer. Multiple
Argument Type Description
Enable Mask Integer 0 = Off
1 = On
2 = Toggle
DSK Index Integer One-based index of the downstream keyer. Default is 1.

DSK Mask Set

Sets a single mask parameter for a downstream keyer.

Message Description Arguments
/mixeffect/dsk/mask/set Sets a single mask parameter for a downstream keyer. Multiple
Argument Type Description
Mask Parameter String top
bottom
left
right
Set Value Float The mask value to set.
DSK Index Integer One-based index of the downstream keyer. Default is 1.

DSK Mask

Sets the mask settings for the downstream keyer.

Message Description Arguments
/mixeffect/dsk/mask Sets the mask settings for the downstream keyer. Multiple
Argument Type Description
Top Float Float from -9.0 to 9.0.
Bottom Float Float from -9.0 to 9.0.
Left Float Float from -16.0 to 16.0.
Right Float Float from -16.0 to 16.0.
DSK Index Integer One-based index of the downstream keyer. Default is 1.

DSK On Air

Sets the On Air status for a downstream keyer.

Message Description Arguments
/mixeffect/dsk/on-air Sets the On Air status for a downstream keyer. Multiple
Argument Type Description
On Air Integer 0 = Off
1 = On
2 = Toggle
DSK Index Integer One-based index of the downstream keyer. Default is 1.

DSK Rate

Sets the rate for the downstream keyer.

Message Description Arguments
/mixeffect/dsk/rate Sets the rate for the downstream keyer. Multiple
Argument Type Description
Rate Integer The number of frames from 1 to 250.
DSK Index Integer One-based index of the downstream keyer. Default is 1.

DSK Tie

Performs an operation on the Tie status for the selected downstream keyer.

Message Description Arguments
/mixeffect/dsk/tie Performs an operation on the Tie status for the selected downstream keyer. Multiple
Argument Type Description
Tie Integer 0 = Off
1 = On
2 = Toggle
DSK Index Integer One-based index of the downstream keyer. Default is 1.

Fairlight Audio

Fairlight Audio Frame Delay

Sets the audio frame delay for an audio source, if supported.

Message Description Arguments
/mixeffect/fairlight/frame-delay Sets the audio frame delay for an audio source, if supported. Audio sources that support frame delay include Mic1 and Mic2 on the ATEM Mini lineup. Multiple
Argument Type Description
Audio Source ID Integer Integer that is the audio source ID.
Source Type Integer 0 = Stereo
1 = Left Channel
2 = Right Channel
Frame Delay Integer Integer from 0 to 8.

Fairlight Fader Gain Adjust

Sets the level for the audio source’s input gain.

Message Description Arguments
/mixeffect/fairlight/fader-gain/adjust Increases or decreases and input’s fader gain Multiple
Argument Type Description
Audio Source ID Integer Integer that is the audio source ID.
Source Type Integer 0 = Stereo
1 = Left Channel
2 = Right Channel
Level Float X will raise the gain by that amount (in dB) or -Y will lower the gain by that amount.

Note: Duration is currently not supported, so changes to the gain value are set immediately.


Fairlight Fader Gain Set

Sets the level for the audio source’s fader gain.

Message Description Arguments
/mixeffect/fairlight/fader-gain or /mixeffect/fairlight/fader-gain/set Sets the level for the audio source’s fader gain. Multiple
Argument Type Description
Audio Source ID Integer Integer that is the audio source ID.
Source Type Integer 0 = Stereo
1 = Left Channel
2 = Right Channel
Level Float The new level in dB.

Fairlight Input Gain Adjust

Increments or decrements the level for the audio source’s input gain.

Message Description Arguments
/mixeffect/fairlight/input-gain/adjust Increments or decrements the level for the audio source’s input gain. Multiple
Argument Type Description
Audio Source ID Integer Integer that is the audio source ID.
Source Type Integer 0 = Stereo
1 = Left Channel
2 = Right Channel
Level Float X will raise the gain by that amount (in dB) or -Y will lower the gain by that amount.

Note: Duration is currently not supported, so changes to the gain value are set immediately.


Fairlight Input Gain Set

Sets the level for the audio source’s fader gain.

Message Description Arguments
/mixeffect/fairlight/input-gain or /mixeffect/fairlight/input-gain/set Sets the level for the audio source’s input gain. Multiple
Argument Type Description
Audio Source ID Integer Integer that is the audio source ID.
Source Type Integer 0 = Stereo
1 = Left Channel
2 = Right Channel
Level Float The new level in dB.

Fairlight Input Mix Option

Sets the mix option for the selected audio source.

Message Description Arguments
/mixeffect/fairlight/mix-option Sets the mix option for the selected audio source. Multiple
Argument Type Description
Audio Source ID Integer Integer that is the audio source ID.
Source Type Integer 0 = Stereo
1 = Left Channel
2 = Right Channel
Mix Option Integer 0 = Toggle
1 = On
2 = Off
3 = AFV

A list of valid, but not exhaustive, Audio Source IDs on a per-switcher basis is included below.

case input1 = 1
case input2 = 2
case input3 = 3
case input4 = 4
case input5 = 5
case input6 = 6
case input7 = 7
case input8 = 8
case input9 = 9
case input10 = 10
case input11 = 11
case input12 = 12
case input13 = 13
case input14 = 14
case input15 = 15
case input16 = 16
case input17 = 17
case input18 = 18
case input19 = 19
case input20 = 20
case input21 = 21
case input22 = 22
case input23 = 23
case input24 = 24
case input25 = 25
case input26 = 26
case input27 = 27
case input28 = 28
case input29 = 29
case input30 = 30
case input31 = 31
case input32 = 32
case input33 = 33
case input34 = 34
case input35 = 35
case input36 = 36
case input37 = 37
case input38 = 38
case input39 = 39
case input40 = 40
case xlr = 1001
case aesbu = 1101
case rca = 1201
case mic1 = 1301
case mic2 = 1302
case mp1 = 2001
case mp2 = 2002
case mp3 = 2003
case mp4 = 2004
case trs = 1400-1499 (this is a range of TRS inputs)
case madi = 1500-1599 (this is a range of MADI inputs)
case madiEnd = 1600

Fairlight Master Gain Adjust

Increments or decrements the level for master gain.

Message Description Arguments
/mixeffect/fairlight/master-gain/adjust Increments or decrements the level for master gain. Integer
Argument Type Description
Level Float X will raise the gain by that amount (in dB). -Y will lower the gain by that amount.

Note: Duration is currently not supported, so changes to the gain value are set immediately.


Fairlight Master Gain Set

Sets the level for the master gain.

Message Description Arguments
/mixeffect/fairlight/master-gain or /mixeffect/fairlight/master-gain/set Sets the level for the master gain. Integer
Argument Type Description
Level Float The new level in dB.

Note: Duration is currently not supported, so changes to the gain value are set immediately.


Fairlight Reset Peaks

Reset the peaks in the audio section for all inputs and gthe master output.

Message Description Arguments
/mixeffect/fairlight/reset-peaks Reset the peaks in the audio section for all inputs and the master output. None

Fairlight Reset Source Peaks

Reset the peaks in the audio section for an individual audio source.

Message Description Arguments
/mixeffect/fairlight/reset-source-peaks Reset the peaks in the audio section for an individual audio source. Multiple
Argument Type Description
Audio Source ID Integer Integer that is the audio source ID.
Source Type Integer 0 = Stereo
1 = Left Channel
2 = Right Channel
Reset Output Peaks Integer 0 = false
1 = true
Reset Dynamics Input Peaks Integer 0 = false
1 = true
Reset Dynamics Output Peaks Integer 0 = false
1 = true

Macros

Macro Continue

If a macro is running and waiting for user input, this action instructs the switcher to continue running the macro and go to the next step.

Message Description Arguments
/mixeffect/macro/continue If a macro is running and waiting for user input, this action instructs the switcher to continue running the macro and go to the next step. None

Macro Loop

Sets the value or toggles the macro loop value in the switcher.

Message Description Arguments
/mixeffect/macro/loop Sets the value or toggles the macro loop value in the switcher. Integer
Argument Type Description
Loop Integer 0 = Off
1 = On
2 = Toggle

Macro Stop

Stop a macro if it is running, waiting, or recording.

Message Description Arguments
/mixeffect/macro/stop Stop a macro if it is running, waiting, or recording. None

Run Macro

Runs the specified macro.

Message Description Arguments
/mixeffect/macro Runs the specified macro. If the macro does not exist, nothing will happen. Integer
Argument Type Description
Macro Index Integer One-based index of the macro to run.

Mix Effects Bus

Auto

Performs an Auto transition on the selected Mix Effects Bus.

Message Description Arguments
/mixeffect/auto Performs an Auto transition on the selected Mix Effects Bus. Integer
Argument Type Description
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

NOTE: This command is different from the SuperSource Auto command in that it always performs an Auto transition between the Preview and Program source, whereas the SuperSource Auto command performs as Auto transition between Program and SuperSource.


Cut

Performs a Cut transition on the selected Mix Effects Bus.

Message Description Arguments
/mixeffect/cut Performs a Cut transition on the selected Mix Effects Bus. Integer
Argument Type Description
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

NOTE: This command is different from the SuperSource Cut command in that it always performs an Cut transition between the Preview and Program source, whereas the SuperSource Cut command performs as Cut transition between Program and SuperSource.


Fade to Black Auto

Performs a FTB transition on the selected Mix Effect Bus.

Message Description Arguments
/mixeffect/ftb Performs a FTB transition on the selected Mix Effects Bus. Integer
Argument Type Description
M/E Integer 1-based index of the Mix Effects Bus. Default is 1.

Fade to Black Rate

Changes the rate of the FTB transition on the selected Mix Effects Bus.

Message Description Arguments
/mixeffect/ftb/rate Changes the rate of the FTB transition on the selected Mix Effects Bus. Multiple
Argument Type Description
Rate Integer The number of frames from 1 to 250.
M/E Integer 1-based index of the Mix Effects Bus. Default is 1.

Set Preview Input

Sets the video source of the preview input on the selected Mix Effect Bus.

Message Description Arguments
/mixeffect/preview Sets the video source of the preview input on the selected Mix Effect Bus. Multiple
Argument Type Description
Source ID Integer Integer that is the video source ID.
M/E Integer 1-based index of the Mix Effects Bus. Default is 1.

Set Program Input

Sets the video source of the program input on the selected Mix Effect Bus.

Message Description Arguments
/mixeffect/program Sets the video source of the program input on the selected Mix Effect Bus. Multiple
Argument Type Description
Source ID Integer Integer that is the video source ID.
M/E Integer 1-based index of the Mix Effects Bus. Default is 1.

Media Players

Media Player Clip

Sets the clip for the desired media player.

Message Description Arguments
/mixeffect/mp/clip Sets the clip for the desired media player. Multiple
Argument Type Description
Clip Index Integer One-based index of the clip.
Media Player Integer One-based index of the Media Player. Default is 1.

NOTE: In versions of MixEffect prior to 1.2.0, the order of the arguments was reversed.


Media Player Clip Cycle

Cycles through clips in the desired media player.

Message Description Arguments
/mixeffect/mp/clip/cycle Cycles through clips in the desired media player. Integer
Argument Type Description
Media Player Integer One-based index of the Media Player. Default is 1.

Media Player Clip Cycle Reverse

Cycles through clips in the desired media player in reverse order.

Message Description Arguments
/mixeffect/mp/clip/cycle-reverse Cycles through clips in the desired media player in reverse order. Integer
Argument Type Description
Media Player Integer One-based index of the Media Player. Default is 1.

Media Player Still

Sets the still for the desired media player.

Message Description Arguments
/mixeffect/mp/still Sets the still for the desired media player. Multiple
Argument Type Description
Still Index Integer One-based index of the still.
Media Player Integer One-based index of the Media Player. Default is 1.

NOTE: In versions of MixEffect prior to 1.2.0, the order of the arguments was reversed.


Media Player Still Cycle

Cycles through stills in the desired media player.

Message Description Arguments
/mixeffect/mp/still/cycle Cycles through stills in the desired media player. Integer
Argument Type Description
Media Player Integer One-based index of the Media Player. Default is 1.

Media Player Still Cycle Reverse

Cycles through stills in the desired media player in reverse order.

Message Description Arguments
/mixeffect/mp/still/cycle-reverse Cycles through stills in the desired media player in reverse order. Integer
Argument Type Description
Media Player Integer One-based index of the Media Player. Default is 1.

Output

Recording Set Filename

Sets the filename for the recording.

Message Description Arguments
/mixeffect/recording/filename Sets the filename for the recording. String
Argument Type Description
Filename String The filename of the new recording.

Recording Start or Stop

Sets the recording status.

Message Description Arguments
/mixeffect/recording/start-stop Sets the recording status. Integer
Argument Type Description
Status Integer 0 = Stop
1 = Start
2 = Toggle

Recording Switch Disk

Switches recording disks.

Message Description Arguments
/mixeffect/recording/switch-disk Sets the recording status. None

Streaming Set Service

Sets the service, URL, key, and bitrates for streaming from the connected ATEM switcher.

Message Description Arguments
/mixeffect/streaming/service Sets the service, URL, key, and bitrates for streaming from the connected ATEM switcher. Multiple
Argument Type Description
Service Name String The service name.
Server URL String The streaming server URL.
Bitrate 1 Integer Bitrate 1. Typical values are 4500000.
Bitrate 2 Integer Bitrate 2. Typical values are 6000000.

Streaming Start or Stop

Sets the streaming status.

Message Description Arguments
/mixeffect/streaming/start-stop Sets the streaming status. Integer
Argument Type Description
Status Integer 0 = Stop
1 = Start
2 = Toggle

SuperSource

SuperSource Animation Speed

Sets the animation speed for SuperSource transitions.

Message Description Arguments
/mixeffect/ssrc/speed Sets the animation speed for SuperSource transitions. Multiple
Argument Type Description
Speed Integer 0 = Instant
1 = Extra Fast
2 = Fast
3 = Normal
4 = Slow
5 = Extra Slow
SuperSource ID Integer One-based index SuperSource ID. Default is 1

SuperSource Animation Style

Sets the mathematical function used to generate the transition animation.

Message Description Arguments
/mixeffect/ssrc/style Sets the mathematical function used to generate the transition animation. Integer
Argument Type Description
Style Integer 0 = Cosine
1 = Cubed
2 = Inverse Cubed
3 = Inverse Squared
4 = Linear
5 = Sine
6 = Smooth Step
7 = Smoother Step
8 = Squared

SuperSource Art

Sets details about the SuperSource Art for the selected SuperSource.

Message Description Arguments
/mixeffect/ssrc/art Sets details about the SuperSource Art for the selected SuperSource. Multiple
Argument Type Description
Fill Source Integer Integer that is the fill video source ID.
Key Source Integer Integer that is the fill video source ID.
Place In Value Integer 0 = Keep existing
1 = Background
2 = Foreground
3 = Toggle
SuperSource ID Integer Integer that is the one-based index that is the SuperSource ID. Default is 1.

SuperSource Art Border

Sets border details about the SuperSource Art for the selected SuperSource.

Message Description Arguments
/mixeffect/ssrc/art/border Sets border details about the SuperSource Art for the selected SuperSource. Multiple
Argument Type Description
Bevel Style Integer 0 = No Bevel
1 = Bevel In Out
2 = Bevel In
3 = Bevel Out
Border Outer Width Float Float from 0 to 16.0.
Border Inner Width Float Float from 0 to 16.0.
Border Outer Softness Integer Integer from 0 to 100.
Border Inner Softness Integer Integer from 0 to 100.
Border Bevel Softness Integer Integer from 0 to 100.
Border Bevel Position Integer Integer from 0 to 100.
Border Hue Float Float from 0 to 360.0.
Border Saturation Float Float from 0 to 100.0.
Border Luminance Float Float from 0 to 100.0.
Light Source Direction Float Float from 0 to 360.0.
Light Source Altitude Integer Integer from 0 to 100.
SuperSource ID Integer Integer that is the one-based index that is the SuperSource ID. Default is 1.

Note: The following ATEM switchers support this feature: ATEM 2 M/E Production Studio 4K, ATEM 4 M/E Broadcast Studio 4K, and the ATEM Constellation 8K.


SuperSource Art Border Enable

Sets the enabled status of the SuperSource Art Border for the selected SuperSource.

Message Description Arguments
/mixeffect/ssrc/art/border/enable Sets the enabled status of the SuperSource Art Border for the selected SuperSource. Multiple
Argument Type Description
Border Enable Integer 0 = Off
1 = On
2 = Toggle
SuperSource ID Integer Integer that is the one-based index that is the SuperSource ID. Default is 1.

Note: The following ATEM switchers support this feature: ATEM 2 M/E Production Studio 4K, ATEM 4 M/E Broadcast Studio 4K, and the ATEM Constellation 8K.


SuperSource Art Border Parameter Adjust

Adjusts one of the border details about the SuperSource Art for the selected SuperSource.

Message Description Arguments
/mixeffect/ssrc/art/border/parameter/adjust Adjusts one of the border details about the SuperSource Art for the selected SuperSource. Multiple
Argument Type Description
Parameter Integer 0 = Bevel Style
1 = Border Outer Width
2 = Border Inner Width
3 = Border Outer Softness
4 = Border Inner Softness
5 = Border Bevel Softness
6 = Border Bevel Position
7 = Border Hue
8 = Border Saturation
9 = Border Luminance
10 = Light Source Direction
11 = Light Source Altitude
Adjustment Value Float or Integer -X will decrement the current parameter by the adjustment value or Y will increment the current parameter by the adjustment value.
SuperSource ID Integer Integer that is the one-based index that is the SuperSource ID. Default is 1.

Note: The following ATEM switchers support this feature: ATEM 2 M/E Production Studio 4K, ATEM 4 M/E Broadcast Studio 4K, and the ATEM Constellation 8K.


SuperSource Art Border Parameter Set

Sets one of the border details about the SuperSource Art for the selected SuperSource.

Message Description Arguments
/mixeffect/ssrc/art/border/parameter/set Sets one of the border details about the SuperSource Art for the selected SuperSource. Multiple
Argument Type Description
Parameter Integer 0 = Bevel Style
1 = Border Outer Width
2 = Border Inner Width
3 = Border Outer Softness
4 = Border Inner Softness
5 = Border Bevel Softness
6 = Border Bevel Position
7 = Border Hue
8 = Border Saturation
9 = Border Luminance
10 = Light Source Direction
11 = Light Source Altitude
New Value Float or Integer The new value.
SuperSource ID Integer Integer that is the one-based index that is the SuperSource ID. Default is 1.

Note: The following ATEM switchers support this feature: ATEM 2 M/E Production Studio 4K, ATEM 4 M/E Broadcast Studio 4K, and the ATEM Constellation 8K.


SuperSource Art Key

Sets all of the key settings about the SuperSource Art for the selected SuperSource.

Message Description Arguments
/mixeffect/ssrc/art/key Sets all of the key settings about the SuperSource Art for the selected SuperSource. Multiple
Argument Type Description
Pre Multiplied Integer 0 = Off
1 = On
2 = Toggle
Clip Float Value from 0-100.0.
Gain Float Value from 0-100.0
Invert Key Integer 0 = Off
1 = On
2 = Toggle
SuperSource ID Integer Integer that is the one-based index that is the SuperSource ID. Default is 1.

SuperSource Art Key Clip Adjust

Adjusts the Clip setting for the SuperSource Art for the selected SuperSource.

Message Description Arguments
/mixeffect/ssrc/art/key/clip/adjust Adjusts the Clip setting for the SuperSource Art for the selected SuperSource. Multiple
Argument Type Description
Adjustment Value Float -X to decrease the value by a certain amount or Y to increase the value by a certain amount
SuperSource ID Integer Integer that is the one-based index that is the SuperSource ID. Default is 1.

SuperSource Art Key Clip Set

Sets the Clip setting for the SuperSource Art for the selected SuperSource.

Message Description Arguments
/mixeffect/ssrc/art/key/clip/set Sets the Clip setting for the SuperSource Art for the selected SuperSource. Multiple
Argument Type Description
Adjustment Value Float The new value.
SuperSource ID Integer Integer that is the one-based index that is the SuperSource ID. Default is 1.

SuperSource Art Key Clip Gain

Sets Clip and Gain details about the SuperSource Art for the selected SuperSource.

Message Description Arguments
/mixeffect/ssrc/art/key/clip-gain Sets Clip and Gain details about the SuperSource Art for the selected SuperSource. Multiple
Argument Type Description
Clip Float Float from 0 to 100.0.
Gain Float Float from 0 to 100.0.
SuperSource ID Integer Integer that is the one-based index that is the SuperSource ID. Default is 1.

SuperSource Art Key Gain Adjust

Adjusts the Gain setting for the SuperSource Art for the selected SuperSource.

Message Description Arguments
/mixeffect/ssrc/art/key/gain/adjust Adjusts the Gain setting for the SuperSource Art for the selected SuperSource. Multiple
Argument Type Description
Adjustment Value Float -X to decrease the value by a certain amount or Y to increase the value by a certain amount.
SuperSource ID Integer Integer that is the one-based index that is the SuperSource ID. Default is 1.

SuperSource Art Key Gain Set

Set the Gain setting for the SuperSource Art for the selected SuperSource.

Message Description Arguments
/mixeffect/ssrc/art/key/gain/set Set the Gain setting for the SuperSource Art for the selected SuperSource. Multiple
Argument Type Description
Adjustment Value Float The new value.
SuperSource ID Integer Integer that is the one-based index that is the SuperSource ID. Default is 1.

SuperSource Art Key Invert

Sets the Invert Key details about the SuperSource Art for the selected SuperSource.

Message Description Arguments
/mixeffect/ssrc/art/key/invert Sets the Invert Key details about the SuperSource Art for the selected SuperSource. Multiple
Argument Type Description
Invert Key Integer 0 = Off
1 = On
2 = Toggle
SuperSource ID Integer Integer that is the one-based index that is the SuperSource ID. Default is 1.

SuperSource Art Key Pre Multiplied

Sets pre multiplied details about the SuperSource Art for the selected SuperSource.

Message Description Arguments
/mixeffect/ssrc/art/key/pre-multiplied Sets pre multiplied details about the SuperSource Art for the selected SuperSource. Multiple
Argument Type Description
Enable Pre Multiplied Integer 0 = Off
1 = On
2 = Toggle
SuperSource ID Integer Integer that is the one-based index that is the SuperSource ID. Default is 1.

SuperSource Art Place In

Sets the Place In Option setting for the SuperSource Art for the selected SuperSource.

Message Description Arguments
/mixeffect/ssrc/art/place-in Sets the Place In Option setting for the SuperSource Art for the selected SuperSource. Multiple
Argument Type Description
Place In Value Integer 0 = Keep existing
1 = Background
2 = Foreground
3 = Toggle
SuperSource ID Integer Integer that is the one-based index that is the SuperSource ID. Default is 1.

SuperSource Auto

Performs an Auto transition. If SuperSource is not on preview, this function will first set Preview to SuperSource before performing the Auto operation.

Message Description Arguments
/mixeffect/ssrc/auto Performs an Auto transition. If SuperSource is not on preview, this function will first set Preview to SuperSource before performing the Auto operation. Multiple
Argument Type Description
SuperSource ID Integer One-based index of the SuperSource ID. If left blank, it will use the currently selected SuperSource.
M/E Integer One-based index of the Mix Effect Bus. If left blank, it will use the currently selected Mix Effects Bus respectively.

SuperSource Box Crop Adjust

Adjusts the crop value of a specific box by a certain amount.

Message Description Arguments
/mixeffect/ssrc/box/crop/adjust Adjusts the crop value of a specific box by a certain amount. Multiple
Argument Type Description
Box ID Integer 1 = Box 1
2 = Box 2
3 = Box 3
4 = Box 4
Crop Type String top
bottom
left
right
Crop Value Float -X to reduce the crop by a certain amount or Y to increase the crop by a certain amount
SuperSource ID Integer One-based index SuperSource ID. Default is 1

For instance, to adjust the vertical crop of Box 1 by 0.01 each time you press a button, you would enter: 1 top 0.01.

Valid crop top and bottom positions range between 0 and 18. Valid Y positions range between 0 and 32.


SuperSource Box Crop Set

Set the crop value of a specific box.

Message Description Arguments
/mixeffect/ssrc/box/crop or /mixeffect/ssrc/box/crop/set Set the crop value of a specific box. Multiple
Argument Type Description
Box ID Integer 1 = Box 1
2 = Box 2
3 = Box 3
4 = Box 4
Crop Type String top
bottom
left
right
New Value String The new crop value.
SuperSource ID Integer One-based index SuperSource ID. Default is 1

To set Box 2 crop left to be at 7.5, you would enter, 2 7.5 or 0 7.5.

Valid crop top and bottom positions range between 0 and 18. Valid Y positions range between 0 and 32.


SuperSource Box Enable

Sets the enabled status for a SuperSource box.

Message Description Arguments
/mixeffect/ssrc/box/enable Sets the enabled status for a SuperSource box. Multiple
Argument Type Description
Box ID Integer One-based index that is the box id.
Box Enabled Integer 0 = Off
1 = On
2 = Toggle
SuperSource ID Integer Integer that is the one-based index that is the SuperSource ID. Default is 1.

SuperSource Box Position Adjust

Adjusts the X or Y position of a specific box by a certain amount.

Message Description Arguments
/mixeffect/ssrc/box/position/adjust Adjusts the X or Y position of a specific box by a certain amount. Multiple
Argument Type Description
Box ID Integer 1 = Box 1
2 = Box 2
3 = Box 3
4 = Box 4
Movement Type String x
y
Adjustment Value String -X to move the box down/left by a certain amount or Y to move the box up/right the box by a certain amount.
SuperSource ID Integer One-based index SuperSource ID. Default is 1

For instance, to move Box 1 up by 0.01 each time you press a button, you would enter: 1 y 0.01.


SuperSource Box Position Set

Set the X or Y position of a specific box.

Message Description Arguments
/mixeffect/ssrc/box/position or /mixeffect/ssrc/box/position/set Set the X or Y position of a specific box. Multiple
Argument Type Description
Box ID Integer 1 = Box 1
2 = Box 2
3 = Box 3
4 = Box 4
Movement Type String x
y
New Value String The new value.
SuperSource ID Integer One-based index SuperSource ID. Default is 1

To set Box 2 to be at the y position of 0, you would enter, 2 0.

Valid X positions range between -48.0 and 48.0. Valid Y positions range between -27.0 and 27.0.


SuperSource Box Size Adjust

Adjusts the size of a specific box by a certain amount.

Message Description Arguments
/mixeffect/ssrc/box/size/adjust Adjusts the size of a specific box by a certain amount. Multiple
Argument Type Description
Box ID Integer 1 = Box 1
2 = Box 2
3 = Box 3
4 = Box 4
Size Value String -X to shrink the size by a certain amount or Y to enlarge the box by a certain amount.
SuperSource ID Integer One-based index SuperSource ID. Default is 1

For instance, to enlarge Box 1 by 0.005 each time you press a button, you would enter: 1 0.005.


SuperSource Box Size Set

Set the size of a specific box.

Message Description Arguments
/mixeffect/ssrc/box/size or /mixeffect/ssrc/box/size/set Set the size of a specific box. Multiple
Argument Type Description
Box ID Integer 1 = Box 1
2 = Box 2
3 = Box 3
4 = Box 4
New Value Float The new value.
SuperSource ID Integer One-based index SuperSource ID. Default is 1

To set Box 2 to be 0.5 in size, you would enter, 2 0.5 or 0 "0.5".

Valid size values range between 0.07 and 1.0.


SuperSource Box Source

Set the video source for a SuperSource Box.

Message Description Arguments
/mixeffect/ssrc/box/source Set the video source for a SuperSource Box. Multiple
Argument Type Description
Box ID Integer 1 = Box 1
2 = Box 2
3 = Box 3
4 = Box 4
Video Source Integer Video Source ID
SuperSource ID Integer One-based index SuperSource ID. Default is 1

Possible Video Source IDs include:


SuperSource Cascade Presets

Sets the presets for the two SuperSources on ATEM Constellation 8K switchers.

Message Description Arguments
/mixeffect/ssrc/cascade/presets Sets the presets for the two SuperSources on ATEM Constellation 8K switchers. Multiple
Argument Type Description
Preset 1 String Name of preset for SuperSource 1
Preset 2 String Name of preset for SuperSource 2

Run this command to have the transitions for both SuperSources run in tandem rather than sequentially when using the SuperSource Preset command.


SuperSource Cascade

Sets the value for the SuperSource Cascade setting on ATEM Constellation switchers.

Message Description Arguments
/mixeffect/ssrc/cascade Sets the value for the SuperSource Cascade setting on ATEM Constellation switchers. Integer or String
Argument Type Description
Enable Cascade String 0 = Off
1 = On
2 = Toggle

off = Off
on = On
toggle = Toggle

SuperSource Cut

Performs a Cut transition. If SuperSource is not on preview, this function will first set Preview to SuperSource before performing the Cut operation.

Message Description Arguments
/mixeffect/ssrc/cut Performs a Cut transition. If SuperSource is not on preview, this function will first set Preview to SuperSource before performing the Cut operation. Multiple
Argument Type Description
SuperSource ID Integer One-based index of the SuperSource ID. If left blank, it will use the currently selected SuperSource.
M/E Integer One-based index of the Mix Effect Bus. If left blank, it will use the currently selected Mix Effects Bus respectively.

SuperSource Cycle Animation Speed

Cycles through the animation speeds.

Message Description Arguments
/mixeffect/ssrc/box/cycle-speed Cycles through the animation speeds. None

SuperSource Cycle Animation Style

Cycles through the various animation styles.

Message Description Arguments
/mixeffect/ssrc/cycle-style Cycles through the various animation styles. None


SuperSource Grow Highlighted Box By

Sets the value to increase the size of a box when highlighted.

Message Description Arguments
/mixeffect/ssrc/grow-by Sets the value to increase the size of a box when highlighted. Float
Argument Type Description
Grow Amount Float The number to increment the current grow value by. The minimum and maximum value the resulting grow value can be is 0 and 0.5.

SuperSource Grow Highlighted Box

Sets the value to increase the size of a box when highlighted.

Message Description Arguments
/mixeffect/ssrc/grow-to Sets the value to increase the size of a box when highlighted. Float
Argument Type Description
Grow Amount Float A number between 0 and 0.5.

SuperSource Highlight

Highlights a box for the currently selected SuperSource preset.

Message Description Arguments
/mixeffect/ssrc/highlight
/mixeffect/highlight
Highlights a box for the currently selected SuperSource preset. Multiple 
Argument Type Description
Box ID Integer 0 = Reset Preset Layout
1 = Box 1
2 = Box 2
3 = Box 3
4 = Box 4
SuperSource ID Integer One-based index SuperSource ID. Default is 1

A SuperSource preset must be set before you can highlight a box.

Configuring a SuperSource Highlight button in Companion.


SuperSource Next Preset

Sets the next SuperSource preset layout based on the current filtered list of presets in MixEffect.

Message Description Arguments
/mixeffect/ssrc/next Sets the next SuperSource preset layout based on the current filtered list of presets in MixEffect. Integer
Argument Type Description
SuperSource ID Integer One-based index SuperSource ID. Default is 1

SuperSource Preset

Sets the SuperSource Preset for the current switcher.

Message Description Arguments
/mixeffect/ssrc/preset
/mixeffect/preset
Sets the SuperSource Preset for the current switcher. Multiple Arguments
Argument Type Description
Preset Name String The name of the preset in quotes.
SuperSource ID Integer One-based index SuperSource ID. Default is 1

Configuring a SuperSource preset button in Companion.

If you have multiple presets with the same name, the first matching preset will be selected.


SuperSource Previous Preset

Sets the previous SuperSource preset layout based on the current filtered list of presets in MixEffect.

Message Description Arguments
/mixeffect/ssrc/previous Sets the previous SuperSource preset layout based on the current filtered list of presets in MixEffect. Integer
Argument Type Description
SuperSource ID Integer One-based index SuperSource ID. Default is 1

SuperSource Shrink Other Boxes By

Sets the value to decrease the size of the other boxes when a box is highlighted.

Message Description Arguments
/mixeffect/ssrc/shrink-by Sets the value to decrease the size of the other boxes when a box is highlighted. Float
Argument Type Description
Shrink Amount Float The number to decrement the current shrink value. The minimum and maximum value the resulting shrink value must be 0 and 0.5.

SuperSource Shrink Other Boxes

Sets the value to shrink the non-highlighted boxes when a box is highlighted.

Message Description Arguments
/mixeffect/ssrc/shrink-to Sets the value to shrink the non-highlighted boxes when a box is highlighted. Float
Argument Type Description
Shrink Amount Float A number between 0 and 0.5.

SuperSource Swap Boxes

This function will swap the sources of the two boxes within a SuperSource.

Message Description Arguments
/mixeffect/ssrc/swap-boxes This function will swap the sources of the two boxes within a SuperSource. Multiple
Argument Type Description
Box A Integer 1 = Box 1
2 = Box 2
3 = Box 3
4 = Box 4
Box B Integer 1 = Box 1
2 = Box 2
3 = Box 3
4 = Box 4
SuperSource ID Integer One-based index of the SuperSource ID. Default is 1.

SuperSource Swap

If two boxes are visible in a preset layout, this function will swap the sources of the two boxes.

Message Description Arguments
/mixeffect/ssrc/swap If two boxes are visible in a preset layout, this function will swap the sources of the two boxes. Integer
Argument Type Description
SuperSource ID Integer One-based index of the SuperSource ID. Default is 1.

Note: If more than two boxes are visible in a preset, this function does nothing.


Switcher

Set Multiview Layout

Sets the multiview layout for those switchers that support the basic configurable multiview.

Message Description Arguments
/mixeffect/multiview/layout Sets the multiview layout for those switchers that support the basic configurable multiview. Integer
Argument Type Description
Layout ID Integer 4 = Program Bottom
6 = Program Right
11 = Program Left
13 = Program Top

Switchers that support this action include:


Set Multiview Layout Advanced

Sets the multiview layout for those switchers that support the advanced configurable multiview, including:

Message Description Arguments
/mixeffect/multiview/layout-advanced Sets the multiview layout for those switchers that support the advanced configurable multiview. Multiple
Argument Type Description
Layout ID Integer 1 = Default
2 = Top Left Small
3 = Top Right Small
4 = Program Bottom
5 = Bottom Left Small
6 = Program Right
7 = Top Right Small Bottom Left Small
8 = Bottom Right Program
9 = Bottom Right Small
10 = Top Left Small Bottom Right Small
11 = Program Left
12 = Bottom Left Program
13 = Program Top
14 = Top Right Program
15 = Top Left Program
16 = All Small
Multiview ID Integer One-based index of the Multiview. Default is 1.

Switchers that support this action include:


Set Multiview Window

Assigns a video source to a Multiview window.

Message Description Arguments
/mixeffect/multiview/window Assigns a video source to a Multiview window. Multiple
Argument Type Description
Window ID Integer One-based index that is the window id.
Source Integer Video source id.
Multiview ID Integer One-based index of the Multiview. Default is 1.

The sources available to the Multiview are greater than the other Video Source pickers. Look in Switcher Settings > Source Labels > All to see a list of possible values for your switcher.


Startup State Clear

Clears the startup state.

Message Description Arguments
/mixeffect/startup/clear Clears the startup state. None

Startup State Save

Save the current startup start

Message Description Arguments
/mixeffect/startup/save Saves the startup state. None

Transitions

Transition Dip

Sets the rate and source for the Dip transition.

Message Description Arguments
/mixeffect/transition/dip Sets the rate and source for the Dip transition. Multiple
Argument Type Description
Rate Integer The number of frames from 1 to 250.
Source Integer Video source id for the Dip transition.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

Transition Dip Source

Sets the source only for the Dip transition.

Message Description Arguments
/mixeffect/transition/dip/source Sets the source only for the Dip transition. Multiple
Argument Type Description
Source Integer Video source id for the Dip transition.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

Transition DVE

Adjusts settings for the DVE transition.

Message Description Arguments
/mixeffect/transition/dve Adjusts settings for the DVE transition. Multiple
Argument Type Description
Rate Integer The number of frames from 1 to 250.
Style Integer Integer from 0-34. Not all ATEM switchers support all of these DVE Effect Styles.

0. Swoosh Top Left
1. Swoosh Top
2. Swoosh Top Right
3. Swoosh Left
4. Swoosh Right
5. Swoosh Bottom Left
6. Swoosh Bottom
7. Swoosh Bottom Right
8. Spin CCW Top Right
9. Spin CW Top Left
10. Spin CCW Bottom Right
11. Spin CW Bottom Left
12. Spin CW Top Right
13. Spin CCW Top Left
14. Spin CW Bottom Right
15. Spin CCW Bottom Left
16. Squeeze Top Left
17. Squeeze Top
18. Squeeze Top Right
19. Squeeze Left
20. Squeeze Right
21. Squeeze Bottom Left
22. Squeeze Bottom
23. Squeeze Bottom Right
24. Push Top Left
25. Push Top
26. Push Top Right
27. Push Left
28. Push Right
29. Push Bottom Left
30. Push Bottom
31. Push Bottom Right
32. Graphic CW Spin
33. Graphic CCW Spin
34. Graphic Logo Wipe
Fill Source Integer Video source id for the fill source.
Key Source Integer Video source id for the key source.
Enable Key Integer 0 = Off
1 = On
2 = Toggle
Pre Multiplied Integer 0 = Off
1 = On
2 = Toggle
Clip Float Float from 0 to 100.0
Gain Float Float from 0 to 100.0
Invert Key Integer 0 = Off
1 = On
2 = Toggle
Reverse Integer 0 = Off
1 = On
2 = Toggle
Flip Flop Integer 0 = Off
1 = On
2 = Toggle
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

Transition DVE Flip Flop

Adjusts the Flip Flop setting for the DVE transition.

Message Description Arguments
/mixeffect/transition/dve/flip-flop Adjusts the Flip Flop setting for the DVE transition. Multiple
Argument Type Description
Flip Flop Integer 0 = Off
1 = On
2 = Toggle
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

Transition DVE Inputs

Sets the inputs for the Transition DVE.

Message Description Arguments
/mixeffect/transition/dve/inputs Sets the inputs for the Transition DVE. Multiple
Argument Type Description
Fill Source Integer Video Source ID for the Fill Source
Key Source Integer Video Source ID for the Key Source
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

Transition DVE Key

Adjusts all of the key settings for the DVE transition.

Message Description Arguments
/mixeffect/transition/dve/key Sets all of the key settings for the DVE transition. Multiple
Argument Type Description
Pre Multiplied Integer 0 = Off
1 = On
2 = Toggle
Clip Float Value from 0-100.0.
Gain Float Value from 0-100.0
Invert Key Integer 0 = Off
1 = On
2 = Toggle
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

Transition DVE Key Clip Adjust

Adjusts the Clip settings for the DVE transition.

Message Description Arguments
/mixeffect/transition/dve/key/clip/adjust Adjusts the Clip setting for the DVE transition. Multiple
Argument Type Description
Adjustment Value Float -X to decrease the value by a certain amount or Y to increase the value by a certain amount
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

Transition DVE Key Clip Set

Sets the Clip settings for the DVE transition.

Message Description Arguments
/mixeffect/transition/dve/key/clip/set Sets the Clip setting for the DVE transition. Multiple
Argument Type Description
Adjustment Value Float The new value.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

Transition DVE Key Clip Gain

Adjusts the Clip and Gain settings for the DVE transition.

Message Description Arguments
/mixeffect/transition/dve/key/clip-gain Adjusts the Clip and Gain settings for the DVE transition. Multiple
Argument Type Description
Clip Float Float from 0 to 100.0
Gain Float Float from 0 to 100.0
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

Transition DVE Key Gain Adjust

Adjusts the Gain settings for the DVE transition.

Message Description Arguments
/mixeffect/transition/dve/key/gain/adjust Adjusts the Gain setting for the DVE transition. Multiple
Argument Type Description
Adjustment Value Float -X to decrease the value by a certain amount or Y to increase the value by a certain amount.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

Transition DVE Key Gain Set

Sets the Gain settings for the DVE transition.

Message Description Arguments
/mixeffect/transition/dve/key/gain/set Sets the Gain setting for the DVE transition. Multiple
Argument Type Description
Adjustment Value Float The new value.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

Transition DVE Key Enable

Adjusts the Enable Key setting for the DVE transition. This is used with the Graphic Logo DVE style.

Message Description Arguments
/mixeffect/transition/dve/key/enable Adjusts the Enable Key setting for the DVE transition. This is used with the Graphic Logo DVE style. Multiple
Argument Type Description
Enable Key Integer 0 = Off
1 = On
2 = Toggle
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

Transition DVE Key Invert

Adjusts the Invert Key setting for the DVE transition

Message Description Arguments
/mixeffect/transition/dve/key/invert Adjusts the Invert Key setting for the DVE transition. Multiple
Argument Type Description
Invert Key Integer 0 = Off
1 = On
2 = Toggle
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

Transition DVE Key Pre Multiplied

Adjusts Pre Multiplied setting for the DVE transition. The Enable Key value must be set to On for this command to be recognized.

Message Description Arguments
/mixeffect/transition/dve/key/pre-multiplied Adjusts Pre Multiplied setting for the DVE transition. The Enable Key value must be set to On for this command to be recognized. Multiple
Argument Type Description
Pre Multiplied Integer 0 = Off
1 = On
2 = Toggle
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

Transition DVE Reverse

Adjusts the Reverse setting for the DVE transition.

Message Description Arguments
/mixeffect/transition/dve/reverse Adjusts the Reverse setting for the DVE transition. Multiple
Argument Type Description
Reverse Integer 0 = Off
1 = On
2 = Toggle
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

Transition DVE Style

Adjusts the style for the DVE transition.

Message Description Arguments
/mixeffect/transition/dve/style Adjusts the style for the DVE transition. Multiple
Argument Type Description
Style Integer Integer from 0-34. Not all ATEM switchers support all of these DVE Effect Styles.

0. Swoosh Top Left
1. Swoosh Top
2. Swoosh Top Right
3. Swoosh Left
4. Swoosh Right
5. Swoosh Bottom Left
6. Swoosh Bottom
7. Swoosh Bottom Right
8. Spin CCW Top Right
9. Spin CW Top Left
10. Spin CCW Bottom Right
11. Spin CW Bottom Left
12. Spin CW Top Right
13. Spin CCW Top Left
14. Spin CW Bottom Right
15. Spin CCW Bottom Left
16. Squeeze Top Left
17. Squeeze Top
18. Squeeze Top Right
19. Squeeze Left
20. Squeeze Right
21. Squeeze Bottom Left
22. Squeeze Bottom
23. Squeeze Bottom Right
24. Push Top Left
25. Push Top
26. Push Top Right
27. Push Left
28. Push Right
29. Push Bottom Left
30. Push Bottom
31. Push Bottom Right
32. Graphic CW Spin
33. Graphic CCW Spin
34. Graphic Logo Wipe
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

Transition DVE Style Cycle

Goes to the next or previous style for the DVE transition.

Message Description Arguments
/mixeffect/transition/dve/style/cycle Goes to the next or previous style for the DVE transition. Multiple
Argument Type Description
Reverse Boolean 0 = False
1 = True
Default is 0
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

Transition Mix

Sets the rate for the Mix transition.

Message Description Arguments
/mixeffect/transition/mix Sets the rate for the Mix transition. Multiple
Argument Type Description
Rate Integer The number of frames from 1 to 250.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

Transition Next

Sets the Background and Key buttons for the next transition.

Message Description Arguments
/mixeffect/transition/next Sets the Background and Key buttons for the next transition. Multiple
Argument Type Description
Key Integer 0 = Background
1 = Key 1
2 = Key 2
3 = Key 3
4 = Key 4
Key Value Integer 0 = Off
1 = On
2 = Toggle
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

Transition Preview

Sets the transition preview setting in the selected Mix Effect Bus.

Message Description Arguments
/mixeffect/transition/preview Sets the transition preview setting in the selected Mix Effect Bus. Multiple
Argument Type Description
Preview Integer 0 = Off
1 = On
2 = Toggle
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

Transition Rate

Changes the rate of a transition.

Message Description Arguments
/mixeffect/transition/rate Changes the rate of a transition. Multiple
Argument Type Description
Style Integer 0 = Mix
1 = Dip
2 = Wipe
4 = DVE
4 = Sting
Rate Integer The number of frames from 1 to 250.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

Transition Style

Changes the style of a transition for the selected Mix Effect Bus.

Message Description Arguments
/mixeffect/transition/style Changes the style of a transition for the selected Mix Effect Bus. Multiple
Argument Type Description
Style Integer 0 = Mix
1 = Dip
2 = Wipe
4 = DVE
4 = Sting
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

Transition Wipe

Adjusts settings for the Wipe transition.

Note: There’s a bug in MixEffect 1.2.2 where the width setting is off by a factor of 10. So, entering 50.0 will change the setting to 5. This will be fixed in the next release of MixEffect.

Message Description Arguments
/mixeffect/transition/wipe Adjusts settings for the Wipe transition. Multiple
Argument Type Description
Rate Integer The number of frames from 1 to 250.
Pattern Integer 0 = Left To Right Bar
1 = Top To BottomBar
2 = Horizontal Barn Door
3. Vertical Barn Door
4 = Corners In Four Box
5 = Rectangle Iris
6 = Diamond Iris
7 = Circle Iris
8 = Top Left Box
9 = Top Right Box
10 = Bottom Right Box
11 = Bottom Left Box
12 = Top Center Box
13 = Right Center Box
14 = Bottom Center Box
15 = Left Center Box
16 = Top Left Diagonal
17 = Top Right Diagonal
Width Float Float from 0 to 100.0.
Fill Source Integer Video Source ID
Symmetry Float Float from 0 to 100.0.
Softness Float Float from 0 to 100.0.
Position X Float Float from 0 to 1.0000.
Position Y Float Float from 0 to 1.0000.
Reverse Integer 0 = Off
1 = On
2 = Toggle
Flip Flop Integer 0 = Off
1 = On
2 = Toggle
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

Transition Wipe Border

Adjusts Border settings for the Wipe transition.

Message Description Arguments
/mixeffect/transition/wipe/border Adjusts Border settings for the Wipe transition. Multiple
Argument Type Description  
Width Float Float from 0 to 100.0. .
Softness Float Float from 0 to 100.0.  
M/E Integer One-based index of the Mix Effect Bus. Default is 1.  

Transition Wipe Border Parameter Adjust

Adjusts either the border softness or border width parameter for the Wipe Transition.

Message Description Arguments
/mixeffect/transition/wipe/border/parameter/adjust Adjusts either the border softness or border width parameter for the Wipe Transition. Multiple
Argument Type Description
Parameter Integer 0 = Softness
1 = Width
Adjustment Value Float -X to decrement the current value or Y to increment the current value by the adjustment value.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

Transition Wipe Border Parameter Set

Sets either the border softness or border width parameter for the Wipe Transition.

Message Description Arguments
/mixeffect/transition/wipe/border/parameter/set Sets either the border softness or border width parameter for the Wipe Transition. Multiple
Argument Type Description
Parameter Integer 0 = Softness
1 = Width
Adjustment Value Float The new value.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

Transition Wipe Flip Flop

Adjusts the Flip Flop settings for the Wipe transition.

Message Description Arguments
/mixeffect/transition/wipe/flip-flop Adjusts the Flip Flop settings for the Wipe transition. Multiple
Argument Type Description
Flip Flop Integer 0 = Off
1 = On
2 = Toggle
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

Transition Wipe Pattern

Adjusts pattern setting for the Wipe transition

Message Description Arguments
/mixeffect/transition/wipe/pattern Adjusts pattern setting for the Wipe transition. Multiple
Argument Type Description
Pattern Integer 0 = Left To Right Bar
1 = Top To BottomBar
2 = Horizontal Barn Door
3. Vertical Barn Door
4 = Corners In Four Box
5 = Rectangle Iris
6 = Diamond Iris
7 = Circle Iris
8 = Top Left Box
9 = Top Right Box
10 = Bottom Right Box
11 = Bottom Left Box
12 = Top Center Box
13 = Right Center Box
14 = Bottom Center Box
15 = Left Center Box
16 = Top Left Diagonal
17 = Top Right Diagonal
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

Transition Wipe Pattern Cycle

Chooses the next or previous pattern setting for the Wipe transition.

Message Description Arguments
/mixeffect/transition/wipe/pattern/cycle Chooses the next or previous pattern setting for the Wipe transition. Multiple
Argument Type Description
Reverse Boolean 0 = False
1 = True
Default is 0
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

Transition Wipe Position

Sets the Position values for the selected for the Wipe transition pattern.

Message Description Arguments
/mixeffect/transition/wipe/position Sets the position values for the Wipe transition. Multiple
Argument Type Description
Position X Float Float from 0 to 1.0000.
Position Y Float Float from 0 to 1.0000.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

Transition Wipe Position Adjust

Adjusts either the X or Y Position value for the selected for the Wipe transition pattern.

Message Description Arguments
/mixeffect/transition/wipe/position/adjust Adjusts either the X or Y Position value for the selected for the Wipe transition pattern. Multiple
Argument Type Description
Position String x
y
Adjustment Value Float -X to decrement the current value or Y to increment the current value by the adjustment value.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

Transition Wipe Position Set

Sets either the X or Y Position value for the selected for the Wipe transition pattern.

Message Description Arguments
/mixeffect/transition/wipe/position/set Sets either the X or Y Position value for the selected for the Wipe transition pattern. Multiple

| Argument | Type | Description | | ————- | ————- | ————- | | Position | String | x
y | | Adjustment Value | Float | The new value. | | M/E | Integer | One-based index of the Mix Effect Bus. Default is 1. | ***

Transition Wipe Reverse

Adjusts the Reverse settings for the Wipe transition.

Message Description Arguments
/mixeffect/transition/wipe/reverse Adjusts the Reverse settings for the Wipe transition. Multiple
Argument Type Description
Reverse Integer 0 = Off
1 = On
2 = Toggle
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

Transition Wipe Source

Adjusts the source for the Wipe transition

Message Description Arguments
/mixeffect/transition/wipe/source Adjusts source for the Wipe transition. Multiple
Argument Type Description
Fill Source Integer Video Source ID
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

Transition Wipe Symmetry

Adjusts Symmetry value for the selected for the Wipe transition pattern.

Message Description Arguments
/mixeffect/transition/wipe/symmetry Adjusts Symmetry value for the selected for the Wipe transition pattern. Multiple
Argument Type Description
Symmetry Float Float from 0 to 100.0.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

Transition Wipe Symmetry Adjust

Adjusts the Symmetry value for the selected for the Wipe transition pattern.

Message Description Arguments
/mixeffect/transition/wipe/symmetry/adjust Adjusts the Symmetry value for the selected for the Wipe transition pattern. Multiple
Argument Type Description
Adjustment Value Float -X to decrement the current value or Y to increment the current value by the adjustment value.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

Upstream Keyers

USK Chroma

Sets the Chroma upstream keyer. This is available on certain, older ATEM switchers such as the ATEM 1 M/E Production Studio 4K, ATEM Television Studio HD, and the ATEM 4 M/E Broadcast Studio 4K.

Message Description Arguments
/mixeffect/usk/chroma Sets the Chroma upstream keyer. This is available on certain, older ATEM switchers such as the ATEM 1 M/E Production Studio 4K, ATEM Television Studio HD, and the ATEM 4 M/E Broadcast Studio 4K. Multiple
Argument Type Description
Hue Float Float from 0 to 360.0.
Gain Float Float from 0 to 100.0.
ySuppress Float Float from 0 to 100.0.
Lift Float Float from 0 to 100.0.
Narrow Integer 0 = False
1 = True
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK Chroma Advanced

Sets the Chroma Advanced upstream keyer. This is available on certain ATEM switchers such as the ATEM Mini line, ATEM Television Studio Pro 4K, and the ATEM Constellation 8K.

Message Description Arguments
/mixeffect/usk/chroma-advanced Sets the Chroma Advanced upstream keyer. This is available on certain ATEM switchers such as the ATEM Mini line, ATEM Television Studio Pro 4K, and the ATEM Constellation 8K. Multiple
Argument Type Description
Foreground Level Float Float from 0 to 100.0.
Background Level Float Float from 0 to 100.0.
Key Edge Float Float from 0 to 100.0.
Spill Suppression Float Float from 0 to 100.0.
Flare Suppression Float Float from 0 to 100.0.
Brightness Float Float from -100.0 to 100.0.
Contrast Float Float from -100.0 to 100.0.
Saturation Float Float from 0 to 100.0.
Red Float Float from -100.0 to 100.0.
Green Float Float from -100.0 to 100.0.
Blue Float Float from -100.0 to 100.0.
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK Chroma Advanced Parameter Adjust

Adjust a single the Chroma Advanced upstream keyer parameter. This is available on certain ATEM switchers such as the ATEM Mini line, ATEM Television Studio Pro 4K, and the ATEM Constellation 8K.

Message Description Arguments
/mixeffect/usk/chroma-advanced/parameter/adjust Adjust a single the Chroma Advanced upstream keyer parameter. This is available on certain ATEM switchers such as the ATEM Mini line, ATEM Television Studio Pro 4K, and the ATEM Constellation 8K. Multiple
Argument Type Description
Parameter Integer 0 = Foreground Level
1 = Background Level
2 = Key Edge
3 = Spill Suppression
4 = Flare Suppression
5 = Brightness
6 = Contrast
7 = Saturation
8 = Red
9 = Green
10 = Blue
Adjustment Value Float -X to decrement the current value or Y to increment the current value.
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK Chroma Advanced Parameter Set

Sets a single the Chroma Advanced upstream keyer parameter. This is available on certain ATEM switchers such as the ATEM Mini line, ATEM Television Studio Pro 4K, and the ATEM Constellation 8K.

Message Description Arguments
/mixeffect/usk/chroma-advanced/parameter/set Sets a single the Chroma Advanced upstream keyer parameter. This is available on certain ATEM switchers such as the ATEM Mini line, ATEM Television Studio Pro 4K, and the ATEM Constellation 8K. Multiple
Argument Type Description
Parameter Integer 0 = Foreground Level
1 = Background Level
2 = Key Edge
3 = Spill Suppression
4 = Flare Suppression
5 = Brightness
6 = Contrast
7 = Saturation
8 = Red
9 = Green
10 = Blue
New Value Float The new value.
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK Chroma Advanced Sample

Sets the Chroma Advanced Sample for the upstream keyer. This is available on certain ATEM switchers such as the ATEM Mini line, ATEM Television Studio Pro 4K, and the ATEM Constellation 8K.

Message Description Arguments
/mixeffect/usk/chroma-advanced/sample Sets the Chroma Advanced Sample for the upstream keyer. This is available on certain ATEM switchers such as the ATEM Mini line, ATEM Television Studio Pro 4K, and the ATEM Constellation 8K. Multiple
Argument Type Description
Sample Y Integer Integer from 0 to 255.
Sample Cb Integer Integer from 0 to 255.
Sample Cr Integer Integer from 0 to 255.
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK DVE Border

Sets the border settings for the DVE upstream keyer.

Message Description Arguments
/mixeffect/usk/dve/border Sets the border settings for the DVE upstream keyer. Multiple
Argument Type Description
Enabled Integer 0 = Off
1 = On
2 = Toggle
Bevel Style Integer 0 = No Bevel
1 = Bevel In Out
2 = Bevel In
3 = Bevel Out
Border Outer Width Float Float from 0 to 16.0.
Border Inner Width Float Float from 0 to 16.0.
Border Outer Softness Integer Integer from 0 to 100.
Border Inner Softness Integer Integer from 0 to 100.
Border Bevel Position Integer Integer from 0 to 100.
Border Opacity Integer Integer from 0 to 100.
Border Hue Float Float from 0 to 360.0.
Border Saturation Float Float from 0 to 100.0.
Border Luminance Float Float from 0 to 100.0.
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK DVE Border Enable

Sets the enabled state of the border for the DVE upstream keyer.

Message Description Arguments
/mixeffect/usk/dve/border/enable Sets the enabled state of the border for the DVE upstream keyer. Multiple
Argument Type Description
Enabled Integer 0 = Off
1 = On
2 = Toggle
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK DVE Border Parameter Adjust

Adjusts a single border parameter for the DVE upstream keyer.

Message Description Arguments
/mixeffect/usk/dve/border/parameter/adjust Adjusts a single border parameter for the DVE upstream keyer. Multiple
Argument Type Description
Parameter Integer 0 = Border Bevel Style
1 = Border Outer Width
2 = Border Inner Width
3 = Border Outer Softness
4 = Border Inner Softness
5 = Border Bevel Softness
6 = Border Bevel Position
7 = Border Opacity
8 = Hue
9 = Saturation
10 = Luminance
Adjustment Value Float or Integer -X to reduce the current parameter by a certain amount or Y to increase the current parameter by a certain amount.
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK DVE Border Parameter Set

Sets a single border parameter for the DVE upstream keyer.

Message Description Arguments
/mixeffect/usk/dve/border/parameter/set Sets a single border parameter for the DVE upstream keyer. Multiple
Argument Type Description
Parameter Integer 0 = Border Bevel Style
1 = Border Outer Width
2 = Border Inner Width
3 = Border Outer Softness
4 = Border Inner Softness
5 = Border Bevel Softness
6 = Border Bevel Position
7 = Border Opacity
8 = Hue
9 = Saturation
10 = Luminance
New Value Float or Integer The new value.
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK DVE Mask Adjust

Adjusts a single mask parameter for the DVE upstream keyer.

Message Description Arguments
/mixeffect/usk/dve/mask/adjust Adjusts a single mask parameter for the DVE upstream keyer. Multiple
Argument Type Description
Mask Parameter String top
bottom
left
right
Adjustment Value Float -X to reduce the current mask parameter setting by a certain amount or Y to increase the mask parameter setting by a certain amount.
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

Note: If you want to adjust an individual mask setting for the Luma, Chroma, or Pattern upstream keyers, use the USK Mask Adjust action.


USK DVE Mask Set

Sets a single mask parameter for the DVE upstream keyer.

Message Description Arguments
/mixeffect/usk/dve/mask/set Sets a single mask parameter for the DVE upstream keyer. Multiple
Argument Type Description
Mask Parameter String top
bottom
left
right
New Value Float The new value.
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

Note: If you want to adjust an individual mask setting for the Luma, Chroma, or Pattern upstream keyers, use the USK Mask Adjust action.


USK DVE Mask

Sets the Top, Bottom, Left, and Right mask values for the DVE upstream keyer.

Message Description Arguments
/mixeffect/usk/dve/mask Sets the Top, Bottom, Left, and Right mask values for the DVE upstream keyer. Multiple
Argument Type Description
Top Float Float from 0 to 38.0
Bottom Float Float from 0 to 38.0
Left Float Float from 0 to 52.0
Right Float Float from 0 to 52.0
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

Note: If you want to set the mask for the Luma, Chroma, or Pattern upstream keyers, use the USK Mask action.


USK DVE Position Adjust

Adjusts either the X or Y position of the DVE for an upstream keyer.

Message Description Arguments
/mixeffect/usk/dve/position/adjust Adjusts either the X or Y position of the DVE for an upstream keyer. Multiple
Argument Type Description
Position String x
y
Adjustment Value Float -X to decrease the position parameter by a certain amount or Y to increase the position parameter by a certain amount
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK DVE Position Set

Sets either the X or Y position of the DVE for an upstream keyer.

Message Description Arguments
/mixeffect/usk/dve/position/set Sets either the X or Y position of the DVE for an upstream keyer. Multiple
Argument Type Description
Position String x
y
New Value Float The new value.
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK DVE Position

Sets the X and Y position values for the DVE upstream keyer.

Message Description Arguments
/mixeffect/usk/dve/position Sets the X and Y position values for the DVE upstream keyer. Multiple
Argument Type Description
Position X Float Float from -1000.0 to 1000.0.
Position Y Float Float from -1000.0 to 1000.0.
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK DVE Position Set

Sets the X or Y position values for the DVE upstream keyer.

Message Description Arguments
/mixeffect/usk/dve/position/set Sets the X or Y position of the DVE for an upstream keyer. Multiple
Argument Type Description
Position String x
y
Adjustment Value String The new position
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK DVE Rotation

Sets the rotation value for the DVE upstream keyer.

Message Description Arguments
/mixeffect/usk/dve/rotation Sets the rotation value for the DVE upstream keyer. Multiple
Argument Type Description
Rotation Float Float from 0 to 360.0.
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

Note: Not all switchers support rotating the DVE.


USK DVE Rotation Adjust

Adjusts the rotation value for the DVE upstream keyer.

Message Description Arguments
/mixeffect/usk/dve/rotation/adjust Adjusts the rotation value for the DVE upstream keyer. Multiple
Argument Type Description
Adjustment Value Float -X to decrease the rotation parameter by a certain amount or Y to increase the rotation parameter by a certain amount.
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

Note: Not all switchers support rotating the DVE.


USK DVE Size Adjust

Adjusts the DVE x and y size by a set amount for an upstream keyer.

Message Description Arguments
/mixeffect/usk/dve/size/adjust Adjusts the DVE x and y size by a set amount for an upstream keyer. Multiple
Argument Type Description
Size Type String x
y.
Adjustment Value Float -X to decrease the size parameter by a certain amount or Y to increase the size parameter by a certain amount.
Constrain Integer 0 = False
1 = True
Default is 0
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK DVE Size Set

Sets the DVE x or y size parameter for an upstream keyer.

Message Description Arguments
/mixeffect/usk/dve/size/set Sets the DVE x or y size parameter for an upstream keyer. Multiple
Argument Type Description
Size Type String x
y.
New Value Float The value to set.
Constrain Integer 0 = False
1 = True
Default is 0
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK DVE Size

Sets the size values for the DVE upstream keyer.

Message Description Arguments
/mixeffect/usk/dve/size Sets the size values for the DVE upstream keyer. Multiple
Argument Type Description
Size X Float Float from 0 to 99.89.
Size Y Float Float from 0 to 99.89.
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK DVE Size Position Rotation

Sets the size, position, and rotation values for the DVE upstream keyer.

Message Description Arguments
/mixeffect/usk/dve/size-position-rotation Sets the size, position, and rotation values for the DVE upstream keyer. Multiple
Argument Type Description
Size X Float Float from 0 to 99.89.
Size Y Float Float from 0 to 99.89.
Position X Float Float from -1000.0 to 1000.0.
Position Y Float Float from -1000.0 to 1000.0.
Rotation Float Float from 0 to 360.0.
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

Note: Not all switchers support rotating the DVE.


USK DVE Mask Enable

Sets the enabled setting for mask for the DVE upstream keyer.

Message Description Arguments
/mixeffect/usk/dve/mask/enable Sets the enabled setting for mask for the DVE upstream keyer. Multiple
Argument Type Description
Enable Mask Integer 0 = Off
1 = On
2 = Toggle
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

Note: If you want to set the enable mask for the Luma, Chroma, or Pattern upstream keyers, use the USK Mask Enable action.


USK DVE Shadow

Sets the shadow settings for the DVE upstream keyer.

Message Description Arguments
/mixeffect/usk/dve/shadow Sets the shadow settings for the DVE upstream keyer. Multiple
Argument Type Description
Light Source Direction Integer Float from 0 to 360
Light Source Altitude Integer Integer from 0 to 100.
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK DVE Shadow Parameter Adjust

Adjusts either the Angle or Altitude shadow setting for the DVE upstream keyer.

Message Description Arguments
/mixeffect/usk/dve/shadow/parameter/adjust Adjusts either the Angle or Altitude shadow setting for the DVE upstream keyer. Multiple
Argument Type Description
Parameter Integer 0 = Angle
1 = Altitude
Adjustment Value Integer -X to decrease the value by a certain amount, Y to increase the value by a certain amount.
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK DVE Shadow Enable

Sets the enabled state of the shadow for the DVE upstream keyer.

Message Description Arguments
/mixeffect/usk/dve/shadow/enable Sets the enabled state of the shadow for the DVE upstream keyer. Multiple
Argument Type Description
Enable Shadow Integer 0 = Off
1 = On
2 = Toggle
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK DVE Shadow Parameter Set

Sets either the Angle or Altitude shadow setting for the DVE upstream keyer.

Message Description Arguments
/mixeffect/usk/dve/shadow/parameter/set Sets either the Angle or Altitude shadow setting for the DVE upstream keyer. Multiple
Argument Type Description
Parameter Integer 0 = Angle
1 = Altitude
New Value Integer The new value.
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK Luma Key

Sets the all of the key settings for the Luma upstream keyer.

Message Description Arguments
/mixeffect/usk/luma/key Sets the all of the key settings for the Luma upstream keyer. Multiple
Argument Type Description
Pre Multiplied Integer 0 = Off
1 = On
2 = Toggle
Clip Float Value from 0-100.0.
Gain Float Value from 0-100.0
Invert Key Integer 0 = Off
1 = On
2 = Toggle
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK Luma Key Clip Adjust

Adjust the Clip settings for the Luma upstream keyer.

Message Description Arguments
/mixeffect/usk/luma/key/clip/adjust Adjust the Clip setting for the Luma upstream keyer. Multiple
Argument Type Description
Adjustment Value Float -X to decrease the value by a certain amount, Y to increase the value by a certain amount.
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK Luma Key Clip Set

Sets the Clip settings for the Luma upstream keyer.

Message Description Arguments
/mixeffect/usk/luma/key/clip/set Sets the Clip setting for the Luma upstream keyer. Multiple
Argument Type Description
New Value Float The new value.
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK Luma Key Clip Gain

Sets the Clip and Gain settings for the Luma upstream keyer.

Message Description Arguments
/mixeffect/usk/luma/key/clip-gain Sets the Clip and Gain settings for the Luma upstream keyer. Multiple
Argument Type Description
Clip Float Float from 0 to 100.0
Gain Float Float from 0 to 100.0
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK Luma Key Gain Adjust

Adjust the Gain setting for the Luma upstream keyer.

Message Description Arguments
/mixeffect/usk/luma/key/gain/adjust Adjust the Gain setting for the Luma upstream keyer. Multiple
Argument Type Description
Adjustment Value Float -X to decrease the value by a certain amount, Y to increase the value by a certain amount
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK Luma Key Gain Set

Sets the Gain settings for the Luma upstream keyer.

Message Description Arguments
/mixeffect/usk/luma/key/gain/set Sets the Gain setting for the Luma upstream keyer. Multiple
Argument Type Description
New Value Float The new value.
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK Luma Key Invert

Sets the Invert Key setting for the Luma upstream keyer.

Message Description Arguments
/mixeffect/usk/luma/key/invert Sets the Invert Key setting for the Luma upstream keyer. Multiple
Argument Type Description
Invert Key Integer 0 = Off
1 = On
2 = Toggle
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK Luma Key Pre Multiplied

Sets the Pre Multiplied setting for the Luma upstream keyer.

Message Description Arguments
/mixeffect/usk/luma/key/pre-multiplied Sets the Pre Multiplied setting for the Luma upstream keyer. Multiple
Argument Type Description
Enable Pre Multiplied Integer 0 = Off
1 = On
2 = Toggle
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK Mask

Sets the mask for the Luma, Chroma, or Pattern upstream keyer.

Message Description Arguments
/mixeffect/usk/mask Sets the mask for the Luma, Chroma, or Pattern upstream keyer. Multiple
Argument Type Description
Top Float Float from -9.0 to 9.0
Bottom Float Float from -9.0 to 9.0
Left Float Float from -16.0 to 16.0
Right Float Float from -16.0 to 16.0
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

Note: If you want to set the mask for the DVE upstream keyer, use the USK DVE Mask action.


USK Mask Adjust

Adjusts a single mask parameter for the Luma, Chroma, or Pattern upstream keyer.

Message Description Arguments
/mixeffect/usk/mask/adjust Adjusts a single mask parameter for the Luma, Chroma, or Pattern upstream keyer. Multiple
Argument Type Description
Mask Parameter String top
bottom
left
right
Adjustment Value Float -X to reduce the current mask parameter setting by a certain amount or Y to increase the mask parameter setting by a certain amount
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

Note: If you want to adjust an individual mask setting for the DVE upstream keyer, use the USK DVE Mask Adjust action.


USK Mask Enable

Turns on, off, or toggles the mask for the upstream keyer.

Message Description Arguments
/mixeffect/usk/mask/enable Turns on, off, or toggles the mask for the upstream keyer. Multiple
Argument Type Description
Enabled Integer 0 = Off
1 = On
2 = Toggle
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

Note: If you want to set the mask enable setting for the DVE upstream keyer, use the USK DVE Mask Enable action.


USK Mask Set

Sets a single mask parameter for the Luma, Chroma, or Pattern upstream keyer.

Message Description Arguments
/mixeffect/usk/mask/set Sets a single mask parameter for the Luma, Chroma, or Pattern upstream keyer. Multiple
Argument Type Description
Mask Parameter String top
bottom
left
right
New Value Value Float The new value.
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

Note: If you want to adjust an individual mask setting for the DVE upstream keyer, use the USK DVE Mask Adjust action.


USK Pattern

Sets all the settings for the Pattern upstream keyer.

Message Description Arguments
/mixeffect/usk/pattern Sets all the settings for the Pattern upstream keyer. Multiple
Argument Type Description
Pattern Integer 0 = Left To Right Bar
1 = Top To BottomBar
2 = Horizontal Barn Door
3 = Vertical Barn Door
4 = Corners In Four Box
5 = Rectangle Iris
6 = Diamond Iris
7 = Circle Iris
8 = Top Left Box
9 = Top Right Box
10 = Bottom Right Box
11 = Bottom Left Box
12 = Top Center Box
13 = Right Center Box
14 = Bottom Center Box
15 = Left Center Box
16 = Top Left Diagonal
17 = Top Right Diagonal
Size Float Float from 0.0 to 100.0
Symmetry Float Float from 0.0 to 100.0
Softness Float Float from 0.0 to 100.0
Position X Float Float from 0.0 to 1.0000
Position Y Float Float from 0.0 to 1.0000
Invert Pattern Integer 0 = Off
1 = On
2 = Toggle
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK Pattern Cycle

Chooses the next or previous pattern setting for the Pattern upstream keyer.

Message Description Arguments
/mixeffect/usk/pattern/cycle Chooses the next or previous pattern setting for the Pattern upstream keyer. Multiple
Argument Type Description
Reverse Boolean 0 = False
1 = True
Default is 0
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK Pattern Invert

Sets the Invert Pattern setting for the Pattern upstream keyer.

Message Description Arguments
/mixeffect/usk/pattern/invert Sets the Invert Pattern setting for the Pattern upstream keyer. Multiple
Argument Type Description
Invert Pattern Integer 0 = Off
1 = On
2 = Toggle
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK Pattern Position

Sets the Position settings for the Pattern upstream keyer.

Message Description Arguments
/mixeffect/usk/pattern/position Sets the Position settings for the Pattern upstream keyer. Multiple
Argument Type Description
Position X Float Float from 0.0 to 1.0000
Position Y Float Float from 0.0 to 1.0000
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK Pattern Position Adjust

Adjusts either the X or Y Position settings for the Pattern upstream keyer.

Message Description Arguments
/mixeffect/usk/pattern/position/adjust Adjusts either the X or Y Position settings for the Pattern upstream keyer. Multiple
Argument Type Description
Position String x
y
Adjustment Value Float -X to decrease the value by a certain amount or Y to increase the value by a certain amount.
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK Pattern Position

Sets either the X or Y Position setting for the Pattern upstream keyer.

Message Description Arguments
/mixeffect/usk/pattern/position/set Sets either the X or Y Position setting for the Pattern upstream keyer. Multiple
Argument Type Description
Position String x
y
New Value Float The new value.
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK Pattern Size

Sets the Size settings for the Pattern upstream keyer.

Message Description Arguments
/mixeffect/usk/pattern/size or /mixeffect/usk/pattern/size/set Sets the Size settings for the Pattern upstream keyer. Multiple
Argument Type Description
Size Float Float from 0.0 to 100.0
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK Pattern Size Adjust

Adjusts the Size settings for the Pattern upstream keyer.

Message Description Arguments
/mixeffect/usk/pattern/size/adjust Adjusts the Size settings for the Pattern upstream keyer. Multiple
Argument Type Description
Adjustment Value Float -X to decrease the value by a certain amount or Y to increase the value by a certain amount.
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK Pattern Size Symmetry Softness Position

Sets the Size, Symmetry, Softness, and Position settings for the Pattern upstream keyer.

Message Description Arguments
/mixeffect/usk/pattern/size-symmetry-softness-position Sets the Size, Symmetry, Softness, and Position settings for the Pattern upstream keyer. Multiple
Argument Type Description
Size Float Float from 0.0 to 100.0
Symmetry Float Float from 0.0 to 100.0
Softness Float Float from 0.0 to 100.0
Position X Float Float from 0.0 to 1.0000
Position Y Float Float from 0.0 to 1.0000
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK Pattern Softness

Sets the Softness setting for the Pattern upstream keyer.

Message Description Arguments
/mixeffect/usk/pattern/softness Sets the Softness setting for the Pattern upstream keyer. Multiple
Argument Type Description
Softness Float Float from 0.0 to 100.0
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK Pattern Softness Adjust

Adjusts the Softness settings for the Pattern upstream keyer.

Message Description Arguments
/mixeffect/usk/pattern/softness/adjust Adjusts the Softness settings for the Pattern upstream keyer. Multiple
Argument Type Description
Adjustment Value Float -X to decrease the value by a certain amount or Y to increase the value by a certain amount.
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK Pattern Style

Sets the Pattern Style for the Pattern upstream keyer.

Message Description Arguments
/mixeffect/usk/pattern/style Sets the Pattern Style for the Pattern upstream keyer. Multiple
Argument Type Description
Pattern Integer 0 = Left To Right Bar
1 = Top To BottomBar
2 = Horizontal Barn Door
3 = Vertical Barn Door
4 = Corners In Four Box
5 = Rectangle Iris
6 = Diamond Iris
7 = Circle Iris
8 = Top Left Box
9 = Top Right Box
10 = Bottom Right Box
11 = Bottom Left Box
12 = Top Center Box
13 = Right Center Box
14 = Bottom Center Box
15 = Left Center Box
16 = Top Left Diagonal
17 = Top Right Diagonal
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK Pattern Symmetry

Sets the Symmetry settings for the Pattern upstream keyer.

Message Description Arguments
/mixeffect/usk/pattern/symmetry Sets the Symmetry settings for the Pattern upstream keyer. Multiple
Argument Type Description
Symmetry Float Float from 0.0 to 100.0
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK Pattern Symmetry Adjust

Adjusts the Symmetry settings for the Pattern upstream keyer.

Message Description Arguments
/mixeffect/usk/pattern/symmetry/adjust Adjusts the Symmetry settings for the Pattern upstream keyer. Multiple
Argument Type Description
Adjustment Value Float -X to decrease the value by a certain amount or Y to increase the value by a certain amount.
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK Flying Key Enable

Enables or disables the flying key.

Message Description Arguments
/mixeffect/usk/flying-key/enable Enables or disables the flying key. Multiple
Argument Type Description
Flying Key Enabled Integer 0 = Off
1 = On
2 = Toggle
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK Flying Key KeyFrame

Saves the current position of the Flying Key to the A or B keyframe slot.

Message Description Arguments
/mixeffect/usk/flying-key/keyframe Saves the current position of the Flying Key to the A or B keyframe slot. Multiple
Argument Type Description
Keyframe Integer 0 = A
1 = B
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK Flying Key Rate

Sets the rate for the Flying Key transition.

Message Description Arguments
/mixeffect/usk/flying-key/rate Sets the rate for the Flying Key transition. Multiple
Argument Type Description
Rate Integer The number of frames from 1 to 250.
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK Flying Key Run

Execute the Flying Key for the specified USK on the selected Mix Effects Bus.

Message Description Arguments
/mixeffect/usk/flying-key/run Execute the Flying Key for the specified USK on the selected Mix Effects Bus. Multiple
Argument Type Description
Type Integer 0 = A
1 = B
2 = Full
3 = Center of Key
4 = Top Left
5 = Top Middle
6 = Top Right
7 = Middle Left
8 = Middle Center
9 = Middle Right
10 = Bottom Left
11 = Bottom Middle
12 = Bottom Right
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK Inputs

Sets the fill and key sources for the selected Upstream Keyer in the selected Mix Effect Bus.

Message Description Arguments
/mixeffect/usk/inputs Sets the fill and key sources for the selected Upstream Keyer in the selected Mix Effect Bus. Multiple
Argument Type Description
Fill Source Integer Video Source ID for the fill source.
Key Source Integer Video Source ID for the key source.
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK On Air

Sets the On Air status for the selected Upstream Keyer in the selected Mix Effect Bus.

Message Description Arguments
/mixeffect/usk/on-air Sets the On Air status for the selected Upstream Keyer in the selected Mix Effect Bus. Multiple
Argument Type Description
On Air Integer 0 = Off
1 = On
2 = Toggle
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

USK Style

Sets the style of the upstream keyer for the selected Mix Effect Bus.

Message Description Arguments
/mixeffect/usk/style Sets the style of the upstream keyer for the selected Mix Effect Bus. Multiple
Argument Type Description
Style Integer 0 = Luma
1 = Chroma
2 = Pattern
3 = DVE
USK Integer One-based index of the Upstream Keyer. Default is 1.
M/E Integer One-based index of the Mix Effect Bus. Default is 1.

Saving Preset Icons for Companion

The most common use case for running MixEffect and Companion is to run SuperSource presets from a Stream Deck. MixEffect makes it easy to download a thumbnail of a preset that you can upload to Companion.

  1. From the MixEffect Home, tap SuperSource.
  2. Tap View All in the upper-right.
  3. Long-press on the desired preset.
  4. In the menu that appears, tap Save Preset Icon.
  5. Choose Companion (73x41).
  6. Repeat steps 3-5 for other presets.

If you are using this feature for the first time, a prompt from iOS will appear asking you for permission to access your Photos Library. If you décline permission, you must enable it in iOS Settings > MixEffect > Photos > Add Photos Only.

Exporting a single preset thumbnail

After a moment, the thumbnail will be saved to your Photos Library.

  1. Go to Photos.
  2. Select the preset thumbnail or thumbnails.
  3. Tap Share.
  4. Send the file to your computer running Companion. AirDrop works great.
  5. Add the thumbnail to your buttons in Companion.

You can also export multiple preset thumbnails at a time by going into List mode on the View All Presets page:

  1. Tap Edit.
  2. Select the presets you wish to export.
  3. Tap the photo icon in the export bar.
  4. Choose your export size.

After a few moments, your thumbnails will have been added to your Photo Library.

Exporting multiple preset thumbnails


Adding Your Thumbnails to Companion

Use AirDrop, Messages, Email, or another sharing option to transfer your thumbnails to your Companion computer. When editing a button, click Browse underneath the button icon. Select your thumbnail, and you will have an accurate representation of your SuperSource preset in Companion and on your Stream Deck!

Shortcut to Resize Icon from 72x41 to 72x58

Some versions of Companion do not allow uploading of icons that are not 72x58 in size. If this happens to you, use this shortcut to resize your 72x41 icons to 72x58:

Back to Top