Loading...
Control Visibox live visual performance software from Bitfocus Companion.
127.0.0.1| Field | Default | Description |
|---|---|---|
| Host | 127.0.0.1 | IP address of the computer running Visibox |
| WebSocket Port | 17734 | Visibox WebSocket API port |
| HTTP Port | 17736 | Visibox HTTP API port |
| Pairing Code | (empty) | 6-digit code from Visibox (Pair with Remote… — Visibox menu on macOS, File menu on Windows). Used once on the next connection, then cleared |
Every connection must be approved by Visibox, including one from the same machine.
Either way Visibox issues a device token. The module stores it (out of sight of the config page) and presents it on every reconnect and restart, so pairing is a one-time step. The Pairing Code field clears itself once the token arrives.
If the status shows Authentication Failure, the stored token was revoked in Visibox or the pairing code was wrong or already used. Pair again: enter a fresh code (or, on the same machine, approve the dialog).
For a ready-made page, use the presets (drag them from the Presets tab), or import visibox-starter.companionconfig (in the starter folder of the module's source repository) in Import / Export. It lays out playback, song and clip navigation, Panic, Fullscreen, Songs 1–4 and Clips 1–8 labelled with their names, a Now Playing status button, and Mute and volume. Map its connection to your Visibox connection when you import it.
Trigger a specific clip by its index within a song. Use Song Offset to target clips in adjacent songs (0 = active song, -1 = previous, +1 = next).
Release a held clip — stops it if it was triggered in Gate launch mode, ignored otherwise. Put it in a button's release (up) actions alongside Trigger Clip for hold-to-play.
Select a song by its index (0-based) or by its internal ID. Optionally stop current playback when switching.
Control playback with the following modes:
Navigate between clips and songs:
Drive a Real-Time Control by its display letter (A–Z), moving every Target bound to it. Set jumps to a value; Adjust moves by an amount per press, for rotaries.
Write one Real-Time Control Target parameter directly by its structured id (for example clip:abc123/opacity or master/volume), bypassing Controls.
| Feedback | Description |
|---|---|
| Clip Playing | True when any clip is currently playing or tailing |
| Clip Paused | True when the active clip is paused |
| Specific Clip Active | True when a clip at a specific index is active (playing, paused, or tailing) |
| Song Active | True when a song at a specific index is the active song |
| Output Muted | True when output audio is muted |
| Output Fullscreen | True when the output window is fullscreen |
Variables are named by the connection's label. The examples below assume the label Visibox; substitute your own.
| Variable | Description |
|---|---|
$(Visibox:playback_status) | Current status: playing, paused, or stopped |
$(Visibox:active_song_name) | Name of the active song |
$(Visibox:active_song_index) | 0-based index of the active song |
$(Visibox:active_clip_name) | Name of the currently active clip |
$(Visibox:active_clip_index) | 0-based index of the currently active clip |
$(Visibox:project_name) | Name of the active project |
$(Visibox:output_level) | Output volume, 0–100 |
$(Visibox:output_muted) | true when output audio is muted |
$(Visibox:output_fullscreen) | true when the output window is fullscreen |
$(Visibox:song_1_name) … song_10_name | Name of song 1–10 in the project (empty if none) |
$(Visibox:clip_1_name) … clip_10_name | Name of clip 1–10 in the active song (empty if none) |
Status shows "Disconnected"
Status shows "Authentication Failure"
Actions not working
Feedbacks not updating