Skip to content

Desuq Cafe
Documentation menu
Back to the plugin page

Documentation

Everything for the Inhyeong OBS WebSocket Client, an OBS Studio WebSocket v5 client for Unreal Engine 5.4 and newer. Pick a reading path below or jump straight to a section.

Where to start

Streamer or VTuber, no code

  1. 1. Overview
  2. 2. Quick Start
  3. 3. OBS Component & Scene Watching
  4. 4. OBS Trigger Volume
  5. 5. Mic / Voice Activity Detection

Blueprint developer

  1. 1. Quick Start
  2. 2. Connection & Reconnection
  3. 3. Subsystem API
  4. 4. Events

Virtual production and cinematics

  1. 1. Sequencer Overview
  2. 2. Track Families
  3. 3. Take Recorder Sync

C++ and extending the plugin

  1. 1. Architecture & Developer Reference
  2. 2. Handlers API
  3. 3. Native C++ Delegates

Browse by section

Getting Started

Start here: what the plugin does, how to install it, and the fastest path to controlling OBS.

Guides

Task-oriented walkthroughs for each OBS feature domain.

Automation

No-/low-code ways to drive OBS from gameplay, the world, your microphone, and in-engine events.

Sequencer

Timeline-based OBS control synced to Level Sequences.

Editor

Controlling OBS from the Unreal Editor: details panels, the editor subsystem, and the shared style system.

Reference

Exhaustive API lookup: every Blueprint-callable function, event, enum, and struct.

Concepts

How the plugin works under the hood, for developers extending it.

Help

Troubleshooting, known limitations, and support.