Update docs to include GetVideoInfo

This commit is contained in:
Chris Angelico 2019-05-09 06:03:14 +10:00
parent 7c457546f1
commit b0e3ea8765
2 changed files with 71 additions and 0 deletions

View File

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

View File

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