companion-module-studiocoast-vmix

Provides essential control over StudioCoast vMix.

For more information, look in HELP.md.
Go over to the vMix website to learn more about the software.

API Poll Interval

The majority of vMix data used by Companion for feedback and variables is retrieved through the vMix REST API, the frequency at which this data is polled can be changed in the instance config. All instances prior to 1.2.6 had a poll interval of 100ms, but from 1.2.6 the default has been changed to 250ms. It is recommended that users who need responsive feedbacks and had no previous issues to lower the interval in the config back to 100ms, and for users with a significantly large number of inputs or running on older hardware to either leave the interval at 250ms, or enter a slower interval should the server be insufficient for the number of inputs.

Using Custom Commands/shortcuts

When using vMix shortcuts, please follow this syntax/layout, with space before the first value:

"ReplayMarkInOut Value=5000"

If there is more than one parameter, use "&" as a separator between them:

"SetOutput2 Value=Input&Input=3"

Button Shifting

The ability to modify the action and feedback options by using the Toggle Shift action, which will split text inputs by the configured Shift Delimiter and determine which value to use based on the state of the Shift Action.

For some feedback, such as Tally and Layer Routing it's possible to enable 'blinking' which causes the feedback to indicate a solid color if the current Shift layer is active, or flash that color if it's an one of the inactive Shift layers that is showing feedback. For example, if you have a feedback to show the preview with the input set to "Cam1/Cam2", when shift is not toggled it would show a solid green when "Cam1" is in preview, or flash if "cam2" is in preview, and when Shift is toggled on the reverse would happen.

HTTP API

This module now supports Companions HTTP API, providing endpoints that can be used by 3rd party applications, and as a Data Source in vMix itself. Information on the API endpoints is available in docs/http_api.md

Recent Patches

v4.2.0

• Added support for vMix 29
• Actions:
  • Updated Overlay - Functions to support 8 overlays, and added the capability to select more than one mix.
  • Updated Transition - Auto/Stinger Transition to support 8 stingers
  • Updated Transition - Transition Mix and Transition - Set Auto Transition Effect to support the new AlphaFade transition
  • Updated Audio - Set Bus Volume to include support for adjusting Headphones volume
  • Updated Title - Begin Animation Page to support variables for animation selection
  • Added Input - GO Action to start the GO action on an input
  • Added Replay - Quad View Action to Toggle, set On, or set Off, Quad View mode
  • Added Replay - Set/Append Event Text and Replay - Clear Event Text Actions for setting, appending, or clearing, text on an Replay Event
• Feedbacks:
  • Added Replay - Quad View Feedback for the new Replay Quad View mode
  • Updated General - Output NDI/SRT Status is now General - Output NDI/OMT/SRT Status, and supports showing if OMT is enabled on an output
• Variables:
  • Added output_X_omt variables to show OMT status on outputs 1 to 4
  • Updated Overlay variables to support 8 overlays
  • Added replay_quad_view variable to show if Quad View mode is enabled
  • Added input_X_layer_Y_titleimage and input_X_layer_Y_titlecolor variables for title inputs image and color values, similar to the titletext variable
  • Added more support for Local Variables
• Fixed preset variable not always updating
• Fixed an issue with Transition feedback/variables not updating under certain conditions

v4.1.2

• Fixed an issue with Mix variables not correctly updating if the Preview or Program was set to none

v4.1.1

• Fixed several issues relating to Variable generation

v4.1.0

• Added Title - Set title Image and Title - Set title Image Visibility Actions for setting images in a Title input and adjusting their visibility
• Added Replay - Play Events by ID Action, allowing playing 1 or more events by ID rather than the current Replay - Play Events Action which uses Event Number
• Added a Config option to control if Input Variables should be generated with a lowercase name or match the case in vMix (with special characters still removed)
• Added output_X_type and output_X_input_name Variables for the 4 vMix outputs. When the type is Input the output_X_input_name Variable will show the name of the input as opposed to output_X_source which only shows Input19 for example.
• Fixed feedback on an inputs playing state being updated by Activator data, improving responsiveness in slow API poll rate environments

Older patch notes available in docs/patch_notes.md