@wave-av/companion-module
v1.0.6
Published
Bitfocus Companion module for WAVE — control Cloud Switcher, cameras, replay, and AI director from StreamDeck
Maintainers
Readme
@wave-av/companion-module
Control WAVE Cloud Switcher, Camera Control, Replay Engine, and Ghost Producer from Elgato StreamDeck via Bitfocus Companion.
Install
npm install @wave-av/companion-moduleOr install directly in Bitfocus Companion via the module browser.
Actions (12)
| Action | Category | What it does |
|--------|----------|-------------|
| switch_source | Switching | Switch to a camera/source |
| trigger_transition | Switching | Cut, mix, wipe, or DVE transition |
| fade_to_black | Switching | Toggle FTB |
| toggle_keyer | Switching | Toggle upstream/downstream keyer |
| recall_preset | Camera | Recall PTZ camera preset |
| mark_poi | Replay | Mark point of interest for replay |
| start_stream | Output | Start streaming to destination |
| stop_stream | Output | Stop streaming |
| start_recording | Output | Start ISO recording |
| stop_recording | Output | Stop recording |
| trigger_macro | Automation | Run a saved macro |
| ghost_producer_toggle | AI | Start/stop AI auto-switching |
Feedbacks (4)
| Feedback | Color | Description |
|----------|-------|-------------|
| tally_program | Red | Source is on program output |
| tally_preview | Green | Source is on preview |
| stream_active | Red | Streaming is live |
| recording_active | Red | Recording in progress |
Presets (16)
8 source buttons + CUT + MIX + FTB + GO LIVE + REC + MARK POI + AI MODE
Configuration
import { getActions, getFeedbacks, getPresets } from '@wave-av/companion-module';
const config = {
apiUrl: 'https://api.wave.online',
apiKey: process.env.WAVE_API_KEY,
switcherId: 'your-switcher-id',
};
const actions = getActions(config);
const feedbacks = getFeedbacks(config);
const presets = getPresets(config);Related packages
- @wave-av/sdk — TypeScript SDK (34 API modules)
- @wave-av/cli — Command-line interface
Links
License
MIT
