From cda22233a66972ba892bcbb128d4827257bf7545 Mon Sep 17 00:00:00 2001 From: Travis CI <> Date: Fri, 26 Jul 2019 03:52:35 +0000 Subject: [PATCH] docs(travis): Update protocol.md - add3075 [skip ci] --- docs/generated/comments.json | 102 +++++++++++++++++++++++++++++++++++ docs/generated/protocol.md | 14 +++++ 2 files changed, 116 insertions(+) diff --git a/docs/generated/comments.json b/docs/generated/comments.json index 31c02dc1..bb8f01e3 100644 --- a/docs/generated/comments.json +++ b/docs/generated/comments.json @@ -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": [] + } + ] } } \ No newline at end of file diff --git a/docs/generated/protocol.md b/docs/generated/protocol.md index 91dfe8a6..a2922da2 100644 --- a/docs/generated/protocol.md +++ b/docs/generated/protocol.md @@ -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