MixEffect Documentation

MixEffect

MixEffect Newsletter

MixEffect Community

OSC

Control MixEffect using devices capable of sending OSC messages like Companion and Stream Decks.


Getting Started with OSC in MixEffect

Activating OSC support is a two-step process.

  1. Enable OSC support in MixEffect.
  2. Configuring the OSC server for each switcher you have created in 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

Next, configure the companion app to communicate with MixEffect. Until there is a dedicated module, we will be using the OSC Generic 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:

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 one of three options:

    • MixEffect Extreme: Send message without arguments
    • 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/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 messages are supported:


Connect

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

Configuring a connect to switcher button in Companion


Run Shortcut

Opens the Shortcuts app and runs the selected shortcut.

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

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 Section

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

Section Tags


Switcher Page

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

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.


SuperSource Preset

Sets the SuperSource Preset for the the current switcher.

Configuring a SuperSource preset button in Companion.

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

NOTE: The SuperSource ID is one-based, meaning you should enter 1 for the first SuperSource. This only comes into play if you have an ATEM Constellation, which features two SuperSources. Leave blank to choose the first SuperSource on your switcher.

BUG AND WORKAROUND: MixEffect 1.0.5 has a bug where you have to specify 3 to select SuperSource 2. This will be resolved in the next version of MixEffect.


SuperSource Previous Preset

NOTE: This feature will be in the next release of MixEffect.

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

SuperSource Next Preset

NOTE: This feature will be in the next release of MixEffect.

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


SuperSource Highlight

Highlights a box for the currently selected SuperSource preset.

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

Configuring a SuperSource Highlight button in Companion.


SuperSource Box Crop

Set the crop value of a specific box or adjust the crop by a certain amount.

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

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 Position

Set the X or Y position of a specific box or move the box in the X or Y position by a certain amount.

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

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

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


SuperSource Box Size

Set the size of a specific box or grow or shrink the box by a certain amount.

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

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 Transition Speed

Sets the transition speed for SuperSource transitions.


SuperSource Cycle Transition Speed

Cycles through the transition speeds.


SuperSource Transition Style

Sets the mathematical function used to generate the transition animation.

SuperSource Cycle Transition Style

Cycles through the various transition styles.


SuperSource Grow Highlighted Box

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


SuperSource Grow Highlighted Box By

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

The minimum and maximum value the resulting grow value can be is 0 and 0.5.

SuperSource Shrink Other Boxes

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


SuperSource Shrink Other Boxes By

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

The minimum and maximum value the resulting shrink value must be 0 and 0.5.


SuperSource Swap

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

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


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.


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.


SuperSource Cascade

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


SuperSource Cascade Presets

NOTE: This feature will be in the next release of MixEffect.

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

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


Video Follows Audio

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

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


View Only Mode

Turns on View Only Mode for the connected switcher.

Do not send any arguments with this message.

Configuring a View Only Mode button in Companion.


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: