Leahnaya/SceneSwitcher
1
0
Fork 0
mirror of https://github.com/WarmUpTill/SceneSwitcher.git synced 2026-09-09 01:56:00 -05:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

Updated Websockets (markdown)

WarmUpTill
2022-08-31 17:42:16 +02:00
parent cd3cef4bee
commit 890ddae84d
1 changed files with 26 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
Websockets.md

@@ -52,4 +52,29 @@ If the status message reports "Connected and authenticated" all is well.
To modify the connection details of an existing connection simply select it in the drop down menu of a websocket action and click the marked gear symbol.
Next click the "Properties" entry and a dialog like described above will open in which you can modify the connection's settings.
The gear icon will also allow you to rename or remove existing connections.
The gear icon will also allow you to rename or remove existing connections.
## Sending messages to the scene switcher from external tools via websocket messages
The scene switcher is using the [obs-websocket protocol](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#callvendorrequest) to send and receive messages.
This can also be used by external tools to send messages, which can be processed by the plugin and thus trigger macros.
To send a message with the contents `testing` one has to create a `CallVendorRequest` type message using a `vendorName` of `AdvancedSceneSwitcher` and a `requestType` of `AdvancedSceneSwitcherMessage` and add the "message" field with the desired contents to the `requestData`:
```
{
"d": {
"requestData": {
"requestData": {
"message": "testing"
},
"requestType": "AdvancedSceneSwitcherMessage",
"vendorName": "AdvancedSceneSwitcher"
},
"requestId": "someUniqueIdHere",
"requestType": "CallVendorRequest"
},
"op": 6
}
```