Yes, check out the Getting started section in Companion's GUI where these things are documented. And partake in forums like https://m.facebook.com/groups/companion/

There's only 1 vMix module in Companion. It's listed under StudioCoast because all modules in Companion are labeled by the company and the product, in this case StudioCoast is the developer, and vMix is the product.


There's no need to create a shortcut in vMix, assign it to a key, and then use Companion to press a key. There's literally a run custom command action that lets you run any vMix function, without the need to assign it to a shortcut or keypress or anything like that. That being said, most functions are in Companion already.



Actually almost all functions are within the Companion module, it's just some of them are grouped together within a single action.

For example, adjusting the position of a layer has 13 functions per layer, SetLayer1Crop, SetLayer1CropX1, SetLayer1cropX2, SetLayer1CropY1, SetLayer1CropY2, SetLayer1PanX, SetLayer1PanY, SetLayer1X, SetLayer1Y, SetLayer1Height, SetLayer1Width, SetLayer1Zoom, SetLayer1Rectangle. Times that by 10 layers and that's 130 functions. In Companion you simply select the Layer - Position action and that has all of those functions for each layer available to you, you just need to select the layer, which position type you wish to change, and values of how to change it.

The same is true of most of the other vMix functions. Rather than having an action for each and every bus/channel/layer/mix, etc... we simply group them together within a single action or feedback, so that the vast majority of the commonly used functions are all within Companion.

Not currently, I'm working on the Wiki for the module to add this sort of info but isn't the highest priority currently. If you browse the actions most of them are obvious by the label so just browse through.

Some functions aren't actions because it would be excessive to add functions that no one really uses, so all of the most commonly used ones are available (what functions are wanted usually comes from the broadcast studios and events we work with, so if it's not natively an action in Companion it's because no on has requested it and none of our studios use it).

For how to use the "Run Custom Command" action, the help icon next to the vMix connection in Companion will open up a help screen with a link to a vMix API reference https://util.dist.dev/vmixapi and how to structure the function to be used within that action.

Feature requests for additional functions to be added can be requested here https://github.com/bitfocus/companion-module-studiocoast-vmix/issues/, but keep in mind we don't bloat the module with every command if only one person uses it, as that's what Run Custom Command is for.

-ReplayPLayLastEventToOutput
-ReplayPlayAllEventsToOutput
-ReplayPlayAllEventsToOutput
-ReplayStopEvents
-ReplayShowHide
-AudioMixerShowHide
These aren't part of the workflows for the productions we work or consult with, so you'd need to use a Custom Command if you wish to use them. If you have a use case for these as opposed to traditional workflows feel free to submit a feature request!

- LoopOn (replay)
- LoopOff (replay)
These are covered by the action "Media - Playback Actions", where there are options for Loop On, Off, or Toggle.

- FullscreenOn
This is covered by the action "Output - Output Functions".

Thanks for input! Will dig into Custom Commands for now. Have posted a feature request on github too.

Thank you, I'm glad it's helped your production!

As for the grouping of actions and feedbacks, please keep in mind that Companion is far more than just vMix, so I keep with certain naming schemes used by some of the other modules in Companion, and in some cases use grouping/naming that is more industry standard.

Also the vMix module in Companion is far more than just shortcut references. https://imgur.com/a/A9lB3wB is a clip showing a test of how on a single StreamDeck XL page I can select an Input, select any of it's 10 layers, and route any input I like to it, without needing to use vMix's Dynamic Inputs or Dynamic Values and having buttons to spare. This is just one example of extra functionality that goes beyond just vMix shortcuts and why it's not just a copy/paste of the shortcut list.

vMix's API doesn't return any data as to if a layer is on or off, so it's not possible to have Companion do any sort of triggers on that event. If vMix devs were to add if a layer is enabled or not to their API in the future then I'd happily add this, as I've had multiple requests for variables/feedback for if a layer is enabled/disabled but it's not something I can do with what vMix provides.

An alternative way to do things that many of us use as a workaround until vMix add the layer state to the API, is to instead leave the layer always enabled, and then when you want something shown you set the layer to that input, and if you want to disable the layer you would instead send a transparent input to that layer, call it 'BLANK' or something. That way you can then do triggers based on variable, so if input 5 layer 1 is set to the input 'BLANK', you know nothing is showing, but if it's anything other than 'BLANK' then the layer is showing something.


You can use a single trigger, Just add a time of day event for each time you wish the trigger to be activated.


You would need 2 triggers for that, because the all actions on a trigger will fire if all conditions are true, you can't fire just some actions if just some conditions are met.

There's a variable, $(vmix:mix_1_program_remaining), that has the time remaining in ms on whatever is currently in program for mix 1. So for example if you wanted to create a trigger that does something when the time remaining is 0, you could set the Event to be a change on that variable, and the Condition would be if that variable = 0.

Keep in mind if you want to do something in the last 10 seconds, that if you have the condition as variable <= 10000 it'll repeat the actions as the trigger will constantly be firing in the last 10 seconds as it'll be true. In that situation you would want the action to be to set a custom variable to true, and then you can have a separate trigger on that custom variable as then that variable will only change once and not spam the action.

Also please keep in mind that the poll rate that the Companion module is configured to use, this is how often that variable will update so although it shows milliseconds it wont update every millisecond.


This can be done through custom variables and a trigger. First, create 2 custom variables, for example these could be called "hhmmss" and "ms". Then as a trigger you would set the Event to "On variable change", and set to internal:custom_hhmmss. Leave condition empty. The action should be "internal: Custom Variable: Set with expression", with the target variable being internal:custom_ms, and the Expression "timestampToSeconds($(internal:custom_hhmmss))".

The way this works, is that whenever the hhmmss variable changes, Companion will parse the timestamp into ms and save that value into the ms variable. That variable can then be used in actions/feedbacks that support variables in options (not all do).

3.4.3 should still have the mix_1_program_remaining variable, but I'll try to look in to why it may not be showing up for you (I expect it's because Companion only shows a subset of variables for triggers, due to how large the variable list is, so if that is the case I'll look to get this fixed this week so it's one of the variables shown).

As for the most recent versions of the module, any update that is sufficient enough for me to increase the version number and write patch notes for I push to the Beta builds of Companion. Those builds happen several times throughout the day so that version is always the most up to date (and for most of the mainstream modules they do go through testing so it is used by many in production even if it does have the name 'beta' in it, the more unstable stuff is on the Develop/Experimental version of Companion).

Edit:
Gaaah, I am sometimes as stupid as my wife thinks...
Of course only the command should be added to the input field in companion, without the ip and port numbers! Now all works as expected.
But I leave my question here if it may help some other stupid poor sod trying to learn this stuff :-) .


Hi again!
So, started testing running cusom commands through studiocast vMix module in companion but run into trouble.
Tried to run this to select all events in the replay list:

http://localhost:8088/api/?function=ReplaySelectAllEvents

...but nothing happens in vMix when I press the streamdeck button.

But if I enter the string in chrome browser on the same pc the events are selected as they should be.

changing "localhost" to the pc:s own ip number or the ip vmix uses for web controller does not work either (but both does work in the browser)
All other buttons works fine.

So what´s up here? Is there any setting in companion I have missed?