mirror of
https://github.com/Palakis/obs-websocket.git
synced 2024-08-30 18:12:16 +00:00
docs(travis): Update protocol.md - add3075 [skip ci]
This commit is contained in:
parent
add307577d
commit
cda22233a6
@ -1599,6 +1599,55 @@
|
||||
"lead": "",
|
||||
"type": "class",
|
||||
"examples": []
|
||||
},
|
||||
{
|
||||
"subheads": [],
|
||||
"description": "A custom broadcast message was received",
|
||||
"param": [
|
||||
"{String} `realm` Identifier provided by the sender",
|
||||
"{Object} `data` User-defined data"
|
||||
],
|
||||
"api": "events",
|
||||
"name": "BroadcastCustomMessage",
|
||||
"category": "general",
|
||||
"since": "4.7.0",
|
||||
"params": [
|
||||
{
|
||||
"type": "String",
|
||||
"name": "realm",
|
||||
"description": "Identifier provided by the sender"
|
||||
},
|
||||
{
|
||||
"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": []
|
||||
}
|
||||
],
|
||||
"sources": [
|
||||
@ -7917,5 +7966,58 @@
|
||||
"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": []
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
@ -82,6 +82,7 @@ auth_response = base64_encode(auth_response_hash)
|
||||
+ [Exiting](#exiting)
|
||||
* [General](#general)
|
||||
+ [Heartbeat](#heartbeat)
|
||||
+ [BroadcastCustomMessage](#broadcastcustommessage)
|
||||
* [Sources](#sources)
|
||||
+ [SourceCreated](#sourcecreated)
|
||||
+ [SourceDestroyed](#sourcedestroyed)
|
||||
@ -702,6 +703,19 @@ Emitted every 2 seconds after enabling it by calling SetHeartbeat.
|
||||
| `stats` | _OBSStats_ | OBS Stats |
|
||||
|
||||
|
||||
---
|
||||
|
||||
### BroadcastCustomMessage
|
||||
|
||||
|
||||
- Added in v4.7.0
|
||||
|
||||
A custom broadcast message was received
|
||||
|
||||
**Response Items:**
|
||||
|
||||
_No additional response items._
|
||||
|
||||
---
|
||||
|
||||
## Sources
|
||||
|
Loading…
x
Reference in New Issue
Block a user