Skip to content

Latest commit

 

History

History
299 lines (238 loc) · 11.5 KB

HELP.md

File metadata and controls

299 lines (238 loc) · 11.5 KB
Raw

MixEffect Companion Module

This module will allow you to control a MixEffect instance running on iOS devices such as an iPhone, iPad, iPod Touch, etc.

Configuration

The MixEffect Companion Module requires that your MixEffect app is configured for OSC. This configuration includes:

  1. Enabling OSC support within MixEffect Automation Settings,
  2. Enabling the OSC server for the particular switcher you want to control, and
  3. Setting a port number to the switcher's OSC server.

For more information see the Getting Started with OSC in MixEffect guide.

Once OSC is enabled on the MixEffect app you can proceed to configure this module. You will need:

  1. the Target IP address (which is the IP of the iOS device running MixEffect), and
  2. the Target Port (which is the port of the switcher's OSC server described above).

Actions

We have included a number of actions to help you control MixEffect. There are actions in each of these categories:

App Actions

  • App: Connect to Switcher
  • App: Remote Webview
  • App: Run Shortcut
  • App: Run Shortcut and Return
  • App: Switcher Section
  • App: Switcher Page
  • App: Switcher Page Previous
  • App: Switcher Page Next
  • App: Video Follows Audio
  • App: View Only Mode

Auxiliary/Output

  • AUX: Set Aux/Output Source (added in v1.1.0)

Color Generators

  • Color Generator: Set (added in v1.1.0)

  • Color Generator: Hue Set (added in v1.1.0)

  • Color Generator: Saturation Set (added in v1.1.0)

  • Color Generator: Luminance Set (added in v1.1.0)

  • Color Generator: Hue Adjust (added in v1.1.0)

  • Color Generator: Saturation Adjust (added in v1.1.0)

  • Color Generator: Luminance Adjust (added in v1.1.0)

Downstream Keyers

  • DSK: Auto (added in v1.1.0)

  • DSK: Inputs (added in v1.1.0)

  • DSK: Key (added in v1.1.0)

  • DSK: Key Clip Gain (added in v1.1.0)

  • DSK: Key Clip Set (added in v1.1.0)

  • DSK: Key Gain Set (added in v1.1.0)

  • DSK: Key Clip Adjust (added in v1.1.0)

  • DSK: Key Gain Adjust (added in v1.1.0)

  • DSK: Key Invert (added in v1.1.0)

  • DSK: Key Pre Multiplied (added in v1.1.0)

  • DSK: Mask (added in v1.1.0)

  • DSK: Mask Enable (added in v1.1.0)

  • DSK: Mask Top Set (added in v1.1.0)

  • DSK: Mask Bottom Set (added in v1.1.0)

  • DSK: Mask Left Set (added in v1.1.0)

  • DSK: Mask Right Set (added in v1.1.0)

  • DSK: Mask Top Adjust (added in v1.1.0)

  • DSK: Mask Bottom Adjust (added in v1.1.0)

  • DSK: Mask Left Adjust (added in v1.1.0)

  • DSK: Mask Right Adjust (added in v1.1.0)

  • DSK: On Air (added in v1.1.0)

  • DSK: Rate (added in v1.1.0)

  • DSK: Tie (added in v1.1.0)

Fairlight Audio

  • Fairlight: Audio Frame Delay (added in v1.1.0)

  • Fairlight: Input Mix Option Set (added in v1.1.0)

  • Fairlight: Fader Gain Set (added in v1.1.0)

  • Fairlight: Input Gain Set (added in v1.1.0)

  • Fairlight: Master Gain Set (added in v1.1.0)

  • Fairlight: Fader Gain Adjust (added in v1.1.0)

  • Fairlight: Input Gain Adjust (added in v1.1.0)

  • Fairlight: Master Gain Adjust (added in v1.1.0)

  • Fairlight: Reset Peaks (added in v1.1.0)

  • Fairlight: Reset Source Peaks (added in v1.1.0)

Macro Actions

  • Macro: Run
  • Macro: Continue (added in v1.1.0)
  • Macro: Loop (added in v1.1.0)
  • Macro: Stop (added in v1.1.0)

Media Player Actions

  • Media Player: Select Media Player
  • Media Player: Clip
  • Media Player: Clip Cycle
  • Media Player: Clip Reverse
  • Media Player: Still
  • Media Player: Still Cycle
  • Media Player: Still Reverse

Mix Effect Bus

  • M/E: Select Mix Effect Bus
  • M/E: Fade to Black Auto' (added in v1.1.0)
  • M/E: Fade to Black Rate (added in v1.1.0)
  • M/E: Set Preview Input (added in v1.1.0)
  • M/E: Set Program Input (added in v1.1.0)

Multiviewer

  • Multiviewer: Set Layout (added in v1.1.0)
  • Multiviewer: Set Layout Advanced (added in v1.1.0)
  • Multiviewer: Set Window (added in v1.1.0)

Output

  • Output: Recording Set Filename (added in v1.1.0)
  • Output: Recording Start or Stop (added in v1.1.0)
  • Output: Recording Switch Disk (added in v1.1.0)
  • Output: Streaming Set Service (added in v1.1.0)
  • Output: Streaming Start or Stop (added in v1.1.0)

SuperSource Actions

  • SuperSource: Art (added in v1.1.0)

  • SuperSource: Art Border (added in v1.1.0)

  • SuperSource: Art Border Enable (added in v1.1.0)

  • SuperSource: Art Border Bevel Style Set (added in v1.1.0)

  • SuperSource: Art Border Outer Width Set (added in v1.1.0)

  • SuperSource: Art Border Inner Width Set (added in v1.1.0)

  • SuperSource: Art Border Outer Softness Set (added in v1.1.0)

  • SuperSource: Art Border Inner Softness Set (added in v1.1.0)

  • SuperSource: Art Border Bevel Softness Set (added in v1.1.0)

  • SuperSource: Art Border Bevel Position Set (added in v1.1.0)

  • SuperSource: Art Border Hue Set (added in v1.1.0)

  • SuperSource: Art Border Saturation Set (added in v1.1.0)

  • SuperSource: Art Border Luminance Set (added in v1.1.0)

  • SuperSource: Art Border Light Source Direction Set (added in v1.1.0)

  • SuperSource: Art Border Light Source Altitude Set (added in v1.1.0)

  • SuperSource: Art Border Outer Width Adjust (added in v1.1.0)

  • SuperSource: Art Border Inner Width Adjust (added in v1.1.0)

  • SuperSource: Art Border Outer Softness Adjust (added in v1.1.0)

  • SuperSource: Art Border Inner Softness Adjust (added in v1.1.0)

  • SuperSource: Art Border Bevel Softness Adjust (added in v1.1.0)

  • SuperSource: Art Border Bevel Position Adjust (added in v1.1.0)

  • SuperSource: Art Border Hue Adjust (added in v1.1.0)

  • SuperSource: Art Border Saturation Adjust (added in v1.1.0)

  • SuperSource: Art Border Luminance Adjust (added in v1.1.0)

  • SuperSource: Art Border Light Source Direction Adjust (added in v1.1.0)

  • SuperSource: Art Border Light Source Altitude Adjust (added in v1.1.0)

  • SuperSource: Art Key (added in v1.1.0)

  • SuperSource: Art Key Clip Gain (added in v1.1.0)

  • SuperSource: Art Key Clip Set (added in v1.1.0)

  • SuperSource: Art Key Gain Set (added in v1.1.0)

  • SuperSource: Art Key Clip Adjust (added in v1.1.0)

  • SuperSource: Art Key Gain Adjust (added in v1.1.0)

  • SuperSource: Art Key Invert (added in v1.1.0)

  • SuperSource: Art Key Pre Multiplied (added in v1.1.0)

  • SuperSource: Art Place In (added in v1.1.0)

  • SuperSource: Preset

  • SuperSource: Previous Preset

  • SuperSource: Next Preset

  • SuperSource: Highlight

  • SuperSource: Box Crop

  • SuperSource: Box Position

  • SuperSource: Box Size

  • SuperSource: Box Crop Set (added in v1.1.0)

  • SuperSource: Box Crop Adjust (added in v1.1.0)

  • SuperSource: Box Position Set (added in v1.1.0)

  • SuperSource: Box Position Adjust (added in v1.1.0)

  • SuperSource: Box Size Set (added in v1.1.0)

  • SuperSource: Box Size Adjust (added in v1.1.0)

  • SuperSource: Box Source

  • SuperSource: Box Enable (added in v1.1.0)

  • SuperSource: Transition Speed

  • SuperSource: Cycle Transition Speed

  • SuperSource: Transition Style

  • SuperSource: Cycle Transition Style

  • SuperSource: Grow Highlighted Box

  • SuperSource: Grow Highlighted Box By

  • SuperSource: Shrink Other Boxes

  • SuperSource: Shrink Other Boxes By

  • SuperSource: Swap

  • SuperSource: Swap Boxes

  • SuperSource: Auto

  • SuperSource: Cut

  • SuperSource: Cascade

  • SuperSource: Cascade Presets

Switcher

  • Switcher: Startup State Save (added in v1.1.0)
  • Switcher: Startup State Clear (added in v1.1.0)

Transition Actions

  • Transition: Auto
  • Transition: Cut
  • Transition: Dip (added in v1.1.0)
  • Transition: Dip Source (added in v1.1.0)
  • Transition: DVE (added in v1.1.0)
  • Transition: DVE Flip Flop (added in v1.1.0)
  • Transition: DVE Inputs (added in v1.1.0)
  • Transition: DVE Key (added in v1.1.0)
  • Transition: DVE Key Clip Gain (added in v1.1.0)
  • Transition: DVE Key Enable (added in v1.1.0)
  • Transition: DVE Key Invert (added in v1.1.0)
  • Transition: DVE Key Pre Multiplied (added in v1.1.0)
  • Transition: DVE Reverse (added in v1.1.0)
  • Transition: DVE Style (added in v1.1.0)
  • Transition: Mix (added in v1.1.0)
  • Transition: Next (added in v1.1.0)
  • Transition: Preview (added in v1.1.0)
  • Transition: Rate (added in v1.1.0)
  • Transition: Style (added in v1.1.0)
  • Transition: Wipe (added in v1.1.0)
  • Transition: Wipe Border (added in v1.1.0)
  • Transition: Wipe Flip Flop (added in v1.1.0)
  • Transition: Wipe Pattern (added in v1.1.0)
  • Transition: Wipe Position (added in v1.1.0)
  • Transition: Wipe Reverse (added in v1.1.0)
  • Transition: Wipe Size (added in v1.1.0)
  • Transition: Wipe Source (added in v1.1.0)
  • Transition: Wipe Symmetry (added in v1.1.0)

Upstream Keyers

  • USK: Chroma (added in v1.1.0)
  • USK: Chroma Advanced (added in v1.1.0)
  • USK: Chroma Advanced Sample (added in v1.1.0)
  • USK: DVE Border (added in v1.1.0)
  • USK: DVE Border Enable (added in v1.1.0)
  • USK: DVE Mask (added in v1.1.0)
  • USK: DVE Position (added in v1.1.0)
  • USK: DVE Rotation (added in v1.1.0)
  • USK: DVE Size (added in v1.1.0)
  • USK: DVE Size Position Rotation (added in v1.1.0)
  • USK: Run Flying Key (added in v1.1.0)
  • USK: Flying Key Keyframe (added in v1.1.0)
  • USK: Flying Key Rate (added in v1.1.0)
  • USK: Flying Size Position (added in v1.1.0)
  • USK: Inputs (added in v1.1.0)
  • USK: Luma Key (added in v1.1.0)
  • USK: Luma Key Clip Gain (added in v1.1.0)
  • USK: Luma Key Invert (added in v1.1.0)
  • USK: Luma Key Pre Multiplied (added in v1.1.0)
  • USK: Mask (added in v1.1.0)
  • USK: Pattern (added in v1.1.0)
  • USK: On Air (added in v1.1.0)
  • USK: Style (added in v1.1.0)

Variables

  • aux_bus - Internal variable set using the Select Aux Bus Action. Used by other actions when the Selected Aux Bus option from the dropdown is selected. (added in v1.1.0)
  • box - Internal variable set using the Select Box Action. Used by other actions when the Selected Box option from the dropdown is selected. (added in v1.1.0)
  • color_generator - Internal variable set using the Select Color Generator Action. Used by other actions when the Selected Color Generator option from the dropdown is selected. (added in v1.1.0)
  • media_player - Internal variable set using the Select Media Player Action. Used by other actions when the Selected Media Player option from the dropdown is selected.
  • mix_effect_bus - Internal variable set using the Select Mix Effect Bus Action. Used by other actions when the Selected Mix Effect Bus option from the dropdown is selected. (added in v1.1.0)
  • supersource - Internal variable set using the Select SuperSource Action. Used by other actions when the Selected SuperSource option from the dropdown is selected. (added in v1.1.0)
  • dsk - Internal variable set using the Select DSK Action. Used by other actions when the Selected DSK option from the dropdown is selected. (added in v1.1.0)
  • usk - Internal variable set using the Select USK Action. Used by other actions when the Selected USK option from the dropdown is selected. (added in v1.1.0)

Feedbacks

  • Set color based on the value of the aux_bus variable (added in v1.1.0)
  • Set color based on the value of the box variable (added in v1.1.0)
  • Set color based on the value of the color_generator variable (added in v1.1.0)
  • Set color based on the value of the media_player variable
  • Set color based on the value of the mix_effect_bus variable (added in v1.1.0)
  • Set color based on the value of the supersource variable (added in v1.1.0)
  • Set color based on the value of the dsk variable (added in v1.1.0)
  • Set color based on the value of the usk variable (added in v1.1.0)