Overview
obs_websocket is a Dart library that enables Flutter applications to connect to and control OBS (Open Broadcaster Software) via the obs-websocket plugin. It provides a clean, asynchronous API for sending commands and receiving events from OBS, allowing developers to automate streaming workflows, manage scenes, transitions, sources, and more. The package supports multiple platforms including Android, iOS, macOS, Windows, and Linux, making it ideal for cross-platform streaming tools. It's designed for developers who need real-time interaction with OBS in their Dart or Flutter apps.
Use cases
- Automating live stream setups
- Controlling scenes and transitions during broadcasts
- Integrating OBS with custom dashboards
- Real-time monitoring of streaming status
- Building companion apps for streamers
Key features
- Asynchronous event handling
- Support for all OBS WebSocket API commands
- Cross-platform compatibility
- Type-safe method calls
- Built-in connection management
- Event subscription system
Suitable for
- Flutter developers building streaming tools
- Streamers creating custom control interfaces
- Developers integrating OBS into automation workflows
- Applications requiring real-time OBS state updates
Considerations
- Requires obs-websocket plugin installed in OBS
- Network connectivity needed between app and OBS
- May require firewall configuration
- Limited to features exposed by the OBS WebSocket plugin
- Authentication setup required in OBS for secure connections