Http web api, Vmix web api, Application programming interface – vMix Live Production Software Pro User Manual

Page 181

Advertising
background image

vMix User Guide

181 / 208

·

Any media related controls such as MediaElement and WebBrowser are not supported and will display
a blank window.

How to add a Custom WPF User Control to vMix

1. First make sure the user control has been compiled as a DLL and follows the implementation guidelines
above.
2. Click Add Input in vMix and then select the Title / XAML tab
3. Click Browse and browse for the DLL file and click OK
4. Click OK and the control will now be available in vMix.
5. If you have built custom properties through the ShowProperties function, this can be displayed through a
right click menu:

HTTP WEB API

The vMix API provides access to common functions through the HTTP protocol.
For example, the following command will signal vMix to fade Preview to Active within 1 second:

http://127.0.0.1:8088/api/?Function=Fade&Duration=1000

Setup

The API uses the same web address as the standard Web Interface and can be configured from the

Web

tab in Settings.

Parameters

Function

Specify a function to execute.
This can be any of the functions provided for the

Shortcuts

feature.

To view a list of what is possible, in vMix go to Settings, Shortcuts and click Add.
All the functions in the "Function" dropdown box can be called from the API.

Click here to view a list of some of the Shortcut Functions that are available.

Duration

If the specified function is a transition this parameter can be set to a time in milliseconds.

Advertising