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

docs(travis): Update protocol.md - fb0a570 [skip ci]

Browse Source
This commit is contained in:
Travis CI 2019-07-26 07:31:42 +00:00
parent fb0a57003c
commit ac26c9114a
2 changed files with 78 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

106
docs/generated/comments.json
View File

@ -1603,7 +1603,7 @@
{
"subheads": [],
"description": "A custom broadcast message was received",
"param": [
"return": [
"{String} `realm` Identifier provided by the sender",
"{Object} `data` User-defined data"
],
@ -1611,7 +1611,7 @@
"name": "BroadcastCustomMessage",
"category": "general",
"since": "4.7.0",
"params": [
"returns": [
{
"type": "String",
"name": "realm",
@ -3027,6 +3027,55 @@
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Broadcast custom message to all connected WebSocket clients",
"return": [
"{String} `realm` Identifier to be choosen by the client",
"{Object} `data` User-defined data"
],
"api": "requests",
"name": "BroadcastCustomMessage",
"category": "general",
"since": "4.7.0",
"returns": [
{
"type": "String",
"name": "realm",
"description": "Identifier to be choosen by the client"
},
{
"type": "Object",
"name": "data",
"description": "User-defined data"
}
],
"names": [
{
"name": "",
"description": "BroadcastCustomMessage"
}
],
"categories": [
{
"name": "",
"description": "general"
}
],
"sinces": [
{
"name": "",
"description": "4.7.0"
}
],
"heading": {
"level": 2,
"text": "BroadcastCustomMessage"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Get basic OBS video information",
@ -7966,58 +8015,5 @@
"examples": []
}
]
},
"general": {
"general": [
{
"subheads": [],
"description": "Broadcast custom message to all connected WebSocket clients",
"param": [
"{String} `realm` Identifier to be choosen by the client",
"{Object} `data` User-defined data"
],
"api": "general",
"name": "BroadcastCustomMessage",
"category": "general",
"since": "4.7.0",
"params": [
{
"type": "String",
"name": "realm",
"description": "Identifier to be choosen by the client"
},
{
"type": "Object",
"name": "data",
"description": "User-defined data"
}
],
"names": [
{
"name": "",
"description": "BroadcastCustomMessage"
}
],
"categories": [
{
"name": "",
"description": "general"
}
],
"sinces": [
{
"name": "",
"description": "4.7.0"
}
],
"heading": {
"level": 2,
"text": "BroadcastCustomMessage"
},
"lead": "",
"type": "class",
"examples": []
}
]
}
}

28
docs/generated/protocol.md
View File

@ -113,6 +113,7 @@ auth_response = base64_encode(auth_response_hash)
+ [SetFilenameFormatting](#setfilenameformatting)
+ [GetFilenameFormatting](#getfilenameformatting)
+ [GetStats](#getstats)
+ [BroadcastCustomMessage](#broadcastcustommessage-1)
+ [GetVideoInfo](#getvideoinfo)
* [Outputs](#outputs)
+ [ListOutputs](#listoutputs)
@ -714,7 +715,11 @@ A custom broadcast message was received
**Response Items:**
_No additional response items._
| Name | Type | Description |
| ---- | :---: | ------------|
| `realm` | _String_ | Identifier provided by the sender |
| `data` | _Object_ | User-defined data |
---
@ -1227,6 +1232,27 @@ _No specified parameters._
| `stats` | _OBSStats_ | OBS stats |
---
### BroadcastCustomMessage
- Added in v4.7.0
Broadcast custom message to all connected WebSocket clients
**Request Fields:**
_No specified parameters._
**Response Items:**
| Name | Type | Description |
| ---- | :---: | ------------|
| `realm` | _String_ | Identifier to be choosen by the client |
| `data` | _Object_ | User-defined data |
---
### GetVideoInfo