MixEffect Documentation

MixEffect

MixEffect Newsletter

MixEffect Community

Shortcuts

Use Siri and Shortcuts to control and automate MixEffect. You can connect to switchers, perform transitions, run macros, change layouts, and much more using just your voice!


Automation Requirements

In order to run automations, the following must be true:

  1. Automations are enabled.
  2. MixEffect Pro enabled.
  3. View Only Mode is disabled.
  4. A switcher is currently connected (exception is the Connect to Switcher or actions that query MixEffect’s local database, such as Get My Streaming Services, Get My Switchers, etc.).

If any of these are false, an error will be displayed when trying to run the shortcut.


Allowing Untrusted Shortcuts

If you are already using Shortcuts on your iOS devices, you can skip this section.

If you have never used Shortcuts before, you will first need to configure the Shortcuts app to allow the running of untrusted shortcuts. Read and follow the instructions in this article.

NOTE: Apple’s documentation is lacking the fact the you first need to have run a shortcut before the Allow Untrusted Shortcuts Toggle becomes tappable.


Enabling Automations

Before you can use the shortcut actions, you first need to enable automations and shortcuts in MixEffect:

  1. Go to the MixEffect Home.
  2. Tap Settings (gear icon).
  3. Tap Automations.
  4. Tap Enable Automations.
  5. Tap Enable Shortcuts.

Adding Pre-Made Shortcuts

MixEffect comes with several pre-made actions that you can add directly to Shortcuts and Siri:

  1. Go to the MixEffect Home.
  2. Tap Settings (gear icon).
  3. Tap Automations.
  4. Tap Sample Shortcuts.
  5. Tap the action you wish to add.
  6. Tap Add to Siri.
  7. Enter a custom phrase for the new shortcut.
  8. Tap Add to Siri.

Add to Siri

To run one of these shortcuts, do one of the following:

  1. Press and hold the sleep wake button. When you hear the beep, say the name of the shortcut you created in the previous section.
  2. Say “Hey, Siri,” followed by the name of the shortcut you created in the previous section.

Making Custom Shortcuts

If you want to string together several MixEffect actions, you can create your own shortcut using the Shortcuts app.


Invoking Shortcuts

Because the ATEM switcher require a constant connection between the iOS device, you will frequently run into situations where you try to run a shortcut but the device has disconnected in the time you left MixEffect to switch to the Shortcuts app. Unless you account for this with a shortcut that waits for reconnection, your shortcut may fail.

Here are tips to mitigate this problem.

Use Siri

Use Siri to run your shortcut while you are using MixEffect. Invoking Siri happens in a separate background thread which does not affect the currently running app in the foreground.

Use Shortcuts in Split View or Slide Over on iPadOS

If Shortcuts is visible alongside MixEffect, MixEffect will not disconnect because it is still a foreground application.

MixEffect Helper and Conditional Detect

If running from the phone or if you run shortcuts outside of Split View or Slide Over, use the Open App or Open MixEffect action. Next, add an alert at the beginning of your shortcut prompting the user to wait until the switcher has connected before continuing the rest of the actions.

MixEffect Helper

Use the MixEffect Helper shortcut to get you started. You can call this shortcut from your own shortcuts by adding a Run Shortcut action at the top of your shortcut:


Available Actions

This section lists the available actions in MixEffect:


Auto

Performs an automatic transition. Waits for the amount of time specified in the transition before continuing to the next action.

Parameters

Returns

Nothing


Change Aux Source

Change the source for an Auxiliary output.

Parameters

Tapping on either field will display a menu with the supported options.

Returns

Video source object.


Change Bus Source

Change the source for the Program or Preview bus.

Parameters

Tapping on either field will display a menu of available options.

Returns

Video source object.


Change Layout

Changes the page layout of the currently active switcher.

Parameters

If a layout with the supplied name does not exist, no error will be thrown.

If two or more layouts exist with the same name, the first matching layout will be chosen.

Returns

Nothing


Change Switcher Section

Opens a different section in MixEffect when connected to a switcher.

Parameters


Change Transition

Sets the current transition style.

Parameters

If your switcher does not support Stinger transitions, nothing will happen when you run this action.

Returns

Nothing


Connect to Switcher

Connects to a named switcher.

Parameters

Running this action will cause MixEffect to disconnect from any current active connection and try to connect to the new switcher.

Running this action will open MixEffect if it is not already in the foreground.

It is highly advisable to add a Show Alert action that pauses execution of the shortcut until after MixEffect has fully connected to the switcher. Once the user taps OK in the alert, the subsequent actions will run.

Returns

Nothing


Control SuperSource

Control the SuperSource if a preset layout has been set.

Parameters

If Box A and Box B are left blank, and if there are only two boxes visible on-screen, running this action will cause the two boxes to swap their video sources.

Choosing Reset will reset the current layout to the last used one on the device.

Returns

Nothing.


Cut

Performs a cut transition.

Parameters

Returns

Nothing


Cycle Media Player

Cycles through stills or clips in the selected Media Player.

Parameters

Returns


Export Streaming XML

Exports a Streaming XML file for all or selected services stored in MixEffect.

Parameters

The Export Streaming XML shortcut demonstrates how to use this action. It uses the Get My Streaming Services action along with the Choose From List action to select a subset of your streaming services to export as a Streaming.xml file.

Returns


Export SuperSource Presets

Exports a JSON file containing your SuperSource presets.

Parameters

Returns

SuperSource Presets JSON text.


Fade to Black

Performs a fade to black transition. If the switcher is already fully black, running this action will return to display the current program source.

Parameters

Returns

Nothing


Find Macros

Search for macros matching a query string in the macro’s name or description.

Parameters

Returns

A list of macro objects.


Get Audio Source

Retrieves a specific audio source from the system.

Parameters

Returns

Audio source object. Master audio is currently not supported. \


Get Audio Sources

Retrieves all audio sources from the currently active switcher.

Parameters

None.

Returns

Audio source objects. Master audio is currently not supported.


Get Current Aux Source

Returns the current video source for the specified Auxiliary output.

Parameters

Returns

Video source object.


Get Current Bus Source

Returns the current video source for the specified bus.

Parameters

Returns

Video source object.


Get Details of Current Switcher

Returns details about the current switcher, including the number of Mix Effect Blocks, SuperSources, Downstream Keyers, Stingers, and more.

Parameters

None.

Returns

Details of the current switcher:


Get Details of Streaming Configuration

Retrieve a specific piece of information from a Streaming Configuration object, such as the service name, server URL, stream key, username, password, and bitrates.

Parameters

Returns

Details of the streaming configuration:


Get Details of Video Source

Returns details from a video source object, such as its long name, short name, or source ID.

Parameters

Returns


Get DSK Details

Returns details about the selected downstream keyer.

Parameters

Returns


Get Chroma Advanced Details

Retrieves details of the Advanced Chroma Keyer. This action returns an error on those switchers that do not feature the Advanced Chroma keyer.

Parameters

Returns

Advanced Chroma details object, which contains the following fields:


Get Chroma Details

Retrieves details of the Chroma Keyer. This action returns an error on those switchers that feature the Advanced Chroma keyer.

Parameters

Returns

Advanced Chroma details object, which contains the following fields:


Get Chroma Sample

Returns the current chroma sample from the current switcher, Mix Effects Block, and keyer.

Parameters

Returns


Get DVE Details

Returns DVE settings from the selected USK.

Parameters

Returns


Get Luma Details

Retrieves details about the luma keyer.

Parameters

Returns

Luma details.


Get Pattern Details

Retrieves details about the pattern keyer.

Parameters

Returns

Pattern details.


Get Master Audio Source

Retrieves details about the master audio source.

Parameters

None.

Returns

Master audio information, including:


Get Media Clips

Returns a list of all media clips.

Parameters

None

Returns

List of media clip objects with the following fields:


Get Media Player Details

Get details of the selected media player, including still/clip capacity.

Parameters

Returns


Get Media Stills

Returns a list of active still objects from the current switcher.

Parameters

None.

Returns

List of still objects with the following fields:


Get My Streaming Servers

Returns all streaming servers stored in this instance of MixEffect.

Parameters

None.

Returns

List of streaming service objects.


Get My Switchers

Returns all ATEM switcher connections stored in this instance of MixEffect.

Parameters

None.

Returns

List of switcher objects.


Get Streaming Configuration

Retrieves the currently selected Streaming Configuration from the currently active switcher.

Parameters

None.


Get Streaming Servers

This action returns all of the streaming servers attached to the selected streaming service.

Parameters

Returns

List of streaming server objects.


Get SuperSource Art Details

Returns information about the current SuperSource art configuration.

Parameters

Returns


Get SuperSource Box Details

Returns information about each box for the specified SuperSource.

Parameters

Returns


Get Transition Details

Returns details for the current and upcoming transition styles.

Parameters

Returns


Get Transition Dip

Retrieves details about the Dip transition for the selected Mix Effect Block.

Parameters

Returns

Dip Transition Details object, which contains the following fields:


Get Transition DVE Details

Retrieves details about the DVE transition for the selected Mix Effect Block.

Parameters

Returns

DVE Transition Details object, which contains the following fields:

The following fields are active only when the DVE Effect field is set to Graphic Logo Wipe:

The following fields are active only if Enable Key is toggled on:


Get Transition Mix Details

Retrieves details about the Mix transition for the selected Mix Effect Block.

Parameters

Returns

Mix Transition Details object, which contains the following fields:


Get Transition Stinger Details

Retrieves details about the Stinger transition for the selected Mix Effect block.

Parameters

Returns

Stinger Transition Details object, which contains the following fields:


Get Transition Wipe Details

Retrieves details about the Wipe transition for the selected Mix Effect Block.

Parameters

Returns

Wipe Transition Details object, which contains the following fields:


Get USK Details

Returns details for the specified USK.

Parameters

Returns


Get Video Source

Retrieves a video source, given its long name, short name, or source ID.

Parameters

Returns

Video source object.


Get Video Sources

Gets all video sources suitable for displaying as a meAndFill source from the currently active switcher. These are sources you can display on the Program and Preview buses.

Parameters

Returns

List of Video source objects for the given type.


Is Recording

Checks if the current switcher is recording.

Parameters

None.

Returns

Returns true if the currently active switcher is recording. False otherwise.


Is Streaming

Checks if the current switcher is streaming.

Parameters

None.

Returns

Returns true if the currently active switcher is streaming. False otherwise.


Is Switcher Active

Checks if the switcher is currently active.

Parameters

None.

Returns

Returns true if the current switcher is active.


Macro Pause

This action adds a pause to a macro. This only works when a macro is currently being recorded.

Parameters

Returns

Nothing.


New Streaming Server

Given a streaming service, add a new streaming server to MixEffect.

Parameters

Returns

Streaming service object.


New Streaming Services

Add a new streaming service to MixEffect.

Parameters

Returns

Streaming server object.


New Switcher

Adds a new switcher connection to MixEffect.

Parameters

Returns

Switcher connection object.


Next SuperSource Preset

Provided a SuperSource preset is active within MixEffect, this action selects the next preset. If a search term has been entered, this action will choose the next preset from the filtered list of presets.

Parameters

Returns

Nothing.


Open MixEffect

Opens MixEffect and optionally waits a 1-8 seconds before continuing the rest of the shortcut.

Parameters

This action is used in the MixEffect Helper shortcut to assist you when running shortcuts when MixEffect is not in the foreground. It allows you to wait for MixEffect to establish a connection with the switcher before continuing with the rest of the shortcut.

Returns

Nothing.


Preview Transition

Sets the Preview Transition mode on the currently active switcher.

Parameters

Returns

Nothing


Previous SuperSource Preset

Provided a SuperSource preset is active within MixEffect, this action selects the previous preset. If a search term has been entered, this action will choose the next preset from the filtered list of presets.

Parameters

Returns

Nothing.


Save Startup State

Saves the state of the switcher to the non-volatile memory of the switcher.

Parameters

None

Returns

Nothing.


Send HyperDeck Command

Sends a HyperDeck command to a network-addressable HyperDeck.

Parameters

Returns

The result of the command. You can parse this string for specific information from the command execution.


Set Audio Source

Sets details for the given audio source.

Parameters

Returns

Nothing.


Record Macro

Records a new macro, given an index (1-based).

Parameters

Returns

Macro object.


Run Flying Key

Runs the flying key using the DVE channel.

Parameters

Returns

Nothing.


Run Macro

Runs a numbered macro on the currently active switcher.

Parameters

If the macro does not exist at the selected index, nothing will happen and no error will be given.

There is an 8 second limit on the Wait parameter. This is due to Shortcuts imposing a 10-second limit on the amount of time an individual action can take.

Returns

Nothing


Set DSK

Sets a downstream keyer in the current switcher.

Parameters

Returns

Nothing.


Set Flying Key Frame

Sets the A or B frame for the Flying Key.

Parameters

Returns


Set Flying Key Frame Rate

Sets the rate at which the flying key runs.

Parameters

Returns


Set Keyer Chroma Advanced Details

Sets details for the advanced chroma keyer. Sets details for the chroma keyer. This action only works on those ATEM switchers that support the advanced chroma keyer.

Parameters

Returns

Nothing.


Set Keyer Chroma Details

Sets details for the chroma keyer. This action only works on those ATEM switchers that lack the advanced chroma keyer.

Parameters

Returns

Nothing


Set Keyer Chroma Sample

Sets the current chroma sample value.

Parameters

Returns

Nothing


Set Keyer DVE

Set the keyer DVE settings for the current switcher.

Parameters

Returns

Nothing.


Set Keyer Luma Details

Sets details for the Luma keyer for the selected USK.

Parameters

Returns

Nothing.


Set Keyer Pattern Details

Sets details for the Pattern keyer for the selected USK.

Parameters

Returns

Nothing.


Set Master Audio Source

Sets details for the master audio source.

Parameters

Returns

Nothing.


Set Media Player

Sets the media player to display a selected still or clip.

Parameters

Returns

Nothing.


Set Streaming Configuration

Instruct the currently active switcher to change its streaming configuration.

Parameters

When changing services, you must remember to re-tap server and profile to select a server and profile from the newly selected service. Shortcuts does not clear those two fields automatically, so you can get a situation where you have the wrong server!

NOTE: This action will fail if the device is currently connecting to a streaming service or already streaming.

Returns

Streaming configuration.


Set SuperSource Art Details

Sets information about the specified SuperSource art configuration.

Parameters

Returns

Nothing.


Set SuperSource Cascade

Enables, disables, or toggles SuperSource Cascade on supported switchers such as the ATEM Constellation 8K. Cascade allows for the two SuperSources to be combined into a single SuperSource that features up to 8 boxes.

Parameters

Returns

Nothing.


Set SuperSource Cascade Presets

Sets SuperSource 1 and 2 to the two presets passed to the shortcut. The transitions will happen at the same time.

Parameters

Returns

Nothing.


Set SuperSource Box Details

Sets information about a particular box for the specified SuperSource.

Parameters

Returns

Nothing.


Set Transition Dip

Parameters

Returns

Nothing on success. Alert if an error was encountered running the action.


Set Transition DVE Details

Parameters

The following fields are active only when the DVE Effect field is set to Graphic Logo Wipe:

The following fields are active only if Enable Key is toggled on:

Returns

Nothing on success. Alert if an error was encountered running the action.


Set Transition Mix Details

Parameters

Returns

Nothing on success. Alert if an error was encountered running the action.


Set Transition Rate Details

Sets the transition rate for Mix, Dip, Wipe, Sting Mix Rate, and DVE transitions.

Parameters

Returns

Nothing on success. Alert if an error was encountered running the action.


Set Transition Stinger Details

Sets details about the Stinger transition for the selected Mix Effect block.

Parameters

Returns

Nothing.


Set Transition Wipe Details

Sets details for the Wipe transition.

Parameters

Nothing on success. Alert if an error was encountered running the action.


Set USK

Sets the status of an upstream keyer in the current switcher.

Parameters

Returns

Nothing.


Set USK Background

Set the state of the USK background button.

Parameters

Returns

Nothing.


Start Recording

Instructs the currently active switcher to start recording.

Parameters

None.

Returns

Nothing.


Start Streaming

Instructs the currently active switcher to start streaming.

Parameters

None.

Returns

Nothing.

Stop Recording

Instructs the currently active switcher to stop recording.

Parameters

None.

Returns

Nothing.


Stop Streaming

Instructs the currently active switcher to stop streaming.

Parameters

None.

Returns

Nothing.


Switch Disk

If recording, this action switches the recording disk.

Parameters

None.

Returns

Nothing. Error if not recording or if there is only one disk attached to the switcher.


Upload Still

Uploads an image to the currently active switcher.

Parameters

Returns

True on success. False otherwise. Error is Show Error is toggled.