Shortcut Function Reference

Previous

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

Parameters

General



KeyPress

Value = Key

Value

Audio



Audio

Toggle Audio Mute On/Off

Input

AudioAuto


Input

AudioAutoOff


Input

AudioAutoOn


Input

AudioBus

Value = Bus M,A,B

Value,Input

AudioBusOff

Value = Bus M,A,B

Value,Input

AudioBusOn

Value = Bus M,A,B

Value,Input

AudioMixerShowHide


None

AudioOff


Input

AudioOn


Input

BusAAudio


None

BusAAudioOff


None

BusAAudioOn


None

BusBAudio


None

BusBAudioOff


None

BusBAudioOn


None

MasterAudio


None

MasterAudioOff


None

MasterAudioOn


None

SetBalance

Value = Balance -1-1

Value,Input

SetBusAVolume

Value = Volume 0-100

Value

SetBusBVolume

Value = Volume 0-100

Value

SetGain

Value = Gain dB 0-24

Value,Input

SetGainChannel1

Value = Gain dB 0-24

Value,Input

SetGainChannel2

Value = Gain dB 0-24

Value,Input

SetHeadphonesVolume

Value = Volume 0-100

Value

SetMasterVolume

Value = Volume 0-100

Value

SetVolume

Value = Volume 0-100

Value,Input

SetVolumeChannel1

When using SeparateMono on an Audio Input, this can be used to set channel volumes independently.


Value = Volume 0-100

Value,Input

SetVolumeChannel2

When using SeparateMono on an Audio Input, this can be used to set channel volumes independently.


Value = Volume 0-100

Value,Input

Solo


Input

SoloOff


Input

SoloOn


Input

Transition



CutDirect

Cuts the input directly to Output without changing Preview

Input

FadeToBlack

Toggle FTB On/Off

None

QuickPlay


Input

SetFader

Set Master Fader T-Bar, 255 will cut to Preview


Value = Fader 0-255

Value

Stinger1


None

Stinger2


None

Transition1

Clicks one of the four Transition buttons in the main vMix window.

None

Transition2


None

Transition3


None

Transition4


None

Output



FullscreenOff


None

FullscreenOn


None

SetOutputExternal2

Change what is displayed on the External2 output.


Output,Preview,MultiView,Input


Value = Output, Preview, MultiView, Input

Value,Input

SetOutputFullscreen

Change what is displayed on the Fullscreen output.


Output,Preview,MultiView,Input


Value = Output, Preview, MultiView, Input

Value,Input

SetOutputFullscreen2

Change what is displayed on the Fullscreen2 output.


Output,Preview,MultiView,Input


Value = Output, Preview, MultiView, Input

Value,Input

Snapshot

Create a snapshot image of the current Output. Optional Value specifies save Filename, otherwise a save file window will appear. Filename can specify date, for example mysnapshot {0:dd MMM yyyy}.jpg


Value = Value

Value

StartExternal


None

StartMultiCorder


None

StartRecording


None

StartStopExternal


None

StartStopMultiCorder


None

StartStopRecording


None

StartStopStreaming


None

StartStreaming


None

StopExternal


None

StopMultiCorder


None

StopRecording


None

StopStreaming


None

WriteDurationToRecordingLog

Write current recording duration to log file with optional tag text Value.


Value = Tag Text

Value

Title



AdjustCountdown

Seconds to add or subtract from current Countdown time


Value = Seconds

Value,Input

NextTitlePreset


Input

PauseCountdown


Input

PauseRender

Freeze Title Input while making multiple updates

Input

PreviousTitlePreset


Input

ResumeRender

Resume Title Input rendering after making multiple updates

Input

SelectTitlePreset

Value = Preset Index

Value,Input

SetCountdown

Set countdown duration according to Value as hh:mm:ss (00:00:00)


Value = Duration 00:00:00

Value,Input

SetImage

Change Image in Title according to Filename or empty to clear.


SelectedIndex or SelectedValue can be used to select text field.


Value = Filename

Value,Input

SetText

Change Text in Title according to Value parameter.


SelectedIndex or SelectedName can be used to select Text Field


Value = Text

Value,Input

StartCountdown


Input

StopCountdown

Stop and Reset Countdown

Input

Input



ActiveInput

Send to Output the selected Input

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


Value = Type|Filename

Value

AutoPauseOff


Input

AutoPauseOn


Input

AutoPlayOff


Input

AutoPlayOn


Input

AutoRestartOff


Input

AutoRestartOn


Input

CreateVirtualInput

Create a new Virtual Input from the specified Input.

Input

DeinterlaceOff


Input

DeinterlaceOn


Input

LoopOff


Input

LoopOn


Input

MarkIn


Input

MarkOut


Input

MarkReset


Input

MarkResetIn


Input

MarkResetOut


Input

MirrorOff


Input

MirrorOn


Input

MoveInput

Value = Number

Value,Input

NextItem

Move to next item in List

Input

NextPicture

Move to Next Picture for Photo and PowerPoint Inputs

Input

Pause


Input

Play


Input

PlayPause


Input

PreviewInput

Send to Preview the selected Input

Input

PreviewInputNext

Send to Preview the next Input

None

PreviewInputPrevious

Send to Preview the previous Input

None

PreviousItem

Move to previous item in List

Input

PreviousPicture

Move to Previous Picture for Photo and PowerPoint Inputs

Input

RemoveInput


Input

Restart

Restart selected Input

Input

SaveVideoDelay

Save video clip from Video Delay according to Duration in milliseconds

Input,Duration

SelectCategory

Change to Category according to Value (All,Red,Green,Orange,Purple,Aqua,Blue)


Value = Category

Value

SelectIndex

Photos,List: Selects item in List according to Value starting from number 1


Virtual Set: Zooms to selected preset using the current speed settings


Value = Index

Value,Input

SetAlpha

Set Input transparency according to Value. 0 is transparent, 255 is opaque


Value = Alpha 0-255

Value,Input

SetPanX

Change current PanX value of Input.


0=centered, -2=100% to left, 2=100% to right


Value = Value -2-2

Value,Input

SetPanY

Change current PanY value of Input.


0=centered, -2=100% to bottom, 2=100% to top


Value = Value -2-2

Value,Input

SetPictureEffect

Set transition effect for Photos and PowerPoint Inputs (Fade, Zoom, etc)


Value = Transition

Value,Input

SetPictureEffectDuration

Set duration of transition effect in Milliseconds


Value = Duration MS

Value,Input

SetPictureTransition

Set transition time between Photos and PowerPoint slides in Seconds


Value = Seconds

Value,Input

SetPosition

Set Position of selected Input according to Value in Milliseconds


Value = Milliseconds

Value,Input

SetRate

Set Playback speed/rate for Videos and Video Delays


0.5=50%,1=100%,2=200% etc


Value = Speed 0.1-4

Value,Input

SetZoom

Change current Zoom level of Input.


1=100%, 0.5=50%, 2=200%


Value = Value 0-5

Value,Input

SharpenOff


Input

SharpenOn


Input

WaitForCompletion

Wait for a Video Input to reach the end of playback.

Input,Duration

Overlay



OverlayInput1

Toggle Overlay1 On/Off with selected Input using configured Transition

Input

OverlayInput1In

Transition Out to Overlay1 with selected Input

Input

OverlayInput1Off

Immediately switch Overlay1 Off (Cut)

None

OverlayInput1Out

Transition Out Overlay1

None

OverlayInput1Zoom

Zooms PIP Overlay to fill Fullscreen and vice versa

None

OverlayInput2


Input

OverlayInput2In


Input

OverlayInput2Off


None

OverlayInput2Out


None

OverlayInput2Zoom


None

OverlayInput3


Input

OverlayInput3In


Input

OverlayInput3Off


None

OverlayInput3Out


None

OverlayInput3Zoom


None

OverlayInput4


Input

OverlayInput4In


Input

OverlayInput4Off


None

OverlayInput4Out


None

OverlayInput4Zoom


None

OverlayInputAllOff

Immediately switch all Overlays Off

None

PreviewOverlayInput1

Preview Overlay1 using the selected Input

Input

PreviewOverlayInput2


Input

PreviewOverlayInput3


Input

PreviewOverlayInput4


Input

SetMultiViewOverlay

Change Overlay in Input MultiView according to Value parameter.


Example: 1,2 changes Overlay1 to Input2


Value = Index,Input

Value,Input

PlayList



NextPlayListEntry

Move to Next Item in a running PlayList

None

PreviousPlayListEntry

Move to Previous Item in a running PlayList

None

SelectPlayList

Open PlayList with Name matching Value


Value = PlayList

Value

StartPlayList


None

StopPlayList


None

Scripting



ScriptStart

Value = Script Name

Value

ScriptStartDynamic

Start a dynamic script using code specified as the Value.


Value = Code

Value

ScriptStop

Value = Script Name

Value

ScriptStopAll


None

ScriptStopDynamic


None

Replay



ReplayACamera1


None

ReplayACamera2


None

ReplayACamera3


None

ReplayACamera4


None

ReplayBCamera1


None

ReplayBCamera2


None

ReplayBCamera3


None

ReplayBCamera4


None

ReplayChangeDirection


None

ReplayChangeSpeed

Value = Speed

Value

ReplayExportLastEvent

Value = Folder

Value

ReplayJumpFrames

Value = Frames

Value

ReplayJumpToNow


None

ReplayLive


None

ReplayLiveToggle


None

ReplayMarkCancel


None

ReplayMarkIn


None

ReplayMarkInLive


None

ReplayMarkInOut

Value = Value

Value

ReplayMarkInOutLive

Value = Value

Value

ReplayMarkInOutRecorded

Value = Value

Value

ReplayMarkInRecorded


None

ReplayMarkInRecordedNow


None

ReplayMarkOut


None

ReplayMoveLastEvent

Value = Event List 0-3

Value

ReplayMoveSelectedEvent

Value = Event List 0-3

Value

ReplayMoveSelectedInPoint

Value = Frames

Value

ReplayMoveSelectedOutPoint

Value = Frames

Value

ReplayPlayEvent

Value = Event Number 0-1000

Value

ReplayPlayEventToOutput

Value = Event Number 0-1000

Value

ReplayPlayLastEvent


None

ReplayPlayLastEventToOutput


None

ReplayPlayNext


None

ReplayPlayPause


None

ReplayPlayPrevious


None

ReplayPlaySelectedEvent


None

ReplayPlaySelectedEventToOutput


None

ReplayRecorded


None

ReplaySelectEvents1


None

ReplaySelectEvents2


None

ReplaySelectEvents3


None

ReplaySelectEvents4


None

ReplaySelectNextEvent


None

ReplaySelectPreviousEvent


None

ReplaySetDirectionBackward


None

ReplaySetDirectionForward


None

ReplaySetLastEventText

Value = Text

Value

ReplaySetSelectedEventText

Value = Text

Value

ReplaySetSpeed

Value = Speed

Value

ReplayShowHide


None

ReplayStartRecording


None

ReplayStopEvents


None

ReplayStopRecording


None

ReplayToggleLastEventCamera1


None

ReplayToggleLastEventCamera2


None

ReplayToggleLastEventCamera3


None

ReplayToggleLastEventCamera4


None

ReplayToggleSelectedEventCamera1


None

ReplayToggleSelectedEventCamera2


None

ReplayToggleSelectedEventCamera3


None

ReplayToggleSelectedEventCamera4


None

NDI



NDISelectSourceByIndex

Value = Index 0-100

Value,Input

NDISelectSourceByName

Value = Name

Value,Input

PTZ



PTZCreateVirtualInput

Creates a PTZ Virtual Input with the current Position

Input

PTZHome


Input

PTZMoveDown

Value = Speed 0-1

Value,Input

PTZMoveDownLeft

Value = Speed 0-1

Value,Input

PTZMoveDownRight

Value = Speed 0-1

Value,Input

PTZMoveLeft

Value = Speed 0-1

Value,Input

PTZMoveRight

Value = Speed 0-1

Value,Input

PTZMoveStop

Stop all PTZ movement

Input

PTZMoveToVirtualInputPosition

Moves to the Position of the PTZ Virtual Input without selecting it into Preview

Input

PTZMoveToVirtualInputPositionByIndex

Moves to the Position of the PTZ Virtual Input associated with this Input. Index is first Input found starting from 0


Value = Index 0-100

Value,Input

PTZMoveUp

Value = Speed 0-1

Value,Input

PTZMoveUpLeft

Value = Speed 0-1

Value,Input

PTZMoveUpRight

Value = Speed 0-1

Value,Input

PTZUpdateVirtualInput

Updates selected PTZ Virtual Input with current Position

Input

PTZZoomIn

Value = Speed 0-1

Value,Input

PTZZoomOut

Value = Speed 0-1

Value,Input

PTZZoomStop


Input

Preset



LastPreset

Load the last preset.

None

OpenPreset

Load preset from the specified Filename.


Value = Filename

Value

SavePreset

Save preset to the specified Filename.


Value = Filename

Value