Logitech/Loupedeck Plugin for interacting with OBS Studio

Control OBS Studio directly from your Logitech/Loupedeck hardware device with dedicated buttons and real-time status displays.

NOTE

Please note that this is not a plugin or an extension for OBS. This project is not supported by or affliated with OBS Project and is not listed in their community.

This project interacts with the websocket server using obs-websocket-dotnet and is a plugin for Logitech Option+ and Loupedeck software that utilise the underlying LogiPluginService and Logi Actions SDK. See the project structure for further details.

An AI Coding Assistant has been used to support the development of this project and the understanding of associated technologies and libraries. The project uses strong engineering principles including TDD, secure coding principles and conventional commits to ensure every change is well understood, reliable and tested as appropriate. Please do report any issues you find with the tests or code base that I may have missed.

Features

• Automatic Connection: Discovers OBS WebSocket settings automatically from OBS configuration
• Streaming Controls: Start, stop, toggle streaming with visual state indicators
• Recording Controls: Start, stop, toggle, pause/resume recording with visual state indicators
• Virtual Camera: Start, stop, toggle virtual camera output
• Scene Management: Switch scenes with dynamic folder and visual feedback
• Source Visibility: Toggle visibility of sources in current scene
• Audio Mixer: Mute/unmute audio inputs with visual feedback (red=muted, green=unmuted)
• Audio Volume Control: Adjust volume via MX big wheel (folder tiles) or standalone dial adjustment
• Audio Source Selection: Global audio source selection for wheel/dial volume control
• User Defined Actions: Configurable actions for source visibility, audio mute, monitoring, and audio selection
• Profile Management: Switch between OBS profiles with selection indicators and dynamic folder
• Scene Collections: Switch between scene collections with selection indicators
• Screenshot Capture: Take screenshots with automatic path detection
• Status Displays: Real-time display of current profile, scene collection, active scene, and connection status
• Resilient Connection: Automatic reconnection with exponential backoff and jitter, manual reconnect button
• Remote OBS Support: Connect to OBS on a remote device via configurable IP/port/password
• Performance Monitoring: Real-time stats display (FPS, CPU, memory, dropped frames) with colour-coded thresholds
• Streaming Stats: Live stream statistics (duration, bytes sent, congestion, skipped frames)
• Media Controls: Play, pause, stop media sources with dynamic folder and user-defined actions

Requirements

• OBS Studio 28.0+ with obs-websocket 5.0+
• Logi Plugin Service installed
• .NET 8.0 SDK (for development)

Installation

1. Build the project:

   dotnet build src/OBSStudioForLogiPlugin.csproj -c Release

2. The plugin automatically installs to Logi Plugin Service via the .link file

3. Launch OBS Studio and the plugin connects automatically

Available Controls

OBS (Group 1)

• Screenshot: Capture screenshot to Pictures/Documents/Desktop folder
• Reconnect: Manually retry connection to OBS
• Studio Mode Toggle: Enable/disable OBS studio mode for preview/program workflow
• Studio Mode Transition: Transition preview scene to program (only works when studio mode is enabled)
• Connection Status Display: Shows "Connected" (green) or "Disconnected" (red)
• OBS Stats Summary: Single button showing FPS, CPU%, and dropped frames (colour-coded)
• OBS Stats Folder: Dynamic folder with individual tiles per stat (FPS, CPU, Memory, Render Missed, Encode Skipped, Total Dropped)
• Plugin Settings: Configure OBS connection (local/remote) and stats polling interval

Streaming (Group 2)

• Streaming Toggle: Toggle streaming on/off
• Streaming Start: Start streaming
• Streaming Stop: Stop streaming
• Stream Stats Folder: Dynamic folder showing live stream statistics
  • Duration, Bytes Sent (MB/GB), Network Congestion, Skipped Frames, Total Frames
  • Colour-coded: green=healthy, yellow=warning, red=problem
  • Shows "Offline" when not streaming

Recording (Group 3)

• Recording Toggle: Toggle recording on/off
• Recording Start: Start recording
• Recording Stop: Stop recording
• Recording Pause/Resume: Pause or resume active recording

Replay Buffer (Group 4)

• Replay Buffer Toggle: Start/stop replay buffer
• Save Replay Buffer: Save the current replay buffer to disk

Virtual Camera (Group 5)

• Virtual Camera Toggle: Toggle virtual camera on/off
• Virtual Camera Start: Start virtual camera
• Virtual Camera Stop: Stop virtual camera

Profiles (Group 6)

• Profile Select: Switch between OBS profiles (multi-state buttons)
• Profiles Folder: Dynamic folder with all available profiles
• Current Profile Display: Shows active profile name

Scenes (Group 7)

• Scene Collection Select: Switch between scene collections (multi-state buttons)
• Scenes Folder: Dynamic folder with all available scenes
  • When studio mode is disabled: Switches scene to program (live)
  • When studio mode is enabled: Switches scene to preview (not live yet)
• Sources Folder: Dynamic folder with sources in current scene (toggle visibility)
• Current Scene Display: Shows active scene name
• Current Scene Collection Display: Shows active scene collection name

Audio (Group 8)

• Audio Mixer Folder: Dynamic folder with all audio inputs (mute/unmute toggle, volume display)
  • Visual feedback: Green text = unmuted, Red text = muted
  • Displays input name and current volume percentage (0-100%)
  • Real-time updates when mute state or volume changes in OBS
  • Toggle mute by pressing the button
• Scene Audio Folder: Dynamic folder with audio sources in the current scene
  • Shows only audio inputs present in the active scene
  • Same mute/unmute controls, volume display, and visual feedback as Audio Mixer
  • Updates automatically when switching scenes or changing volume
• Audio Select Folder: Dynamic folder for selecting the global audio source
  • Single tap selects/deselects an audio source
  • Displays mute state, volume, and monitoring mode for each source
  • Selection persists after folder is closed
  • Selected source is used by volume wheel/dial controls
• Audio Volume Folder: Dynamic folder with adjustment tiles for MX big wheel
  • Tap a tile to arm the MX big wheel for that source's volume
  • Displays volume percentage and mute state (green/red)
  • Compatible with MX Creative Console Dialpad
• Selected Source Volume: Standalone adjustment for wheel/dial
  • Controls volume of the globally selected audio source
  • Drag onto MX big wheel, CT wheel, or any dial
  • Turn to adjust volume, press to reset to 100%

User Defined Actions (Group 99)

• Switch to Scene (Adjustable): Switch to a specific scene with optional profile and collection switching
  • Configure profile name, collection name, and scene name via textboxes
• Toggle Source Visibility (User defined): Toggle visibility of one or more sources
  • Comma-separate multiple source names
  • Optional scene name (defaults to current active scene)
• Toggle Audio Mute (User defined): Toggle mute/unmute for a named audio source
• Cycle Audio Monitoring (User defined): Cycle monitoring type for a named audio source
  • Cycles: None → Monitor Only → Monitor & Output
• Select Audio Source (User defined): Toggle global audio source selection
  • Selects/deselects the named source as the globally selected audio source
  • Used by Selected Source Volume adjustment and other audio controls
• Media Action (User defined): Trigger media actions on a named source
  • Actions: Play, Pause, Stop, Restart, Next, Previous
  • Source name textbox + action listbox

Media (Group 9)

• Media Controls Folder: Dynamic folder of media sources (ffmpeg, VLC, slideshow, text)
  • Single tap while stopped/paused: Play
  • Single tap while playing: Pause
  • Double tap: Stop (reset to beginning)
  • Colour-coded: Green = Playing, Yellow = Paused, Grey = Stopped/Ended
  • Real-time updates when media starts/finishes naturally

Configuration

The plugin automatically reads OBS WebSocket settings from:

• Windows: %AppData%\obs-studio\plugin_config\obs-websocket\config.json
• macOS: ~/Library/Application Support/obs-studio/plugin_config/obs-websocket/config.json

For remote OBS connections or custom settings, use the Plugin Settings action to configure:

• Use Local OBS (checkbox): When checked, auto-discovers local OBS. When unchecked, uses manual settings.
• IP Address: Remote OBS machine IP
• Port: WebSocket port (default 4455)
• Password: WebSocket password
• Stats Polling Interval: How often to refresh stats (2s, 5s, or 10s)

Development

Build

dotnet build src/OBSStudioForLogiPlugin.csproj

Test

dotnet test tests/OBSStudioForLogiPlugin.Tests/OBSStudioForLogiPlugin.Tests.csproj

Note: Tests are run locally only. The GitHub Actions workflow performs dependency checking and build validation but does not run tests due to timing issues with fire-and-forget Task.Run patterns in CI environments.

Clean

dotnet clean OBSStudioForLogiPlugin.sln

Architecture

• TDD Approach: Comprehensive test coverage with 348 unit tests
• Dependency Injection: Interface-based design for testability
• Async Operations: All OBS operations wrapped in Task.Run to prevent UI freezing
• Event-Driven: Real-time updates via OBS WebSocket events
• Singleton Pattern: Command instances accessible via static Instance properties
• Resilient Reconnection: Timer-based reconnection with exponential backoff (1s to 30s) and jitter (0.85-1.15x)
• Command Base Classes: ToggleCommandBase and StartStopCommandBase eliminate duplication across similar commands

Troubleshooting

Plugin doesn't connect:

• Ensure OBS Studio is running
• Verify obs-websocket is enabled in OBS (Tools → WebSocket Server Settings)
• Check logs in Logi Plugin Service
• For remote OBS: verify IP address, port, and password in Plugin Settings

Commands disabled:

• Plugin only enables when connected to OBS
• Wait for automatic connection or restart OBS Studio

License

See LICENSE file for details.