Integration

Streamfog

Trigger Streamfog overlays and media cues from FaustBot.

Overview

The Streamfog integration adds dedicated triggers and actions so you can build workflows around events, device state, or external updates.

Event Triggers

React to inbound events and status updates.

Action Effects

Send commands and automate responses.

Automation Hooks

Combine triggers with other plugins and scripts.

Setup

1

Enable the Plugin

Open FaustBot settings and enable the Streamfog integration.

2

Connect Your Account or Device

Provide any required credentials or connection details.

3

Verify the Connection

Trigger a test action to confirm the integration is responding.

Connection Tips

Keep the service running and verify network permissions if the connection fails.

Triggers

  • Connection status changes (connected, disconnected, error).
  • Incoming events or webhook notifications.
  • State changes reported by the service or device.

Effects

  • Send commands or updates to Streamfog.
  • Change device settings or activate presets.
  • Sync data into variables for other actions.

Scripting API

Use the CPH API to control Streamfog overlays and media cues directly from scripts.

Overlay Control

Overlay control 
# Show an overlay by name
CPH.StreamfogShowOverlay("AlertBox")

# Hide an overlay
CPH.StreamfogHideOverlay("AlertBox")

# Toggle overlay visibility
CPH.StreamfogToggleOverlay("ChatWidget")

# Show overlay for a duration (milliseconds)
CPH.StreamfogShowOverlay("Notification", 5000)

Media Cues

Media cues 
# Trigger a media cue by name
CPH.StreamfogPlayCue("VictorySound")

# Stop a playing cue
CPH.StreamfogStopCue("BackgroundMusic")

# Get list of available cues
cues = CPH.StreamfogGetCues()

# Set cue volume (0.0 - 1.0)
CPH.StreamfogSetCueVolume("AlertSound", 0.8)

See the full API reference for all available Streamfog methods.