Chapter 1: Overview

DjMirror Pulse can route its live visual output to external video software — OBS Studio, vMix, Resolume Arena, TouchDesigner, and any other NDI or Spout receiver — without any capture card or video encoding overhead. Two complementary technologies are available:

• NDI® (Network Device Interface by Vizrt) — streams over your local network to any machine on the same LAN.
• Spout — shares the GPU texture directly to other applications on the same Windows PC, with near-zero latency and CPU cost.

This guide covers both output methods, single and multi-output layouts, integration with OBS and Resolume, HTTP API control, and troubleshooting.

Chapter 2: Ndi Vs. Spout — Choosing The Right Output Method

Chapter 3: Ndi Setup: Simple Single Output

The quickest way to publish a single NDI source for the entire DjMirror Pulse window.

Prerequisites

• DjMirror Pulse built/installed with NDI enabled (includes DjMirrorPulseNdiBridge and the ndi_config/ folder next to the executable).
• On macOS: grant Screen Recording permission: System Settings → Privacy & Security → Screen Recording → enable for both DjMirror Pulse and DjMirrorPulseNdiBridge.
• NDI receiver (OBS, vMix, etc.) on the same LAN or same machine.

Steps

Chapter 4: Ndi Setup: Advanced Multi-Output JSON Layout

For installations requiring multiple independent NDI sources — each with its own crop, rotation, and mask — use the NDI – Multiple Outputs panel.

Use Cases

• Panoramic stage: split one wide DjMirror Pulse window into three separate screen zones (left, center, right), each published as its own NDI source.
• Circular content: mask outputs as circles, triangles, or custom polygons for projection mapping.
• Mixed formats: send one source at full 1080p and another at 720p cropped from a different region.

Steps

One bridge, hard stops. A single bridge process serves single and layout modes — starting either stops the other. Status means "process alive" only; stop kills the process. A self-exited bridge raises ndi.error (EXITED).

Pre-Built Layout Examples

Figure 3: JSON loaded, bridge stopped, 1920×1080 preview canvas.

The ndi_config/ folder ships with ready-made layouts:

JSON Reference

A minimal two-output configuration:

{
  "outputs": [
    {
      "name": "Stage Left",
      "crop": { "enabled": true, "x": 0, "y": 0, "width": 960, "height": 1080 }
    },
    {
      "name": "Stage Right",
      "crop": { "enabled": true, "x": 960, "y": 0, "width": 960, "height": 1080 }
    }
  ]
}

Per-output fields:

Mask example — circle:

"mask": { "enabled": true, "type": "circle", "center": [0.5, 0.5], "radius": 0.45 }

Chapter 5: Spout Setup (Windows Only — Same-Pc Gpu Sharing)

Figure 2: sending as "DjMirrorPulse Main" — source name, window title, fps, scale.

Spout sends the DjMirror Pulse visual output as a shared GPU texture to any Spout receiver running on the same Windows PC. No network, no encoding, near-zero overhead.

Prerequisites

• Windows only (Spout panel does not appear on macOS or in builds without Spout support).
• DjMirror Pulse built with the Spout2 SDK (standard Windows release includes it).
• Spout receiver installed: OBS with the Spout plugin, Resolume, TouchDesigner, etc.

Steps

GPU vs. CPU Send Path

Automatic selects GPU when possible. If GPU is requested but the Qt backend is not Direct3D 11, the output falls back to CPU and the panel displays a degraded warning.

Figure 4: sender name, visual-only mode, GPU path, fps, scale, start-at-open.

Chapter 6: Spout Multi-Output Layout

Like the NDI multi-output panel, Spout can send multiple named senders simultaneously, each with its own crop, rotation, and mask, defined in a JSON file.

Steps

Per-output Spout-specific fields (inside a "spout" object in the JSON):

Pre-Built Spout Layout Examples

The spout_config/ folder (next to the program) ships with ready-made layouts (same format as NDI):

Chapter 7: Integration With Obs Studio

Figure 5: 1 of 3 outputs sending — rotated circle crops on the preview canvas.

NDI in OBS

Spout in OBS

Chapter 8: Integration With Resolume Arena

NDI in Resolume

Spout in Resolume

Resolume Arena supports Spout natively on Windows. Add a Spout Receiver source, select DjMirror Pulse, and it will appear as a live clip.

Chapter 9: HTTP API & MCP Control For Output

Both NDI and Spout can be fully controlled without opening the DjMirror Pulse UI, via the HTTP API or MCP tools.

NDI HTTP API

# Check bridge status
curl http://127.0.0.1:8080/api/v1/ndi/status

# Start the NDI bridge
curl -X POST http://127.0.0.1:8080/api/v1/ndi/start

# Stop the NDI bridge
curl -X POST http://127.0.0.1:8080/api/v1/ndi/stop

# Configure bridge settings
curl -X PATCH http://127.0.0.1:8080/api/v1/ndi/settings \
  -H "Content-Type: application/json" \
  -d '{"fps": 30, "singleWindowMode": true}'

# List available NDI config files
curl http://127.0.0.1:8080/api/v1/ndi/files

The settings you can change with PATCH /api/v1/ndi/settings are autoStart, bridgeExecutablePath, singleWindowMode, windowTitle, sourceName, fps, scale (a factor from 0.1 to 1.0), width and height (0 and 0 follow the window size). Unknown fields are rejected.

NDI WebSocket events: ndi.started, ndi.stopped, ndi.error, ndi.updated

NDI MCP tools: get_ndi_status, start_ndi_bridge, stop_ndi_bridge, configure_ndi_bridge, list_ndi_configs

Spout HTTP API

# Check Spout status
curl http://127.0.0.1:8080/api/v1/spout/status

# Start Spout output
curl -X POST http://127.0.0.1:8080/api/v1/spout/start

# Stop Spout output
curl -X POST http://127.0.0.1:8080/api/v1/spout/stop

# Configure (e.g. change frame rate)
curl -X PATCH http://127.0.0.1:8080/api/v1/spout/config \
  -H "Content-Type: application/json" \
  -d '{"fps": 30}'

The settings you can change with PATCH /api/v1/spout/config are senderName, fps (0 = automatic), scale (a factor), width, height, source (output = visual output only, or the whole window), mode (auto, gpu or cpu), adapterIndex (-1 = automatic) and autoStart. GET /api/v1/spout/status also lists the graphics adapters it found, which helps on laptops with two GPUs.

Spout WebSocket events: spout.started, spout.stopped, spout.updated, spout.error

Spout MCP tools: get_spout_status, start_spout_output, stop_spout_output, configure_spout_output, list_spout_senders

Spout Layout MCP tools: get_spout_layout, set_spout_layout, start_spout_layout, stop_spout_layout, reload_spout_layout, list_spout_layouts

Chapter 10: Troubleshooting

NDI Troubleshooting

Spout Troubleshooting

Chapter 11: Summary Table

Chapter 12: Related Documentation

• NDI SDK installation: docs_tech/docs_ndi/README_INSTALL_SDK_NDI.md
• HTTP API reference: docs_tech/docs_http_ws/README_HTTP_API_REFERENCE.md
• MCP tools reference: docs_tech/docs_mcp/README_MCP.md
• Build environment: docs_tech/docs_build/README_BUILD_ENV.md
• Client-Server setup: MULTI_SCREEN_CLIENT_SERVER_GUIDE.md (this manual set)