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(ci): Update protocol.md - 9fb0f56 [skip ci]

Browse Source
This commit is contained in:
Azure CI 2020-11-27 16:24:32 +00:00
parent 9fb0f56aa0
commit ef0e907014
2 changed files with 99 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
docs/generated/comments.json
View File

@ -562,10 +562,18 @@
{
"subheads": [],
"description": "\n\nNote: This event is not fired when the scenes are reordered.",
"return": "{Array<Scene>} `scenes` Scenes list.",
"api": "events",
"name": "ScenesChanged",
"category": "scenes",
"since": "0.3",
"returns": [
{
"type": "Array<Scene>",
"name": "scenes",
"description": "Scenes list."
}
],
"names": [
{
"name": "",
@ -595,10 +603,18 @@
{
"subheads": [],
"description": "Triggered when switching to another scene collection or when renaming the current scene collection.",
"return": "{String} `sceneCollection` Name of the new current scene collection.",
"api": "events",
"name": "SceneCollectionChanged",
"category": "scenes",
"since": "4.0.0",
"returns": [
{
"type": "String",
"name": "sceneCollection",
"description": "Name of the new current scene collection."
}
],
"names": [
{
"name": "",
@ -628,10 +644,26 @@
{
"subheads": [],
"description": "Triggered when a scene collection is created, added, renamed, or removed.",
"return": [
"{Array<Object>} `sceneCollections` Scene collections list.",
"{String} `sceneCollections.*.name` Scene collection name."
],
"api": "events",
"name": "SceneCollectionListChanged",
"category": "scenes",
"since": "4.0.0",
"returns": [
{
"type": "Array<Object>",
"name": "sceneCollections",
"description": "Scene collections list."
},
{
"type": "String",
"name": "sceneCollections.*.name",
"description": "Scene collection name."
}
],
"names": [
{
"name": "",
@ -704,10 +736,26 @@
{
"subheads": [],
"description": "The list of available transitions has been modified.\nTransitions have been added, removed, or renamed.",
"return": [
"{Array<Object>} `transitions` Transitions list.",
"{String} `transitions.*.name` Transition name."
],
"api": "events",
"name": "TransitionListChanged",
"category": "transitions",
"since": "4.0.0",
"returns": [
{
"type": "Array<Object>",
"name": "transitions",
"description": "Transitions list."
},
{
"type": "String",
"name": "transitions.*.name",
"description": "Transition name."
}
],
"names": [
{
"name": "",
@ -975,10 +1023,18 @@
{
"subheads": [],
"description": "Triggered when switching to another profile or when renaming the current profile.",
"return": "{String} `profile` Name of the new current profile.",
"api": "events",
"name": "ProfileChanged",
"category": "profiles",
"since": "4.0.0",
"returns": [
{
"type": "String",
"name": "profile",
"description": "Name of the new current profile."
}
],
"names": [
{
"name": "",
@ -1008,10 +1064,26 @@
{
"subheads": [],
"description": "Triggered when a profile is created, added, renamed, or removed.",
"return": [
"{Array<Object>} `profiles` Profiles list.",
"{String} `profiles.*.name` Profile name."
],
"api": "events",
"name": "ProfileListChanged",
"category": "profiles",
"since": "4.0.0",
"returns": [
{
"type": "Array<Object>",
"name": "profiles",
"description": "Profiles list."
},
{
"type": "String",
"name": "profiles.*.name",
"description": "Profile name."
}
],
"names": [
{
"name": "",

33
docs/generated/protocol.md
View File

@ -394,7 +394,10 @@ Note: This event is not fired when the scenes are reordered.
**Response Items:**
_No additional response items._
| Name | Type | Description |
| ---- | :---: | ------------|
| `scenes` | _Array&lt;Scene&gt;_ | Scenes list. |
---
@ -407,7 +410,10 @@ Triggered when switching to another scene collection or when renaming the curren
**Response Items:**
_No additional response items._
| Name | Type | Description |
| ---- | :---: | ------------|
| `sceneCollection` | _String_ | Name of the new current scene collection. |
---
@ -420,7 +426,11 @@ Triggered when a scene collection is created, added, renamed, or removed.
**Response Items:**
_No additional response items._
| Name | Type | Description |
| ---- | :---: | ------------|
| `sceneCollections` | _Array&lt;Object&gt;_ | Scene collections list. |
| `sceneCollections.*.name` | _String_ | Scene collection name. |
---
@ -452,7 +462,11 @@ Transitions have been added, removed, or renamed.
**Response Items:**
_No additional response items._
| Name | Type | Description |
| ---- | :---: | ------------|
| `transitions` | _Array&lt;Object&gt;_ | Transitions list. |
| `transitions.*.name` | _String_ | Transition name. |
---
@ -543,7 +557,10 @@ Triggered when switching to another profile or when renaming the current profile
**Response Items:**
_No additional response items._
| Name | Type | Description |
| ---- | :---: | ------------|
| `profile` | _String_ | Name of the new current profile. |
---
@ -556,7 +573,11 @@ Triggered when a profile is created, added, renamed, or removed.
**Response Items:**
_No additional response items._
| Name | Type | Description |
| ---- | :---: | ------------|
| `profiles` | _Array&lt;Object&gt;_ | Profiles list. |
| `profiles.*.name` | _String_ | Profile name. |
---