mirror of
https://github.com/Palakis/obs-websocket.git
synced 2024-08-30 18:12:16 +00:00
docs(travis): Update protocol.md - 563936e [skip ci]
This commit is contained in:
parent
563936ea08
commit
3ecb9702ef
@ -3284,8 +3284,9 @@
|
||||
"description": "List all sources available in the running OBS instance",
|
||||
"return": [
|
||||
"{Array of Objects} `sources` Array of sources as objects",
|
||||
"{String} `sources.*.name` Source name",
|
||||
"{String} `sources.*.type` Source type"
|
||||
"{String} `sources.*.name` Unique source name",
|
||||
"{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\""
|
||||
],
|
||||
"api": "requests",
|
||||
"name": "GetSourcesList",
|
||||
@ -3300,12 +3301,132 @@
|
||||
{
|
||||
"type": "String",
|
||||
"name": "sources.*.name",
|
||||
"description": "Source name"
|
||||
"description": "Unique source name"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"name": "sources.*.typeId",
|
||||
"description": "Non-unique source internal type (a.k.a type id)"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"name": "sources.*.type",
|
||||
"description": "Source type"
|
||||
"description": "Source type. Value is one of the following: \"input\", \"filter\", \"transition\", \"scene\" or \"unknown\""
|
||||
}
|
||||
],
|
||||
"names": [
|
||||
{
|
||||
"name": "",
|
||||
"description": "GetSourcesList"
|
||||
}
|
||||
],
|
||||
"categories": [
|
||||
{
|
||||
"name": "",
|
||||
"description": "sources"
|
||||
}
|
||||
],
|
||||
"sinces": [
|
||||
{
|
||||
"name": "",
|
||||
"description": "unreleased"
|
||||
}
|
||||
],
|
||||
"heading": {
|
||||
"level": 2,
|
||||
"text": "GetSourcesList"
|
||||
},
|
||||
"lead": "",
|
||||
"type": "class",
|
||||
"examples": []
|
||||
},
|
||||
{
|
||||
"subheads": [],
|
||||
"description": "Get a list of all available sources types",
|
||||
"return": [
|
||||
"{Array of Objects} `ids` Array of sources as objects",
|
||||
"{String} `ids.*.typeId` Non-unique internal source type ID",
|
||||
"{String} `ids.*.displayName` Display name of the source type",
|
||||
"{String} `ids.*.type` Type. Value is one of the following: \"input\", \"filter\", \"transition\" or \"other\"",
|
||||
"{Object} `ids.*.defaultSettings` Default settings of this source type",
|
||||
"{Object} `ids.*.caps` Source type capabilities",
|
||||
"{Boolean} `ids.*.caps.isAsync` True if source of this type provide frames asynchronously",
|
||||
"{Boolean} `ids.*.caps.hasVideo` True if sources of this type provide video",
|
||||
"{Boolean} `ids.*.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} `ids.*.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} `ids.*.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",
|
||||
"name": "GetSourcesList",
|
||||
"category": "sources",
|
||||
"since": "unreleased",
|
||||
"returns": [
|
||||
{
|
||||
"type": "Array of Objects",
|
||||
"name": "ids",
|
||||
"description": "Array of sources as objects"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"name": "ids.*.typeId",
|
||||
"description": "Non-unique internal source type ID"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"name": "ids.*.displayName",
|
||||
"description": "Display name of the source type"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"name": "ids.*.type",
|
||||
"description": "Type. Value is one of the following: \"input\", \"filter\", \"transition\" or \"other\""
|
||||
},
|
||||
{
|
||||
"type": "Object",
|
||||
"name": "ids.*.defaultSettings",
|
||||
"description": "Default settings of this source type"
|
||||
},
|
||||
{
|
||||
"type": "Object",
|
||||
"name": "ids.*.caps",
|
||||
"description": "Source type capabilities"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"name": "ids.*.caps.isAsync",
|
||||
"description": "True if source of this type provide frames asynchronously"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"name": "ids.*.caps.hasVideo",
|
||||
"description": "True if sources of this type provide video"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"name": "ids.*.caps.hasAudio",
|
||||
"description": "True if sources of this type provide audio"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"name": "ids.*.caps.canInteract",
|
||||
"description": "True if interaction with this sources of this type is possible"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"name": "ids.*.caps.isComposite",
|
||||
"description": "True if sources of this type composite one or more sub-sources"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"name": "ids.*.caps.doNotDuplicate",
|
||||
"description": "True if sources of this type should not be fully duplicated"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"name": "ids.*.caps.doNotSelfMonitor",
|
||||
"description": "True if sources of this type may cause a feedback loop if it's audio is monitored and shouldn't be"
|
||||
}
|
||||
],
|
||||
"names": [
|
||||
|
Loading…
x
Reference in New Issue
Block a user