vMix Live Production Software Pro User Manual

Page 178

Advertising
background image

vMix User Guide

178 / 208

Both of these scripts do the same thing, that is to find the Title Input with name "NewsHD.xaml" and assign
the "Headline" field with the text "Hello World!"
To try it out add the NewsHD.xaml title template to vMix and then run the script.

VB.NET

vMix Scripting supports the majority of VB.NET 2.0 code that will work within a single sub or function.
This means that custom classes and structures are not supported, however you can use the vast majority of
the built in base classes in the .NET framework
including the handy System.Net.WebClient for downloading data over the internet.

vMix Objects

There are a number of built in objects that can be used from within vMix scripting:

Input

Shared Properties

Output As Input
Preview As Input
Find(inputNameNumberOrKey as String) As Input

Example:

Input.Preview.Function("Cut")

Instance Properties

Text(Optional fieldName As String = "") As String

Change the text of a Field within an Title input, or read the current value

Instance Methods

Function(functionName As String, Optional value As String = "", Optional duration As

Integer = 0, Optional selectedName As String = "", Optional selectedIndex As Integer = 0)

Function can be used to call any Shortcut function in vMix

WaitForCompletion(timeoutMilliseconds As Integer) As Boolean

Wait for a video to finish playing and return True, otherwise return False if timed out.

Overlay

Shared Properties

Find(number as Integer) As Overlay

Instance Methods

In(input as String)
Out
Off

Advertising