User's Manual
Table Of Contents
- Introduction and Features
- Getting Started
- Presets
- Video Controls
- Fullscreen
- Transitions
- Production Clocks
- Categories
- Fade Bar
- Pause Inputs
- Overlays
- Right Click Menus
- Settings
- Inputs
- Input Settings
- Audio
- Recording
- Live Streaming
- External Output
- Keyboard, MIDI and Controller Shortcuts
- Activators - MIDI Lights and Faders
- vMix Control Surface
- Web Controller
- Instant Replay
- PTZ - Pan Tilt Zoom
- NDI - Network Device Interface
- SRT - Secure Reliable Transport
- Data Sources
- vMix Call
- GT Title Designer
- vMix Title Designer (Legacy)
- PlayList
- MultiCorder
- Tally Lights
- Interlaced Support
- Statistics
- Snapshot
- Padlock
- Scripting and Automation
- Developer Information
- Shortcut Function Reference
- Safe Areas
- Undo Button
- Waveform and Vectorscope Monitor
vMix User Guide
179 / 208
Examples:
Overlay.Find(1).In("NewsHD.xaml")
For i As Integer = 1 to 4
Overlay.Find(i).Off
Next
Console
Shared Methods
WriteLine(message as String)
Write the message string to the vMix Script console accessible from the Scripting tab of Settings.
This is useful for debugging purposes
Examples:
Console.WriteLine("Beginning Example Script")
Overlay.Find(1).In("NewsHD.xaml")
Console.WriteLine("Title should now appear in Overlay 1, now we wait 5 seconds")
Sleep(5000)
Console.WriteLine("Now we will transition out Overlay 1")
Overlay.Find(1).Out
Console.WriteLine("Finished!")
API
Shared Methods
XML() As String
Returns the XML state of vMix as per the vMix Web API
Function(functionName As String, Optional input As String = "", Optional value As String
= "", Optional duration As Integer = 0, Optional selectedName As String = "", Optional
selectedIndex As Integer = 0)
Calls an API function as per the vMix Web API
Examples:
API.Function("CubeZoom",,1000)
Web Scripting
Web Scripting supports a basic URL syntax to execute multiple functions one after the other.
Example










