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

docs(travis): Update protocol.md - 65a1f8b [skip ci]

Browse Source
This commit is contained in:
Travis CI 2019-06-18 16:41:13 +00:00
parent 65a1f8b746
commit 29679ff94c
2 changed files with 39 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
docs/generated/comments.json
View File

@ -4607,19 +4607,19 @@
"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", "{Array<Object>} `types` Array of source types",
"{String} `ids.*.typeId` Non-unique internal source type ID", "{String} `types.*.typeId` Non-unique internal source type ID",
"{String} `ids.*.displayName` Display name of the source type", "{String} `types.*.displayName` Display name of the source type",
"{String} `ids.*.type` Type. Value is one of the following: \"input\", \"filter\", \"transition\" or \"other\"", "{String} `types.*.type` Type. Value is one of the following: \"input\", \"filter\", \"transition\" or \"other\"",
"{Object} `ids.*.defaultSettings` Default settings of this source type", "{Object} `types.*.defaultSettings` Default settings of this source type",
"{Object} `ids.*.caps` Source type capabilities", "{Object} `types.*.caps` Source type capabilities",
"{Boolean} `ids.*.caps.isAsync` True if source of this type provide frames asynchronously", "{Boolean} `types.*.caps.isAsync` True if source of this type provide frames asynchronously",
"{Boolean} `ids.*.caps.hasVideo` True if sources of this type provide video", "{Boolean} `types.*.caps.hasVideo` True if sources of this type provide video",
"{Boolean} `ids.*.caps.hasAudio` True if sources of this type provide audio", "{Boolean} `types.*.caps.hasAudio` True if sources of this type provide audio",
"{Boolean} `ids.*.caps.canInteract` True if interaction with this sources of this type is possible", "{Boolean} `types.*.caps.canInteract` True if interaction with this sources of this type is possible",
"{Boolean} `ids.*.caps.isComposite` True if sources of this type composite one or more sub-sources", "{Boolean} `types.*.caps.isComposite` True if sources of this type composite one or more sub-sources",
"{Boolean} `ids.*.caps.doNotDuplicate` True if sources of this type should not be fully duplicated", "{Boolean} `types.*.caps.doNotDuplicate` True if sources of this type should not be fully duplicated",
"{Boolean} `ids.*.caps.doNotSelfMonitor` True if sources of this type may cause a feedback loop if it's audio is monitored and shouldn't be" "{Boolean} `types.*.caps.doNotSelfMonitor` True if sources of this type may cause a feedback loop if it's audio is monitored and shouldn't be"
], ],
"api": "requests", "api": "requests",
"name": "GetSourceTypesList", "name": "GetSourceTypesList",
@ -4628,67 +4628,67 @@
"returns": [ "returns": [
{ {
"type": "Array<Object>", "type": "Array<Object>",
"name": "ids", "name": "types",
"description": "Array of source types" "description": "Array of source types"
}, },
{ {
"type": "String", "type": "String",
"name": "ids.*.typeId", "name": "types.*.typeId",
"description": "Non-unique internal source type ID" "description": "Non-unique internal source type ID"
}, },
{ {
"type": "String", "type": "String",
"name": "ids.*.displayName", "name": "types.*.displayName",
"description": "Display name of the source type" "description": "Display name of the source type"
}, },
{ {
"type": "String", "type": "String",
"name": "ids.*.type", "name": "types.*.type",
"description": "Type. Value is one of the following: \"input\", \"filter\", \"transition\" or \"other\"" "description": "Type. Value is one of the following: \"input\", \"filter\", \"transition\" or \"other\""
}, },
{ {
"type": "Object", "type": "Object",
"name": "ids.*.defaultSettings", "name": "types.*.defaultSettings",
"description": "Default settings of this source type" "description": "Default settings of this source type"
}, },
{ {
"type": "Object", "type": "Object",
"name": "ids.*.caps", "name": "types.*.caps",
"description": "Source type capabilities" "description": "Source type capabilities"
}, },
{ {
"type": "Boolean", "type": "Boolean",
"name": "ids.*.caps.isAsync", "name": "types.*.caps.isAsync",
"description": "True if source of this type provide frames asynchronously" "description": "True if source of this type provide frames asynchronously"
}, },
{ {
"type": "Boolean", "type": "Boolean",
"name": "ids.*.caps.hasVideo", "name": "types.*.caps.hasVideo",
"description": "True if sources of this type provide video" "description": "True if sources of this type provide video"
}, },
{ {
"type": "Boolean", "type": "Boolean",
"name": "ids.*.caps.hasAudio", "name": "types.*.caps.hasAudio",
"description": "True if sources of this type provide audio" "description": "True if sources of this type provide audio"
}, },
{ {
"type": "Boolean", "type": "Boolean",
"name": "ids.*.caps.canInteract", "name": "types.*.caps.canInteract",
"description": "True if interaction with this sources of this type is possible" "description": "True if interaction with this sources of this type is possible"
}, },
{ {
"type": "Boolean", "type": "Boolean",
"name": "ids.*.caps.isComposite", "name": "types.*.caps.isComposite",
"description": "True if sources of this type composite one or more sub-sources" "description": "True if sources of this type composite one or more sub-sources"
}, },
{ {
"type": "Boolean", "type": "Boolean",
"name": "ids.*.caps.doNotDuplicate", "name": "types.*.caps.doNotDuplicate",
"description": "True if sources of this type should not be fully duplicated" "description": "True if sources of this type should not be fully duplicated"
}, },
{ {
"type": "Boolean", "type": "Boolean",
"name": "ids.*.caps.doNotSelfMonitor", "name": "types.*.caps.doNotSelfMonitor",
"description": "True if sources of this type may cause a feedback loop if it's audio is monitored and shouldn't be" "description": "True if sources of this type may cause a feedback loop if it's audio is monitored and shouldn't be"
} }
], ],

26
docs/generated/protocol.md
View File

@ -1900,19 +1900,19 @@ _No specified parameters._
| Name | Type | Description | | Name | Type | Description |
| ---- | :---: | ------------| | ---- | :---: | ------------|
| `ids` | _Array&lt;Object&gt;_ | Array of source types | | `types` | _Array&lt;Object&gt;_ | Array of source types |
| `ids.*.typeId` | _String_ | Non-unique internal source type ID | | `types.*.typeId` | _String_ | Non-unique internal source type ID |
| `ids.*.displayName` | _String_ | Display name of the source type | | `types.*.displayName` | _String_ | Display name of the source type |
| `ids.*.type` | _String_ | Type. Value is one of the following: "input", "filter", "transition" or "other" | | `types.*.type` | _String_ | Type. Value is one of the following: "input", "filter", "transition" or "other" |
| `ids.*.defaultSettings` | _Object_ | Default settings of this source type | | `types.*.defaultSettings` | _Object_ | Default settings of this source type |
| `ids.*.caps` | _Object_ | Source type capabilities | | `types.*.caps` | _Object_ | Source type capabilities |
| `ids.*.caps.isAsync` | _Boolean_ | True if source of this type provide frames asynchronously | | `types.*.caps.isAsync` | _Boolean_ | True if source of this type provide frames asynchronously |
| `ids.*.caps.hasVideo` | _Boolean_ | True if sources of this type provide video | | `types.*.caps.hasVideo` | _Boolean_ | True if sources of this type provide video |
| `ids.*.caps.hasAudio` | _Boolean_ | True if sources of this type provide audio | | `types.*.caps.hasAudio` | _Boolean_ | True if sources of this type provide audio |
| `ids.*.caps.canInteract` | _Boolean_ | True if interaction with this sources of this type is possible | | `types.*.caps.canInteract` | _Boolean_ | True if interaction with this sources of this type is possible |
| `ids.*.caps.isComposite` | _Boolean_ | True if sources of this type composite one or more sub-sources | | `types.*.caps.isComposite` | _Boolean_ | True if sources of this type composite one or more sub-sources |
| `ids.*.caps.doNotDuplicate` | _Boolean_ | True if sources of this type should not be fully duplicated | | `types.*.caps.doNotDuplicate` | _Boolean_ | True if sources of this type should not be fully duplicated |
| `ids.*.caps.doNotSelfMonitor` | _Boolean_ | True if sources of this type may cause a feedback loop if it's audio is monitored and shouldn't be | | `types.*.caps.doNotSelfMonitor` | _Boolean_ | True if sources of this type may cause a feedback loop if it's audio is monitored and shouldn't be |
--- ---