Developer information, Custom xaml – vMix Live Production Software Pro User Manual

Page 180

Advertising

vMix User Guide

180 / 208

Function=OverlayInput1In&Input=NewsHD.xaml
Sleep 2000
Function=OverlayInput1Out

Syntax

The syntax for each line is the same as the query string used with the but

vMix Web API

without the URL

portion

For example

http://localhost:8088/API/?Function=Cut

in the Web API would be just

Function=Cut

with

Web Scripting

All the same parameters apply for example:

Function=Slide&Input=NewsHD.xaml&Duration=1000
Function=SetText&Input=NewsHD.xaml&SelectedName=Description&Value=Hello World

The only exception is the Sleep command which is unique to Web Scripting and will pause for a number of
milliseconds between two functions.
URL encoding may need to be used when using special characters in the Value parameter.

Developer Information

vMix provides two interfaces for developers:

Custom XAML

Application Programming Interface

Custom XAML

vMix supports the use of custom WPF User Controls compiled into an assembly.

Custom User Controls can implement the

vMixWPFUserContro

l interface from the

vMixInterop.dll

in the

vMix installation directory.
This interface allows vMix to communicate with the User Control and gather duration and position
information.

Implementation Guidelines

All controls must be compatible with .NET Framework 3.5 SP1 (4.0 is not supported at this time)

ShowProperties should display a WinForms window without blocking (Form.Show instead of
Form.ShowDialog)

Displaying WPF windows through ShowProperties is untested and unsupported.

Any code within ShowProperties will not run in the context of the WPF UI thread so the use of
Dispatcher is required to modify UI elements.

All other methods run within the WPF UI thread so cpu intensive procedures should be avoided to
prevent frame drops.

Advertising