vMix has a robust API, but one key limitation of the API is that while you can tell vMix to take a snapshot of an input, it will save the image on the vMix machine but not send the image over the network.
The Snapshot Proxy is a small application written in the Go language to automatically generate those images and provide them over the network to other applications.
The application is especially helpful in providing preview images of each input for
Instructional Video here: https://youtu.be/7tXUx9Q_O58
- Download the latest zip file from the Releases Page
- Unzip the file.
- Put the
.exeand the.batfiles both in the same directory wherever you want (NOTE: they must be on the SAME computer that's running vMix). - Start vMix.
- Double-click on the
.batfile. - If you have problems, look at the
.batfile for the available command line options:-hwill print the help-pwill allow you to specify the Web API port vMix is using-dwill allow you to specify the directory where vMix stores snapshot images
When running, the proxy will open a web server at port 8098 and will expose the following HTTP endpoints:
http://[IP_ADDRESS]:8098/will return a list of all the discovered vMix inputshttp://[IP_ADDRESS]:8098/regenwill trigger a global regeneration of all input snapshotshttp://[IP_ADDRESS]:8098/regen/[INPUT_NUMBER]will trigger a regeneration of one input's snapshothttp://[IP_ADDRESS]:8098/[INPUT_NUMBER].jpgwill serve the input snapshot as a jpg image.