From c62178a7fe900d8acbd68a1c3b9e52e641c7c353 Mon Sep 17 00:00:00 2001 From: Travis CI <> Date: Tue, 16 Apr 2019 21:14:32 +0000 Subject: [PATCH] docs(travis): Update protocol.md - c12a432 [skip ci] --- docs/generated/comments.json | 34 ++++++++++++++++++++++++++++++++++ docs/generated/protocol.md | 22 ++++++++++++++++++++++ 2 files changed, 56 insertions(+) diff --git a/docs/generated/comments.json b/docs/generated/comments.json index 20e74484..ecb61da4 100644 --- a/docs/generated/comments.json +++ b/docs/generated/comments.json @@ -5581,6 +5581,40 @@ "lead": "", "type": "class", "examples": [] + }, + { + "subheads": [], + "description": "Send the provided text as embedded CEA-608 caption data.\nAs of OBS Studio 23.1, captions are not yet available on Linux.", + "param": "{String} `text` Captions text", + "api": "requests", + "name": "SendCaptions", + "category": "streaming", + "params": [ + { + "type": "String", + "name": "text", + "description": "Captions text" + } + ], + "names": [ + { + "name": "", + "description": "SendCaptions" + } + ], + "categories": [ + { + "name": "", + "description": "streaming" + } + ], + "heading": { + "level": 2, + "text": "SendCaptions" + }, + "lead": "", + "type": "class", + "examples": [] } ], "studio mode": [ diff --git a/docs/generated/protocol.md b/docs/generated/protocol.md index d26b63bf..7f7e92bf 100644 --- a/docs/generated/protocol.md +++ b/docs/generated/protocol.md @@ -162,6 +162,7 @@ auth_response = base64_encode(auth_response_hash) + [SetStreamSettings](#setstreamsettings) + [GetStreamSettings](#getstreamsettings) + [SaveStreamSettings](#savestreamsettings) + + [SendCaptions](#sendcaptions) * [Studio Mode](#studio-mode-1) + [GetStudioModeStatus](#getstudiomodestatus) + [GetPreviewScene](#getpreviewscene) @@ -2299,6 +2300,27 @@ Save the current streaming server settings to disk. _No specified parameters._ +**Response Items:** + +_No additional response items._ + +--- + +### SendCaptions + + +- Added in v + +Send the provided text as embedded CEA-608 caption data. +As of OBS Studio 23.1, captions are not yet available on Linux. + +**Request Fields:** + +| Name | Type | Description | +| ---- | :---: | ------------| +| `text` | _String_ | Captions text | + + **Response Items:** _No additional response items._