๐Ÿ”Œ
R-Flow app

Resolume API

Your whole Resolume composition in a browser โ€” from the booth, from the back of the room, or from another city.

R-Flow โ€” Resolume API
Resolume API inside R-Flow

What it does

The Resolume API app connects R-Flow to Resolume Arena over its REST web API, then publishes a full browser interface for it. The app window itself stays deliberately small โ€” connection settings, video monitors and audio โ€” because the real work happens in the web UI: clips and decks with thumbnails, live video previews, effects, sticky notes and MIDI. That interface is reachable at your own private r-flow.io address from anywhere you are signed in, and you can share it with other R-Flow users to run a show together.


Key features

Why it earns its place in your booth

1

Your own address, anywhere

r-flow.io/u/<your name>/ reaches your machine over HTTPS from any network. It is tied to your R-Flow account, so signing in is the only key required โ€” no port forwarding, no tunnel config, no static IP.

2

Share a rig with your crew

Grant other R-Flow users access to your link from your account page and revoke it just as fast. Useful for a VJ duo swapping control, or a tech helping you from front of house.

3

The whole composition in a browser

Decks and clips with thumbnails, click-to-trigger, effects with live parameters, sticky notes and MIDI โ€” rendered in the browser rather than cramped into a desktop panel.

4

Play it with a MIDI controller

A built-in MIDI bridge reads the mapping files you already made in Resolume โ€” the same XMLs from its Shortcuts folder, so you don't remap anything. Pick a mapping and an input port on the R-Flow machine and start it from the browser: notes fire clips and columns, and CCs drive faders, knobs and tempo through Resolume's API. The last message received is shown live, so you can tell at a glance whether a controller is actually talking.

5

Video monitors over NDI or Spout

Pull your composition output plus up to two preview feeds into the web UI. NDI works across the network; Spout shares GPU textures on the same machine.

6

Audio alongside the video

Stream any input device, including system audio via a loopback device, so remote monitoring tells you how the set actually sounds, not just how it looks.

7

Works with no internet at all

The local link runs entirely on the venue's wifi with a private key, so the browser interface still works when the connection does not.


Documentation

How to use Resolume API

  1. Turn on Resolume's Webserver & REST API

    In Resolume Arena open Preferences (Ctrl+,) and pick Webserver in the left-hand list. Tick Enable Webserver & REST API โ€” the switch at the top. Leave Listen Port on 8080 and Listen Address on 0.0.0.0 unless you have a reason to change them; those are the defaults R-Flow expects. 0.0.0.0 simply means accept connections on any network adapter, which is what lets R-Flow reach it. Resolume remembers the setting, so this is a one-time job per machine.

    Resolume Preferences, Webserver panel, with Enable Webserver & REST API ticked
  2. Sign in to your R-Flow account

    Your web UI address is tied to your account, so sign in from the Updates app (Account & License, then Sign In) if you have not already. This is what gives you a private link nobody else can open, and what lets you share it with people you choose.

    Sign in to your R-Flow account
  3. Connect to Resolume

    In the Resolume API app enter the Host and Port of the machine running Resolume โ€” 127.0.0.1 and 8080 when it is the same computer โ€” and click Connect. The status line turns green and reports the composition name along with its layer and column counts.

    Connect to Resolume
  4. Start the video monitors

    Choose NDI or Spout as the backend, then pick your composition source in the Comp dropdown; sources named with COMP are selected automatically. Add up to two preview feeds if you want them, set fps and quality, and click Start. These feeds are what appear in the browser.

    Start the video monitors
  5. Add audio (optional)

    In the Audio row pick an input device โ€” a system-audio loopback device is chosen automatically when one exists โ€” and click Start Audio. The web UI then carries sound alongside the video, which is what makes remote monitoring genuinely useful.

    Add audio (optional)
  6. Open your R-Flow Web UI

    Click Open R-Flow Web UI. It opens your own address, r-flow.io/u/<your name>/, which reaches this machine from anywhere over HTTPS and only for people signed in and allowed. This is the full interface: decks and clips with thumbnails, live monitors, effects, notes and MIDI.

    Open your R-Flow Web UI
  7. Run the show from the browser

    Click a clip to trigger it, browse decks, watch the composition and preview monitors, add effects, and leave sticky notes for whoever is on next. Anything you do there lands in Resolume immediately. A phone works as well as a laptop.

  8. Share it with your crew

    On r-flow.io open your account page, find Your R-Flow link, and add another R-Flow user by username or email. They will see your rig under Shared with you and can open it just like you do. Remove access any time with one click โ€” it takes effect immediately.

  9. No internet? Use the local link

    At a venue with no usable connection click Open on this network instead. That hands you a link on the local wifi containing a private key for your machine, so a phone or laptop on the same network still gets the whole interface with nothing but a router between you.

    No internet? Use the local link

Reference

Settings

Host / PortAddress of the machine running Resolume. Defaults to 127.0.0.1 port 8080 (this computer).
Auto-refresh (3s)Re-reads the composition from Resolume every three seconds so the status stays current.
NDI / Spout backendHow the video monitors receive frames: NDI works across the network; Spout is GPU texture sharing on the same machine.
Comp / Preview / Preview 2 sourcesWhich video feeds to monitor. Sources containing COMP or PREVIEW are matched automatically.
fpsMonitor frame rate, 1 to 120 (default 10). Higher looks smoother but uses more bandwidth.
qualityPresets balancing sharpness against bandwidth โ€” drop to Smooth on cellular or busy venue wifi.
Audio deviceThe input streamed to the web UI. A system-audio loopback device is preferred automatically when present.

Pro tips

๐Ÿ’ก Running R-Flow on the same machine as Resolume? Switch the monitor backend to Spout - it shares frames on the GPU for lower CPU load and latency than NDI.
๐Ÿ’ก Name your Resolume NDI outputs with COMP and PREVIEW in them and R-Flow auto-selects the right sources every time you scan.
๐Ÿ’ก Bookmark your r-flow.io link on your phone. As long as you are signed in it opens straight into the rig - handy for checking output from the crowd.
๐Ÿ’ก Share your link with a bandmate before doors rather than during: access is instant, but it is one less thing to fiddle with mid-set.
๐Ÿ’ก Streaming over a phone hotspot? Use the Smooth quality preset at around 10 fps - it is tuned for cellular-grade bandwidth.
๐Ÿ’ก Start audio before or after the video monitors, in either order - the streams link up automatically once both are running.

Good to know

โš ๏ธ Nothing loads until Resolume's webserver is on: enable it under Preferences > Webserver > Enable Webserver & REST API.
โš ๏ธ The hosted link needs you signed in to your R-Flow account, and it only works while R-Flow is running with the web UI started โ€” close R-Flow and the page reports the machine is offline.
โš ๏ธ Only you and the people you have shared with can open your link. Anyone else is asked to sign in and then turned away.
โš ๏ธ Clicking a clip triggers it; there is no stop or eject action โ€” use Resolume itself or a blank clip to clear a layer.
โš ๏ธ Video monitoring needs its libraries present: NDI mode requires the NDI runtime bundled with R-Flow, and Spout mode requires the Spout components.
โš ๏ธ Streaming system audio (not just a microphone) requires a loopback-capable input device; if none exists, only real inputs are listed.
โš ๏ธ The web UI streams video as JPEG frames at your chosen fps and quality โ€” on slow or cellular connections drop to Smooth.
โš ๏ธ Text and file-path effect parameters are read-only; sliders, switches, dropdowns, triggers and colours are all editable.
โš ๏ธ The local network link carries a private key for your machine. Treat that URL like a password โ€” anyone on the wifi holding it can drive Resolume.

Requirements

Resolume Arena with Webserver & REST API enabled (Preferences > Webserver), listening on port 8080An R-Flow account, signed in, for the hosted r-flow.io linkNDI runtime (bundled) for NDI monitoring, or Spout components for GPU texture sharingA loopback-capable audio input if you want to stream system audio rather than a microphoneWindows 10 or 11

Plays well with

Resolume Arena REST web API over HTTP (default port 8080)Resolume's OSC input over UDP (default port 7000) โ€” not used by this app, which controls Resolume over REST; it's how the DJ Sync and Auto Save apps send tempo, clip triggers and save commandsNDI video sources on the networkSpout GPU texture sharing (same-machine video)Your r-flow.io account โ€” the hosted link and its sharing permissionsWindows system-audio capture via loopback input devices