vMix
Control vMix over its HTTP Web API, giving you one action that can trigger full catalog commands or send raw API queries for flexible broadcast automation, with secure request options and cross-platform support for iOS/macOS/macCatalyst.
Required Parameters
host (required): vMix API host.port: optional numeric port for API requests, constrained to 0...65535 (default 8088).useHTTPS: optional transport toggle (false for HTTP, true for HTTPS).Function or Raw Function (one required path): set Use Raw Function = false to choose a command from the implemented catalog, or set Use Raw Function = true and provide a raw query string.Use Raw Function toggles between catalog mode and raw query mode.
Commands
ActivatorRefresh
CallManagerShowHide
KeyPress
SendKeys
SetDynamicValue1
SetDynamicValue2
SetDynamicValue3
SetDynamicValue4
Undo
Audio
AudioAuto
AudioAutoOff
AudioAutoOn
AudioBus
AudioBusOff
AudioBusOn
AudioChannelMatrixApplyPreset
AudioMixerShowHide
AudioOff
AudioOn
AudioPluginOff
AudioPluginOn
AudioPluginOnOff
AudioPluginShow
BusAAudio
BusAAudioOff
BusAAudioOn
BusAAudioPluginOff
BusAAudioPluginOn
BusAAudioPluginOnOff
BusAAudioPluginShow
BusBAudio
BusBAudioOff
BusBAudioOn
BusBAudioPluginOff
BusBAudioPluginOn
BusBAudioPluginOnOff
BusBAudioPluginShow
BusXAudio
BusXAudioOff
BusXAudioOn
BusXAudioPluginOff
BusXAudioPluginOn
BusXAudioPluginOnOff
BusXAudioPluginShow
BusXSendToMaster
BusXSendToMasterOff
BusXSendToMasterOn
BusXSolo
BusXSoloOff
BusXSoloOn
MasterAudio
MasterAudioOff
MasterAudioOn
MasterAudioPluginOff
MasterAudioPluginOn
MasterAudioPluginOnOff
MasterAudioPluginShow
SetBalance
SetBusAVolume
SetBusAVolumeFade
SetBusBVolume
SetBusBVolumeFade
SetBusCVolume
SetBusCVolumeFade
SetBusDVolume
SetBusDVolumeFade
SetBusEVolume
SetBusEVolumeFade
SetBusFVolume
SetBusFVolumeFade
SetBusGVolume
SetBusGVolumeFade
SetGain
SetGainChannel1
SetGainChannel2
SetHeadphonesVolume
SetMasterVolume
SetMasterVolumeFade
SetVolume
SetVolumeBusMixer
SetVolumeBusMixerA
SetVolumeBusMixerB
SetVolumeBusMixerC
SetVolumeBusMixerD
SetVolumeBusMixerE
SetVolumeBusMixerF
SetVolumeBusMixerG
SetVolumeBusMixerM
SetVolumeChannel1
SetVolumeChannel2
SetVolumeChannelMixer
SetVolumeChannelMixer1
SetVolumeChannelMixer10
SetVolumeChannelMixer11
SetVolumeChannelMixer12
SetVolumeChannelMixer13
SetVolumeChannelMixer14
SetVolumeChannelMixer15
SetVolumeChannelMixer16
SetVolumeChannelMixer2
SetVolumeChannelMixer3
SetVolumeChannelMixer4
SetVolumeChannelMixer5
SetVolumeChannelMixer6
SetVolumeChannelMixer7
SetVolumeChannelMixer8
SetVolumeChannelMixer9
SetVolumeFade
Solo
SoloAllOff
SoloOff
SoloOn
SoloPFL
SoloPFLOff
SoloPFLOn
CutDirect
FadeToBlack
QuickPlay
SetFader
SetTransitionDuration1
SetTransitionDuration2
SetTransitionDuration3
SetTransitionDuration4
SetTransitionEffect1
SetTransitionEffect2
SetTransitionEffect3
SetTransitionEffect4
Stinger1
Stinger2
Stinger3
Stinger4
Stinger5
Stinger6
Stinger7
Stinger8
Transition1
Transition2
Transition3
Transition4
Fullscreen
FullscreenOff
FullscreenOn
SetOutput2
SetOutput3
SetOutput4
SetOutputExternal2
SetOutputFullscreen
SetOutputFullscreen2
Snapshot
StartExternal
StartMultiCorder
StartRecording
StartSRTOutput
StartStopExternal
StartStopMultiCorder
StartStopRecording
StartStopSRTOutput
StartStopStreaming
StartStreaming
StopExternal
StopMultiCorder
StopRecording
StopSRTOutput
StopStreaming
StreamingSetKey
StreamingSetPassword
StreamingSetURL
StreamingSetUsername
WriteDurationToRecordingLog
AdjustCountdown
ChangeCountdown
NextTitlePreset
PauseCountdown
PauseRender
PreviousTitlePreset
ResumeRender
SelectTitlePreset
SetColor
SetCountdown
SetImage
SetImageVisible
SetImageVisibleOff
SetImageVisibleOn
SetText
SetTextColour
SetTextVisible
SetTextVisibleOff
SetTextVisibleOn
SetTickerSpeed
StartCountdown
StopCountdown
SuspendCountdown
TitleBeginAnimation
AutoPauseOff
AutoPauseOn
AutoPlayFirst
AutoPauseOn
AutoPlayFirstOff
AutoPlayFirstOn
AutoPlayNext
AutoPlayNextOff
AutoPlayNextOn
AutoPlayOff
AutoPlayOn
AutoRestartOff
AutoRestartOn
ColourCorrectionAuto
ColourCorrectionReset
DeinterlaceOff
DeinterlaceOn
Effect1
Effect1Off
Effect1On
Effect2
Effect2Off
Effect2On
Effect3
Effect3Off
Effect3On
Effect4
Effect4Off
Effect4On
GO
LayerOff
LayerOn
LayerOnOff
ListAdd
ListExport
ListPlayOut
ListRemove
ListRemoveAll
ListShowHide
ListShuffle
LivePlayPause
Loop
LoopOff
LoopOn
MarkIn
MarkOut
MarkReset
MarkResetIn
MarkResetOut
MirrorOff
MirrorOn
MoveLayer
NextItem
NextPicture
Pause
Play
PlayPause
PreviousItem
PreviousPicture
Restart
SaveVideoDelay
SelectCategory
SelectIndex
SetAlpha
SetCCGainB
SetCCGainG
SetCCGainR
SetCCGainRGB
SetCCGainY
SetCCGammaB
SetCCGammaG
SetCCGammaR
SetCCGammaRGB
SetCCGammaY
SetCCHue
SetCCLiftB
SetCCLiftG
SetCCLiftR
SetCCLiftRGB
SetCCLiftY
SetCCSaturation
SetCrop
SetCropX1
SetCropX2
SetCropY1
SetCropY2
SetEffect1Strength
SetEffect2Strength
SetEffect3Strength
SetEffect4Strength
SetFrameDelay
SetLayer
SetLayer10Crop
SetLayer10CropX1
SetLayer10CropX2
SetLayer10CropY1
SetLayer10CropY2
SetLayer10Height
SetLayer10PanX
SetLayer10PanY
SetLayer10Rectangle
SetLayer10Width
SetLayer10X
SetLayer10Y
SetLayer10Zoom
SetLayer1Crop
SetLayer1CropX1
SetLayer1CropX2
SetLayer1CropY1
SetLayer1CropY2
SetLayer1Height
SetLayer1PanX
SetLayer1PanY
SetLayer1Rectangle
SetLayer1Width
SetLayer1X
SetLayer1Y
SetLayer1Zoom
SetLayer2Crop
SetLayer2CropX1
SetLayer2CropX2
SetLayer2CropY1
SetLayer2CropY2
SetLayer2Height
SetLayer2PanX
SetLayer2PanY
SetLayer2Rectangle
SetLayer2Width
SetLayer2X
SetLayer2Y
SetLayer2Zoom
SetLayer3Crop
SetLayer3CropX1
SetLayer3CropX2
SetLayer3CropY1
SetLayer3CropY2
SetLayer3Height
SetLayer3PanX
SetLayer3PanY
SetLayer3Rectangle
SetLayer3Width
SetLayer3X
SetLayer3Y
SetLayer3Zoom
SetLayer4Crop
SetLayer4CropX1
SetLayer4CropX2
SetLayer4CropY1
SetLayer4CropY2
SetLayer4Height
SetLayer4PanX
SetLayer4PanY
SetLayer4Rectangle
SetLayer4Width
SetLayer4X
SetLayer4Y
SetLayer4Zoom
SetLayer5Crop
SetLayer5CropX1
SetLayer5CropX2
SetLayer5CropY1
SetLayer5CropY2
SetLayer5Height
SetLayer5PanX
SetLayer5PanY
SetLayer5Rectangle
SetLayer5Width
SetLayer5X
SetLayer5Y
SetLayer5Zoom
SetLayer6Crop
SetLayer6CropX1
SetLayer6CropX2
SetLayer6CropY1
SetLayer6CropY2
SetLayer6Height
SetLayer6PanX
SetLayer6PanY
SetLayer6Rectangle
SetLayer6Width
SetLayer6X
SetLayer6Y
SetLayer6Zoom
SetLayer7Crop
SetLayer7CropX1
SetLayer7CropX2
SetLayer7CropY1
SetLayer7CropY2
SetLayer7Height
SetLayer7PanX
SetLayer7PanY
SetLayer7Rectangle
SetLayer7Width
SetLayer7X
SetLayer7Y
SetLayer7Zoom
SetLayer8Crop
SetLayer8CropX1
SetLayer8CropX2
SetLayer8CropY1
SetLayer8CropY2
SetLayer8Height
SetLayer8PanX
SetLayer8PanY
SetLayer8Rectangle
SetLayer8Width
SetLayer8X
SetLayer8Y
SetLayer8Zoom
SetLayer9Crop
SetLayer9CropX1
SetLayer9CropX2
SetLayer9CropY1
SetLayer9CropY2
SetLayer9Height
SetLayer9PanX
SetLayer9PanY
SetLayer9Rectangle
SetLayer9Width
SetLayer9X
SetLayer9Y
SetLayer9Zoom
SetLayerAnimated
SetLayerDynamicCrop
SetLayerDynamicCropX1
SetLayerDynamicCropX2
SetLayerDynamicCropY1
SetLayerDynamicCropY2
SetLayerDynamicHeight
SetLayerDynamicPanX
SetLayerDynamicPanY
SetLayerDynamicRectangle
SetLayerDynamicWidth
SetLayerDynamicX
SetLayerDynamicY
SetLayerDynamicZoom
SetPanX
SetPanY
SetPictureEffect
SetPictureEffectDuration
SetPictureTransition
SetPosition
SetRate
SetRateSlowMotion
SetZoom
SharpenOff
SharpenOn
SwapLayerAnimated
VideoCallAudioSource
VideoCallConnect
VideoCallReconnect
VideoCallVideoSource
VideoDelayStartRecording
VideoDelayStartStopRecording
VideoDelayStopRecording
WaitForCompletion
ZoomJoinMeeting
ZoomMuteSelf
ZoomSelectParticipantByName
ZoomUnMuteSelf
MoveMultiViewOverlay
MultiViewOverlay
MultiViewOverlayOff
MultiViewOverlayOn
SetMultiViewOverlay
NextPlayListEntry
PreviousPlayListEntry
SelectPlayList
StartPlayList
StopPlayList
ScriptStart
ScriptStartDynamic
ScriptStop
ScriptStopAll
ScriptStopDynamic
ReplayACamera1
ReplayACamera2
ReplayACamera3
ReplayACamera4
ReplayACamera5
ReplayACamera6
ReplayACamera7
ReplayACamera8
ReplayAppendLastEventText
ReplayAppendLastEventTextCamera
ReplayAppendSelectedEventText
ReplayAppendSelectedEventTextCamera
ReplayBCamera1
ReplayBCamera2
ReplayBCamera3
ReplayBCamera4
ReplayBCamera5
ReplayBCamera6
ReplayBCamera7
ReplayBCamera8
ReplayCamera1
ReplayCamera2
ReplayCamera3
ReplayCamera4
ReplayCamera5
ReplayCamera6
ReplayCamera7
ReplayCamera8
ReplayCCamera1
ReplayCCamera2
ReplayCCamera3
ReplayCCamera4
ReplayCCamera5
ReplayCCamera6
ReplayCCamera7
ReplayCCamera8
ReplayChangeDirection
ReplayChangeSpeed
ReplayCopyLastEvent
ReplayCopySelectedEvent
ReplayDCamera1
ReplayDCamera2
ReplayDCamera3
ReplayDCamera4
ReplayDCamera5
ReplayDCamera6
ReplayDCamera7
ReplayDCamera8
ReplayDeleteLastEvent
ReplayDeleteSelectedEvent
ReplayDuplicateLastEvent
ReplayDuplicateSelectedEvent
ReplayExportLastEvent
ReplayFastBackward
ReplayFastForward
ReplayJumpFrames
ReplayJumpFramesFastOff
ReplayJumpFramesFastOn
ReplayJumpToNow
ReplayJumpToSelectedInPoint
ReplayJumpToSelectedOutPoint
ReplayLastEventCameraOff
ReplayLastEventCameraOn
ReplayLastEventSingleCameraOn
ReplayLive
ReplayLiveToggle
ReplayMarkCancel
ReplayMarkIn
ReplayMarkInLive
ReplayMarkInOut
ReplayMarkInOutLive
ReplayMarkInOutLiveFuture
ReplayMarkInOutRecorded
ReplayMarkInRecorded
ReplayMarkInRecordedNow
ReplayMarkOut
ReplayMoveLastEvent
ReplayMoveSelectedEvent
ReplayMoveSelectedEventDown
ReplayMoveSelectedEventUp
ReplayMoveSelectedInPoint
ReplayMoveSelectedOutPoint
ReplayPause
ReplayPlay
ReplayPlayAllEvents
ReplayPlayAllEventsToOutput
ReplayPlayBackward
ReplayPlayEvent
ReplayPlayEventsByID
ReplayPlayEventsByIDToOutput
ReplayPlayEventToOutput
ReplayPlayForward
ReplayPlayLastEvent
ReplayPlayLastEventToOutput
ReplayPlayNext
ReplayPlayPause
ReplayPlayPrevious
ReplayPlaySelectedEvent
ReplayPlaySelectedEventToOutput
ReplayQuadModeOff
ReplayQuadModeOn
ReplayRecorded
ReplaySelectAllEvents
ReplaySelectChannelA
ReplaySelectChannelAB
ReplaySelectChannelB
ReplaySelectedEventCameraOff
ReplaySelectedEventCameraOn
ReplaySelectedEventSingleCameraOn
ReplaySelectEvents1
ReplaySelectEvents10
ReplaySelectEvents11
ReplaySelectEvents12
ReplaySelectEvents13
ReplaySelectEvents14
ReplaySelectEvents15
ReplaySelectEvents16
ReplaySelectEvents17
ReplaySelectEvents18
ReplaySelectEvents19
ReplaySelectEvents2
ReplaySelectEvents20
ReplaySelectEvents3
ReplaySelectEvents4
ReplaySelectEvents5
ReplaySelectEvents6
ReplaySelectEvents7
ReplaySelectEvents8
ReplaySelectEvents9
ReplaySelectFirstEvent
ReplaySelectLastEvent
ReplaySelectNextEvent
ReplaySelectPreviousEvent
ReplaySetAudioSource
ReplaySetChannelAToBTimecode
ReplaySetChannelAToBTimecodeAndCamera
ReplaySetChannelBToATimecode
ReplaySetChannelBToATimecodeAndCamera
ReplaySetDirectionBackward
ReplaySetDirectionForward
ReplaySetLastEventText
ReplaySetLastEventTextCamera
ReplaySetSelectedEventText
ReplaySetSelectedEventTextCamera
ReplaySetSpeed
ReplaySetTimecode
ReplayShowHide
ReplayStartRecording
ReplayStartStopRecording
ReplayStopEvents
ReplayStopRecording
ReplaySwapChannels
ReplayToggleLastEventCamera1
ReplayToggleLastEventCamera2
ReplayToggleLastEventCamera3
ReplayToggleLastEventCamera4
ReplayToggleLastEventCamera5
ReplayToggleLastEventCamera6
ReplayToggleLastEventCamera7
ReplayToggleLastEventCamera8
ReplayToggleQuadMode
ReplayToggleSelectedEventCamera1
ReplayToggleSelectedEventCamera2
ReplayToggleSelectedEventCamera3
ReplayToggleSelectedEventCamera4
ReplayToggleSelectedEventCamera5
ReplayToggleSelectedEventCamera6
ReplayToggleSelectedEventCamera7
ReplayToggleSelectedEventCamera8
ReplayUpdateSelectedInPoint
ReplayUpdateSelectedOutPoint
ReplayUpdateSelectedSpeed
ReplayUpdateSelectedSpeedDefault
ReplayUpdateSelectedSpeedFromValue
NDICommand
NDISelectSourceByIndex
NDISelectSourceByName
NDIStartRecording
NDIStopRecording
OMTSelectSourceByIndex
OMTSelectSourceByName
PTZFocusAuto
PTZFocusFar
PTZFocusManual
PTZFocusNear
PTZFocusStop
PTZHome
PTZMoveDown
PTZMoveDownLeft
PTZMoveDownRight
PTZMoveLeft
PTZMoveRight
PTZMoveStop
PTZMoveUp
PTZMoveUpLeft
PTZMoveUpRight
PTZZoomIn
PTZZoomOut
PTZZoomStop
LastPreset
OpenPreset
SavePreset
DataSourceAutoNextOff
DataSourceAutoNextOn
DataSourceAutoNextOnOff
DataSourceNextRow
DataSourcePause
DataSourcePlay
DataSourcePlayPause
DataSourcePreviousRow
DataSourceSelectRow
BrowserBack
BrowserForward
BrowserKeyboardDisabled
BrowserKeyboardEnabled
BrowserMouseDisabled
BrowserMouseEnabled
BrowserNavigate
BrowserReload