From b0e3ea8765bc294a9dbddcbefa0d3682ef6573ff Mon Sep 17 00:00:00 2001 From: Chris Angelico Date: Thu, 9 May 2019 06:03:14 +1000 Subject: [PATCH] Update docs to include GetVideoInfo --- docs/generated/comments.json | 49 ++++++++++++++++++++++++++++++++++++ docs/generated/protocol.md | 22 ++++++++++++++++ 2 files changed, 71 insertions(+) diff --git a/docs/generated/comments.json b/docs/generated/comments.json index cda71eec..d0552f66 100644 --- a/docs/generated/comments.json +++ b/docs/generated/comments.json @@ -2824,6 +2824,55 @@ "lead": "", "type": "class", "examples": [] + }, + { + "subheads": [], + "description": "Get basic OBS video information", + "return": [ + "{Number} `base_width` Base (canvas) width", + "{Number} `base_height` Base (canvas) height" + ], + "api": "requests", + "name": "GetVideoInfo", + "category": "general", + "since": "4.6.0", + "returns": [ + { + "type": "Number", + "name": "base_width", + "description": "Base (canvas) width" + }, + { + "type": "Number", + "name": "base_height", + "description": "Base (canvas) height" + } + ], + "names": [ + { + "name": "", + "description": "GetVideoInfo" + } + ], + "categories": [ + { + "name": "", + "description": "general" + } + ], + "sinces": [ + { + "name": "", + "description": "4.6.0" + } + ], + "heading": { + "level": 2, + "text": "GetVideoInfo" + }, + "lead": "", + "type": "class", + "examples": [] } ], "profiles": [ diff --git a/docs/generated/protocol.md b/docs/generated/protocol.md index 24484f53..4680a0cd 100644 --- a/docs/generated/protocol.md +++ b/docs/generated/protocol.md @@ -111,6 +111,7 @@ auth_response = base64_encode(auth_response_hash) + [SetFilenameFormatting](#setfilenameformatting) + [GetFilenameFormatting](#getfilenameformatting) + [GetStats](#getstats) + + [GetVideoInfo](#getvideoinfo) * [Profiles](#profiles-1) + [SetCurrentProfile](#setcurrentprofile) + [GetCurrentProfile](#getcurrentprofile) @@ -1181,6 +1182,27 @@ _No specified parameters._ | `stats` | _OBSStats_ | OBS stats | +--- + +### GetVideoInfo + + +- Added in v4.6.0 + +Get basic OBS video information + +**Request Fields:** + +_No specified parameters._ + +**Response Items:** + +| Name | Type | Description | +| ---- | :---: | ------------| +| `base_width` | _Number_ | Base (canvas) width | +| `base_height` | _Number_ | Base (canvas) height | + + --- ## Profiles