From ac26c9114a0eec5131519a76a7d9e047820c2064 Mon Sep 17 00:00:00 2001 From: Travis CI <> Date: Fri, 26 Jul 2019 07:31:42 +0000 Subject: [PATCH] docs(travis): Update protocol.md - fb0a570 [skip ci] --- docs/generated/comments.json | 106 +++++++++++++++++------------------ docs/generated/protocol.md | 28 ++++++++- 2 files changed, 78 insertions(+), 56 deletions(-) diff --git a/docs/generated/comments.json b/docs/generated/comments.json index bb8f01e3..f8b02f46 100644 --- a/docs/generated/comments.json +++ b/docs/generated/comments.json @@ -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": [] - } - ] } } \ No newline at end of file diff --git a/docs/generated/protocol.md b/docs/generated/protocol.md index a2922da2..2fad8845 100644 --- a/docs/generated/protocol.md +++ b/docs/generated/protocol.md @@ -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