

These settings are available to change and review through the OBS user interface by clicking Tools, obs-websocket Settings. Password - is the password configured for obs-websocket.

Port is the port number used to connect to the OBS device running obs-websocket protocol v5.0.0 Obs-studio host ip - is the ip address or host name of the OBS device running obs-websocket protocol v5.0.0 that wou would like to send remote control commands to. To open a websocket connection, we need to create new ObsWebSocket using the special protocol ws in the url: final obsWebSocket =Īwait nnect('ws://:', password: '') The instruction and links to downloaded and install are available on the project Release page. The data can be passed in both directions as “packets”.īefore a websocket connection can be made to a running instance of OBS, you will need to have the obs-websocket plugin installed and configured.

The WebSocket protocol, described in the specification RFC 6455 provides a way to exchange data between client and server via a persistent connection. import 'package:obs_websocket/obs_websocket.dart' Import the websocket connection library and the response library. In your project add the dependency: dependencies:įor help getting started with dart, check out these guides. The obs-websocket is included with OBS in current versions.The OBS v27.x or above application needs to be installed on a machine reachable on the local network.Any code written for the v4.9.1 protocol needs to be re-written for v5.0.0 Getting Started Requirements The obs-websocket v5.0.0 protocol is very different from the older v4.9.1 protocol. The short answer is that everything has changed. obs_websocket cli (OBS at the command prompt)īreaking changes from v2.4.3 (obs-websocket v4.9.1 protocol).Breaking changes from v2.4.3 (obs-websocket v4.9.1 protocol).Please feel free to submit PRs for any additional helper methods, or report an issue for a missing helper method and I'll add it if I have time available. This package gives access to all of the methods and events outlined by the obs-websocket 5.0.0 protocol reference through the send method documented below, but also has helper methods for many of the more popular requests that are made available through the protocol reference.
