Functions.xml.txt

<?xml version="1.0"?>
<ArrayOfVMixFunctionReference xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <!-- Many non-native functions can be mapped to existing vMix functions
  {0} - Input
  {1} - Parameter
  {2} - StringParameter
  {3} - Parameter - 1
  {4} - Number of Input-->

  <vMixFunctionReference>
    <Native>true</Native>
    <Description>Dummy function</Description>
    <Function>None</Function>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description></Description>
    <Function>vMix UTC Native Functions</Function>
	<IsGroup>true</IsGroup>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Native>true</Native>
    <Description>Execute link</Description>
    <Function>ExecLink</Function>
    <HasInputProperty>false</HasInputProperty>
    <HasIntProperty>false</HasIntProperty>
    <HasStringProperty>true</HasStringProperty>
    <StringDescription>Link</StringDescription>
    <InputDescription>N/A</InputDescription>
    <IntDescription>N/A</IntDescription>
  </vMixFunctionReference>
  
  <vMixFunctionReference>
    <Native>true</Native>
    <Description>Wait some time in milliseconds</Description>
    <Function>Timer</Function>
    <HasInputProperty>false</HasInputProperty>
    <HasIntProperty>true</HasIntProperty>
    <HasStringProperty>false</HasStringProperty>
    <IntDescription>Interval</IntDescription>
    <InputDescription>N/A</InputDescription>
    <StringDescription>N/A</StringDescription>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Native>true</Native>
    <Description>Update vMix state</Description>
    <Function>UpdateState</Function>
    <HasInputProperty>false</HasInputProperty>
    <HasIntProperty>false</HasIntProperty>
    <HasStringProperty>false</HasStringProperty>
    <InputDescription>N/A</InputDescription>
    <StringDescription>N/A</StringDescription>
    <IntDescription>N/A</IntDescription>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Native>true</Native>
    <Description>Go to command</Description>
    <Function>GoTo</Function>
    <HasInputProperty>false</HasInputProperty>
    <HasIntProperty>true</HasIntProperty>
    <HasStringProperty>false</HasStringProperty>
    <IntDescription>Command Index</IntDescription>
    <InputDescription>N/A</InputDescription>
    <StringDescription>N/A</StringDescription>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description></Description>
    <Function>Input Switching and Transitions</Function>
	<IsGroup>true</IsGroup>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description>Quick play</Description>
    <Function>QuickPlay</Function>
    <FormatString>Function=QuickPlay</FormatString>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description>CutPlayFade</Description>
    <Function>CutPlayFade</Function>
    <FormatString>Function=QuickPlay&amp;Input={0}</FormatString>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description>Cut Direct</Description>
    <Function>Cut Direct</Function>
    <FormatString>Function=CutDirect&amp;Input={0}</FormatString>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description>Use transition</Description>
    <Function>Transition</Function>
    <FormatString>Function=Transition{1}</FormatString>
    <IntDescription>Effect Number</IntDescription>
    <IntValues>
      <int>1</int>
      <int>2</int>
      <int>3</int>
      <int>4</int>
    </IntValues>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description>Transition using stinger</Description>
    <Function>Stinger</Function>
    <FormatString>Function=Stinger{1}</FormatString>
    <IntDescription>Number</IntDescription>
    <IntValues>
      <int>1</int>
      <int>2</int>
    </IntValues>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description>Set active input</Description>
    <Function>ActiveInput</Function>
    <FormatString>Function=ActiveInput&amp;Input={0}</FormatString>
    <ActiveStatePath>Active</ActiveStatePath>
    <ActiveStateValue>{0}</ActiveStateValue>
  </vMixFunctionReference>
  
  <vMixFunctionReference>
    <Description>Set preview input</Description>
    <Function>PreviewInput</Function>
    <FormatString>Function=PreviewInput&amp;Input={0}</FormatString>
    <ActiveStatePath>Preview</ActiveStatePath>
    <ActiveStateValue>{0}</ActiveStateValue>
  </vMixFunctionReference>
  
  <vMixFunctionReference>
    <Description>FadeToBlack</Description>
    <Function>FadeToBlack</Function>
    <FormatString>Function=FadeToBlack</FormatString>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description></Description>
    <Function>--- Media Controls ---</Function>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description>Play</Description>
    <Function>Play</Function>
    <FormatString>Function=Play&amp;Input={0}</FormatString>
    <IntDescription>N/A</IntDescription>
    <StringDescription>N/A</StringDescription>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description>Pause</Description>
    <Function>Pause</Function>
    <FormatString>Function=Pause&amp;Input={0}</FormatString>
    <IntDescription>N/A</IntDescription>
    <StringDescription>N/A</StringDescription>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description>Restart</Description>
    <Function>Restart</Function>
    <FormatString>Function=Restart&amp;Input={0}</FormatString>
    <IntDescription>N/A</IntDescription>
    <StringDescription>N/A</StringDescription>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description></Description>
    <Function>Output Controls</Function>
	<IsGroup>true</IsGroup>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description>StartStreaming</Description>
    <Function>StartStreaming</Function>
    <FormatString>Function=StartStreaming</FormatString>
    <ActiveStatePath>Streaming</ActiveStatePath>
    <ActiveStateValue>False</ActiveStateValue>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description>StopStreaming</Description>
    <Function>StopStreaming</Function>
    <FormatString>Function=StopStreaming</FormatString>
    <ActiveStatePath>Streaming</ActiveStatePath>
    <ActiveStateValue>True</ActiveStateValue>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description>StartRecording</Description>
    <Function>StartRecording</Function>
    <FormatString>Function=StartRecording</FormatString>
    <ActiveStatePath>Recording</ActiveStatePath>
    <ActiveStateValue>False</ActiveStateValue>
  </vMixFunctionReference>
  
  <vMixFunctionReference>
    <Description>StopRecording</Description>
    <Function>StopRecording</Function>
    <FormatString>Function=StopRecording</FormatString>
    <ActiveStatePath>Recording</ActiveStatePath>
    <ActiveStateValue>True</ActiveStateValue>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description>StartStopExternal</Description>
    <Function>StartStopExternal</Function>
    <FormatString>Function=StartStopExternal</FormatString>
    <ActiveStatePath>External</ActiveStatePath>
    <ActiveStateValue>True</ActiveStateValue>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description>StartStopMultiCorder</Description>
    <Function>StartStopMultiCorder</Function>
    <FormatString>Function=StartStopMultiCorder</FormatString>
    <ActiveStatePath>MultiCorder</ActiveStatePath>
    <ActiveStateValue>True</ActiveStateValue>
  </vMixFunctionReference>
    
  <vMixFunctionReference>
    <Description>StartStopRecording</Description>
    <Function>StartStopRecording</Function>
    <FormatString>Function=StartStopRecording</FormatString>
    <ActiveStatePath>Recording</ActiveStatePath>
    <ActiveStateValue>True</ActiveStateValue>
  </vMixFunctionReference>
    
   <vMixFunctionReference>
    <Description>StartStopStreaming</Description>
    <Function>StartStopStreaming</Function>
    <FormatString>Function=StartStopStreaming</FormatString>
    <ActiveStatePath>Streaming</ActiveStatePath>
    <ActiveStateValue>True</ActiveStateValue>
  </vMixFunctionReference>
  
   <vMixFunctionReference>
    <Description>StartStopFullscreen</Description>
    <Function>Fullscreen Toggle</Function>
    <FormatString>Function=Fullscreen</FormatString>
    <ActiveStatePath>Fullscreen</ActiveStatePath>
    <ActiveStateValue>True</ActiveStateValue>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description></Description>
    <Function>External 2</Function>
	<IsGroup>true</IsGroup>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description>Set Output External2</Description>
    <Function>SetOutputExternal2</Function>
    <FormatString>Function=SetOutputExternal2&amp;Value={2}&amp;Input={0}</FormatString>
    <StringDescription>Type</StringDescription>
    <!--<IntDescription>Input Number</IntDescription>-->
    <StringValues>
      <string>Input</string>
      <string>Preview</string>
      <string>Output</string>
      <string>MultiView</string>
    </StringValues>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description></Description>
    <Function>Replay Controls</Function>
	<IsGroup>true</IsGroup>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description>ReplayPlayLastEventToOutput</Description>
    <Function>ReplayPlayLastEventToOutput</Function>
    <FormatString>Function=ReplayPlayLastEventToOutput</FormatString>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description>ReplayMarkInOutLive</Description>
    <Function>ReplayMarkInOutLive</Function>
    <FormatString>Function=ReplayMarkInOutLive&amp;Value={1}</FormatString>
    <IntDescription>Time</IntDescription>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description></Description>
    <Function>Overlay Controls</Function>
	<IsGroup>true</IsGroup>
  </vMixFunctionReference>
  
  <vMixFunctionReference>
    <Description>Fade in input as overlay</Description>
    <Function>OverlayInputIn</Function>
    <FormatString>Function=OverlayInput{1}In&amp;Input={0}</FormatString>
    <ActiveStatePath>Overlays[{3}].ActiveInput</ActiveStatePath>
    <ActiveStateValue>!{0}</ActiveStateValue>
    <IntDescription>Overlay</IntDescription>
    <IntValues>
      <int>1</int>
      <int>2</int>
      <int>3</int>
      <int>4</int>
    </IntValues>
  </vMixFunctionReference>
  
  <vMixFunctionReference>
    <Description>Switch overlay off</Description>
    <Function>OverlayInputOff</Function>
    <FormatString>Function=OverlayInput{1}Off</FormatString>
    <ActiveStatePath>Overlays[{3}].ActiveInput</ActiveStatePath>
    <ActiveStateValue>*</ActiveStateValue>
    <TransitionIndex>0</TransitionIndex>
    <IntDescription>Overlay</IntDescription>
    <IntValues>
      <int>1</int>
      <int>2</int>
      <int>3</int>
      <int>4</int>
    </IntValues>
  </vMixFunctionReference>
  
  <vMixFunctionReference>
    <Description>Fade out overlay</Description>
    <Function>OverlayInputOut</Function>
    <FormatString>Function=OverlayInput{1}Out</FormatString>
    <ActiveStatePath>Overlays[{3}].ActiveInput</ActiveStatePath>
    <ActiveStateValue>*</ActiveStateValue>
    <TransitionIndex>0</TransitionIndex>
    <IntDescription>Overlay</IntDescription>
    <IntValues>
      <int>1</int>
      <int>2</int>
      <int>3</int>
      <int>4</int>
    </IntValues>
  </vMixFunctionReference>
  
  <vMixFunctionReference>
    <Description>Toggle overlay</Description>
    <Function>OverlayInputToggle</Function>
    <FormatString>Function=OverlayInput{1}&amp;Input={0}</FormatString>
    <ActiveStatePath>Overlays[{3}].ActiveInput</ActiveStatePath>
    <ActiveStateValue>{0}</ActiveStateValue>
    <TransitionIndex>0</TransitionIndex>
    <IntDescription>Overlay</IntDescription>
    <IntValues>
      <int>1</int>
      <int>2</int>
      <int>3</int>
      <int>4</int>
    </IntValues>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description></Description>
    <Function>vMix Countdowns</Function>
	<IsGroup>true</IsGroup>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description>Set countdown format hh:mm:ss</Description>
    <Function>SetCountdown</Function>
    <FormatString>Function=SetCountdown&amp;Input={0}&amp;Value={2}&amp;SelectedIndex={1}</FormatString>
    <IntDescription>Title</IntDescription>
    <StringDescription>Time</StringDescription>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description>Start countdown</Description>
    <Function>StartCountdown</Function>
    <FormatString>Function=StartCountdown&amp;Input={0}&amp;SelectedIndex={1}</FormatString>
    <IntDescription>Title</IntDescription>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description>Stop countdown</Description>
    <Function>StopCountdown</Function>
    <FormatString>Function=StopCountdown&amp;Input={0}&amp;SelectedIndex={1}</FormatString>
    <IntDescription>Title</IntDescription>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description>Pause countdown</Description>
    <Function>PauseCountdown</Function>
    <FormatString>Function=PauseCountdown&amp;Input={0}&amp;SelectedIndex={1}</FormatString>
    <IntDescription>Title</IntDescription>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description></Description>
    <Function>vMix Shortcuts</Function>
	<IsGroup>true</IsGroup>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description>KeyPress</Description>
    <Function>KeyPress</Function>
    <FormatString>Function=KeyPress&amp;Value={2}</FormatString>
    <StringDescription>Key</StringDescription>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description></Description>
    <Function>Title Controls</Function>
	<IsGroup>true</IsGroup>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description>Set title text</Description>
    <Function>SetText</Function>
    <FormatString>Function=SetText&amp;Input={0}&amp;SelectedIndex={1}&amp;Value={2}</FormatString>
    <ActiveStatePath>Inputs[{0}].Elements[{1}].Text</ActiveStatePath>
    <ActiveStateValue>{2}</ActiveStateValue>
    <StateDirect>true</StateDirect>
    <StatePath>Inputs[{0}].Elements[{1}].Text</StatePath>
    <StateValue>String</StateValue>
    <IntDescription>Index</IntDescription>
    <StringDescription>Value</StringDescription>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description>Set title text with native indexes</Description>
    <Function>SetTextNative</Function>
    <FormatString>Function=SetText&amp;Input={0}&amp;SelectedIndex={1}&amp;Value={2}</FormatString>
    <ActiveStatePath>Inputs[{0}].Elements[InputText/Index/{1}].Text</ActiveStatePath>
    <ActiveStateValue>{2}</ActiveStateValue>
    <StateDirect>true</StateDirect>
    <StatePath>Inputs[{0}].Elements[InputText/Index/{1}].Text</StatePath>
    <StateValue>String</StateValue>
    <IntDescription>Index</IntDescription>
    <StringDescription>Value</StringDescription>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description>Set Image path</Description>
    <Function>SetImage</Function>
    <FormatString>Function=SetImage&amp;Input={0}&amp;SelectedIndex={1}&amp;Value={2}</FormatString>
    <ActiveStatePath>Inputs[{0}].Elements[{1}].Image</ActiveStatePath>
    <ActiveStateValue>{2}</ActiveStateValue>
    <StateDirect>true</StateDirect>
    <StatePath>Inputs[{0}].Elements[{1}].Image</StatePath>
    <StateValue>String</StateValue>
    <IntDescription>Index</IntDescription>
    <StringDescription>Path</StringDescription>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description>Set image path with native indexes</Description>
    <Function>SetImageNative</Function>
    <FormatString>Function=SetImage&amp;Input={0}&amp;SelectedIndex={1}&amp;Value={2}</FormatString>
    <ActiveStatePath>Inputs[{0}].Elements[InputImage/Index/{1}].Image</ActiveStatePath>
    <ActiveStateValue>{2}</ActiveStateValue>
    <StateDirect>true</StateDirect>
    <StatePath>Inputs[{0}].Elements[InputImage/Index/{1}].Image</StatePath>
    <StateValue>String</StateValue>
    <IntDescription>Index</IntDescription>
    <StringDescription>Path</StringDescription>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description></Description>
    <Function>vMix DataSource Controls</Function>
	<IsGroup>true</IsGroup>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description>DataSourceSelectRow</Description>
    <Function>DataSourceSelectRow</Function>
    <FormatString>Function=DataSourceSelectRow&amp;Value={2}</FormatString>
    <StringDescription>Data Source</StringDescription>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description>DataSourceNextRow</Description>
    <Function>DataSourceNextRow</Function>
    <FormatString>Function=DataSourceNextRow&amp;Value={2}</FormatString>
    <StringDescription>Data Source</StringDescription>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description>DataSourcePreviousRow</Description>
    <Function>DataSourcePreviousRow</Function>
    <FormatString>Function=DataSourcePreviousRow&amp;Value={2}</FormatString>
    <StringDescription>Data Source</StringDescription>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description></Description>
    <Function>Multiviews and Virtual Sets Controls</Function>
	<IsGroup>true</IsGroup>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description>MultiView Overlay Toggle</Description>
    <Function>MultiViewOverlay Toggle</Function>
    <FormatString>Function=MultiViewOverlay&amp;Input={0}&amp;Value={1}</FormatString>
    <IntDescription>Overlay number</IntDescription>
    <StringDescription>N/A</StringDescription>
    <IntValues>
      <int>1</int>
      <int>2</int>
      <int>3</int>
      <int>4</int>
      <int>5</int>
      <int>6</int>
      <int>7</int>
      <int>8</int>
      <int>9</int>
      <int>10</int>
    </IntValues>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description>Move MultiView Overlay</Description>
    <Function>Move MultiView Overlay</Function>
    <FormatString>Function=MoveMultiViewOverlay&amp;Input={0}&amp;Value={1},{2}</FormatString>
    <IntDescription>Overlay Number</IntDescription>
    <StringDescription>Overlay Position</StringDescription>
    <IntValues>
      <int>1</int>
      <int>2</int>
      <int>3</int>
      <int>4</int>
      <int>5</int>
      <int>6</int>
      <int>7</int>
      <int>8</int>
      <int>9</int>
      <int>10</int>
    </IntValues>
    <StringValues>
      <string>1</string>
      <string>2</string>
      <string>3</string>
      <string>4</string>
      <string>5</string>
      <string>6</string>
      <string>7</string>
      <string>8</string>
      <string>9</string>
      <string>10</string>
    </StringValues>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description>Set MultiView Overlay</Description>
    <Function>SetMultiViewOverlay</Function>
    <FormatString>Function=SetMultiViewOverlay&amp;Input={0}&amp;Value={1},{2}</FormatString>
    <IntDescription>Overlay Number</IntDescription>
    <StringDescription>New Input Key</StringDescription>
    <!-- Type Property Value -->
    <ActiveStatePath>Inputs[{0}].Elements[InputOverlay/Index/{3}].Key</ActiveStatePath>
    <ActiveStateValue>{2}</ActiveStateValue>
    <IntValues>
      <int>1</int>
      <int>2</int>
      <int>3</int>
      <int>4</int>
      <int>5</int>
      <int>6</int>
      <int>7</int>
      <int>8</int>
      <int>9</int>
      <int>10</int>
    </IntValues>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description>Select Zoom Index in VirtualSets</Description>
    <Function>Select Zoom Index in VirtualSets</Function>
    <FormatString>Function=SelectIndex&amp;Input={0}&amp;Value={1}</FormatString>
    <IntDescription>Zoom Index</IntDescription>
    <StringDescription>N/A</StringDescription>
    <IntValues>
      <int>1</int>
      <int>2</int>
      <int>3</int>
      <int>4</int>
    </IntValues>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description></Description>
    <Function>Playlist, Lists and Photos Controls</Function>
	<IsGroup>true</IsGroup>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description>SelectPlayList</Description>
    <Function>SelectPlayList</Function>
    <FormatString>Function=SelectPlayList&amp;Value={2}</FormatString>
    <StringDescription>Name</StringDescription>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description>StartPlayList</Description>
    <Function>StartPlayList</Function>
    <FormatString>Function=StartPlayList</FormatString>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description>StopPlayList</Description>
    <Function>StopPlayList</Function>
    <FormatString>Function=StopPlayList</FormatString>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description>PreviousPlayListEntry</Description>
    <Function>PreviousPlayListEntry</Function>
    <FormatString>Function=PreviousPlayListEntry</FormatString>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description>NextPlayListEntry</Description>
    <Function>NextPlayListEntry</Function>
    <FormatString>Function=NextPlayListEntry</FormatString>
  </vMixFunctionReference>

  <vMixFunctionReference>
    <Description>Select Index in Photos and Lists Inputs</Description>
    <Function>Select Index in Photos and Lists Inputs</Function>
    <FormatString>Function=SelectIndex&amp;Input={0}&amp;Value={1}</FormatString>
    <IntDescription>Media Input Index</IntDescription>
    <StringDescription>N/A</StringDescription>
  </vMixFunctionReference>

</ArrayOfVMixFunctionReference>