Mirrored_Repos/obs-websocket
1
0
Fork 0
mirror of https://github.com/Palakis/obs-websocket.git synced 2024-08-30 18:12:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Stéphane L 2016-11-20 23:31:07 +01:00 committed by GitHub
parent a3bc9ae8d0
commit 36cf2a4126
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -6,6 +6,11 @@ Websocket API for OBS Studio.
The Websocket API server runs on port 4444. A settings window is available in "Websocket server settings" under OBS' "Tools" menu. The Websocket API server runs on port 4444. A settings window is available in "Websocket server settings" under OBS' "Tools" menu.
There's currently no frontend or language API available for obs-websocket. However, the full protocol reference is available in [PROTOCOL.md](PROTOCOL.md). There's currently no frontend or language API available for obs-websocket. However, the full protocol reference is available in [PROTOCOL.md](PROTOCOL.md).
## 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 (like the AGDQ overlay does)
- Automate scene switching with a third-party program (e.g. : auto-pilot, foot pedal, ...)
## How to build ## How to build
You'll need QT 5.7 with QtWebSockets, CMake, and a working development environment for OBS Studio installed on your computer. You'll need QT 5.7 with QtWebSockets, CMake, and a working development environment for OBS Studio installed on your computer.
In CMake, you'll have to set the following variables : In CMake, you'll have to set the following variables :