OSC Triggers

Fire audio cues from QLab, Bitfocus Companion, TouchOSC, or any system that speaks OSC.

🌐 Web UI ⌨️ CLI 🔌 HTTP API 📡 OSC

Overview

BPSoundscape listens for OSC messages on port 8514 (configurable). You can trigger any cart, player, or audio file via OSC.

Common Integrations

  • QLab — Network cues to fire sound effects
  • Companion — Stream Deck buttons for instant triggers
  • TouchOSC — Custom tablet/phone interfaces
  • Lighting consoles — MA, ETC, etc. with OSC output

🌐 Web UI

Configure OSC Port

  1. Go to Settings → OSC
  2. Set Listen Port (default: 8514)
  3. Enable OSC Input

OSC Activity Monitor

The OSC settings page shows incoming messages in real-time—useful for debugging your triggers.

⌨️ CLI

Configure OSC

bpsoundscape config set osc.port 8514
bpsoundscape config set osc.enabled true

Monitor OSC Messages

bpsoundscape osc monitor

🔌 HTTP API

Get OSC Status

curl http://localhost:8513/api/v1/osc/status

Configure OSC

curl -X PUT http://localhost:8513/api/v1/osc/config \
  -H "Content-Type: application/json" \
  -d '{"enabled": true, "port": 8514}'

📡 OSC Reference

Cart Triggers

AddressArgsDescription
/bpsoundscape/cart/{page}/{slot}/triggernoneTrigger cart
/bpsoundscape/cart/{page}/{slot}/stopnoneStop cart
/bpsoundscape/cart/{page}/{slot}/volumefloat (0-1)Set volume

Player Triggers

AddressArgsDescription
/bpsoundscape/player/{id}/playnonePlay
/bpsoundscape/player/{id}/stopnoneStop
/bpsoundscape/player/{id}/volumefloat (0-1)Set volume

Global

AddressArgsDescription
/bpsoundscape/stopallnoneStop all audio
/bpsoundscape/masterfloat (0-1)Master volume
/bpsoundscape/pageintSwitch cart page

QLab Setup

1. Create a Network Cue
2. Set Destination: [BPSoundscape IP]:8514
3. Message Type: OSC
4. Message: /bpsoundscape/cart/1/1/trigger

Companion Setup

1. Add Connection: Generic OSC
2. Target IP: [BPSoundscape IP]
3. Target Port: 8514
4. Button Action: Send OSC
5. Path: /bpsoundscape/cart/1/1/trigger
← Fades & Levels DMX Triggers →