Skip to content

Remote connection

Windows ships Eiviz.Host.exe (the mixer) and Eiviz.Remote.exe (the operator client). macOS ships eiviz-mac.app and eiviz-remote.app. Live ops and session edits are handled by the destination ControlService. See eiviz API for the protocol.

  1. Enable API listen on the destination (Eiviz.Host.exe Preferences, or Headless eiviz-headless run)
  2. Set a listen token
  3. Launch Eiviz.Remote.exe (or eiviz-remote.app)
  4. Click Connect in the top left, enter the IP, port, and token, then OK. The operator UI opens after the connection succeeds.

The connection is authenticated ws:// on a trusted LAN or VPN. Tokens live in Windows Credential Manager / macOS Keychain. They are not stored in the session file. Host listen fields are in Settings. When the destination is eiviz-headless, listen and token steps are in Headless.

The Connect ▾ menu lists recent destinations. Disconnect closes the connection.

Multiple clients can stay connected; live state stays aligned through subscribe.

The main video row is either Preview and Program, or one Multiview pane. Switch the layout from the top bar. Pick the NDI or OMT source from each header menu. CPU versus GPU OMT receive is a Preferences setting on Eiviz.Remote.exe (or eiviz-remote.app). The default is CPU (Recommended). See NDI / OMT Capture for when to use each path. Add, tile-edit, and delete Multiview layouts from Settings.

The scene list and switcher scene buttons show every Scene, collapsed. Preview/Program chrome still paints the collapsed tiles.

Adding Still/Video picks a file on the client, stores it in the destination media directory, then adds an Input.

The Settings window sends display, performance, outputs, audio, and Web API fields to the destination session. Adding, editing tiles, and deleting Multiview layouts are also sent from Settings. Language, theme, and OMT receive belong to Eiviz.Remote.exe Preferences.

Session edits use MutateSession with expected_revision. A mismatched revision is rejected; reload and try again.

The Save button writes the host current session file. Headless run always has that file (--session, or a dated default under the OS eiviz/sessions directory). GUI New has no current file until the first Save; that request returns UNAVAILABLE. Success shows the saved path and how many in-file history entries remain. A .eivz keeps up to 20 previous documents. Export (.eivzx) is a separate Save-menu action with embedded Still/Video and empty history.

eivizctl save is the same command.

Uploaded Still/Video files land on the host. The default when unset is:

  • Windows: %LOCALAPPDATA%\eiviz\media
  • macOS: ~/Library/Application Support/eiviz/media
  • Linux / headless: $XDG_DATA_HOME/eiviz/media, or ~/.local/share/eiviz/media if that is unset

Change it in the host Preferences, with --media-directory / EIVIZ_MEDIA_DIRECTORY, or eivizctl prefs.

Latest: v0.3.0