obs_websocket
5.7.0+7, released 4 weeks ago by cdavis.ca
An OBS WebSocket client written in Dart for remote-controlling Open Broadcaster Software.
What it does
Allows Dart and Flutter applications to connect to the obs-websocket plugin running inside OBS Studio. It provides helper methods for all protocol requests, supports auto-reconnection, handles events, and manages authentication.
AI-written summary of version 5.7.0+7, based on the package's README and metadata. Report an inaccuracy
Use it when
- Building a custom remote control companion app for OBS Studio
- Automating streaming and recording workflows using Dart or Flutter
Skip it when
- Building general-purpose WebSocket connections unrelated to OBS
Strengths
- Full coverage of the obs-websocket v5.x protocol requests and events
- Built-in auto-reconnection with exponential backoff and connection state stream
- Environment variable and .env file configuration support
Weaknesses
- Requires a running instance of OBS with the obs-websocket plugin configured
- Does not handle video rendering or local stream encoding directly
Setup
- Kind
- Pure Dart
- Effort
- Low
- Code generation
- Yes (build_runner)
- Direct dependencies
- 8
Requires the OBS application (v27.x or above) installed with the obs-websocket plugin enabled and reachable on the network.
final obsWebSocket = await ObsWebSocket.connectFromEnv();
final status = await obs.stream.status;
if (!status.outputActive) {
await obsWebSocket.stream.start();
}Alternatives
Packages that do the same job and could replace obs_websocket.
- dbus
Native Dart D-Bus client for Linux and Windows.
91Compare - centrifuge
Dart client for real‑time communication with Centrifuge/Centrifugo over WebSockets.
80Compare - angel3_websocket
WebSockets support and event broadcasting for the Angel3 framework.
77Compare - nm
Client for interacting with Linux NetworkManager via D-Bus
81Compare
Works with
Packages commonly used together with obs_websocket: ones it builds on, ones built on it, and its own family.
- yamlobs_websocket depends on itA Dart library for parsing YAML documents into Dart data structures.
- cryptoobs_websocket depends on itProvides SHA, MD5, and HMAC hashing functions for Dart.
- uuidobs_websocket depends on itGenerates and parses RFC‑4122/9562 UUIDs (v1‑v8) for Dart.
- json_annotationobs_websocket depends on itProvides annotations for json_serializable to generate JSON (de)serialization code.
- web_socket_channelobs_websocket depends on itCross‑platform WebSocket channel wrapper for Dart
- universal_ioobs_websocket depends on itCross-platform dart:io implementation with browser support for HttpClient and other APIs
- validatorsobs_websocket depends on itString validation and sanitization library for Dart
- loggyobs_websocket depends on itLogger for Dart and Flutter applications using mixins for separation