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-27 16:11:19 +01:00 committed by GitHub
parent e3a28b640f
commit 0df6bde5cb
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -3,8 +3,10 @@ obs-websocket
Websocket API for OBS Studio.
## How to use
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).
The Websocket API server runs on port 4444 and a settings window is available in "Websocket server settings" under OBS' "Tools" menu. The obs-websocket protocol is documented in [PROTOCOL.md](PROTOCOL.md).
Here is a list of language APIs for obs-websocket :
- Javascript (browser & nodejs) : https://github.com/haganbmj/obs-websocket-js
There's currently no frontend available for obs-websocket.
## Possible use cases
- Remote control OBS from a phone or tablet on the same local network