The value should be A, B, Current or left blank. If this parameter is left blank it will default to the currently selected channel in the Replay user interface. Some replay functions can be applied to a specific channel. This parameter can be used to select the Mix to use where 0 = main mix, 1 = first Mix input, 2 = second Mix input etc. In the 4K and Pro editions up to three separate Mix inputs are available. 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:ilename.wmv Image|c:ilename.jpg. SetText : Specify the text to display in the text field specified by SelectedIndex above. SetImage : Specify the image to display in an image field within a supported XAML or Title input For a full list of functions that use Value parameters refer to the Shortcut Function Reference. Value is used with many different API Functions including the following. VideoList : Specify the video to play starting from 1 Virtual Set : Specify the camera zoom to transition to Title : Specify the text item to configure starting from 0 Specify an index to pass to the input The following Inputs support the SelectedIndex parameter: For reference, these full names are displayed in the Title Editor built into vMix. When using GT titles, the name should include '.Text' at the end for text fields and '.Source' at the end for images or rectangles with brush images. When using Title or XAML inputs, SelectedName can be used to specify the name of the text field to modify. The GUID can be found from the 'Key' attribute in the XML. A GUID can be used to specify an exact input. (note that it is case sensitive, and requires the full title name including spaces) 3. Input can be used to specify the Input in one of three ways:Ġ can be used for Preview and -1 for Active.Ģ. If the specified function is a transition this parameter can be set to a time in milliseconds.

All the functions in the 'Function' dropdown box can be called from the API.Ĭlick here to view a list of some of the Shortcut Functions that are available. To view a list of what is possible, in vMix go to Settings, Shortcuts and click Add. This can be any of the functions provided for the Shortcuts feature. The API uses the same web address as the standard Web Interface and can be configured from the Web tab in Settings.

Vmix control surface app tutorial