AudioInspector

OBS Studio plugin for visualizing and inspecting audio sources and global audio devices.

Features

• Active Sources Tab: Displays only currently playing audio sources in real-time
• Global Devices Tab: Lists all global audio devices (Desktop Audio 1-2, Mic/Aux 1-4)
  • Shows device status (Active/Disabled)
  • Displays audio mixer bus assignments (1-6)
  • Quick device information view
• Audio Map Tab: Complete hierarchical view of all audio sources
  • Organized by scenes
  • Shows source types, mute status, and monitor settings
  • Indicates shared sources across multiple scenes
  • JSON export to clipboard functionality
• Audio Information Display: Shows current audio configuration
  • Sample rate (Hz)
  • Audio driver type (CoreAudio, WASAPI, PulseAudio)
  • Channel count
  • OBS version info
• Auto-refresh: Updates every second to reflect current state

UI Overview

The plugin adds a dock window to OBS Studio with three tabs:

1. Active: Lists audio sources currently outputting sound
2. Global: Shows global audio device configuration
3. Map: Complete audio routing map with JSON export

Building

This plugin is built using the OBS Plugin Template build system.

Prerequisites

Platform	Tool
Windows	Visual Studio 17 2022
Windows	CMake 3.30.5+
macOS	XCode 16.0+
macOS	CMake 3.30.5+
macOS	Homebrew (recommended)
Ubuntu 24.04	CMake 3.28.3+
Ubuntu 24.04	ninja-build
Ubuntu 24.04	pkg-config
Ubuntu 24.04	build-essential

Build Instructions

macOS

Method 1: Using CMake Presets (Recommended)

# Clone and navigate to the repository
cd AudioInspector

# Configure using preset
cmake --preset macos

# Build
cmake --build build_macos --config Release

Method 2: Manual CMake Configuration

# Create build directory
mkdir build && cd build

# Configure with Xcode generator
cmake -G Xcode ..

# Build
cmake --build . --config Release

Or build using Xcode directly:

cd build
xcodebuild -configuration Release

Windows

Method 1: Using CMake Presets (Recommended)

# Clone and navigate to the repository
cd AudioInspector

# Configure using preset
cmake --preset windows-x64

# Build
cmake --build build_x64 --config Release

Method 2: Manual CMake Configuration

# Create build directory
mkdir build
cd build

# Configure with Visual Studio
cmake -G "Visual Studio 17 2022" -A x64 ..

# Build
cmake --build . --config Release

Or open the generated solution in Visual Studio and build from the IDE.

Linux (Ubuntu)

Method 1: Using CMake Presets (Recommended)

# Clone and navigate to the repository
cd AudioInspector

# Install dependencies
sudo apt install cmake ninja-build pkg-config build-essential

# Configure using preset
cmake --preset ubuntu-x86_64

# Build
cmake --build build_x86_64 --config RelWithDebInfo

Method 2: Manual CMake Configuration

# Create build directory
mkdir build && cd build

# Configure with Ninja
cmake -G Ninja ..

# Build
cmake --build .

Installation

After building, the plugin binary will be located in the build output directory. Copy it to your OBS Studio plugins folder:

macOS

cp -r build_macos/Release/AudioInspector.plugin ~/Library/Application\ Support/obs-studio/plugins/

Windows

# Copy to OBS plugins directory (adjust path as needed)
xcopy /E /I build_x64\Release\AudioInspector.dll "%APPDATA%\obs-studio\plugins\AudioInspector\"

Linux

# Copy to user plugins directory
mkdir -p ~/.config/obs-studio/plugins/AudioInspector
cp -r build_x86_64/AudioInspector.so ~/.config/obs-studio/plugins/AudioInspector/

Development

Project Structure

AudioInspector/
├── src/
│   ├── plugin-main.cpp              # Plugin entry point
│   ├── audio_inspector_core.h/cpp   # Core audio inspection logic
│   └── audio_inspector_widget.h/cpp # Qt UI implementation
├── data/
│   └── locale/
│       └── en-US.ini                # Localization strings
├── cmake/                           # Build system configuration
└── CMakeLists.txt                   # Main CMake configuration

Key Components

• AudioInspectorCore: Interfaces with OBS libobs to query audio sources and devices
• AudioInspectorWidget: Qt-based UI widget with three-tab interface
• Dynamic API Loading: Uses dlsym() to safely load OBS frontend APIs at runtime

License

See LICENSE file for details.

Based on OBS Plugin Template

This plugin uses the official OBS Plugin Template build system and project structure. For more information about the build system:

• Getting Started
• Build System Requirements
• CMake Build Options