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
582 Commits 6 Branches 45 Tags 65 MiB
C++ 94.7%
C 2.6%
CMake 2.5%
Shell 0.2%
c64e360c2d
Go to file
tt2468 c64e360c2d
Merge pull request #904 from dnaka91/fix-int-type 
server: Fix int type of batch execution enum
2022-02-13 14:41:45 -08:00
.github workflows: Enable plugin tests on nightly linux builds 2021-12-31 15:26:54 -08:00
CI ci: Set the minimum MacOS version to 10.13 2021-12-19 17:35:34 +09:00
cmake everything: Massive amount of changes who knows 2021-04-26 08:46:11 -07:00
data/locale Base: Add more module exports + code cleanup 2021-11-21 02:50:41 -08:00
deps deps: Downgrade asio to 1.12.1 2022-01-04 00:42:09 -08:00
docs docs(ci): Update generated docs - b206321 [skip ci] 2022-02-13 22:41:10 +00:00
installer Base: Update obs-websocket git locations 2021-11-19 17:24:15 -08:00
lib lib: Add version define 2021-12-30 01:15:54 -08:00
src Merge pull request #904 from dnaka91/fix-int-type 2022-02-13 14:41:45 -08:00
.editorconfig Base: General cleanup 2021-11-21 02:10:41 -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
CMakeLists.txt RequestHandler: Add VirtualCam requests 2022-01-18 19:23:06 -08:00
LICENSE Initial commit for attempted rewrite 2021-03-08 03:56:43 -08:00
README.md README: Update link to workflow 2022-01-28 16:07:23 -08:00

README.md

obs-websocket

WebSocket API for OBS Studio.

CI Multiplatform Build Discord Financial Contributors on Open Collective

Downloads

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

Using obs-websocket

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, ...)

Client software

  • (No known clients supporting 5.0.0 at the moment. Ping us in the Discord if you have one!)

Client libraries (for developers)

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

The 5.x server is a typical WebSocket server running by default on port 4455 (the port number can be changed in the Settings dialog under Tools). The protocol we use is documented in PROTOCOL.md.

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

Contributors

Code Contributors

This project exists thanks to all the people who contribute. Contribute.

Financial Contributors

Become a financial contributor and help us sustain our community. Contribute

Individuals

Organizations

Support this project with your organization. Your logo will show up here with a link to your website. Contribute