Web Scripting
Web Scripting supports a basic URL syntax to execute multiple functions one after the other.
Examples
Overlay a title for 2 seconds using the in and out transitions.
Function=OverlayInput1In&Input=Title 0- The Classic Blue.gtzip Sleep 2000 Function=OverlayInput1Out |
Fade to an input called "Camera1" using the transition time of 1000 milliseconds:
Function=Fade&Input=Camera1&Duration=1000 |
Set the text of field called "Description.Text" in the Title to "Hello World" then overlay that title for 4 seconds using the in/out transitions.
Function=SetText&Input=Title 0- The Classic Blue.gtzip&SelectedName=Description.Text&Value=Hello World Function=OverlayInput1In&Input=Title 0- The Classic Blue.gtzip Sleep 4000 Function=OverlayInput1Out |
Syntax
The syntax for each line is the same as the query string used with the vMix Web API exception without the URL portion
For example http://localhost:8088/API/?Function=Cut in the Web API would be just Function=Cut with Web Scripting
All the same parameters apply for example:
Function=Slide&Input=Title 0- The Classic Blue.gtzip&Duration=1000 Function=SetText&Input=Title 0- The Classic Blue.gtzip&SelectedName=Description.Text&Value=Hello World |
The only exception is the Sleep command which is unique to Web Scripting and will pause for a number of milliseconds between two functions.
URL encoding may need to be used when using special characters in the Value parameter.