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

wip: remove redundant "as object" descriptions

Browse Source
This commit is contained in:
Alex Van Camp 2018-12-05 14:02:25 -06:00
parent b204f3ec90
commit b4c3141170
3 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/generated/comments.json
View File

@ -2952,7 +2952,7 @@
"subheads": [], "subheads": [],
"description": "List all sources available in the running OBS instance", "description": "List all sources available in the running OBS instance",
"return": [ "return": [
"{Array<Object>} `sources` Array of sources as objects", "{Array<Object>} `sources` Array of sources",
"{String} `sources.*.name` Unique source name", "{String} `sources.*.name` Unique source name",
"{String} `sources.*.typeId` Non-unique source internal type (a.k.a type id)", "{String} `sources.*.typeId` Non-unique source internal type (a.k.a type id)",
"{String} `sources.*.type` Source type. Value is one of the following: \"input\", \"filter\", \"transition\", \"scene\" or \"unknown\"" "{String} `sources.*.type` Source type. Value is one of the following: \"input\", \"filter\", \"transition\", \"scene\" or \"unknown\""
@ -2965,7 +2965,7 @@
{ {
"type": "Array<Object>", "type": "Array<Object>",
"name": "sources", "name": "sources",
"description": "Array of sources as objects" "description": "Array of sources"
}, },
{ {
"type": "String", "type": "String",
@ -3013,7 +3013,7 @@
"subheads": [], "subheads": [],
"description": "Get a list of all available sources types", "description": "Get a list of all available sources types",
"return": [ "return": [
"{Array<Object>} `ids` Array of source types as objects", "{Array<Object>} `ids` Array of source types",
"{String} `ids.*.typeId` Non-unique internal source type ID", "{String} `ids.*.typeId` Non-unique internal source type ID",
"{String} `ids.*.displayName` Display name of the source type", "{String} `ids.*.displayName` Display name of the source type",
"{String} `ids.*.type` Type. Value is one of the following: \"input\", \"filter\", \"transition\" or \"other\"", "{String} `ids.*.type` Type. Value is one of the following: \"input\", \"filter\", \"transition\" or \"other\"",
@ -3035,7 +3035,7 @@
{ {
"type": "Array<Object>", "type": "Array<Object>",
"name": "ids", "name": "ids",
"description": "Array of source types as objects" "description": "Array of source types"
}, },
{ {
"type": "String", "type": "String",
@ -5803,7 +5803,7 @@
"subheads": [], "subheads": [],
"typedef": "{Object} `Source` An OBS Scene Item.", "typedef": "{Object} `Source` An OBS Scene Item.",
"property": [ "property": [
"{Number} `cy` -", "{Number} `cy`",
"{Number} `cx`", "{Number} `cx`",
"{String} `name` The name of this Scene Item.", "{String} `name` The name of this Scene Item.",
"{Boolean} `render` Whether or not this Scene Item is set to \"visible\".", "{Boolean} `render` Whether or not this Scene Item is set to \"visible\".",

4
docs/generated/protocol.md
View File

@ -1427,7 +1427,7 @@ _No specified parameters._
| Name | Type | Description | | Name | Type | Description |
| ---- | :---: | ------------| | ---- | :---: | ------------|
| `sources` | _Array&lt;Object&gt;_ | Array of sources as objects | | `sources` | _Array&lt;Object&gt;_ | Array of sources |
| `sources.*.name` | _String_ | Unique source name | | `sources.*.name` | _String_ | Unique source name |
| `sources.*.typeId` | _String_ | Non-unique source internal type (a.k.a type id) | | `sources.*.typeId` | _String_ | Non-unique source internal type (a.k.a type id) |
| `sources.*.type` | _String_ | Source type. Value is one of the following: "input", "filter", "transition", "scene" or "unknown" | | `sources.*.type` | _String_ | Source type. Value is one of the following: "input", "filter", "transition", "scene" or "unknown" |
@ -1450,7 +1450,7 @@ _No specified parameters._
| Name | Type | Description | | Name | Type | Description |
| ---- | :---: | ------------| | ---- | :---: | ------------|
| `ids` | _Array&lt;Object&gt;_ | Array of source types as objects | | `ids` | _Array&lt;Object&gt;_ | Array of source types |
| `ids.*.typeId` | _String_ | Non-unique internal source type ID | | `ids.*.typeId` | _String_ | Non-unique internal source type ID |
| `ids.*.displayName` | _String_ | Display name of the source type | | `ids.*.displayName` | _String_ | Display name of the source type |
| `ids.*.type` | _String_ | Type. Value is one of the following: "input", "filter", "transition" or "other" | | `ids.*.type` | _String_ | Type. Value is one of the following: "input", "filter", "transition" or "other" |

4
src/WSRequestHandler_Sources.cpp
View File

@ -20,7 +20,7 @@
/** /**
* List all sources available in the running OBS instance * List all sources available in the running OBS instance
* *
* @return {Array<Object>} `sources` Array of sources as objects * @return {Array<Object>} `sources` Array of sources
* @return {String} `sources.*.name` Unique source name * @return {String} `sources.*.name` Unique source name
* @return {String} `sources.*.typeId` Non-unique source internal type (a.k.a type id) * @return {String} `sources.*.typeId` Non-unique source internal type (a.k.a type id)
* @return {String} `sources.*.type` Source type. Value is one of the following: "input", "filter", "transition", "scene" or "unknown" * @return {String} `sources.*.type` Source type. Value is one of the following: "input", "filter", "transition", "scene" or "unknown"
@ -78,7 +78,7 @@ void WSRequestHandler::HandleGetSourcesList(WSRequestHandler* req) {
/** /**
* Get a list of all available sources types * Get a list of all available sources types
* *
* @return {Array<Object>} `ids` Array of source types as objects * @return {Array<Object>} `ids` Array of source types
* @return {String} `ids.*.typeId` Non-unique internal source type ID * @return {String} `ids.*.typeId` Non-unique internal source type ID
* @return {String} `ids.*.displayName` Display name of the source type * @return {String} `ids.*.displayName` Display name of the source type
* @return {String} `ids.*.type` Type. Value is one of the following: "input", "filter", "transition" or "other" * @return {String} `ids.*.type` Type. Value is one of the following: "input", "filter", "transition" or "other"