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

Fixed typos and line breaks

Browse Source
This commit is contained in:
Stéphane Lepin 2016-11-11 19:31:06 +01:00
parent 5248cde766
commit 4e5f7d1e50
2 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
PROTOCOL.md
View File

@ -17,7 +17,7 @@ Additional fields will be present in the event message if the event type require
### Event types ### Event types
#### "SwitchScenes" #### "SwitchScenes"
OBS is switching to another scene. OBS is switching to another scene.
Additional fields : Additional fields :
- **scene-name** : the name of the scene being switched to - **scene-name** : the name of the scene being switched to
@ -35,27 +35,27 @@ Streaming has been started successfully.
Streaming is stopping but isn't completely stopped yet. Streaming is stopping but isn't completely stopped yet.
#### "StreamStopped" #### "StreamStopped"
*New in OBS Studio* *New in OBS Studio*
Streaming has been stopped successfully. Streaming has been stopped successfully.
#### "RecordingStarting" #### "RecordingStarting"
*New in OBS Studio* *New in OBS Studio*
Recording is starting but isn't completely started yet. Recording is starting but isn't completely started yet.
#### "RecordingStarted" #### "RecordingStarted"
*New in OBS Studio* *New in OBS Studio*
Recording has been started successfully. Recording has been started successfully.
#### "RecordingStopping" #### "RecordingStopping"
*New in OBS Studio* *New in OBS Studio*
Recording is stopping but isn't completely stopped yet. Recording is stopping but isn't completely stopped yet.
#### "RecordingStopped" #### "RecordingStopped"
*New in OBS Studio* *New in OBS Studio*
Recording has been stopped successfully. Recording has been stopped successfully.
#### "Exiting" #### "Exiting"
*New in OBS Studio* *New in OBS Studio*
OBS is exiting. OBS is exiting.
## Requests ## Requests

4
README.md
View File

@ -12,8 +12,8 @@ In CMake, you'll need to fill these CMake variables :
- **LIBOBS_LIB** (filepath) : location of the obs.lib file - **LIBOBS_LIB** (filepath) : location of the obs.lib file
- **OBS_FRONTEND_LIB** (filepath) : location of the obs-frontend-api.lib file - **OBS_FRONTEND_LIB** (filepath) : location of the obs-frontend-api.lib file
After building the obs-websocket plugin's binary, copy its Qt dependencies (QtCore, QtNetwork and QtWebSockets library binaries)in the same folder. After building the obs-websocket plugin's binary, copy its Qt dependencies (QtCore, QtNetwork and QtWebSockets library binaries) in the same folder.
## How to use ## How to use
There's currently no frontend or language API available for obs-websocket. However, the full protocol reference is documented in the [PROTOCOL.md](PROTOCOL.md) file. There's currently no frontend or language API available for obs-websocket. However, the full protocol reference is documented in the [PROTOCOL.md](PROTOCOL.md) file.
A simple websocket client can connect to the plugin's embedded server. A simple websocket client can connect to the plugin's embedded server.