websocket-obs-java

A java library for the OBS-Studio websocket plugin by Palakis.

---

Getting started

First include the library in your project using Maven:

<!-- https://mvnrepository.com/artifact/net.twasi/obs-websocket-java -->
<dependency>
    <groupId>net.twasi</groupId>
    <artifactId>obs-websocket-java</artifactId>
    <version>1.0.5</version>
</dependency>

To get started just instantiate the OBSRemoteController:

OBSRemoteController controller = new OBSRemoteController("ws://localhost:4444", false);

if (controller.isFailed()) { // Awaits response from OBS
  // Here you can handle a failed connection request
}
// Now you can start making requests

If you don't want your program to wait for a connection you could alternatively register an onConnect callback:

controller.registerConnectCallback(response -> {
	GetVersionResponse version = (GetVersionResponse) response;
	System.out.println(version.getObsStudioVersion());

	// Other requests...
});

Websocket server with authentication

If your OBS websocket server is secured with a password, pass the password as a string to the controller:

OBSRemoteController controller = new OBSRemoteController("ws://localhost:4444", false, "myPassword");

Catch any authentication errors by registering a callback for this:

controller.registerConnectionFailedCallback(message -> {
    System.err.println("Failed to connect: " + message);
})

---

Supported requests and events

A list of supported requests and events can be found in the corresponding enum class files:

• RequestType class file
• EventType class file

A description of every request and event can be found in the plugin's Protocol.MD file.

---

Protocol References

Protocol reference can be found here

---

Examples

Examples can be found here. Just uncomment the requests you want to test or copy.

---

Contribution

If you miss an endpoint feel free to make a pull request. Any help is appreciated.

---

Thanks to Palakis for the great plugin!