V Mix User Guide
V Mix User Guide
V Mix User Guide
Table of contents
2 / 224
vMix User Guide
3 / 224
vMix User Guide
4 / 224
vMix User Guide
5 / 224
vMix User Guide
vMix is feature rich live production software that allows you to record and stream professional productions all
from a single PC or Laptop.
vMix supports SD, HD and 4K productions.
The two major system requirements for vMix are Windows 7 or higher and a DirectX 10 compatible graphics
card.
More detailed requirements can be found on the Supported Hardware page on our web site.
http://www.vmix.com/
Below is an overview of the features available in vMix. This User Guide will provide you with some in depth
knowledge
of each of these features and enable you to create the best possible production in the least amount of time!
Features
Input Sources
Video Capture from HDMI, HD-SDI, SDI, Component, S-Video, Composite as supported by source from SD
up to 4K
Virtual Sets - Use live chroma keying to place talent in animated 3D virtual sets
CGI Titles - High Quality CGI Titles with customisable text including Headline (lower two-thirds) and
ScoreBoard templates
Audio Devices
Photos
RTSP and TS (Transport Stream) Sources (H264 Video / AAC Audio), Teradek Cube
RTMP Sources
WPF (Xaml)
Video Delay /Replay - Create a looping delay feed of any camera and save short video clips in real time
Web Browser
6 / 224
vMix User Guide
Cut
3D Zoom
Slide Effect
Wipe Effect
Cube Effect
FlyRotate Effect
Fly Effect
CrossZoom Effect
Merge Effect
Colour Keying and Chroma Keying with Auto Green or Blue Screen
Stinger Transitions
Luma Key
Web/Tablet Interface
Multi View
Combine six inputs (background and five foreground) to create a multi view output in many configurations
including split-screen and picture-in-picture.
Overlay
Overlay any Input with alpha channel transparency as either a full overlay or PIP (Picture In Picture)
PlayList
Automate playback of multiple inputs with the PlayList feature
Set start time, duration and transition effect for each item in the PlayList
Output
7 / 224
vMix User Guide
Output over NDI - Network Device Interface to other devices on the same network
Optional output to compatible rendering device such as from AJA, BlueFish and Blackmagic Design
Output to streaming applications such as the Adobe Flash Media Live Encoder and Skype
Live Streaming
Built in RTMP live streaming to providers such as USTREAM, YouTube Live and more.
Recording
Live Recording to local hard disk in DV in SD resolutions or the MJPEG, MagicYUV or CineForm Codec for
recording in HD (CineForm Codec not included)
Live Recording in HD to the Decklink MJPEG Encoder when using Intensity/Decklink cards.
Live Recording in FFMPEG to a number of formats including MPEG-2, MP4 and VC-3
Audio can be included with Video Recording using any available audio capture sources.
vMix Audio device available for easy audio recording with 3rd party applications
Up to three independent Audio Mixes can be created and sent out to Windows and ASIO compatible devices
vMix introduces approximately 2 frames of delay between input and output. This is similar in performance to
standard HD switchers. Other factors that will influence delay include delays in video cameras and video
capture hardware and delays causing by video scaling of the output (such as by a projector)
8 / 224
vMix User Guide
An unlimited number of functions can be assigned to Keyboard, MIDI, Control Surface, X-Keys and
ShuttlePROv2 buttons, faders and knobs.
Activators
Setup lights and faders in MIDI and X-Keys controllers to respond to changes in vMix
Data Sources
Languages
Support for multiple translations such as Spanish and Korean from Google Translate
9 / 224
vMix User Guide
Getting Started
This main window is where all the video mixing takes place.
If you have used traditional video switchers before, the main window might look familiar.
1. Output Window
(Top-Right hand corner with the Green Title Bar)
This is the Live or Program video output window. This output is also displayed in a Fullscreen window that
defaults to the computer's secondary display.
This output is also what is used when setting up a recording.
2. Preview Window
(Top-Left hand corner with the Orange Title Bar)
Just like a traditional video mixer, an input you wish to display should be placed in this preview window first.
The Preview Window swaps with the Output Window whenever you select the Cut, Fade or Transition
buttons, located along the center.
3. Tabs
Colour coded tabs on the left hand side can be used to organise Inputs into categories and tabs on the
right hand side can be used to dock features such as the Audio Mixer and Instant Replay Controller
3. Input Bar
(Bottom row)
Each source such as Camera, Video and all other types of Inputs are loaded into this Input Bar.
A small real-time preview window is shown for each of these inputs.
If you click any of these items they will be queued in the Preview Window ready to go.
If you double click any of these items the Input Settings window will be displayed.
Multiple rows of inputs can also be displayed at a time. See Inputs to find out more.
4. Footer Bar
(Bottom)
Along the bottom are buttons to Add Input and buttons to configure and start features such as
Recordings, Streams and External Output.
10 / 224
vMix User Guide
11 / 224
vMix User Guide
Presets
The Preset bar at the top left hand corner of vMix is where you can quickly save your production, including
Inputs, recording and streaming settings to file.
This Preset can then be recalled again at a moments notice.
Each input and it's associated input settings (including positions, colour adjustments, chroma key,
multiview etc)
Recording settings
Overlay settings
Any shortcut keys assigned as local
Any activators assigned as local
Audio settings for each input and all three audio buses (Master, A and B)
All PlayLists, including the active PlayList if applicable
Category labels
Streaming settings. All existing streaming profiles and settings will be replaced with the settings from
when the Preset was last saved
External Output settings including Size, Frame Rate and Device, as per corresponding tab in Settings
Outputs configuration (for example if MultiView is selected for Fullscreen) as per corresponding tab in
Settings
Data Sources and related settings
In addition to the above, if the Preset was saved with a different Master Frame Rate or Output Size then
what is currently configured (1920x1080 29.97p for example)
then a message will appear asking to confirm these changes.
Any media used by inputs including Videos, Images, Photos, Title templates etc will be referred to by
filename only.
So if the Preset is used on a different system, be sure to copy any media assets and place them in the
same folder locations.
All other settings can be saved and recalled from the Settings Import/Export buttons
NOTE: In the Open Preset window, the Append button will add the selected inputs only, ignoring all other
settings.
12 / 224
vMix User Guide
New Preset
Creates a new blank Preset and optionally changes the current output video format.
13 / 224
vMix User Guide
Open Preset
Open Preset opens up a file open dialog where you can select an existing Preset.
Once a Preset has been selected the Open Preset window will appear.
Click Open to close all open inputs and replace them with this Preset.
Any settings included with the Preset will also be applied (See here for more information)
Click Append to add the inputs in this Preset to the existing session.
Any settings included with the Preset will be ignored.
Each input can be unticked if you want to exclude it from being added
Recent Presets
Quickly open a recent preset by clicking the arrow button next to the Open button.
14 / 224
vMix User Guide
Last Preset
Periodically, vMix automatically saves the current Preset to a separate file. Click Last to load this Preset
15 / 224
vMix User Guide
Video Controls
The Preview Window and Output Window have various video controls available:
Position Control
For non-live inputs (such as Video and DVD) the position control allows you to skip to any point.
Restart Button
Play/Pause Button
16 / 224
vMix User Guide
Fullscreen
The Fullscreen button can be used to display video through one of the video outputs on your computer
Graphics Card.
These can be connected to displays such as Monitors, Projectors and TVs.
First, connect these displays to your computer prior to opening vMix and make sure they are configured as
"Extend these displays" in the Screen Resolution control panel in Windows.
See Windows 7 Display Instructions on the Microsoft web site for further instructions.
Second, select the display from Settings under the Display tab as shown below:
By default the Fullscreen will display the final mixed output of vMix. Click the arrow to the right of the
Fullscreen button to select a different output option:
Output
The final mixed output of vMix, this is also shown on the right hand side of vMix.
Preview
Display the input currently selected in the "Preview" area of vMix (left hand side).
MultiView
Display Preview, Output and 8 or more Inputs in one of the configurations below.
All configurations with the exception of Legacy include audio meters and titles.
17 / 224
vMix User Guide
Legacy
Input X
Display the input at position X
Multiple Outputs
vMix 4K supports up to two Fullscreen outputs.
The second Fullscreen output is available on graphics cards that support three simultaneous displays.
18 / 224
vMix User Guide
Transitions
Quick Play
Cut
Fade / Transition Buttons
Merge Effect
Stinger Transitions
FTB (Fade To Black)
19 / 224
vMix User Guide
Quick Play
The Quick Play button automatically transitions the Preview Window to the Output Window and for video
inputs, starts playing input from current position.
There is also a Quick Play button for each input.
By default Quick Play is set to a half second fade. This can be customised in Settings - Options
20 / 224
vMix User Guide
Cut
The Cut button instantly swaps the Preview Window with the Output Window without any delay or transition
effect.
21 / 224
vMix User Guide
Fade/Transition Buttons
vMix provides four customisable buttons that can be used to set the transition effect when switching from
Preview to Output
Click the arrow next to each button to customise the transition effect and the duration.
The Stinger 1 and Stinger 2 can be configured in the Overlay settings. See Stinger Transitions
The first effect button also determines the transition used by the Fade Bar / T-Bar.
22 / 224
vMix User Guide
Merge Effect
The Merge effect is a unique transition effect that seamlessly animates matching Inputs between Preview
and Output.
In the above example, clicking the Merge transition will zoom the fireworks graphic out of the double box
until it fills the screen.
Any other layers or inputs that do not appear in both Preview and Output will transition using the Fade
transition effect.
23 / 224
vMix User Guide
Stinger Transitions
Note: Stinger Transitions are only supported on vMix editions with more than one Overlay channel
such as vMix HD.
Stinger Transitions allow the use of an animation instead of a fade or cut when transition between Preview
and Output.
Configuration
1. Add the animation you wish to use as an Input. The Image Sequence option is recommended as it
supports high quality animations with full alpha transparency.
2. In the Overlay settings window, select Stinger 1 from the Number dropdown box.
3. Configure the following settings:
Effect: This specifies an additional effect when transitioning to and from the stinger transition. In
most cases this will be set to Cut
Duration: Specify the total duration of the animation in milliseconds or frames. This will usually be
the length of the animation.
Stinger Input: Select the Input added in step 1
Stinger Cut Point: Specify the point in time when the transition will cut between the Preview and
Output inputs. If your animation has alpha channel, this will usually be the point where the animation covers
the entire screen.
24 / 224
vMix User Guide
When the stinger transition is required, simply click the transition button as you would any other effect
25 / 224
vMix User Guide
Recordings
External Output
Fullscreen
The Output window will not be affected by the Fade to black in order to make it easier to queue up a source
for later.
26 / 224
vMix User Guide
Categories
Inputs can be placed into up to six (6) different colour coded categories.
These categories can be selected from the left hand side of the Inputs Row
The six categories are RED, GREEN, ORANGE, PURPLE, AQUA and BLUE
Each colour has no special significance and can be used for any purpose that suits your production.
For example, Titles could be placed in the PURPLE category and Video Clips in the ORANGE category.
Labels can be added to particular categories by right clicking any category button so the Input Categories
window appears.
Once the labels have been added, click OK and the the buttons will change as follows:
27 / 224
vMix User Guide
The currently selected category will be indicated by a matching coloured separating line between the
category buttons and the inputs as shown below.
28 / 224
vMix User Guide
1. Drag and drop the inputs preview window (the video thumbnail square, not the title) over the top of the
category button you wish to assign it to.
2. Select the Category from the Input Settings window.
When an Input has been assigned to a particular category, the Input Settings button will be changed to a
matching colour.
29 / 224
vMix User Guide
Fade Bar
The Fade Bar (also known as a T-Bar) just below the FTB button allows you to manually transition from the
Preview Window and the Output Window.
The transition effect used is taken from the first Transition button. See Fade/Transition Buttons
30 / 224
vMix User Guide
Pause Inputs
31 / 224
vMix User Guide
Overlays
The Overlay feature allows you to display an Input on top of the currently displayed Input.
An Overlay can be activated by clicking the Overlay (1,2,3,4) buttons from the Input Bar.
Overlay Settings
The Overlay Settings window specifies how an Overlay will display.
The window can be accessed by clicking the Overlay button in the bottom right hand corner of the main
window.
Number
Select the overlay channel to configure. 4 Channels are supported in the SD and HD editions.
Type
There are two types of overlay available:
Fullscreen
Picture In Picture
Display on top of the currently selected Input using the specified Pan and Zoom settings..
The blue box will display a preview of what the Picture In Picture will look like.
Effect
Specify the transition effect to use when the Overlay is activated.
Animated transition effects will run forward when the overlay is activated and run in reverse when the overlay
is closed.
Effect Duration
Specify how long the effect should last, in milliseconds.
Duration
Specify how long the overlay should appear before automatically closing. Set this to 0 to disable automatic
closing.
Border
32 / 224
vMix User Guide
Colour: Double click the colour box to set the border colour.
Thickness: Specify how large the border will appear
Radius: Specify how rounded the corners of the border will appear. Set to 0 for square borders.
33 / 224
vMix User Guide
Different types of Inputs provide a right click menu to quickly access advanced settings associated with a
particular input type.
The following is a list of some of the right click menus available
Video
Show/Hide PlayBack Speed: Displays a dropdown box next to the input to control the speed of video
playback in real time.
Pictures/PowerPoint
SlideShow Settings: Shows the SlideShow settings window.
DVD
DVD Menu, Next Chapter, Previous Chapter, Jump To Title
Titles
Title Editor: Show the Title Editor window.
Title Presets: The Titles right click menu will also show title presets if they have been configured.
List
Select a video or audio file to jump to in the List.
See List for more information.
Capture/Flash
Reset: Resets the input to the settings when it was first added.
Web Browser
Go Back / Go Forward
Properties: Displays a window to change the web site URL.
34 / 224
vMix User Guide
35 / 224
vMix User Guide
SlideShow Settings
The SlideShow Settings window is available for Photos and PowerPoint inputs from a right-click menu.
36 / 224
vMix User Guide
Settings
Import/Export
Display
Outputs
Options
Performance
Decoders
Recording
External Output
Audio
Audio Outputs
Web Controller
Tally Lights
Shortcuts
Scripting
About
37 / 224
vMix User Guide
Import/Export/Default
Import
Import all settings from file. This includes all settings configurable from the Settings window.
Export
Export all settings to file. These settings can be imported from any other vMix installation as long as the
version is the same.
Default
Restores settings to when vMix was first installed.
38 / 224
vMix User Guide
Display
Theme
There are multiple themes available that change the colour scheme of the user interface.
Preview/Output Colour
Customise the colour to display for the input currently set as Preview or Output.
Output Size
This is the master resolution all inputs are scaled to prior to being sent to Fullscreen, Recording, External
Output or Streaming.
Fullscreen
Display
Screen number to output Fullscreen to. By default this is set to the secondary display.
Note: vMix Window and the Output Screen must be connected to the same Graphics Card. Multiple
Graphics Cards are not supported.
Two output screens are supported in vMix 4K and can be configured here by clicking the Display 1 or
Display 2 buttons.
Position
By default the Output Screen will be set to fill the entire screen. Output Position can be used to set a
custom size if necessary.
The four boxes are Top, Left, Width and Height.
Input Size
39 / 224
vMix User Guide
Size of the Input previews. If you have a large screen this can be increased to be able to see each input
more clearly.
40 / 224
vMix User Guide
Outputs
Two separate outputs can be configured in all versions of vMix, one for Fullscreen and one for External
Output, Recording and Streaming.
For example, a MultiView can be configured to be displayed on a second display without affecting the live
stream.
The different output options are described in the Fullscreen help page.
Custom Overlays
If both output options are set to "Output" the Overlay check boxes can be used to customise which overlays
are displayed on each unique output.
For example a "clean feed" can be set for the recording, while all the overlays are displayed on the full
screen.
External 2
In vMix 4K an additional external output is available that can be configured to it's own independent source.
Fullscreen 2
In vMix 4K an additional fullscreen output is available that can be configured to it's own independent source.
MultiView
41 / 224
vMix User Guide
Options
Select the language vMix will use for buttons, labels and messages.
These languages are provided by Google Translate and are not guaranteed to be accurate.
Start Maximised
QuickPlay Transition
Customise the transition used when the Quick Play button is pressed.
QuickPlay Duration
Customise how long the QuickPlay transition lasts in milliseconds (default 500 milliseconds)
42 / 224
vMix User Guide
43 / 224
vMix User Guide
Performance
Graphics Adapter
This is for selecting the graphics card vMix will use on systems with multiple graphics cards installed.
For best performance this should match the graphics card that monitor displaying the vMix interface is
attached to.
For laptops with hybrid graphics (also known as Optimus), only the graphics card selected in the Nvidia
control panel
will be visible here. In this case, you can instead control Integrated or Dedicated graphics use in vMix from
the Nvidia control panel, or equivalent control panel
if using a different graphics card vendor.
44 / 224
vMix User Guide
Decoders
Preferred Deinterlacing
Select the preferred deinterlacing method, when using Progressive output formats in vMix.
For example, if you have a camera set to 59.94i and the Master Frame Rate is set to 29.97p, then vMix
will deinterlace the camera according to the settings here.
Blend: Blends the two fields together to form a single progressive frame. Motion blur may be seen on fast
movement.
Discard: Uses the first field for each frame and discards the second. No motion blur during fast movement,
lower vertical resolution than Blend.
FFMPEG
Select the file formats that will be played using the built in FFMPEG decoder.
QuickTime files and MXF files are enabled by default.
Note: This option is only available under the 64bit version of vMix.
DirectShow
Select custom decoders to be used for various video formats. It is recommended that these be set to Auto.
MPEG 2 Video
Select a custom MPEG 2 codec to use when playing DVDs and MPG files.
Tick this box to automatically set deinterlacing in vMix for DVD/MPG sources.
Set this option only if the selected MPEG 2 codec does not support deinterlacing. (such as the codec
included with Windows 7)
MPEG Audio
Select a custom MPEG audio codec to use when playing DVDs and MPG files.
x264 Video
Select a custom video codec to use when playing x264, (h264) sources.
45 / 224
vMix User Guide
Recording
Default Folder for Recordings
Select a default folder to use when storing recorded videos.
Filename Format
The filename format is for advanced users that need to change the way video recordings are named.
The default is {0} - {1:dd MMMM yyyy - hh-mm-ss tt}
46 / 224
vMix User Guide
vMix Video is a device that appears in 3rd party applications such as Adobe Flash Media Live Encoder
and Skype and is also used for the built in Streaming feature.
See Streaming
External Renderer
Select this option to send video and audio out to compatible output devices.
Some examples of hardware that support output including most AJA, Blackmagic Design and BlueFish
devices.
External 2
In vMix 4K and Pro a second independent output can be configured for both vMix Video and External
Renderer.
This vMix Video device is called vMix Video External 2 in 3rd party applications.
Frame Rate
Select the Frame Rate for the External Output. When using the External Renderer this should be set to the
frame rate required by the device's output.
For vMix Video / Streaming, this should be set to the Master Frame Rate set under the Display tab for
optimal performance.
Output Size
47 / 224
vMix User Guide
Resolution for the External Output. This must be set to the output format when using the External
Renderer. For example if using the Composite/S-Video output this will usually be 720x576 for PAL and
720x480 for NTSC.
Audio Delay
This sets a delay on the audio input in milliseconds. For example if the audio is earlier than the video by
200ms, type in 200 here.
NDI Outputs
48 / 224
vMix User Guide
Audio
49 / 224
vMix User Guide
Audio Outputs
Master Output
Select the output to send the Master audio mix to. This is the default audio mix
used for streaming, recording and external output.
Headphones
Select the output to send the Headphones audio mix to.
This mix is the same as Master Output except when Solo is enabled on an input.
When Solo is enabled on an input only that input will be heard.
A, B
These are optionally auxiliary audio buses that can be configured as an independent mix from the Audio
Mixer.
For additional information about the audio buses feature, see the Audio Mixer documentation.
Audio Channels
Many sound cards provide 3 or more stereo outputs from a single device.
These are typically used to output surround sound, but can be used to output up to three independent
stereo audio mixes in vMix.
1-2 The most common setting for standard stereo audio outputs
3-4 This will send a stereo mix out over the output usually used for Center-Subwoofer
5-6 This will send a stereo mix out over the output usually used for RearLeft-RearRight
50 / 224
vMix User Guide
51 / 224
vMix User Guide
Web Controller
See the Web Controller section for information about this tab.
52 / 224
vMix User Guide
Tally Lights
This section will cover using Tally Lights with Arduino based hardware.
For other tally light options see Tally Lights
The Tally Lights settings can be used to specify the pin numbers for each tally light when using Arduino
based hardware.
Reset to Default: Reset to the default pin order as of vMix 2012 v4.
Reset to Legacy Mode: Revert to the pin order used in all previous versions of vMix.
53 / 224
vMix User Guide
Shortcuts
Add and edit Shortcuts here.
Click here to read the User Guide for Keyboard and Controller Shortcuts.
54 / 224
vMix User Guide
Scripting
Add and edit custom programming scripts here in 4K and Pro editions of vMix
55 / 224
vMix User Guide
About
Change Registration Key
Upgrade your software license here.
56 / 224
vMix User Guide
Advanced Settings
The following are Advanced Settings that are only visible when the Show Advanced Settings tick box is
enabled.
IMPORTANT: These settings should not be changed unless instructed to do so by vMix Support.
Many of these settings can potentially have an adverse effect on performance and quality on most
systems.
Performance
Output Format
Renders to recordings, vMix Virtual Capture and External Output in the specified format if supported by the
graphics hardware.
This should be left at the default of UYVY in most cases.
Video Renderer
Some codecs such as H264 perform better under the new EVR renderer which can be selected here.
For reliability the VMR9 renderer should be selected if you are unsure.
Preview Skip
Tick this option to skip every x frames when rendering the preview.
For example if the output is rendering at 30fps and the Preview Skip is set to one, Preview windows will
render at 15fps.
This is useful to improve performance on older Graphics Cards.
Application Priority
If you have other programs running alongside vMix, you can set a higher priority here to prevent dropped
frames.
This option is not required and may actually reduce performance when using vMix with Windows
7 in Aero Glass mode or Windows 8 and higher
57 / 224
vMix User Guide
Memory Lock
This option is not documented.
Recording
Interlaced Recording
Enables interlaced recording and external output under the following scenarios:
Master Frame Rate is 50p or higher and recording or external Frame Rate is interlaced
Master Frame Rate is interlaced and recording or external Frame Rate is interlaced
Note: NTSC 480i recordings are lower field first, all other recordings are upper field first.
Audio
Recording Audio
Select the audio source to use in recordings, external output and streaming.
58 / 224
vMix User Guide
Inputs
Inputs are the various sources that can be loaded into vMix. For example Camera (Video Camera), Video or
a DVD.
They will appear along the Input Bar as shown in the screenshot below.
Collapsing Inputs
Right click the title of an input to collapse it. This can be used to save space or hide blank inputs such as
audio sources.
59 / 224
vMix User Guide
The number of rows that can be added or removed depends on the display resolution set in Windows.
1920x1080 is recommended and allows up to three rows of inputs to be displayed at a time.
If more inputs are added than can be displayed, a scroll bar will appear to the right of the inputs.
60 / 224
vMix User Guide
Add Input
Click this button from the Main Window to bring up the Add Input window.
Video
Use the Video Input to load video files such as AVI, MPG, MXF, MP4, WMV and QuickTime.
DVD files should be loaded through the DVD option instead.
Mark In/Out
The Video Input supports specifying custom Start (Mark In) and End (Mark Out) points for playback.
61 / 224
vMix User Guide
The Start and End points are marketed by a Green square for Start and a Red square for End.
To change the Start point, drag the bar to the chosen position and right click to select Mark In from the
menu.
62 / 224
vMix User Guide
To change the End point, repeat these steps only select Mark Out from the menu instead.
DVD
Select a DVD drive or folder to load a DVD as an input.
List
The List feature can be used to create a playlist of video and audio files.
The Randomise button can be used to shuffle the list (useful for example when playing a set of music videos
for example)
63 / 224
vMix User Guide
M3U files are supported which can contain a combination of video and audio filenames.
List Control
To switch between items with the playlist, right click the preview area of the input and left click the item from
the dropdown list.
Edit Items
Click Edit Items in the right click menu to open up the List Editing Tab in the main vMix window.
This tab can be undocked and placed on a separate monitor by clicking the pin button at the top left
hand corner.
Auto Next
Toggle the "Auto Next" button to enable/disable automatic playback of the next item in the list. This option
is enabled by default.
Auto First
Toggle the "Auto First" button to enable/disable always playing from the first item in the list before a
transition to output.
Loop
Toggle the "Loop" button to have the list play from the beginning when it reaches the end of the list.
64 / 224
vMix User Guide
Interlaced
Individual videos in the list may not be detected as Interlaced in some situations. Toggle this button to
enable interlaced processing for a particular video.
Add
Click the Add button to add one or more items to the list.
Files can also be dragged and dropped into the Edit - List window
Edit/Remove
Click Edit to change the name of the selected item
Click Remove to remove one or more items from the list. There must be at least one active item in the List
at all times
Note: These options do not change the underlying files, so files will not be deleted or renamed.
Shuffle
Randomise the order of items in the list
Export
Export the current List as an M3U file
Checkboxes
A list item can be disabled by clicking the checkbox. When disabled the item will be skipped during
playback.
Up/Down Arrows
The up and down arrows can be used to move the selected item up or down in the list.
List Duration
If supported by the video or audio format, vMix will display a Total Time Remaining for the entire List.
In the screenshot below, Clip 1 is 21 minutes and 27 seconds in length and there is 1 hour, 4 minutes and
22 seconds remaining.
65 / 224
vMix User Guide
Camera
Camera is used to load in supported Video Capture Devices and Video Cameras.
Camera
Input
Resolution
Frame Rate
Interlaced
Untick the interlaced Check Box if the source video is in PsF format. (Progressive segmented frame)
Video Format
If the selected Video Capture Device supports more than one video format (such as YUY2 and YV12), vMix
will select one of these formats automatically.
If the automatically selected format is not suitable, a specific format can be enforced here.
66 / 224
vMix User Guide
Audio Input
Some cameras support selecting a particular audio input or channel here.
If using an AJA, Blackmagic or Magewell device, EmbeddedAllChannels can be selected to bring up to 16
channels of audio in at once.
These channels can be then be mixed from the Channel Mixer.
Audio Device
Audio Format
NDI
Easily add audio and video sources on the local network that support the NDI standard.
This also includes capturing remote desktops on PCs and Macs using vMix Desktop Capture.
NDI is an easy way to send and receive high quality, low latency video and audio between supported devices
using a standard Gigabit enabled network.
For example you can produce one aspect of your show on one computer and send the output to vMix
running on another.
You can also add any NDI enabled source to vMix as long as it is on the same network. This might be a NDI
enabled hardware device
or another computer or laptop running 3rd party software that supports the NDI standard.
67 / 224
vMix User Guide
In the screenshot above, there are four NDI sources available across two different computers.
While the vMix Desktop Capture program is running, any windows open on that computer will appear in the
NDI list.
In the screenshot above, Microsoft PowerPoint is running on a laptop called "THUNDER1" and can be added
to vMix simply by double clicking it from the list.
NOTE: users running versions of vMix Desktop Capture older than 17 will need to upgrade the
software to the latest version
68 / 224
vMix User Guide
Windows 7 Note: "Aero" theme must be enabled in order to capture individual windows.
Windows 8 or higher will always work when capturing individual windows regardless of theme.
Desktop Capture
For Desktop Capture support in vMix, see the NDI / Desktop Capture topic.
Stream
69 / 224
vMix User Guide
The Stream input supports adding IP Cameras and Streaming Servers that support the RTSP or Transport
Stream protocols.
In particular, the Stream input supports the Teradek Cube device and Teradek Sputnik server.
Stream Type
RTSP over UDP / RTSP over TCP
Select this option if a Transport Stream is being sent directly to the vMix machine over UDP
Selecting this option sets up vMix as a TCP server that can accept connections from remote streams
Enter the port to listen for connections
Select this option to connect to a remote Transport Stream server such as the Teradek Sputnik using the
TCP protocol.
Enter the hostname and port of the remote Transport Stream server
Buffer
The network buffer in milliseconds can be configured to reduce jitter when receiving high latency network
streams.
For local network streams, this should be set between 0 and 500 milliseconds or 1000 to 5000 milliseconds
for Internet streams.
70 / 224
vMix User Guide
Mode.
To use this mode, set the Buffer to 0 and tick the Low Latency Mode checkbox.
NOTE: If this option is enabled and the stream does not support Low Latency the video will show
compression artefacts and will play back at a lower frame rate.
Network Formats
RTSP
RTP (UDP and TCP)
TS (UDP, TCP and TCP Pull)
Firewall
UDP ports 35000 to 35500 will need to be open on your Firewall in order to receive streams in vMix.
Instant Replay
Full documentation on Instant Replay can be found below:
vMix will automatically search for the next image in the list based on the filename of the selected file.
For example if the image is called image1.png then vMix will load image2.png, image3.png and so on, until
no more files can be found.
Sound
Sound can be added to an image sequence by creating an MP3 or WAV file and naming it to match the first
image in the sequence.
For example if the first image is image1.png then the sound file should be called image1.png.wave or
image1.png.mp3
The sound will then start playing each time the Image Sequence is played.
Video Delay
The Video Delay Input allows you to select a custom delay to the Output or a Capture Input.
This feature can be used to achieve many types of effects including slow motion replay.
Setup
71 / 224
vMix User Guide
Seconds: Select the delay buffer size in seconds. This is an approximate value based on a 30FPS input.
Control
Record: Turn on or off the updating of the Video Delay.
Speed (100%): The delay can be played back at a variety of speeds including full speed and slow motion
such as 50%.
Save Seconds (10): Select the number of seconds of the most recent Video Delay footage to save to file.
Save Location (List): Select the location to save the video delay clip once the Save button has been
clicked. See Saved Delay Clips section below.
Save: Click this button to begin saving the Video Delay footage to file. This button will light up red while the
save is in progress. The video delay will stop recording until the file has been completed.
List
Each saved clip will automatically be added to a separate List Input when complete. This List Input is
dedicated to holding all video delay clips in a vMix session regardless of source.
Category
Each saved clip will be added as a separate Input in the selected colour category. See Categories.
72 / 224
vMix User Guide
Image
Add an Image to vMix in PNG, JPEG, TIFF or BMP format.
Photos
Load all photos in a directory into a single Input in vMix using this option.
Selecting a Photo
Once the Input has been loaded you can right click the Input to select a photo to display from the
SlideShow Settings window.
The controls on the Preview or Output windows can also be used to move backward and forward through the
list of photos.
PowerPoint
Load a PowerPoint slideshow with this option.
You must have a copy of PowerPoint installed to use this option.
Colour
Select a solid colour to use as a separate input. This can be used with the Multi View feature as a
background colour.
Audio
Play Audio Files such as MP3 and WAV.
Audio Input
Audio Input can be used to add multiple audio sources to vMix such as Microphones, USB audio devices
and any sources compatible with the ASIO drivers.
Each of these inputs can be independently controlled from the vMix Audio Mixer, turning vMix into a fully
fledged audio mixer alongside your video production.
Audio Device
Select the Audio Device or Microphone to add.
Audio Channels
73 / 224
vMix User Guide
Some devices support multiple channels, you can select any stereo pair or a single mono channel here.
To add more than two channels, add multiple inputs selecting a different channel each time.
Title / XAML
The Title input is a quick and easy way to bring in Titles and Lower Thirds into your production.
Each Title input can have its own customisation text and Title Presets can be created to make it easy to
change the text of a title during a production.
You can select one of the many built in Title Templates or build your own using the vMix Title Designer.
The text in each template can be edited through a right click menu on the Input.
74 / 224
vMix User Guide
Font
Decrease Font Size
Increase Font Size
Font Colour
Duration (To set Ticker duration)
Live Mode
While the Live button is green, all text typed into the Title Editor window will update the title in real time.
Click the Live button to display live updating and click it again once all changes have been made.
Title Presets
Click the + button to save the text from all the elements in the title as a preset.
This preset can be selected by right clicking the input in the main vMix window to recall these values at any
time.
Title Presets can be Imported and Exported in CSV format using the Import and Export buttons
Countdown Timer
The countdown timer can be used to automatically update the title with a timer that runs either in reverse
(countdown to 0) and optionally forward.
To specify the countdown parameters click the Settings button to bring up the Countdown Settings window.
75 / 224
vMix User Guide
Duration
Specify the duration in hours, minutes and seconds the timer will count. For example 00:15:00 for a 15
minute timer.
Specify the to either begin or end with depending on the countdown direction.
For example, in countdown mode with a duration of 15 minutes, if the Stop Time is set as 00:05:00 (5
minutes) the countdown will run from 00:20:00 to 00:05:00 and then stop.
In reverse mode the countdown would run from 00:05:00 to 00:20:00.
Display Format
Reverse
Flash/RTMP
The Flash Input allows you to insert SWF and FLV files as well as Live RTMP streams into vMix.
The latest version of Adobe Flash Player for Internet Explorer (version 10 or higher) should be installed first.
Flash Settings
URL
A URL can also be typed in if it refers directly to a SWF file.
e.g http://www.example.com/test.swf
RTMP Streams
RTMP Streams can be loaded into vMix in the following URL format: rtmp://web_site_url/live/myStream
Refer to the documentation of the streaming server for the correct URL format for your particular stream.
RTMP Buffer
The RTMP Buffer can be configured to assist with either low speed connections or low-latency streams.
Set this to 0 if you have a fast connection and want the least amount of delay possible.
76 / 224
vMix User Guide
YouTube
In the case of YouTube a special URL is required in the format of http://www.youtube.com/v/VIDEO_ID
Where VIDEO_ID is the unique ID provided by YouTube for a particular video.
Performance
Converting FLV files prior to another format such as AVI prior to use in vMix may result in better
performance.
Alpha Channel
The alpha channel transparency within the SWF file is fully preserved allowing the use of Flash Animations
as animated overlays.
(For example an animated watermark or logo)
Flash will also receive mouse input if it has been setup as an MultiView Overlay on top of another input.
This allows for the possiblity of using a transparent flash based drawing control, to enable drawing on top of
another input (such as a Video Delay for Sports)
Virtual Set
The Virtual Set features provides the ability to integrate a chroma keyed live camera and other graphic
elements into a real-time 3D rendered virtual set.
This virtual set can then be smoothly zoomed and panned just like in a live television studio.
Setup
Choose from one of the built-in Virtual Set presets to add it to vMix.
Each will show a placeholder image giving an idea of where the camera and other elements will be located
within the virtual set.
Control
Each Virtual Set has two tabs that can be used for customisation.
Camera
77 / 224
vMix User Guide
The Camera Tab provides thumbnail previews of the camera angles available within the Virtual Set.
To switch to a camera angle, simply click on the thumbnail.
To customise the camera angle, right click on the thumbnail.
The speed of the camera zoom is determined by the F (Fast), M (Medium), S (Slow) and C (Cut) buttons
above the thumbnail previews.
Setup
The Setup Tab can be used to adjust the various layers that form a complete Virtual Set.
While in the Setup Tab the mouse can be used to click and drag on the preview window to change the
location of the layer.
Hold down the Shift key to resize the layer.
Reset Position: Revert the layers position and scale to the default setting.
Visible: Toggle on or off this layer. This can be used to hide desk in some Virtual Sets.
Web Browser
Use the Web Browser input to add any web page to vMix.
Settings
URL
Type in the full web page URL that you wish to display. For example: http://www.vmix.com/
Width, Height
Specify the Width and Height in pixels when rendering the web page.
If these are set to a size smaller than the vMix Output Size, the web page will initially be displayed centred
and at the reduced size.
This is handy for HTML widgets you may wish to use as Overlays as they will show at the correct size and
simply need to be moved into position
from Input Settings - Position.
Mouse Control
78 / 224
vMix User Guide
Once added, the web page can be controlled by clicking and dragging the mouse on either the Input window
or the Preview/Output within vMix.
Keyboard Control
Keyboard use within the web page can be enabled by right clicking the input and selecting the Keyboard
Enabled option.
IMPORTANT: When this option is enabled, keyboard shortcuts in vMix will no longer be active.
To enable the keyboard shortcuts again, right click the web page and disable the Keyboard
Enabled option.
Transparency
The Web Browser input in vMix supports transparent backgrounds and alpha channel when used by sites
such as TwitchAlerts.
To create your own page with transparent background, simply create a page where the background colour
for the <body> element is not specified.
Right click on the Web Browser input to Go Back, Go Forward or change the web page from the Properties
window.
Media
The Web Browser Input utilises the Chromium Embedded Framework (CEF) and has most of the features
available in the Google Chrome browser.
This includes HTML5 video and audio playback and other media features such as WebRTC.
Audio
Audio is fully supported with the Web Browser input and can be independently mixed just like any other
audio source in vMix, no desktop audio capture needed.
79 / 224
vMix User Guide
Input Buttons
Input Buttons are the buttons available underneath each input.
Close
Close the Input and remove it from the Input Bar.
Quick Play
Fades directly to the Output Window and for video inputs, starts playing input from current position.
Cut
Cuts directly to the Output Window and for video inputs, starts playing input from current position.
Loop
The input will automatically begin from the start again once it has finished playing.
1,2,3,4 (Overlay)
Click one of the numbered buttons to overlay this input on top of the currently displayed Input.
The input will display according to the overlay settings.
Click the button again to remove the overlay with the transition running in reverse.
Overlay Preview
Each overlay can be display in the Preview window by using a right click instead of a left click.
Use a right click again to remove the overlay.
When in preview mode the Picture In Picture Zoom feature described below is activated with a left click
instead.
TIP: An Overlay that is being previewed will be sent to the Output automatically when the next
transition or cut occurs
When an overlay is active and set to "Picture In Picture" mode you can right click the numbered button to
expand it to fill the screen.
Right click again to reduce the size back to the Picture In Picture settings.
Audio
Mute/unmute Audio.
80 / 224
vMix User Guide
81 / 224
vMix User Guide
Input Settings
Input Settings are available by clicking the cog button underneath an input while in Advanced mode or
by double clicking the Input Title Bar.
General
Colour Adjust
Colour Key / Chroma Key
MultiView
Position
Triggers
Tally Light
Advanced
82 / 224
vMix User Guide
General
Change
Click Change to change the source of this input while preserving all settings including colour adjustments,
chroma key, position and multi view.
Settings
Name: Change the name of the input as it displays in the title bar.
Mouse Click Action: Select the action to take when the preview window of this input is clicked. By default
this is to send the Input to preview.
The Virtual Input depends on the original input in order to display video, so if a camera input is closed
any virtual inputs created from that camera will become blank.
83 / 224
vMix User Guide
Colour Adjust
Black Stretch: Increase the black level of the video.
White Stretch: Increase the white level (or brightness) of the video.
Red / Green / Blue: Independently adjust the rgb channels of the video.
Saturation: Drag this bar to the right to increase colour saturation or drag it to the left to convert colours into
black and white (greyscale).
84 / 224
vMix User Guide
Colour Key
Colour Key can be used to select a transparent colour when using an input as an Overlay or inside a Virtual
Set.
This option can also be used with a green screen, see the options below for more information.
Chroma Key: Move this slider slightly to the right to improve the colour key quality when a green/blue
screen is being used.
Chroma Key Filter: Removes green/blue halos from an image when using a green screen. The scroll
bar can also be used to increase the transparency of the green elements.
Auto Chroma Key Presets: Click the 1, 2 or 3 button presets to automatically select settings suitable for
use with a green/blue screen.
Depending on your green screen setup some of these presets may work better than others.
The sliders can then be adjusted slightly to fine tune.
1. Click Auto Colour Key at the top of the window and select a colour.
2. Click Auto Chroma Key towards the bottom of the window.
3. Drag the Chroma Key slider all the way to the right, this will initially appear to decrease the effectiveness
of the colour key until step 4 is utilised below.
4. Drag the Chroma Key Filter slider towards the right to increase the transparency of the background.
5. If objects or actors appear transparent, try dragging back the Chroma Key slider and repeating step 4
until the most effective combination has been found.
6. Click Anti Aliasing if jagged edges appear.
85 / 224
vMix User Guide
Luma Key
Luma Key is used to key out the background based on brightness or luminance. For example white text on
black background.
Key/Fill Input
Select another input to use as the Key channel for this input.
The input selected should be grey scale with black representing fully transparent (0) and white as opaque
(255).
86 / 224
vMix User Guide
MultiView
Select up to five inputs to display in one of the selected configurations. For example, split screen and
picture in picture.
Each of these inputs can be positioned by dragging the windows within the preview box at the bottom of the
window.
Hold down shift while dragging to resize each input. Alternatively click one of the Position buttons to adjust
manually.
Once the positions have been configured, the Add button on the right hand side can be used to create a
template.
87 / 224
vMix User Guide
Position
Zoom: Zoom in or out.
Pan X: Pan from left to right
Pan Y: Pan from top to bottom
Rotate: Rotate image from right to left.
Crop X1: Crop from the left hand side
Crop X2: Crop from the right hand side
Crop Y1: Crop from the top
Crop Y2: Crop from the bottom
Each of these options can also be changed for one of the four overlays through the dropdown menu.
88 / 224
vMix User Guide
Triggers
Triggers can be used to automate tasks when an Input either begins a transition (OnTransitionIn), begins a
transition out (OnTransitionOut) or when a video completes playback (OnCompletion)
OnOverlayIn and OnOverlayOut can also be used when an Input is used as an Overlay
An unlimited number of tasks can be added, with each task running in the order it appears in the list.
In the example above the Title 1 input is turned on as an overlay 1 second after the current input begins a
transition. After 5 seconds the overlay is turned off again.
Trigger
OnTransitionIn
OnTransitionOut
OnOverlayIn
OnOverlayOut
OnCompletion
Function
Select a task or transition effect (such as Fade, Cut etc)
Note that in order to prevent loops, transition effects have no effect for OnTransitionIn or OnTransitionOut.
Input
Select the Input the Function applies to (if applicable)
Duration
Select the duration of the transition effect (if applicable)
Delay
This trigger will wait for the selected amount of time (in milliseconds) before completing the selected
Function and moving on to the next item in the list.
89 / 224
vMix User Guide
Tally Light
See Tally Lights
90 / 224
vMix User Guide
PTZ
See PTZ - Pan Tilt Zoom
91 / 224
vMix User Guide
Advanced
Filters
View and change properties for the DirectShow filters used to display this input.
92 / 224
vMix User Guide
Audio
Audio Mixer
Audio Settings
Control settings such as Gain and add effects including Compression, EQ and Noise Gate here
Recording Audio
Audio Meters
93 / 224
vMix User Guide
Audio Mixer
Click the Audio Mixer button on the right hand side of the main interface to bring up the Audio Mixer tab as
shown below.
Each fader also includes an Audio Level Meter for the Left and Right channels respectively.
Detach Button
The Audio Mixer can be detached from the main vMix window by clicking the Pin button.
To dock the Audio Mixer back again, click the Minimise button of the detached Audio Mixer window.
Outputs
The Master audio mix is displayed here alongside Bus A and B if they have been configured.
Headphones volume can be configured independently by spinning the Headphone volume control knob.
Inputs
Each Input that contains audio will be displayed here.
94 / 224
vMix User Guide
Audio Settings
Solo
Click the Solo button to preview Input audio in the Headphones without affecting the mix.
Solo audio is Post-Effects and Post-Fader and will be audible even if the Input is muted.
Mute
Click the Green and Orange Arrow button to enable/disable automatic mixing of audio.
This option is also known as "Follow" on traditional video switchers.
Audio Buses
vMix allows for up to three independent audio buses to allow for complex audio routing scenarios including
mix minus.
M is the Master or Default audio mix and is sent to Recording, Streaming and External Output.
A, B
A and B are two additional audio mixes that are sent to the A and B Audio Output devices configured in the
Audio Outputs settings window.
Click the M, A or B buttons underneath each input to configure each independent each mix. By default all
new inputs will be sent to the Master mix only.
Note: The Speaker/Mute button controls the audio for all audio buses not just the Master or M
bus.
Collapsing Mixers
All mixers can be collapsed and restored by right clicking the Title of the mixer.
95 / 224
vMix User Guide
96 / 224
vMix User Guide
Audio Settings
General
Headphones Volume
Each audio input can have its own independent headphones volume set.
This is great for situations where you want an audio source such as a microphone audible on the final
recording or stream but do not want to hear
it in your own headphones as the slight audio delay coming from your own microphone can be disorienting.
Pre / Post
These audio meters can be used to monitor the audio audio at the pre-effects stage (for any effects, volume
or gain, including delay)
and the post-effects stage (after all effects, volume, gain and delay have been applied)
Format
Displays the current audio format of the input
Channel
Select the audio channel to use for this input.
If you have a Microphone plugged into the left channel or right channel independently. Select
SeparateMono here.
Separate mono allows you to adjust the volume of both mono channels independently from the Audio Mixer.
The audio from each microphone will be audible on both the left and right channels simultaneously.
For finer control of how different channels are mixed. See Channel Mixer below.
97 / 224
vMix User Guide
Gain
Select the gain (or amplification) in decibels.
Gain is added after the compressor. (See below)
Delay
Delay the audio source in milliseconds
EQ
Compressor
Compressor is a standard dynamic audio compressor.
98 / 224
vMix User Guide
Noise Gate
The Noise Gate is a handy way of reducing noise on an Audio Input such as a Microphone
It works by quickly fading out the audio when it drops below a certain dB (decibel) Threshold
Channel Mixer
The channel mixer can be used to route and control individual channels.
For example if a Microphone is connected that is only audible on channel 1, select L and R
for channel one so it can be heard on both the Left and Right channels on the final output mix.
1,2,.. represent the channels coming in from the source, L + R represent the final stereo left and right
channels coming out of vMix and used in recordings and streams.
Audio from sources such as NDI and Cameras may have up to 16 channels available which can be mixed
here into a final 2 channel output.
99 / 224
vMix User Guide
100 / 224
vMix User Guide
Recording Audio
There are a number of ways to use audio in a vMix production. A couple of these approaches are described
below including an advanced setup using an external audio mixer.
In the diagram above, all audio sources such as Microphones and Cameras run directly into vMix.
vMix provides a built in fully functional professional audio mixer with built in EQ, Compression and Gain
controls.
More details can be found in the Audio Settings section.
The Master audio mix includes all inputs in vMix, including Cameras, Microphones and Videos and will be
recorded according to the levels set in the built in Audio Mixer.
Make note of the Automatically Mix Audio setting as this determines if audio sources are automatically
muted when not in use.
Multiple microphones can be connected to your vMix PC using a USB ASIO audio interface, such as from
Behringer, M-Audio, Focusrite and others.
The Behringer UMC404 is an example of an audio interface that supports up to 4 XLR microphones and
each can be added separately to the vMix audio mixer for independent control.
101 / 224
vMix User Guide
In the diagram above, all external audio sources such as Microphones are connected to a separate external
Audio Mixer.
This contains all the audio from vMix inputs such as video clips.
This can be connected using a stereo audio cable from the computers built in Speaker Output or a USB
Audio Interface such as the Behringer UMC404.
Many Audio Mixers include built in USB connectivity which is recommended to ensure the highest possible
audio quality.
Regardless of which output method you choose, this output can be selected under the Master option
Settings -> Audio Outputs in vMix
This is the final audio mix that should include all audio needed for the recording and stream.
This connection from the mixer to vMix can be made using a USB Audio Interface or the built in USB
capabilities of some audio mixers (recommended)
Or using the Line In / Microphone input on the computer. If using the computers Line In, be sure to confirm
the audio mixer output is "unbalanced".
As "balanced" audio signal will result in heavily muted and/or distorted audio.
Finally, to add this audio mix to vMix, follow the instructions below:
102 / 224
vMix User Guide
3. Open up the vMix Audio Mixer and turn off the "M" bus and enable bus "A" instead.
4. From Recording Setup, select BusA as the audio source and also from Streaming Settings -> Quality
as shown below:
103 / 224
vMix User Guide
5. A negative audio delay should also be used to compensate for the delay of routing all audio externally.
This can be done from the Recording Setup window and also Settings -> External Output for the Stream
You may need to adjust this to suit your particular setup, but in general a delay of -80 for 30p and -100 for
25p works best.
104 / 224
vMix User Guide
Audio Meters
vMix displays Audio Meters in four different locations:
3. Audio Mixer
4. Audio Settings
Each audio meter will display green levels when the audio is turned on and blue levels when muted.
The audio meters are also colour coded into 5 distinct bands to make it easy to determine the approximate
audio level at a glance.
105 / 224
vMix User Guide
Levels are always displayed in dBFS (digital "full scale") where 0 dB equals the maximum possible volume
for a given bit rate.
Peak Levels
So see the maximum peak levels of an audio source at any time, hover the mouse over the audio meters.
The peak level displayed here is calculated as the maximum audio volume (amplitude) received in the past
~2 seconds.
106 / 224
vMix User Guide
To enable the A or B buses, do one of the following in Settings -> Audio Outputs
1. Set A or B to Enabled
2. Set A or B to a free channel on an audio device (such an ASIO audio interface)
Recording
Select the audio mix from the dropdown box next to Audio in Recording Setup
NOTE: Only the AVI video format and the WAV File Record options supports more than 2 channels,
if a 4 or 6 channel option is selected here for other formats
then only the first 2 channels will be included.
Streaming
Select the audio mix from the Channels dropdown box in Streaming Quality Settings
External Output
Select the audio mix from the Audio Channels dropdown box in Settings -> External Output
AJA and Blackmagic support 2, 4 and 6 channel output. When embedding up to 6 channels in SDI, the
remaining
10 channels will be left silent.
107 / 224
vMix User Guide
108 / 224
vMix User Guide
Recording
vMix supports recording the Output into a number of formats including AVI and MP4.
109 / 224
vMix User Guide
Pros: Fast, high quality recordings with moderate file sizes. Supported by most video editors.
110 / 224
vMix User Guide
Uploading to YouTube
MP4
Bit Rate: 25 Mbps (HD) or 8 Mbps (SD)
Audio Bit Rate: 192 Kbps
Pros: Files can be played anywhere and can be easily uploaded to most web sites
Cons: Provides good video quality for file size, but may not be suitable for high quality post
production video editing.
111 / 224
vMix User Guide
112 / 224
vMix User Guide
Setup
Click the Cog Button next to Record from the Main Window to bring up the Recording Setup window.
Some video formats do not support partial recordings in the event of a power outage or system failure.
Read about Fault Tolerant recordings here
AVI
Filename
System
Frame rate of the recording. (Set this to match the Frame Rate set under the Display tab under
Settings)
Codec
File Format
Audio
Enable audio on this recording and select the audio channels to include. See Output Audio Channels
Audio Delay
This sets a delay on the audio input in milliseconds. For example if the audio is earlier than the video by
200ms, type in 200 here.
FFMPEG
FFMPEG is an open source encoding tool that provides the ability to record to a number of formats
including MPG, TS, MP4, MOV and MXF.
Codec
113 / 224
vMix User Guide
Select the recording format to use out of MPEG-2, MP4 X264 with AAC audio and VC-3
Format
Depending on the codec a number of file formats will be available.
MXF or the MOV/MP4 non-Indexed formats are recommended as they support file recovery in the event
of a power or system failure.
MP4
MP4 creates a video file containing H264 video and AAC audio.
Due to the complexity of H264 compression, this option requires a faster processor for optimal
performance.
Bit Rate
Select the Bit Rate for the H264 video stream in Mbps (Megabits per second). 25 is recommended for
high quality HD (similar to AVCHD)
MPEG-2
Options are the same as above but with the following additional settings:
Bit Rate
Specify the Bit Rate for the MPEG-2 recording in Mbps (Megabits per second). 8 is recommended for
SD, 25 for HD.
File Format
Port that Windows Media Player can connect to to view the stream.
Width/Height
Bitrate
FPS
114 / 224
vMix User Guide
Quality
Codec
WMV codec to use. WMV1 is the fastest but the lowest quality. WMV3 is the slowest with the highest
quality.
Audio Compression
115 / 224
vMix User Guide
Record
Click Record to start the video recording.
Note: The Cog Button must be clicked first to configure the recording prior to starting
A duration counter will begin next to the Start button as well as a dropped frame counter.
Dropped frames may indicate a computer performance issue, or merely as a side effect of using a different
frame rate.
(For example of recording at 30fps from a 25fps source, 5 dropped frames will show up per second)
116 / 224
vMix User Guide
TIP: Use the "New File Every" option to create new recordings at regular intervals so if one file is
lost in event of a power outage, the majority of the recording can be recovered.
The following table describes the fault tolerance of each recording format supported by vMix:
MPEG-2 TS (Transport Stream) is the best fault tolerant format out of the above.
117 / 224
vMix User Guide
Live Streaming
Getting Started
Settings
Streaming Quality
Advanced
118 / 224
vMix User Guide
Getting Started
The following is a quick overview of the steps needed to begin streaming to the web
Click the cog icon next to the Stream button in the main vMix window.
119 / 224
vMix User Guide
Alternatively, the channel settings can be specified manually using the instructions below.
vMix supports most 3rd party streaming providers (also known as CDNs) and dedicated streaming servers
such as WOWZA.
Stream Name or Key This may also be called Stream or Stream Name.
Once you have retrieved this information, type it into the boxes provided.
The cog icon can also be clicked to open up the Streaming Quality window where you can customise these
settings to suit your requirements.
5. Select an Application
By default the free FFMPEG is installed with vMix and provides high quality
streaming with H264 video and AAC audio.
Optionally, the free Adobe Flash Media Live Encoder (FMLE) can be installed in order to stream with
vMix.
This can be downloaded from the Adobe web site.
FMLE can be used if your streaming provider does not support FFMPEG, or if you need MP3 audio
encoding support.
6. Start Streaming!
Click Start to begin streaming. The button will light up red in both the Streaming window and in the main
vMix window when streaming.
After a few seconds if you receive an error, double check the settings in step 3. to ensure they match the
details given to you by your streaming provider.
7. Advanced settings
An overview of all the settings available can be found in the Streaming - Settings section.
120 / 224
vMix User Guide
Settings
1,2,3 Buttons
These buttons allow streaming to up to three different streaming providers simultaneously. See Using
Multiple Destinations for more information.
These buttons will only appear when selecting FFMPEG as the application. (See Applications section
below).
Profile
Create one or more profiles with unique streaming settings, for example one for each streaming provider.
Only one profile can be used at a time.
Click Add to add a new profile that contains a COPY of the settings from the current profile. Delete to delete
the currently selected profile.
Destination
Select from one of the built in streaming providers, or select Custom RTMP Server if you want to enter in the
streaming details manually.
121 / 224
vMix User Guide
Stream Key
Advanced
This is the resolution and frame rate of the video that vMix sends to the stream prior to it being resized for
broadcast.
This setting matches what is set in Settings - External Output - vMix Video Device and by default will
automatically match the settings used in the Streaming Quality window as close as possible for best
performance.
The green lock button automatically adjusts the Input Size to match the settings used in Streaming
Quality and should be left green for best results.
Quality
Select the encoding profile to use for the stream. A number of built in presets are included or you can click
the cog icon to customise these.
See Streaming Quality for more information
Application
FMLE
Use Adobe Flash Media Live Encoder as the streaming encoder. Requires Adobe Flash Media Live Encoder
to be installed which is free from the Adobe web site.
FMLE has built in support for H264 video and MP3 audio. For AAC audio an additional plugin can be
purchased from MainConcept.
FFMPEG
This is a free streaming encoder installed with vMix.
FFMPEG supports H264 video and AAC audio.
FFMPEG provides better quality and AAC audio support, but may not be supported by some providers.
This check box is available for most NVIDIA graphics cards and substantially reduces the CPU usage of the
computer when streaming by taking advantage
122 / 224
vMix User Guide
of the hardware encoder built into most recent NVIDIA graphics cards, including the 750, and 9xx series.
Start
Save all streaming settings and start the stream. This button will light up Red when running in addition to the
Stream button in the main vMix window.
View Status
View some technical information on the stream while it is running. This is useful when troubleshooting
connection issues.
123 / 224
vMix User Guide
Streaming Quality
The Streaming Quality window allows you to customise your streaming quality settings to suit your
production.
Encode Size
Set the resolution of the stream here. These sizes should match the aspect ratio you are using in vMix. For
example 640x360 for Widescreen and 640x480 for Normal (4:3)
Video
124 / 224
vMix User Guide
Profile
Select the H264 encoding profile to use. Baseline is lower quality, but uses less CPU. Main is higher quality
at the expense of higher CPU usage.
Level
This is an advanced setting for users wishing to specify a particular encoding level to match the capabilities
of an end point decoder.
Preset
This is an advanced setting for users who wish to fine tune the FFMPEG encoder (x264)
veryfast is the recommended setting which provides the best balance of CPU usage and quality
Keyframe Frequency
Select the number of seconds between each keyframe in the video stream. Higher numbers generally result
in better video quality. 2 seconds is recommended
by some streaming providers and is the default here.
Threads
Specify the number of threads to use when encoding video and audio with FFMPEG as the Application.
4 is the default and is recommended. For 4K streaming, extra threads may provide better performance.
Network Buffer
This is the maximum number of seconds vMix can keep buffered at any time and reflects the maximum
streaming latency
from vMix. (Note that streaming servers and players add their own buffers on to this time)
Increase the Network Buffer if the maximum network speed available is unreliable.
Strict CBR
When this is enabled, vMix will try to keep the streaming speed as close to the selected bit rates as
possible.
Note that this option may reduce the quality of the stream.
Keyframe Aligned
When sending multiple bitrates, select this option to ensure all streams are aligned on the same keyframe.
This can improve seamless switching support at the expense of slightly lower quality.
Auto Adjust
When using FMLE as the encoder, the quality of the stream can be dynamically adjusted to suit the
conditions of the internet connection.
Audio
Select the Audio encoding format to use with the stream.
MP3 is supported when using FMLE (Flash Media Live Encoder) as the encoder, while AAC is the only
option when using FFMPEG.
125 / 224
vMix User Guide
If you would like to use FMLE with AAC, an additional plugin needs to be purchased from MainConcept.
Audio Channels
See Output Audio Channels
126 / 224
vMix User Guide
In the example above, two streams are enabled, one at 1500kbps and 640x360 and one at 3000kbps at
1280x720.
Independent Audio Bit Rates can also be selected when using FFMPEG only. In FMLE audio bit rates are
the same for each streams.
Stream Key
By default vMix will append a number to the end of the stream key when Multi Bitrate is used.
For example, with three streams a Stream Key of "myStream" will become myStream1, myStream2, and
127 / 224
vMix User Guide
myStream3
If each Stream Key is named differently, consider using Multiple Destinations instead.
128 / 224
vMix User Guide
NOTE: If you do not see these buttons, make sure Application has been set to FFMPEG.
Limitations
129 / 224
vMix User Guide
Advanced
Click the Advanced button for the following additional options:
Stream
Username/Password
Backup Stream
URL
Specify a backup URL if the primary stream URL is not available (FMLE only)
Save to file
Save a copy of the stream in file format here. (FMLE only)
130 / 224
vMix User Guide
External Output
External Output allows you to send audio and video out of vMix in a number of different ways:
1. To HDMI, SDI or Analog outputs through compatible hardware from AJA, Blackmagic Design and
Bluefish.
2. To other applications running on the same PC such as Skype
3. To other devices on the network using NDI
The External Output Settings window will be displayed. More more information on the options available see
Settings - External Output.
131 / 224
vMix User Guide
Important Note: Many older Blackmagic cards can only perform one task at a time, either Capture
or Output.
2. Under the External Output tab check the External Renderer box
2. Under the Device dropdown box, select the item that matches the name of your output
card.
(For example "Intensity Pro", "AJA Kona" etc)
Frame Rate: In most cases this should be set to either PAL 50i, PAL 25p or NTSC 59.94i, NTSC
29.97p
Output Size: For full HD select 1920x1080, for SD select either 720x576 (For PAL) or 720x480 (For
NTSC)
Port: This setting should match the connector being used, for example HDMI or Component
132 / 224
vMix User Guide
3. Click OK to confirm your settings and head back to the main vMix Window.
4. Click the External Button on the bottom right hand corner of the screen next to the Cog
Button. The output of vMix should now appear on your external display.
If the external display is blank, make sure the correct connector is being used on the device. (There
are separate outputs for input and output for both HDMI and Component on the Intensity Pro for example)
133 / 224
vMix User Guide
vMix supports an unlimited number of Shortcuts that can be assigned to anything from Keyboard Keys to
MIDI Faders.
In other systems you may know these as Macros.
All of these shortcuts can be configured from the Shortcuts tab in Settings
Controllers you can use with vMix (Keyboard, MIDI, X-Keys etc)
How to add a Shortcut
Templates
Local and Global Shortcuts
Assigning Multiple Functions to a single Shortcut
Advanced MIDI Shortcuts
134 / 224
vMix User Guide
Controller Options
Keyboard
Shortcuts can be assigned to almost any key on the keyboard.
Web Interface
All shortcuts are available from the built in web interface allowing you to use any web enabled
device to control vMix. See Web for more information.
Control Surface
The vMix Control Surface provides three programmable keys (F1, F2, F3) that can be assigned to a
Shortcut.
MIDI / X-Keys
Shortcuts can be assigned to buttons, faders and knobs on any MIDI compatible device.
X-keys controllers are also supported automatically by vMix and show up as MIDI commands as well.
135 / 224
vMix User Guide
To quickly select the Key or Control you wish to assign this shortcut to, click the Find ... button
and then press or move the control you wish to use.
MIDI Note: If using a MIDI controller, make sure it has been plugged in and turned on before
starting vMix.
Then from the Shortcuts tab in Settings click the MIDI Settings button to enable the device.
Function
Click the arrow next to the Function dropdown box and the Select Function window appear with a number
of commands or macros to choose from, organised by category.
136 / 224
vMix User Guide
Duration
If the function selected is a transition, configure the duration here in Milliseconds
Input
If the function controls a particular Input, select it here.
You can also tick Assign Shortcut to Input Number so this shortcut will always
control any input assigned to a particular Number, otherwise the shortcut will
control the same input even if it has been moved.
137 / 224
vMix User Guide
Templates
The Shortcut Templates feature allows you to import and export sets of shortcut keys and save graphical
layouts for reference and printing purposes.
2. Click the Apply button. This will override any existing Shortcuts that share any of the buttons.
AudioLaunchControlXL
This template is designed to be used with the novation LaunchControlXL USB MIDI controller.
It assigns the first 7 faders to the first 7 inputs in vMix and the final fader is assigned as the Master volume
control.
Default Keyboard
This template contains the default keyboard shortcuts that were included with previous versions of vMix.
Replay ShuttlePROv2
This template assigns common Instant Replay functions to the ShuttlePROv2 USB controller
138 / 224
vMix User Guide
Global shortcuts are saved in the vMix settings and will be remembered each time vMix is opened.
Local shortcuts are saved in Presets and will only be remembered if a Preset is saved and subsequently
opened later.
Local shortcuts take preference over Global shortcuts, so if you have two shortcuts assigned to the letter A,
one local and one global, the local shortcut will be triggered and the global shortcut will be ignored.
139 / 224
vMix User Guide
When the button is pressed they will be called in the order in which they appear in the Shortcuts list.
Use the up and down buttons to change the order if necessary.
140 / 224
vMix User Guide
However, some controllers may have controls that operate a bit differently to what vMix expects, which is
why
there are a couple of extra MIDI control options available in the Edit Shortcut window as shown below.
Channel, Note
Channel and Note are automatically detected by clicking Find and pressing the MIDI button or moving the
fader or knob.
Value
If you would like to assign different shortcuts to different positions of a single control, such as a rotary knob,
you can tick
the Value box and specify a number between 0 and 127.
Type
For most controls that provide a linear value from 0-127 the Default setting is recommended here.
Other controls, known as Jog Wheels are continuous and only send a value for left and a value for right,
and some may even provide different values depending on how fast the wheel is turned.
For these controls, set the Type to one of the JogWheel settings.
There are four speeds of JogWheel available in vMix so that the jog wheel either controls the corresponding
Function in slow (JogWheel and JogWheel2X) or fast (JogWheel5X and JogWheel10X)
increments.
For example, setting the Type to JogWheel and setting the Function to SetMasterVolume will increase the
volume when turning the control right and lower the volume when turning the control left.
For instant replay, JogWheel MIDI controls can be assigned to the ReplayJumpFrames function to move
backwards/forwards through a replay frame by frame
or ReplayChangeSpeed to slow down playback when moving the control left, and speed up again when
moving the control right.
NOTE: Both the Shuttle and Jog Wheel controls on X-Keys controllers should be configured as
JogWheel here.
141 / 224
vMix User Guide
Activators can be used to activate lights, button LEDs and motorised faders in response to changes in vMix.
For example, you can assign a row of LED buttons on MIDI controller to a row of Inputs in vMix and have
them each light up when the corresponding input is live.
Getting Started
Add/Edit Activator
Activator Examples
142 / 224
vMix User Guide
Getting Started
1. Go to vMix Settings and click the Activators tab
2. By default no devices (i.e MIDI or X-Keys controllers) are enabled, so to select the controller you wish to
use click Enable Devices.
NOTE: For best results, also make sure the corresponding controller is enabled under the
Shortcuts tab by clicking MIDI Devices
X-Keys Controllers are enabled by default under Shortcuts and do not need to be selected.
For some examples of Activators that can be setup see Activator Examples
143 / 224
vMix User Guide
For help on all the settings available when adding an Activator see Add/Edit Activator
144 / 224
vMix User Guide
Add/Edit Activator
Control
Select and configure the type of control. For X-Keys controllers this will also be "Note". For MIDI controllers
this is usually Note for buttons and ControlChange for things like knobs and faders.
This is also where the Channel and Note need to be selected that correspond with the button, light or fader
you wish to setup.
To make things easier you can click Find and press the button or control to locate the correct settings.
Event
This is the change in vMix that you want to turn on a button light, or move a motorised fader.
There are a number of events to choose from as described below:
Default
Default is handy for configuring a default color for buttons that support multiple colors when the button state
is "off".
For example you may want a row of buttons to be orange when none are selected here.
When using this option you can also type in a range of notes up the top.
Input
This will turn on when the selected input is currently live and in the vMix Output.
InputPreview
InputPlaying
145 / 224
vMix User Guide
This will assign a MIDI value from 0 to 127 when the volume of an Input, Headphones or Master volume
changes.
This can be used with motorised faders or rotary controls with LED indicators
This will turn on when the selected input's audio/solo/bus etc button is turned on.
This will turn on when the Master or Bus audio button is turned on.
FadeToBlack
This will turn on when the FTB button in vMix is turned on.
This will turn on when the Recording, Streaming, External or Fullscreen output are turned on.
Input
Select the input you wish to use with the selected event.
Tick the "Assign Activator to Input Number" box if you want this activator assigned to a particular input
position only, so if inputs are moved around in vMix, the activator will not move.
Type
Select the type of button, fader or other type of MIDI control here.
There are a number of options available, depending on the model of MIDI controller.
This is also where the button color is selected if the MIDI controller supports different colors, such as the
AKAI APC40
146 / 224
vMix User Guide
Activator Examples
Toggle ON/OFF LED Button when Input 1 is in Output
This is for MIDI buttons that only have a single color on/off light.
147 / 224
vMix User Guide
Move the first motorized fader on the Behringer X-Touch when volume on Input
1 is changed
This example may also work on other MIDI controllers with motorized faders.
148 / 224
vMix User Guide
Turn a button on the AKAI APC40 MK2 controller blue when Input 1 is in
Preview
149 / 224
vMix User Guide
vMix Control Surface is an optional hardware control surface for vMix that connects via USB.
The following is a User Guide that describes the capabilities of each of the buttons and controls.
Setting Up
Visit http://www.vmix.com/controlsurfacedownload/ to download the latest drivers.
Run the installer and accept the prompts to install. Once installed, verify you have the latest version of vMix.
vMix Control Surface is compatible with all installations of vMix version 15 and beyond.
Plug in USB cable from vMix Control Surface to Computer. The lights should flash briefly indicating the unit
is receiving power over the USB connection. When using the Control Surface, it must be plugged in prior to
opening vMix in order to be recognized. If you plug the unit in while vMix is running, you may need to restart
vMix to recognize the Control Surface is connected.
The Control Surface uses an industry standard cross point layout consisting of Preview, Program and
Overlay keys.
Each input in vMix has a number next to the input name. These correspond to numbers on the Overlay,
Program and Preview rows on the Control Surface.
The Control Surface provides access to the first 12 inputs. Inputs can be dragged and dropped in vMix to
position the most frequently used sources for use by the control surface.
150 / 224
vMix User Guide
Press the number of the input on the Preview row that you want to assign to Preview.
1. Select the Overlay channel you wish to use. Example: if you want to overlay an input on channel 1,
press the DSK1 button. It will now light up indicating overlay channel one on the first 12 inputs is ready to be
used.
2. Press the desired input you wish to overlay. Example: if you have a lower third title in input 6, press
button 6 on the Overlay row. Button 6 will then light up indicating that input 6 is overlaid on channel 1 of the
chosen input.
3. To see which inputs are currently active on each overlay channel, you can cycle through the 4 DSK
buttons. If an overlay channel has an active input, the corresponding input will light up.
151 / 224
vMix User Guide
4. Select the desired Function. Example: if you wanted a button to start recording, select Start
Recording.
5. Press Ok and the selected function button is now ready to be used.
ALT Button
The ALT button can be held down in conjunction with other buttons in order to change their functionality.
This will allow enhancements to be added to future updates of vMix.
1. Hold down ALT while pressing a Preview row button to start playing that input if it is a video clip.
2. Hold down ALT while pressing one of the Overlay row buttons to turn on that overlay in the Preview
window instead of directly to Program/Output.
During the next transition the previewed Overlay will automatically be activated over the top of Program/
Output.
Transition Buttons
In live switching, changing from one camera or clip to another is called a transition. The vMix Control Surface
has three available transition types available, corresponding to transition buttons in vMix.
1. For a hard cut between two inputs, press the Take button
2. To use a stylized transition such as a wipe, fade or zoom, there are customizable transitions
located at the top of the vMix interface. Auto 1 and Auto 2 correspond to the first two transitions below
Cut. When these transition types are changed in the vMix window, the transition will also change for the
buttons.
3. Press FTB to fade the live output to a black screen. (Fade To Black)
T-Bar Operation
By default, the T-Bar allows a manual fade transition between Preview and Program.
The transition effect is linked with the Auto 1 and the first transition button in the vMix interface. If this button
is changed from Fade to Wipe for example the T-Bar movement will create a wipe transition instead of a
fade.
152 / 224
vMix User Guide
Web Controller
vMix Web Controller allows any web capable device to remotely control Shortcuts, Switching and Titles.
It can also be used to turn any mobile phone into a wireless tally light.
Examples of web capable devices include tablets, iPads and mobile phones.
The vMix Web Controller is turned on by default and you can find the web site address to type in our device
by clicking
Settings in the main vMix window and then clicking the Web Controller tab.
After typing in the Web Site Address into your device's browser, the following page will be displayed:
Shortcuts
Switcher
Tally Lights
Title Editor
153 / 224
vMix User Guide
Shortcuts
The shortcuts button will display any Shortcuts that have been added to vMix.
You can assign each of these Shortcuts a memorable title or description from the Edit Shortcut window in
vMix.
154 / 224
vMix User Guide
Switcher
Click the Switcher button to display the web interface in a mode similar to the hardware controller available
on a traditional video switcher.
The transition effects along the bottom match the transition buttons seen in the middle of the vMix main
window. (See Transition Buttons)
155 / 224
vMix User Guide
Tally Lights
The Tally Lights feature allows you to turn any WiFi enabled smart phone into an instant tally light!
The entire screen will be used as a tally light allowing you to mount it on top of the camera or place it near
your on air talent.
4. Select any Input from the list to start the tally light display.
The tally light display will change between the Preview and Output colours depending on the status of that
input.
WARNING: Most smart phones will automatically switch off or lock the display after a certain
period of time.
On Apple smart phones this can be turned off through the "Auto Lock" settings.
On Android smart phones you can install an app such as "Screen Timeout Toggle"
156 / 224
vMix User Guide
Title Editor
The title editor allows you to edit the text of any Title or XAML input in vMix from any WiFi web enabled
device.
This includes smart phones, tablets etc.
Select the Title Editor icon from the web interface and select a Title from the list.
Live
This section allows quick editing of each title field. Simply change the text and click Update.
To add the changed text to a Preset instead of updating the live title click Add Preset
Click Revert to go back to the title text the last time it was updated.
Presets
Presets uses the same presets found within the Title Editor Window.
To apply a preset to the Title click Apply. To delete the preset click X
157 / 224
vMix User Guide
Instant Replay
vMix Replay is a powerful Instant Replay system that adds full slow motion replay capabilities to vMix for up
to four camera inputs.
Features
158 / 224
vMix User Guide
System Requirements
The table below shows the minimum requirements to use vMix Replay.
Operating System Windows 7 or higher (64 bit only) Windows 7 or higher (64 bit only).
Windows 8.1 or higher
recommended
CPU Quad Core 3.4 Ghz Quad Core 4.0 Ghz (Six Core 3.6
Ghz highly recommended)
Storage Dedicated SSD for Replay 200GB Dedicated SSD for Replay 500GB
and higher. and higher. 1TB recommended.
Storage Connection Internal SATA only Internal SATA 3 and higher only.
Camera Requirements
Instant Replay primarily works with cameras connected to a capture card.
This includes HDMI and SDI cameras connected to a capture card either via PCI Express, Thunderbolt or
USB 3.0.
NDI sources can also be used with Instant Replay as long as they are in the same format as the current
Replay Session.
Webcams, IP cameras, and other types of video sources are not directly supported.
To use these types of inputs, the "Output" camera option can be selected in the Instant Replay settings.
Output will capture everything that is currently playing to the output in vMix.
159 / 224
vMix User Guide
Getting Started
To begin using vMix Replay, first add all of the cameras you will be using to vMix as inputs.
Next, click Add Input and select the Instant Replay tab as shown below:
Session Folder
This is the location where all Instant Replay recordings will be saved.
This must be dedicated SSD based storage
After selecting a folder, vMix will display an estimated recording time based on the selected recording format
and bit rate.
Recording Format
The recording format must match all camera sources that will be used.
The last mbps setting represents the bit rate quality of the recordings. 100Mbps is recommended for
broadcast quality recordings, but lower settings can be selected if there is limited SSD space available.
A four camera 100Mbps production will need around 530GB for three hours while a two camera 50Mbps
production will fit up to 12 hours in the same amount of space.
Delete All
This button will delete all video, audio and events within the selected session folder while keeping all replay
settings intact, including music and tags.
This allows you to use the same session folder and configuration for each game.
160 / 224
vMix User Guide
If disk space is running low, vMix Replay can automatically delete the earliest 20 minutes of the recording to
continue.
Note that any events that occurred in this deleted video will be lost.
If this option is left unticked, vMix Replay will automatically stop recording and notify the user that the disk
space is low.
Cameras
Select any Camera input already added to vMix here, if you add an input later on you can revisit this
configuration window by clicking the cog icon in the Instant Replay Controller window.
Output is also supported as one of the four camera inputs, and will record all video and audio playing in the
vMix output just like a standard recording.
In Transition
Select the transition to use when playing back events. This can be a standard transition, or optionally any
stinger that has already been configured.
Out Transition
Select the transition to use once the event playback has completed.
Event Transition
Select the transition to use between each event when more than one event is selected for playback, such as
in a highlight reel.
161 / 224
vMix User Guide
Workflow Overview
Once a new Instant Replay session has been configured and added to vMix (See Getting Started)
two new Inputs will appear. Replay A and Replay B.
These are two playback channels that can be used to play previously recorded footage at any time.
Each can have a camera angle assigned from any of the recorded cameras and these can be switched live.
1. Make sure vMix Replay is recording by clicking the record button so it lights up red.
2. When a team scores a goal, click the -5 button to instantly create a replay.
3. When you are ready to play back that goal, click the automatic replay button .
This will transition input A to output, play the event then transition back to Camera 1 when completed.
While the event is playing, try moving the scroll wheel on your mouse to change the playback speed.
Advanced Replay
The example above allows you create quick replays of a single camera with only a single click.
But what if you want to playback one or more previous events or change camera angles and add notes?
The Main Interface can be displayed by clicking the vMix Replay tab
162 / 224
vMix User Guide
When in Live Mode, all new events are created are based on
the current time "as it happens" on the live cameras.
Recorded Mode
When in Recorded Mode, all new events are created based on the time displayed above the position bar
in the Instant Replay controller.
This allows the operator to move the position bar back and forth through previous video to create events that
may have been missed live.
TIP: Be sure to enable Live Mode again when finished if you are in the middle of a recording
163 / 224
vMix User Guide
Main Interface
Mini Interface
The mini interface is located next to the Instant Replay channel "A" input and includes common controls
such as recording, quick 5 second or 10 second mark in / out buttons,
a playback last event button and a settings button.
Slow motion can also be controlled here in addition to the main interface.
164 / 224
vMix User Guide
Control Options
MIDI and X-Keys Controllers
The buttons on most MIDI and X-Keys controllers can be programmed vis the Shortcut feature to activate
most functions in Instant Replay.
For more information see Shortcuts User Guide
Jog and shuttle wheels can also be used on supported devices such as the Behringer CMD PL-1 or the X-
Keys XK-12 Jog and Shuttle.
Pay special attention to the Jog wheel configuration options when setting up a MIDI Shortcut. See
Advanced MIDI Shortcuts
Contour ShuttlePro v2
The ShuttlePro has 14 configurable buttons in addition to the Jog and Shuttle wheels.
To assign these buttons to shortcuts use the "ReplayA" to "ReplayO" Key options when creating a Shortcut
in vMix.
See Shortcut Reference for a list of Instant Replay related functions that can be assigned.
Keyboard
A number of keyboard shortcuts can be configured using the existing Shortcuts feature in vMix.
For a full list of what is available see Shortcut Reference.
Mouse
The mouse scroll wheel can be used at any time in the following ways:
165 / 224
vMix User Guide
166 / 224
vMix User Guide
Shortcut Reference
The shortcuts below can be configured as keyboard or controller shortcuts to allow easy control of common
Instant Replay functions.
See the Shortcuts User Guide
For a complete list of Instant Replay Shortcuts see Shortcut Function Reference.
ReplayStartRecordin
g
ReplayStopRecordin
g
ReplayMarkIn Create a new event with the In Point set to the current time (when live), or the time
displayed in the Replay Controller (when in recorded mode)
ReplayMarkInRecor Create a new event with the In Point set to either the current time or the time
ded displayed in the Replay Controller
ReplayMarkInLive
ReplayMarkInRecor Jumps to recorded mode and starts a new event from the most recent frame
dedNow allowing the operator to move the position bar backwards to set the out point.
ReplayMarkOut Complete an event started with ReplayMarkIn and set the Out Point to the time
described in Live and Recorded modes
ReplayMarkInOut Create an event with Value specifying the number of previous seconds to use
according to the time described in Live and Recorded modes
ReplayMarkInOutLiv Create an event With Value specifying the number of previous seconds to use from
e either the current time or the time displayed in the Replay Controller
ReplayMarkInOutRe
corded
ReplayMoveSelecte Set Value to the number of frames (positive or negative) to add to the InPoint of
dInPoint the selected event
ReplayMoveSelecte Set Value to the number of frames (positive or negative) to add to the OutPoint of
dOutPoint the selected event
ReplayLive Set all new event timing to Live mode. See Live and Recorded modes
ReplayRecorded Set all new event timing to Recorded mode. See Live and Recorded modes
ReplayLiveToggle Toggle between Live and Recorded modes.See Live and Recorded modes
ReplaySelectEvents Select the Event List to display in the Instant Replay Controller and to use as a
1,2,3,4,5,6,7,8 reference for any related controls
ReplayPlayEvent Set Value to a positive number starting from 0 where 0 is the most recent event
and 1 is the next most recent and so on.
ReplayPlayEventTo Same as ReplayPlayEvent but this will also automatically transition Replay A to
Output output if it is not already.
167 / 224
vMix User Guide
ReplayPlaySelected Play all of the selected events in the current Events list
Event
ReplaySetLastEvent Set text of the most recent event (based on time) to Value
Text
ReplayPlayPause This is the same as the PlayPause shortcut except it will always apply to the
Replay regardless of what Input is selected for the shortcut.
ReplayChangeSpee Specify Value as a number, positive or negative, to subtract from the current
d playback speed. For example 0.5 will increase current speed by 50%
ReplayExportLastEv Export last event (based on time) as a separate video file. This will default to the
ent export folder in the Replay Session Folder, otherwise Value can be used to
specify a custom folder.
ReplayPlayNext Transition to next event or angle in the currently playing events list
ReplayPlayPrevious Transition to the previous event or angle in the currently playing events list
ReplayMoveLastEve Specify Value as the number from 0 to 3 specifying the Events list to move the
nt last event (based on time).
ReplayMoveSelecte Specify Value as the number from 0 to 3 specifying the Events list to move the
dEvent selected events
ReplayToggleLastEv Toggle on or off playing back the Camera 1,2,3 or 4 of the last event.
entCamera1,2,3,4
ReplayToggleSelect Toggle on or off playing back the Camera 1,2,3 o 4 of the selected event.
edEventCamera1,2,
3,4
ReplayJumpToNow Jump to recorded mode and move the playback position to the most recent frame
of video.
168 / 224
vMix User Guide
vMix supports controlling multiple Pan Tilt and Zoom cameras directly from the main interface and by
shortcut and/or joystick control.
PTZ support can be enabled on any input, providing the ability to enable PTZ support regardless of how the
camera is connected, be it SDI, HDMI, NDI
or RTSP Stream.
NOTE: PTZ cameras will need to be connected to the same network as vMix in order to be
controlled.
This is usually done over Ethernet and is a separate cable connection if the video is coming in via
SDI or HDMI through a Capture Card.
PTZ Optics cameras and and other cameras that support the VISCA over UDP protocol such as
ValueHD.
Panasonic PTZ cameras that support CGI control over Ethernet including the AW-HE40, 50, 60, 65, 70,
120 and 130 series
Sony PTZ cameras that support CGI control other Ethernet including the SRG-300 series.
It is important to note that for simplicity and ease of use, only PTZ cameras that support network control are
supported.
Cameras that only have serial control such as via the VISCA or Pelco RS-422 or RS-232 protocols are not
currently supported.
169 / 224
vMix User Guide
Once the Device Type and Address have been selected click Connect to connect to the camera.
If successful, the controls below the Connect button will be enabled.
vMix provides three different methods for controlling a PTZ camera, you can either pick the method that suits
your production or use a combination of all three!
This method allows assigning a PTZ position to its own Input in vMix, turning one camera into potentially
unlimited "Virtual" cameras!
Simple push button controls for up, down, left, right etc to move the camera into position
Assign shortcut keys or controls to PTZ movements, including the ability to assign the joysticks on an
XBOX controller to a PTZ camera.
170 / 224
vMix User Guide
This will create a new input based on the current camera and PTZ position.
You can see these two inputs side by side in the screenshot above.
TIP: You can also right click the cog icon underneath the PTZ camera to create PTZ Virtual Inputs
without going into Input Settings
171 / 224
vMix User Guide
Step 5 - Use these inputs just as you would if multiple real cameras were
available
Any time one of these inputs is selected into Preview, the PTZ camera will automatically move into position.
When the input is not visible in either Preview or Output, a static image of what the camera was seeing
when the input was created will be displayed to make it easy to locate a particular camera angle.
PTZ enables the operator to create the illusion of a large multi camera
production with just 2 PTZ cameras!
The basic work flow involves swapping between the two cameras, paying careful attention to make sure the
movement of a camera is complete in Preview before switching it to Output.
Each virtual input that is created will create a corresponding update button in the Input Settings PTZ tab.
172 / 224
vMix User Guide
The number next to each button (for example "Update Input 2") corresponds to the number of the input in the
main window.
Moving the camera and then clicking the corresponding update button will update that virtual input so that it
recalls that position in the future.
TIP: You can also right click the cog icon underneath the PTZ camera to update any of the PTZ
Virtual Inputs without going into Input Settings
Most of the buttons available for PTZ are also available a shortcuts.
See the PTZ section of Shortcut Function Reference for more information.
173 / 224
vMix User Guide
174 / 224
vMix User Guide
For more information on the shortcuts available see Shortcut Function Reference
By default this template assigns all the buttons to the Preview input which means as long as a PTZ enabled
camera is in input it can be moved and controlled using this template.
Of course, the shortcuts in this template can be edited to assign to a particular input if you prefer.
175 / 224
vMix User Guide
NDI is an easy way to send and receive high quality, low latency video and audio between supported devices
using a standard Gigabit enabled network.
For example you can produce one aspect of your show on one computer and send the output to vMix
running on another.
Output
This is the main Output (or "Program") feed and includes the Master stereo audio mix
Audio Outputs
Master, Headphones, A and B mixes in vMix can all be independently accessed over the network using NDI.
The A and B mixes can be enabled by assigning them to Enabled in the dropdown list in Settings - Audio
Outputs
and also be checking the Audio Output box in the NDI section under Settings - External Output
176 / 224
vMix User Guide
Note: certain features in vMix such as Recording may not work as expected when ARGB32 is
enabled
177 / 224
vMix User Guide
Data Sources
Data Sources in vMix can be used to assign dynamic text and images to Titles from a variety of sources
including Google Sheets, Excel, CSV, XML and Text.
These sources can be from files on the local system, network or internet and data will update the title
automatically as it changes.
For example, you can create a Spreadsheet with a list of speakers and have somebody update the data
from a different computer on the same network
or even from the other side of the world!
178 / 224
vMix User Guide
If the first row of each table contains the names of each column, tick the "Use first row as column names"
tick box in the Settings window.
Google Sheets
This data source supports Google Sheets that have been shared to be viewed by anyone.
From within Google Docs, click the Share button in the top right hand corner.
Finally copy the link provided into the URL box in the vMix Data Source Settings.
Google Sheets also requires an API Key which can be created by following the instructions below.
How to create a Google API Key
RSS
Use any web site address in RSS format with this data source. RSS is commonly used by news sites,
blogs and other online information sites.
179 / 224
vMix User Guide
Text
Select any text file to use as a data source, for example Stream Labels on Twitch Alerts.
XML
Select any XML compliant web site or file to use as a data source.
To select which XML element to use as a data source, the XPath setting will need to be filled in.
For more information on the XPath format, refer to the Wikipedia page below:
https://en.wikipedia.org/wiki/XPath
JSON
This supports JSON data that is stored as an object array.
Each element in the array will be treated as a row.
180 / 224
vMix User Guide
1. Open up the Data Sources Manager from the menu in the bottom right hand corner of the main vMix
window.
2. The following window will appear. click the button to add the first Data Source
3. Once added, a window will appear where you can type either the web address to the data file or browse
for it on the local computer.
Depending on the Data Source type, a number of other settings may appear in this window.
181 / 224
vMix User Guide
182 / 224
vMix User Guide
1. Right click a Title input from within vMix and click Title Editor from the menu.
2. Select one of the Title fields from the left hand column (such as Headline, Description etc) then click Data
Source from the top menu bar.
3. Select the Data Source and other settings such as Table and Column.
Table: Select the table you wish to source the data from. Some data sources may only have a default table
available to select here.
Column: Select the column to use for this particular Title Field, if you leave this set to Auto, the data
source will map based on the following:
a) Will first look for the first column with the same name as the Title field, for example "Headline"
b) If no column is found, use the column index that matches the Title field index. For example Headline
would be Column1, Description Column2 and so on.
Format: This option can be used to add additional text to the data, for example "Name: {0}" will output the
data as "Name: Bob"
A preview will be displayed showing the data that will be assigned to the title.
183 / 224
vMix User Guide
4. Click OK and the data will automatically populate the text box in the Title Editor
5. Repeat steps 1 to 4 for each Title field you wish to assign to data.
184 / 224
vMix User Guide
There are a number of methods to select rows that are described in the following section.
When a row is selected, all Titles that refer to that data source will update automatically.
For manual control, select any data source from the buttons along the top and click a row in the table to
select it.
To automatically move down the list, click the Auto Next button so that it lights up green and type in the
number of seconds between each row in the provided text box.
Click Loop to jump to the start of the list after the last row.
TIP: The Data Sources window can be left option and setup on a separate monitor for quick and easy
access.
Using Shortcuts
A number of Shortcut Functions are available for controlling data sources such as DataSourceNextRow,
DataSourcePreviousRow and DataSourceSelectRow
These are described in the Shortcut Function Reference guide.
1. A Title mapped to a Excel data source with the first row selected
2. The Excel file is open on another computer
The computer that has opened the excel file can move or copy the data they wish select into the first row
and click save.
Each time they click save, the data will update in vMix.
185 / 224
vMix User Guide
http://www.example.com/image.jpg
c:\images\logo.png
186 / 224
vMix User Guide
5. A new API key will be created that can be used with Google Sheets data sources
IMPORTANT: Once the API key has been created, Google Sheets will also need to be enabled
from the Dashboard:
9. Select Enable up the top. If Google prompts for additional steps after this, they can be safely ignored and
the key will be ready to use.
10. The API key can now be used in vMix Data Sources.
187 / 224
vMix User Guide
188 / 224
vMix User Guide
vMix Title Designer is included with vMix and can be found in the Start Menu.
vMix Title Designer allows you to create high quality titles that combine dynamic text and graphics.
The interface is shown below:
Add Text
Add a new dynamic text element to the title. When selected the properties pane on the right hand side will
contain the following options.
Drop Shadow
Specify a drop shadow for the text with colour, radius and direction
Font
Specify font and font size for the text. This can be changed later from within vMix.
StrokeThickness / StrokeColor
Name
Specify a unique name to identify this text box. This name will appear in the Title Editor within vMix.
Position
189 / 224
vMix User Guide
Add Image
Add an image to the title. If the image will act as a background image, use the Background Image option
instead.
Background Image
If you have a full resolution graphic created that includes an alpha channel (such as PNG) this can be set as
the title background.
This image should be the same size as the title (for example 1920x1080)
190 / 224
vMix User Guide
PlayList
PlayList provides the ability to automate switching tasks or play multiple videos sequentially.
Click the Cog Button next to PlayList to bring up the PlayList window.
Click PlayList to start or stop the PlayList once it has been configured.
PlayList Window
Begin from selected item: Start the PlayList from the item currently selected in the list.
Manual Mode: When in Manual Mode, the playlist will not automatically progress to the next input until
Next is clicked.
Previous: Jump to the previous item in the playlist using the PlayList item's transition
Next: Skip to the next item in the playlist using the PlayList item's transition.
Creating a PlayList
To create a PlayList, click the PlayList button from the bottom left hand corner of vMix.
Select an input from the Available Inputs column and click the > arrow to add it to the Playlist.
191 / 224
vMix User Guide
Each item in the right hand Playlist can have its own starting position, duration, transition and transition
time.
Double click the item in the list to bring up the settings window.
Starting Position: If the PlayList item is a video clip, a starting position can be set here. If the Starting
Position checkbox is not checked the item will start playing from the current position.
Duration: Set length of time this PlayList item will run before moving to the next item in the list. If the
duration is 0 the PlayList will default to the inputs duration.
Transition Duration: Set the Transition Duration for the Transition Effect in milliseconds.
Display Type: Optionally select the display type for this PlayList item. When an Overlay is set as the
Display Type this PlayList item will appear as an overlay over the previous PlayList item, display for the
length of the duration before
moving to the next item.
Opening/Saving a PlayList
PlayLists are linked to the currently active Preset in vMix. This means any saved playlists can only be
loaded alongside the preset in which they were created.
192 / 224
vMix User Guide
MultiCorder
The number of simultaneous recordings and the type of recording formats will depend
on the processing capabilities of the computer.
The interface above appears by clicking the Cog Button next to MultiCorder in the main interface.
All available capture inputs are listed within the MultiCorder window. Tick the capture inputs you wish to
record and click Start.
Recording Format
AVI, MKV, MP4 and FFMPEG are available as recording options in MultiCorder.
For more information about these formats see Recording Setup.
193 / 224
vMix User Guide
It is recommended that a fault tolerant recording format is selected when using MultiCorder.
This means in the event of a power outage, the recording will still be recoverable.
See Fault Tolerant Recordings for a list of options available.
Folder
Select the folder to place the video files. This will need to be a fast storage device as listed above under the
system requirements.
The more cameras that are recorded simultaneously, the greater chance of dropped frames if the storage
device is unable to keep up.
Audio
Select and audio source to include with each recording. This can either be the embedded audio in the
capture source, or Master to record the main audio mix.
194 / 224
vMix User Guide
Tally Lights
Tally-Lights.com
Tally lights can be purchased from tally-lights.com and connected via USB.
These lights work automatically with vMix and will be assigned to Inputs according to the tally number.
(Tally 1 = Input 1, Tally 2 = Input 2, ...)
To connect to the Arduino device, go to the Input properties (click the i button) and from the Tally Light tab,
select the COM port of the Arduino device and select the Tally Number.
The Tally Numbers are assigned to individual Digital Pins on the Arduino in the order specified in the Tally
Lights tab in Settings.
The following is an overview of the digital pins and how to attach LED lights to them:
http://arduino.cc/en/Tutorial/DigitalPins
195 / 224
vMix User Guide
Interlaced Support
To enable interlaced processing in vMix, set Master Frame Rate to one of the settings below.
This can be done from Settings -> Display
Interlaced sources will be separated into two separate frames for frame rates 50p and higher.
All other master frame rates are progressive and any Interlaced inputs will be deinterlaced automatically.
Inputs
Recording
NOTE: Interlaced Recording must be checked under Settings -> Recording
Interlaced recording is supported for AVI and MPEG-2 formats by setting the Recording Frame Rate to 50i,
59.94i or 60i
All recordings are Upper Field First with the exception of NTSC 480i which is Lower Field First
External Output
NOTE: Interlaced Recording must be checked under Settings -> Recording
Interlaced recording is supported by setting the Frame Rate to 50i, 59.94i or 60i in External Output
Fullscreen Display
Fullscreen and preview windows will display the first field only when the Master Frame Rate is set to 50i,
196 / 224
vMix User Guide
59.94i or 60i
For full field display, set the Master Frame Rate to 50p or higher.
197 / 224
vMix User Guide
Statistics
The statistics window can be displayed by clicking the icon in the bottom right hand corner as shown below
This window displays real time statistics of each live input including dropped frames and audio sync.
Source Dropped
This shows the number of dropped frames as a result of the capture card / camera running slowly.
For example, the camera clock might be slower than vMix or the capture card is experiencing a bandwidth
bottleneck.
Renderer Dropped
This shows the number of dropped frames as a result of the graphics card running slowly.
Resync
This number shows the number of dropped frames as a result of the capture card / camera running too fast.
For example, the camera clock might be running slightly faster than vMix.
Video
This column shows timing statistics relating to the arrival time of each frame from the source.
Example: 33 33 33 33 (49)
In the above example, the four previous frames arrived 33 milliseconds after each other (indicating approx. 30
fps)
The number in brackets shows how long it took for the frame to displayed on screen. (1.5 frames in this
case)
These numbers will coincide with the results seen in the other dropped columns.
Audio
This column shows timing statistics relating to the arrival time of each sample of audio from the source.
60/67 ms
198 / 224
vMix User Guide
Dropped: 2/0
Resampled: 0/40
199 / 224
vMix User Guide
Padlock
The Padlock icon in the bottom right hand corner of vMix can be used to lock certain buttons in vMix so they
are not clicked accidentally.
When the icon is grey and open, everything is unlocked, when the icon is orange and closed, the functions
below are locked:
200 / 224
vMix User Guide
4K and Pro editions of vMix include powerful programming capabilities through the Scripting feature.
Consider this is a highly advanced version of Shortcuts, instead of a simple function assigned to a keyboard
key
you can assign any code you can think of including tasks like downloading internet content and assigning it
to a title.
1. Create a Script from the Scripting tab in Settings and assign it a unique Name.
2. Create a Shortcut and select "ScriptStart" as the function and type in the name of the script in the Script
Name box.
VB.NET Scripting
Web Scripting
201 / 224
vMix User Guide
VB.NET Scripting
vMix Scripting supports the powerful and easy to understand VB.NET language when writing your script.
dim i = Input.Find("NewsHD.xaml")
i.Text("Headline") = "Hello World!"
Both of these scripts do the same thing, that is to find the Title Input with name "NewsHD.xaml" and assign
the "Headline" field with the text "Hello World!"
To try it out add the NewsHD.xaml title template to vMix and then run the script.
VB.NET
vMix Scripting supports the majority of VB.NET 2.0 code that will work within a single sub or function.
This means that custom classes and structures are not supported, however you can use the vast majority of
the built in base classes in the .NET framework
including the handy System.Net.WebClient for downloading data over the internet.
vMix Objects
There are a number of built in objects that can be used from within vMix scripting:
Input
Shared Properties
Output As Input
Preview As Input
Find(inputNameNumberOrKey as String) As Input
Example:
Input.Preview.Function("Cut")
Instance Properties
Change the text of a Field within an Title input, or read the current value
Instance Methods
202 / 224
vMix User Guide
Wait for a video to finish playing and return True, otherwise return False if timed out.
Overlay
Shared Properties
Instance Methods
In(input as String)
Out
Off
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:
API
Shared Methods
XML() As String
Returns the XML state of vMix as per the vMix Web API
203 / 224
vMix User Guide
Examples:
API.Function("CubeZoom",,1000)
204 / 224
vMix User Guide
Web Scripting
Web Scripting supports a basic URL syntax to execute multiple functions one after the other.
Example
Function=OverlayInput1In&Input=NewsHD.xaml
Sleep 2000
Function=OverlayInput1Out
Syntax
The syntax for each line is the same as the query string used with the but vMix Web API without the URL
portion
For example http://localhost:8088/API/?Function=Cut in the Web API would be just Function=Cut with
Web Scripting
Function=Slide&Input=NewsHD.xaml&Duration=1000
Function=SetText&Input=NewsHD.xaml&SelectedName=Description&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.
205 / 224
vMix User Guide
Developer Information
Custom XAML
206 / 224
vMix User Guide
Custom XAML
vMix supports the use of custom WPF User Controls compiled into an assembly.
Custom User Controls can implement the vMixWPFUserControl interface from the vMixInterop.dll in the
vMix installation directory.
This interface allows vMix to communicate with the User Control and gather duration and position
information.
Implementation Guidelines
All controls must be compatible with .NET Framework 3.5 SP1 (4.0 is not supported at this time)
ShowProperties should display a WinForms window without blocking (Form.Show instead of
Form.ShowDialog)
Displaying WPF windows through ShowProperties is untested and unsupported.
Any code within ShowProperties will not run in the context of the WPF UI thread so the use of
Dispatcher is required to modify UI elements.
All other methods run within the WPF UI thread so cpu intensive procedures should be avoided to
prevent frame drops.
Any media related controls such as MediaElement and WebBrowser are not supported and will display
a blank window.
207 / 224
vMix User Guide
API
The vMix API provides access to common functions through the HTTP protocol.
For example, the following command will signal vMix to fade Preview to Active within 1 second:
http://127.0.0.1:8088/api/?Function=Fade&Duration=1000
Setup
The API uses the same web address as the standard Web Interface and can be configured from the Web
tab in Settings.
Parameters
Function
Click here to view a list of some of the Shortcut Functions that are available.
Duration
If the specified function is a transition this parameter can be set to a time in milliseconds.
Input
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
SelectedIndex
208 / 224
vMix User Guide
Value
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
...
Return
If successful, the API will return the standard 200 response code.
If an error occurs, the API will return the standard 500 error code.
Information
If all parameters are left blank the API will return state information in XML format.
The following is an example of the XML output:
<vmix>
<version>11.0.0.16</version>
<inputs>
<input key="26cae087-b7b6-4d45-98e4-de03ab4feb6b" number="1" type="Xaml" title="NewsHD.xaml"
state="Paused" position="0" duration="0" muted="True" loop="False" selectedIndex="0">
NewsHD.xaml
<text index="0" name="Headline">Hello</text>
<text index="1" name="Description">Hello</text>
</input>
<input key="55cbe357-a801-4d54-8ff2-08ee68766fae" number="2" type="VirtualSet" title="LateNightNews"
state="Paused" position="0" duration="0" muted="True" loop="False" selectedIndex="0">
LateNightNews
<overlay index="0" key="2fe8ff9d-e400-4504-85ab-df7c17a1edd4"/>
<overlay index="1" key="20e4ee9a-05cc-4f58-bb69-cd179e1c1958"/>
<overlay index="2" key="94b88db0-c5cd-49d8-98a2-27d83d4bf3fe"/>
</input>
</inputs>
<overlays>
<overlay number="1"/>
<overlay number="2">1</overlay>
<overlay number="3"/>
<overlay number="4"/>
<overlay number="5"/>
<overlay number="6"/>
</overlays>
<preview>1</preview>
<active>2</active>
<fadeToBlack>False</fadeToBlack>
<transitions>
<transition number="1" effect="Fade" duration="500"/>
<transition number="2" effect="Wipe" duration="500"/>
<transition number="3" effect="Fly" duration="500"/>
<transition number="4" effect="CubeZoom" duration="3000"/>
</transitions>
209 / 224
vMix User Guide
<recording>False</recording>
<external>False</external>
<streaming>False</streaming>
<playList>False</playList>
<multiCorder>False</multiCorder>
</vmix>
In the example above Input 2 is active and Input 1 is currently running as Overlay 2.
210 / 224
vMix User Guide
The following shortcut functions can be called either via a Shortcut or via the API.
The list of functions is constantly growing so the functions below only represent a small fraction of what is
available.
Fade, Zoom, Cut Etc: Assign a keyboard key to a transition effect. The duration can also be selected.
Name Description
General
211 / 224
vMix User Guide
Output,Preview,MultiView,Input
212 / 224
vMix User Guide
Output,Preview,MultiView,Input
Output,Preview,MultiView,Input
Value = Value
StartExternal
StartMultiCorder
StartRecording
StartStopExternal
StartStopMultiCorder
StartStopRecording
StartStopStreaming
StartStreaming
StopExternal
StopMultiCorder
StopRecording
StopStreaming
WriteDurationToRecordingLog Write current recording duration to log file with optional tag text V
Value = Seconds
ChangeCountdown Change countdown time according to Value as hh:mm:ss (00:00:00)
213 / 224
vMix User Guide
NextTitlePreset
PauseCountdown Pause or Resume Countdown or if complete, Start from beginning.
PauseRender Freeze Title Input while making multiple updates
PreviousTitlePreset
ResumeRender Resume Title Input rendering after making multiple updates
SelectTitlePreset Value = Preset Index
SetCountdown Set countdown duration according to Value as hh:mm:ss (00:00:00)
Value = Filename
SetText Change Text in Title according to Value parameter.
Value = Text
StartCountdown
StopCountdown Stop and Reset Countdown
SuspendCountdown Pause Countdown Only
Input
ActiveInput Send to Output the selected Input
AddInput Create a new Input based on information provided in Value.
Video|c:\path\to\video.avi
Image|c:\path\to\image.jpg
Photos|c:\path\to\folder
Xaml|c:\path\to\title.xaml
VideoList|c:\path\to\playlist.m3u
Colour|HTMLColor
AudioFile|c:\path\to\audio.wav
Flash|c:\path\to\flash.swf
PowerPoint|c:\path\to\powerpoint.pptx
214 / 224
vMix User Guide
Value = Type|Filename
AutoPauseOff
AutoPauseOn
AutoPlayFirst Toggle automatically playing first item in a List with Transition
AutoPlayFirstOff Turn Off automatically playing first item in a List with Transition
AutoPlayFirstOn Turn On automatically playing first item in a List with Transition
AutoPlayNext Toggle automatically playing next item in a List
AutoPlayNextOff Turn Off automatically playing next item in a List
AutoPlayNextOn Turn On automatically playing next item in a List
AutoPlayOff
AutoPlayOn
AutoRestartOff
AutoRestartOn
CreateVirtualInput Create a new Virtual Input from the specified Input.
DeinterlaceOff
DeinterlaceOn
ListPlayOut
LoopOff
LoopOn
MarkIn
MarkOut
MarkReset
MarkResetIn
MarkResetOut
MirrorOff
MirrorOn
215 / 224
vMix User Guide
Value = Category
SelectIndex Photos,List: Selects item in List according to Value starting from num
Virtual Set: Zooms to selected preset using the current speed settin
Value = Index
SetAlpha Set Input transparency according to Value. 0 is transparent, 255 is o
Value = Transition
216 / 224
vMix User Guide
Value = Duration MS
SetPictureTransition Set transition time between Photos and PowerPoint slides in Secon
Value = Seconds
SetPosition Set Position of selected Input according to Value in Milliseconds
Value = Milliseconds
SetRate Set Playback speed/rate for Videos and Video Delays
0.5=50%,1=100%,2=200% etc
0.5=50%,1=100% etc
217 / 224
vMix User Guide
OverlayInput3In
OverlayInput3Off
OverlayInput3Out
OverlayInput3Zoom
OverlayInput4
OverlayInput4In
OverlayInput4Off
OverlayInput4Out
OverlayInput4Zoom
OverlayInputAllOff Immediately switch all Overlays Off
PreviewOverlayInput1 Preview Overlay1 using the selected Input
PreviewOverlayInput2
PreviewOverlayInput3
PreviewOverlayInput4
SetMultiViewOverlay Change Overlay in Input MultiView according to Value parameter.
Value = Index,Input
PlayList
NextPlayListEntry Move to Next Item in a running PlayList
PreviousPlayListEntry Move to Previous Item in a running PlayList
SelectPlayList Open PlayList with Name matching Value
Value = PlayList
StartPlayList
StopPlayList
Scripting
ScriptStart Value = Script Name
ScriptStartDynamic Start a dynamic script using code specified as the Value.
Value = Code
ScriptStop Value = Script Name
ScriptStopAll
ScriptStopDynamic
Replay
218 / 224
vMix User Guide
ReplayACamera1
ReplayACamera2
ReplayACamera3
ReplayACamera4
ReplayBCamera1
ReplayBCamera2
ReplayBCamera3
ReplayBCamera4
ReplayChangeDirection
ReplayChangeSpeed Value = Speed
ReplayCopyLastEvent Value = Event List 0-7
ReplayCopySelectedEvent Value = Event List 0-7
ReplayExportLastEvent Value = Folder
ReplayJumpFrames Value = Frames
ReplayJumpToNow
ReplayLive
ReplayLiveToggle
ReplayMarkCancel
ReplayMarkIn
ReplayMarkInLive
ReplayMarkInOut Number of previous seconds to use when creating a new event.
Value = Seconds
ReplayMarkInOutLive Number of previous seconds to use when creating a new event.
Value = Seconds
ReplayMarkInOutRecorded Number of previous seconds to use when creating a new event.
Value = Seconds
ReplayMarkInRecorded
ReplayMarkInRecordedNow
ReplayMarkOut
ReplayMoveLastEvent Value = Event List 0-7
ReplayMoveSelectedEvent Value = Event List 0-7
ReplayMoveSelectedEventDown
219 / 224
vMix User Guide
ReplayMoveSelectedEventUp
ReplayMoveSelectedInPoint Value = Frames
ReplayMoveSelectedOutPoint Value = Frames
ReplayPlayEvent Value = Event Number 0-1000
ReplayPlayEventsByID Value = List of IDs
ReplayPlayEventsByIDToOutput Value = List of IDs
ReplayPlayEventToOutput Value = Event Number 0-1000
ReplayPlayLastEvent
ReplayPlayLastEventToOutput
ReplayPlayNext
ReplayPlayPause
ReplayPlayPrevious
ReplayPlaySelectedEvent
ReplayPlaySelectedEventToOutput
ReplayRecorded
ReplaySelectEvents1
ReplaySelectEvents2
ReplaySelectEvents3
ReplaySelectEvents4
ReplaySelectEvents5
ReplaySelectEvents6
ReplaySelectEvents7
ReplaySelectEvents8
ReplaySelectFirstEvent
ReplaySelectLastEvent
ReplaySelectNextEvent
ReplaySelectPreviousEvent
ReplaySetDirectionBackward
ReplaySetDirectionForward
ReplaySetLastEventText Value = Text
ReplaySetSelectedEventText Value = Text
220 / 224
vMix User Guide
221 / 224
vMix User Guide
Value = Filename
SavePreset Save preset to the specified Filename.
Value = Filename
DataSources
DataSourceNextRow Name of the Data Source and Table Name (optional) eg 'Excel/CSV,
Value = Name,Table
DataSourcePreviousRow Name of the Data Source and Table Name (optional) eg 'Excel/CSV,
Value = Name,Table
DataSourceSelectRow Name of the Data Source, Table Name (optional) and Row Index sta
eg 'Excel/CSV,Sheet1,5'
Value = Name,Table,Index
Browser
BrowserBack
BrowserForward
BrowserKeyboardDisabled
BrowserKeyboardEnabled
BrowserMouseDisabled
BrowserMouseEnabled
BrowserNavigate URL
Value = URL
BrowserReload
222 / 224
vMix User Guide
223 / 224
vMix User Guide
Safe Areas
Safe Areas for the Preview Window can be enabled by clicking the icon at the top right hand corner of the
Preview Title Bar as shown below.
A number of display options are supported including EBU/SMPTE, 80/90% and grids of various sizes.
Safe Areas can also be displayed and controlled from the Input Settings window.
224 / 224