mirror of
https://github.com/Palakis/obs-websocket.git
synced 2024-08-30 18:12:16 +00:00
Switch doc type from Number to int for clarity and precision
This commit is contained in:
parent
b0512b3ba7
commit
5834c6ed54
@ -2829,10 +2829,10 @@
|
||||
"subheads": [],
|
||||
"description": "Get basic OBS video information",
|
||||
"return": [
|
||||
"{Number} `baseWidth` Base (canvas) width",
|
||||
"{Number} `baseHeight` Base (canvas) height",
|
||||
"{Number} `outputWidth` Output width",
|
||||
"{Number} `outputHeight` Output height",
|
||||
"{int} `baseWidth` Base (canvas) width",
|
||||
"{int} `baseHeight` Base (canvas) height",
|
||||
"{int} `outputWidth` Output width",
|
||||
"{int} `outputHeight` Output height",
|
||||
"{String} `scaleType` Scaling method used if output size differs from base size",
|
||||
"{double} `fps` Frames rendered per second",
|
||||
"{String} `videoFormat` Video color format",
|
||||
@ -2845,22 +2845,22 @@
|
||||
"since": "4.6.0",
|
||||
"returns": [
|
||||
{
|
||||
"type": "Number",
|
||||
"type": "int",
|
||||
"name": "baseWidth",
|
||||
"description": "Base (canvas) width"
|
||||
},
|
||||
{
|
||||
"type": "Number",
|
||||
"type": "int",
|
||||
"name": "baseHeight",
|
||||
"description": "Base (canvas) height"
|
||||
},
|
||||
{
|
||||
"type": "Number",
|
||||
"type": "int",
|
||||
"name": "outputWidth",
|
||||
"description": "Output width"
|
||||
},
|
||||
{
|
||||
"type": "Number",
|
||||
"type": "int",
|
||||
"name": "outputHeight",
|
||||
"description": "Output height"
|
||||
},
|
||||
|
@ -1199,10 +1199,10 @@ _No specified parameters._
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | :---: | ------------|
|
||||
| `baseWidth` | _Number_ | Base (canvas) width |
|
||||
| `baseHeight` | _Number_ | Base (canvas) height |
|
||||
| `outputWidth` | _Number_ | Output width |
|
||||
| `outputHeight` | _Number_ | Output height |
|
||||
| `baseWidth` | _int_ | Base (canvas) width |
|
||||
| `baseHeight` | _int_ | Base (canvas) height |
|
||||
| `outputWidth` | _int_ | Output width |
|
||||
| `outputHeight` | _int_ | Output height |
|
||||
| `scaleType` | _String_ | Scaling method used if output size differs from base size |
|
||||
| `fps` | _double_ | Frames rendered per second |
|
||||
| `videoFormat` | _String_ | Video color format |
|
||||
|
@ -185,10 +185,10 @@ HandlerResponse WSRequestHandler::HandleGetStats(WSRequestHandler* req) {
|
||||
/**
|
||||
* Get basic OBS video information
|
||||
*
|
||||
* @return {Number} `baseWidth` Base (canvas) width
|
||||
* @return {Number} `baseHeight` Base (canvas) height
|
||||
* @return {Number} `outputWidth` Output width
|
||||
* @return {Number} `outputHeight` Output height
|
||||
* @return {int} `baseWidth` Base (canvas) width
|
||||
* @return {int} `baseHeight` Base (canvas) height
|
||||
* @return {int} `outputWidth` Output width
|
||||
* @return {int} `outputHeight` Output height
|
||||
* @return {String} `scaleType` Scaling method used if output size differs from base size
|
||||
* @return {double} `fps` Frames rendered per second
|
||||
* @return {String} `videoFormat` Video color format
|
||||
|
Loading…
x
Reference in New Issue
Block a user