Mirrored_Repos/obs-websocket
1
0
Fork 0
mirror of https://github.com/Palakis/obs-websocket.git synced 2024-08-30 18:12:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

Switch doc type from Number to int for clarity and precision

Browse Source
This commit is contained in:
Chris Angelico 2019-05-10 18:48:51 +10:00
parent b0512b3ba7
commit 5834c6ed54
3 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/generated/comments.json
View File

@ -2829,10 +2829,10 @@
"subheads": [], "subheads": [],
"description": "Get basic OBS video information", "description": "Get basic OBS video information",
"return": [ "return": [
"{Number} `baseWidth` Base (canvas) width", "{int} `baseWidth` Base (canvas) width",
"{Number} `baseHeight` Base (canvas) height", "{int} `baseHeight` Base (canvas) height",
"{Number} `outputWidth` Output width", "{int} `outputWidth` Output width",
"{Number} `outputHeight` Output height", "{int} `outputHeight` Output height",
"{String} `scaleType` Scaling method used if output size differs from base size", "{String} `scaleType` Scaling method used if output size differs from base size",
"{double} `fps` Frames rendered per second", "{double} `fps` Frames rendered per second",
"{String} `videoFormat` Video color format", "{String} `videoFormat` Video color format",
@ -2845,22 +2845,22 @@
"since": "4.6.0", "since": "4.6.0",
"returns": [ "returns": [
{ {
"type": "Number", "type": "int",
"name": "baseWidth", "name": "baseWidth",
"description": "Base (canvas) width" "description": "Base (canvas) width"
}, },
{ {
"type": "Number", "type": "int",
"name": "baseHeight", "name": "baseHeight",
"description": "Base (canvas) height" "description": "Base (canvas) height"
}, },
{ {
"type": "Number", "type": "int",
"name": "outputWidth", "name": "outputWidth",
"description": "Output width" "description": "Output width"
}, },
{ {
"type": "Number", "type": "int",
"name": "outputHeight", "name": "outputHeight",
"description": "Output height" "description": "Output height"
}, },

8
docs/generated/protocol.md
View File

@ -1199,10 +1199,10 @@ _No specified parameters._
| Name | Type | Description | | Name | Type | Description |
| ---- | :---: | ------------| | ---- | :---: | ------------|
| `baseWidth` | _Number_ | Base (canvas) width | | `baseWidth` | _int_ | Base (canvas) width |
| `baseHeight` | _Number_ | Base (canvas) height | | `baseHeight` | _int_ | Base (canvas) height |
| `outputWidth` | _Number_ | Output width | | `outputWidth` | _int_ | Output width |
| `outputHeight` | _Number_ | Output height | | `outputHeight` | _int_ | Output height |
| `scaleType` | _String_ | Scaling method used if output size differs from base size | | `scaleType` | _String_ | Scaling method used if output size differs from base size |
| `fps` | _double_ | Frames rendered per second | | `fps` | _double_ | Frames rendered per second |
| `videoFormat` | _String_ | Video color format | | `videoFormat` | _String_ | Video color format |

8
src/WSRequestHandler_General.cpp
View File

@ -185,10 +185,10 @@ HandlerResponse WSRequestHandler::HandleGetStats(WSRequestHandler* req) {
/** /**
* Get basic OBS video information * Get basic OBS video information
* *
* @return {Number} `baseWidth` Base (canvas) width * @return {int} `baseWidth` Base (canvas) width
* @return {Number} `baseHeight` Base (canvas) height * @return {int} `baseHeight` Base (canvas) height
* @return {Number} `outputWidth` Output width * @return {int} `outputWidth` Output width
* @return {Number} `outputHeight` Output height * @return {int} `outputHeight` Output height
* @return {String} `scaleType` Scaling method used if output size differs from base size * @return {String} `scaleType` Scaling method used if output size differs from base size
* @return {double} `fps` Frames rendered per second * @return {double} `fps` Frames rendered per second
* @return {String} `videoFormat` Video color format * @return {String} `videoFormat` Video color format