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

This commit is contained in:
Travis CI 2019-07-26 03:52:35 +00:00
parent add307577d
commit cda22233a6
2 changed files with 116 additions and 0 deletions

View File

@ -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": []
}
]
}
}

View File

@ -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