User's Manual

vMix User Guide
185 / 208
Commands
TALLY
Event Supported: Yes
Example Request: TALLY\r\n
Example Response: TALLY OK 0121...\r\n
Description: Returns a list of tally values where 0 = off, 1 = program, 2 = preview.
The list is padded to the total number of inputs currently added to vMix and may have up to 1000 entries as
a result.
(Maximum possible length = 9 + 1000 + 2 = 1011 bytes)
FUNCTION
Format: FUNCTION <Function> [QueryString]\r\n
Example Request: FUNCTION PreviewInput Input=5\r\n
Example Request: FUNCTION SetText Input=3&SelectedName=Headline&Value=Hello world\r\n
Example Response: FUNCTION OK PreviewInput\r\n
Example Response: FUNCTION ER Error message\r\n
Description: Calls a Shortcut Function with optional Query String. This Query String exactly matches the
syntax
and layout of HTTP WEB API. Standard URL escape/encoding characters should be used.
ACTS
Event Supported: Yes
Format: ACTS <ActivatorName> [InputNumber]\r\n
Example Request: ACTS Input 1\r\n
Example Response: ACTS OK Input 1 1\r\n
Description: Retrieves the current state of an Activator. This can be used even if a particular activator has
not been added in vMix and is handy
for retrieving state information for use with custom controllers.
To subscribe to all activator events use the command SUBSCRIBE ACTS. This will retrieve all events
as it is not possible to subscribe to only a particular activator.
The input number can be left blank for Input, InputPreview and Overlay1,2,3,4 to show the currently
assigned input, if any, otherwise ER No Input will be returned.
Return values will always be between 0 and 1. In contrast to the XML output this means boolean True/False
becomes 1/0 and integer values such as Volume become 32bit floating point values.
XML
Example Request: XML\r\n
Example Response: XML 37\r\n
<vmix><version>x.x.x.x</version></vmix>
Description: Returns the current XML state as binary data encoded in UTF-8 format.
The data length has no size limit and can be quite large, therefore embedded devices should use the XML
parsing commands below to efficiently retrieve values.
XMLTEXT
Format: XMLTEXT XPATH
Example Request: XMLTEXT vmix/inputs/input[1]/@title\r\n
Example Response: XMLTEXT OK This is the title of the first input\r\n
Example Request: XMLTEXT vmix/inputs/input[6]/text[@name='Headline']\r\n
Example Response: XMLTEXT OK This is the value of Headline text field in title input that is the number 6
(index 5) input.\r\n
Description: Uses the XPATH syntax to retrieve individual text values of the XML state.
To simplify parsing, multiline text will use the status length, while single line data will always use a single
line response.
SUBSCRIBE
Format: SUBSCRIBE <COMMAND>\r\n
Example Request: SUBSCRIBE TALLY\r\n
Example Response: SUBSCRIBE OK TALLY\r\n