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
186 / 208
Description: Subscribe to an event/command. Event responses matching the selected command may begin
immediately, even before the SUBSCRIBE response is received.
Event responses will continue to be received until either a. UNSUBSCRIBE is called or b. the connection is
closed.
UNSUBSCRIBE
Format: UNSUBSCRIBE <COMMAND>\r\n
Example Request: UNSUBSCRIBE TALLY\r\n
Example Response: UNSUBSCRIBE OK TALLY\r\n
Description: Due to the internal event queue in vMix, event responses may continue to be received briefly
after the UNSUBSCRIBE command has been called.
QUIT
Description: Closes the connection
Shortcut Function Reference
The following shortcut functions can be called either via a Shortcut or via the API.
Fade, Zoom, Cut Etc: Assign a keyboard key to a transition effect. The duration can also be selected.
Name Description Parameters
General
ActivatorRefresh Refresh all activator device lights and controls None
CallManagerShowHide None
KeyPress Value = Key Value
SendKeys Send keys to active window
Value = Keys
Value
Audio
Audio Toggle Audio Mute On/Off Input
AudioAuto Input
AudioAutoOff Input
AudioAutoOn Input
AudioBus M,A,B,C,D,E,F,G
Value = Bus
Value,Input
AudioBusOff M,A,B,C,D,E,F,G
Value = Bus
Value,Input
AudioBusOn M,A,B,C,D,E,F,G
Value = Bus
Value,Input
AudioMixerShowHide None
AudioOff Input
AudioOn Input
AudioPluginOff Turn off Audio Plugin, starting from 1 Value,Input