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
182 / 208
Input
Input can be used to specify the Input in one of three ways:
1. By number starting from 1.
0 can be used for Preview and -1 for Active.
2. By name. (note that it is case sensitive, and requires the full title name including spaces)
3. A GUID can be used to specify an exact input. The GUID can be found from the "Key" attribute in the
XML.
For example:
http://127.0.0.1:8088/API/?Function=Fade&Duration=1000&Input=877bb3e7-58bd-46a1-85ce-0d673aec6bf5
SelectedName
When using Title or XAML inputs, SelectedName can be used to specify the name of the text field to
modify.
For example:
http://127.0.0.1:8088/API/?Function=SetText&Input=877bb3e7-58bd-46a1-85ce-
0d673aec6bf5&SelectedName=Headline&Value=Hello
When using GT titles, the name should include ".Text" at the end for text fields and ".Source" at the end for
images or rectangles with brush images.
For reference, these full names are displayed in the Title Editor built into vMix.
For example:
http://127.0.0.1:8088/API/?Function=SetText&Input=877bb3e7-58bd-46a1-85ce-
0d673aec6bf5&SelectedName=Headline.Text&Value=Hello
http://127.0.0.1:8088/API/?Function=SetImage&Input=877bb3e7-58bd-46a1-85ce-
0d673aec6bf5&SelectedName=MyImage.Source&Value=filename.jpg
SelectedIndex
Specify an index to pass to the input
The following Inputs support the SelectedIndex parameter:
VideoList: Specify the video to play starting from 1
Virtual Set: Specify the camera zoom to transition to
Title: Specify the text item to configure starting from 0
Value
Value is used with many different API Functions including the following.
For a full list of functions that use Value parameters refer to the Shortcut Function Reference.
SetImage: Specify the image to display in an image field within a supported XAML or Title input
SetText: Specify the text to display in the text field specified by SelectedIndex above.
SetPosition: In milliseconds
SetCountdown: As a timespan (00:00:00)
SetFader: As a number between 0 and 255
AddInput: Specify the Video/Image/Photos or Xaml input filename in the following formats:
Video|c:\filename.wmv
Image|c:\filename.jpg
...