vMix API Reference

vMixAPI.com is a third-party utility built by Nick Roberts.

My day job is Lead Developer for OctoCue - a remote slide control tool - but I also program and operate vMix shows for corporate clients worldwide.

vMixAPI.com is not made, operated or endorsed, by StudioCoast Pty Ltd. (the makers of vMix) - don't write to them if you find a mistake.

All the API information is sourced from vMix's own documentation, and the original source material should be referenced if required:

• vMix shortcut function reference table v24 v25 v26 v27 v28
• VB.NET scripting reference v24 v25 v26 v27 v28
• Web scripting reference v24 v25 v26 v27 v28
• TCP API reference v24 v25 v26 v27 v28
• HTTP GET API reference v24 v25 v26 v27 v28

If you find this utility useful, consider buying me a coffee:

Questions? Comments? Found a mistake? Drop me an email.

Want to contribute to the project? You can do so on GitHub! Feel free to fork the repository, make improvements, and submit a pull request.

Finally, there's no guarantee that anything on this site is relevant, correct or useful. Use at your own risk.

Happy vMixing!

Set the default vMix URL so the example HTTP hyperlinks work with your network setup.

Details are stored locally on your device in a cookie and not sent to our servers.

Common examples:

• http://127.0.0.1:8088 - Local machine & default port
• http://192.168.xxx.xxx:8088 - Machine on local subnet
• http://172.xxx.xxx.xxx:8088 - Machine on local subnet (alternative IP range)

There are multiple ways to reference a specific input in vMix:

• By input number: 1 to n*
• By GUID (from XML): 877bb3e7-58bd-46a1-85ce-0d673aec6bf5
• By name: My input

* Generally, using input numbers is not recommended, as these will break if inputs are re-ordered.

There are also some special references - but these will not work with all API functions, so YMMV:

• 0 Input in preview
• -1 Active input
• -3 Input currently under mouse cursor (hover)