mirror of https://github.com/Palakis/obs-websocket.git synced 2024-08-30 18:12:16 +00:00

Go to file

tt2468 622e1c9aeb Merge pull request #842 from dnaka91/macos-scripts Build: Make scripts executable and fix dep links		2021-10-29 17:20:18 -07:00
.github	Revert "CI: Build against OBSProject Qt distribution"	2021-09-24 18:26:34 -07:00
CI	Build: Make scripts executable and fix dep links	2021-10-24 14:54:34 +09:00
cmake	everything: Massive amount of changes who knows	2021-04-26 08:46:11 -07:00
data/locale	Base: Add system tray notifications	2021-06-13 03:58:15 -07:00
deps	SettingsDialog: Mild refactor and add Connect Info dialog	2021-05-08 04:29:03 -07:00
docs	docs(ci): Update generated docs - `b9b8e38` [skip ci]	2021-09-04 17:58:05 +00:00
installer	Installer: Fail if OBS is not installed	2021-09-12 00:22:11 -07:00
src	Requests: Add note `SetCurrentSceneCollection`	2021-10-06 00:45:14 -07:00
.editorconfig	Initial commit for attempted rewrite	2021-03-08 03:56:43 -08:00
.gitignore	GitIgnore: Ignore generated installer file	2021-08-30 02:51:14 -07:00
.gitmodules	SettingsDialog: Mild refactor and add Connect Info dialog	2021-05-08 04:29:03 -07:00
BUILDING.md	Docs: Update BUILDING.md ci badge	2021-06-09 00:06:03 -07:00
CMakeLists.txt	Base: Add request batch execution types	2021-09-26 03:12:29 -07:00
CONTRIBUTING.md	Docs: Update contributing doc	2021-06-14 23:31:42 -07:00
crowdin.yml	Initial commit for attempted rewrite	2021-03-08 03:56:43 -08:00
LICENSE	Initial commit for attempted rewrite	2021-03-08 03:56:43 -08:00
README.md	README: Add Rust obws to library list	2021-09-28 23:34:30 +09:00
SSL-TUNNELLING.md	Initial commit for attempted rewrite	2021-03-08 03:56:43 -08:00

README.md

obs-websocket

YOU HAVE STUMBLED UPON THE DEV BRANCH FOR V5.0.0

You can find the main protocol spec here: PROTOCOL.md.
You can find the planned requests sheet here

WebSockets API for OBS Studio.

Downloads

Binaries for Windows, MacOS, and Linux are available in the Releases section.

Homebrew

If you're using MacOS you can use Homebrew for installation as well:

brew install obs-websocket

Using obs-websocket

Here is a list of available web clients: (compatible with tablets and other touch interfaces)

(No known clients supporting 5.0.0)

It is highly recommended to protect obs-websocket with a password against unauthorized control. To do this, open the "Websocket server settings" dialog under OBS' "Tools" menu. In the settings dialogs, you can enable or disable authentication and set a password for it.

(Psst. You can use --websocket_port(value), --websocket_password(value), and --websocket_debug(flag) on the command line to override the configured values.)

Possible use cases

Remote control OBS from a phone or tablet on the same local network
Change your stream overlay/graphics based on the current scene
Automate scene switching with a third-party program (e.g. : auto-pilot, foot pedal, ...)

For developers

The server is a typical Websockets server running by default on port 4444 (the port number can be changed in the Settings dialog). The protocol understood by the server is documented in PROTOCOL.md.

Here's a list of available language APIs for obs-websocket :

Python 3.7+ (Asyncio): simpleobsws by IRLToolkit
Rust: obws by dnaka91

We'd like to know what you're building with or for obs-websocket. If you do something in this fashion, feel free to drop a message in #project-showoff in the discord server!