vMixCUE v260918_02
Untitled
Not connected — you can still build commands
Settings / Reset

App updates

Saved in the file / Kept in the app

Your scripts, boards and title text settings go into a file (.vcue) with “Save” at the very top. “New” clears them, and “Open” brings them back.

Connection, Favorites, presets, the reference and the StreamDeck template, on the other hand, carry over from one job to the next, so they aren’t saved in the file. “New” doesn’t clear them. You can reset them here.

Presets (stored in this app)

Keeps the current state inside this app instead of a file. Handy for switching between jobs.

Loading a preset replaces the current state, then reloads the window.

Reset

Check what you want to reset, then press the button. A reset can’t be undone.
If you only want to clear your work, use “New” at the top.

The window reloads after the reset.
How to make the template

Elgato doesn’t publish the format of Stream Deck profiles. A profile built by guesswork won’t import, so instead you make one real profile, and its button gets copied. You only need to do this once.

1. Create a new profile

  1. In the Stream Deck app, click the profile name at the top left, under the device name (e.g. Stream Deck XL), and create a new profile (or use gear → Profiles at the top right)
  2. Any name will do

2. Place a single “Website” action

From System in the list on the right, drag Website onto the top-left key.

3. Enter the three settings below

Title
URL
Dropdown under URLChoose GET request in background

The third one starts out as “Default browser”. Unless you change it, a browser opens every time you press the key.
The title and URL are markers. vMixCUE looks for this text in the exported file and replaces it with its own names and URLs. Enter them exactly as shown.

4. Export it and load it here

  1. Right-click → Export the profile you just made (from the profile name at the top left, or from gear → Profiles)
  2. Choose that file with “Use my own template” on this screen

For safety: vMixCUE doesn’t touch the Stream Deck settings folder or rewrite any existing profile. It only creates a new file. It doesn’t send commands to vMix when exporting, either.

Guide

1What vMixCUE does

vMixCUE is for building vMix commands, laying them out as buttons, and pressing them during the show. The tabs are arranged in workflow order: setup → the show. Everything up to building commands works even when you’re not connected to vMix.

Setup (before the show) Cue Generator Script Builder StreamDeck Transfer Setup Checker Send The show (on the day) Control Board Title Editor State Monitor vMix Can be remote The line under the tabs explains each screen

2Files (New / Open / Save)

Click “Save” at the very top of the window to save your work as a file (.vcue). Keep one file per production, and “Open” brings the whole thing back.

A file holds the work for that production: Script Builder scripts, Control Board boards, StreamDeck layouts, Title Editor settings and the Setup Checker snapshot.
Connection settings, Favorites, settings presets, the reference and StreamDeck templates, on the other hand, carry over from job to job, so they are not saved in the file. “New” doesn’t clear them either.

NewClear your work and start from scratch
OpenLoad a saved file (.vcue)
SaveWrite the current work to a file (⌘/Ctrl + S)

A * after the file name means there are unsaved changes. If you try to close anyway, you’ll be asked to confirm.

3Cue Generator — build one command

Pick a function from the list on the left, fill in fields such as Input and Value, then choose a format from the tabs below and copy it. When connected to vMix, “Send to vMix” lets you try it on the spot. Click ★ to add a function to Favorites; from then on it appears at the top of the list.

SetText Pick from 792 functions Input Value Fill in the fields GET http://…/api/?… Copy / Send
  • Inputs can be given by GUID, name or number. The default is GUID: it doesn’t change when inputs are reordered, so it’s the hardest to break.
  • Special values … None (not specified) / Program (0) / Preview (-1) / Dynamic 1–4. A Dynamic input is a “swappable slot”: set what it points to beforehand with SetDynamicInput1.

4Script Builder — combine steps into one script

Turns commands into a list that runs from top to bottom. Use “Wait before next” to insert a pause (in milliseconds). Drag rows to reorder them, and save the list as a named preset.

1. OverlayInput1In 2. Wait 1000ms 3. OverlayInput1Out Runs from top to bottom Copy as a Web script, etc. Send as one button (below)

Send the whole list with + StreamDeck Transfer (it becomes a Multi Action) or + Control Board (it becomes one button).

5StreamDeck Transfer — make real Stream Deck keys

Lay out the commands you sent on the same key grid as your device, set names, colors and labels, and export a .streamDeckProfile. Just double-click the exported file and Stream Deck imports it. Nothing needs to be set up on the Stream Deck side.

CAM1 CAM2 Profile.stream…Double-click to import Device
Shift + clickSend that key to vMix to test it (check before exporting)
⌘/Ctrl + clickSelect multiple keys to move or recolor them together
Alt (Option) + dragDuplicate
⌘/Ctrl + C / X / V / D / ACopy / Cut / Paste / Duplicate / Select all
DeleteClear the key

6Setup Checker — catch oversights before the show

Click “▶ Run check” to go through the current vMix setup and list anything likely to cause trouble. There are three levels: Critical will cause a problem on air; Warning is fine to leave if it’s intentional; Check can’t be judged from the vMix API, so someone needs to look at it.
Snapshots record the state at the moment setup is finished. Run the check again before the show, and only what has changed since then is listed.

Critical … preset not saved Warning … input left muted OK … 12 items Snapshot Setup done → take a snapshot Recheck before the show → changes only

6.5Relink media (inside Setup Checker)

When you move to another PC, media paths no longer match and the inputs go black. Relink media opens the vMix preset (.vmix) and relinks all the paths inside it at once.

Input Keys and shortcuts stay as they are. vMix has no command to “replace just the file of an input”, and recreating inputs breaks everything that points to them. Rewriting only the paths in the preset is the reliable way.

Open .vmixCollect all paths MatchFind by name Save as new fileOriginal is kept

Even if your media is scattered all over, pointing to one file fixes the rest in a chain. Use “Locate…” on a missing row to show where the file is, and everything else in that same location is relinked too. Searched locations are remembered, so each location you point to relinks more files (the same idea as relinking in Premiere).

When it opens, it automatically loads whatever vMix has open right now. Once fixed, “Load into vMix” loads it into vMix (same PC only). On a different PC, read the file with “Open .vmix…” and save it with “Save as new file”.

You can also relink to a file with a different name. Pick it right there with “Other file…” on the row. Once chosen, it stays even if you search again.

Recording destinations and files that come with vMix (under Program Files) are left alone. The original preset is never overwritten either.

7Control Board — press-to-send control panel

Arrange five kinds of widgets freely: buttons, labels, text, timers and scores.

The key thing is the switch at the top right. In Edit mode, pressing a widget sends nothing. Commands go to vMix only in Live mode (red). A button’s border lights up red when its input is on Program and green when it’s on Preview (it follows vMix automatically).

CAM 1 CAM 2 Title Red = on Program Green = on Preview Edit mode … safe to touch Live mode … press to send

Arranging works the same way as in StreamDeck Transfer. On top of that, dragging a box from an empty spot selects every widget it touches. Use pages to have as many boards as you like.

8Title Editor — edit title text

Load a vMix title (GT), edit its text and send it out on the spot. You can also take overlays 1–4 in and out, add or subtract scoreboard points and run countdowns from here.

Save content you use often as a named preset. Recalling a preset sends nothing to vMix (it only fills in the screen), so nothing goes on air by mistake.

9State Monitor — keep an eye on vMix

A screen to glance at during the show. There is nothing on it you can press to change anything.

It shows Preview and Program large, and below them the overlays (red = Program / green = Preview), recording and streaming status, audio, and the time left on the video that’s playing.

List running orders are shown too. For Lists that are playing or on PGM / PVW, it shows the clip on air now (▶), the clip coming up next (marked “Next”), each clip’s duration and the total duration of the running order. Durations come from “Check durations” in List Deck, so clips not read yet show --:--, and images, which have no duration, show —. Nothing can be changed here (reorder in List Deck; take clips in and out in vMix itself or on the Control Board).

PVWUp next PGMOn air now Opening video · 0:42 left Time left updates every second

10List Deck — organize List contents

Each vMix List input becomes one card. It can hold not only video but also images and audio. This screen is for viewing and reordering.

Playback and cueing are not done here. Send them from vMix itself or from buttons you made on the Control Board. Being able to take clips in and out from this screen during the show would invite accidents.

List name · Input 5 PVW Name of the current clip 0:21 / 1:30 1 Opening.mp4 · Video 2 Sponsor.png · Image

What you can do

  • Show and change the name (the input name in vMix changes too)
  • The name of the current clip and a playback progress bar
  • Reorder the running order (drag rows), and duplicate + / delete × clips
  • Duplicate the whole List (creates another List with the same contents in vMix)
  • Loop (goes back to the top after the last clip)
  • Check durations … selects each clip in turn to read its length, then goes back to where it was. Used for the total duration (right of the header) and the overall time left in State Monitor
  • Drag the bottom-right corner of a card to resize it

You can’t change the running order of a List that’s on Program (red border). vMix has no command to reorder, so the only way is to “clear everything and add it all back”. For that moment the List is empty and the output goes black. Take it off air first, then reorder.

11Connecting to vMix

Enter the vMix IP and port in the bar above, then click “Connect / Refresh”. Once connected, the input list fills in automatically, and tally and State Monitor start working.

vMixCUE This PC (Mac / Win) http://192.168.x.x:8088 vMix PC Turn on Web Controller
  • vMix on the same PC … the IP is 127.0.0.1 (the address that means “this computer”)
  • vMix on another PC … enter the IP shown in that vMix under Settings → Web Controller
  • Port … usually leave it at 8088. If you’ve changed things, “↺ Reset” sets them back to 127.0.0.1 / 8088

12If it won’t connect (CORS)

vMix doesn’t allow web pages from elsewhere to read its data directly (a browser rule called CORS), so only when you open the HTML version in a browser, the input list may fail to load. Building commands still works fully, so type input names or numbers directly.

HTML version (browser) Browser The browser’s rules may block it vMix Web Controller App (Windows / macOS) App UI Built-in server Built-in server relays = no limits

For a reliable connection, use the Windows or macOS version. If it still won’t connect, check that Web Controller is enabled in vMix Settings, that the IP and port are correct, and that both machines are on the same network.

The web version you open on the website works like the HTML version: it can’t read vMix’s state (Title Editor, Setup Checker, List Deck and State Monitor aren’t available). It can send commands. The first time you send, Chrome / Edge asks for access to “devices on your local network” — allow it. Once you’ve opened it, it also opens at venues without an internet connection.

13Output formats (5 types)

HTTP GETA URL to call from a browser, Stream Deck’s “Website” action, curl, etc.
TCP APISent over a TCP connection on port 8099
CompanionPaste into “Scripting - Run custom command” in Bitfocus Companion
Web scriptFor the script box in Web Controller. One command per line; Sleep 1000 waits
VB.NET scriptPaste into vMix Settings → Scripting

14Updating the reference (when vMix 30 comes out)

  1. Open the Windows or macOS version (not available in the HTML version). An internet connection is also needed
  2. Change the number at the bottom right of the window from 29 to 30
  3. Click “Update reference” → it’s done when you see “Updated (NN functions)”

Descriptions of new functions come straight from the official vMix reference. To go back to the built-in v29, click

Choose a folder
Relink media
Search in