mirror of
https://github.com/Palakis/obs-websocket.git
synced 2024-08-30 18:12:16 +00:00
docs(ci): Update protocol.md - 3d7511c [skip ci]
This commit is contained in:
parent
3d7511ca75
commit
b9cbd0ecd1
@ -10521,6 +10521,112 @@
|
|||||||
"lead": "",
|
"lead": "",
|
||||||
"type": "class",
|
"type": "class",
|
||||||
"examples": []
|
"examples": []
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"subheads": [],
|
||||||
|
"description": "Get the current settings of a transition",
|
||||||
|
"param": "{String} `transitionName` Transition name",
|
||||||
|
"return": "{Object} `transitionSettings` Current transition settings",
|
||||||
|
"api": "requests",
|
||||||
|
"name": "GetTransitionSettings",
|
||||||
|
"category": "transitions",
|
||||||
|
"since": "unreleased",
|
||||||
|
"returns": [
|
||||||
|
{
|
||||||
|
"type": "Object",
|
||||||
|
"name": "transitionSettings",
|
||||||
|
"description": "Current transition settings"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"params": [
|
||||||
|
{
|
||||||
|
"type": "String",
|
||||||
|
"name": "transitionName",
|
||||||
|
"description": "Transition name"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"names": [
|
||||||
|
{
|
||||||
|
"name": "",
|
||||||
|
"description": "GetTransitionSettings"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"categories": [
|
||||||
|
{
|
||||||
|
"name": "",
|
||||||
|
"description": "transitions"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"sinces": [
|
||||||
|
{
|
||||||
|
"name": "",
|
||||||
|
"description": "unreleased"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"heading": {
|
||||||
|
"level": 2,
|
||||||
|
"text": "GetTransitionSettings"
|
||||||
|
},
|
||||||
|
"lead": "",
|
||||||
|
"type": "class",
|
||||||
|
"examples": []
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"subheads": [],
|
||||||
|
"description": "Change the current settings of a transition",
|
||||||
|
"param": [
|
||||||
|
"{String} `transitionName` Transition name",
|
||||||
|
"{Object} `transitionSettings` Transition settings (they can be partial)"
|
||||||
|
],
|
||||||
|
"return": "{Object} `transitionSettings` Updated transition settings",
|
||||||
|
"api": "requests",
|
||||||
|
"name": "SetTransitionSettings",
|
||||||
|
"category": "transitions",
|
||||||
|
"since": "unreleased",
|
||||||
|
"returns": [
|
||||||
|
{
|
||||||
|
"type": "Object",
|
||||||
|
"name": "transitionSettings",
|
||||||
|
"description": "Updated transition settings"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"params": [
|
||||||
|
{
|
||||||
|
"type": "String",
|
||||||
|
"name": "transitionName",
|
||||||
|
"description": "Transition name"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "Object",
|
||||||
|
"name": "transitionSettings",
|
||||||
|
"description": "Transition settings (they can be partial)"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"names": [
|
||||||
|
{
|
||||||
|
"name": "",
|
||||||
|
"description": "SetTransitionSettings"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"categories": [
|
||||||
|
{
|
||||||
|
"name": "",
|
||||||
|
"description": "transitions"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"sinces": [
|
||||||
|
{
|
||||||
|
"name": "",
|
||||||
|
"description": "unreleased"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"heading": {
|
||||||
|
"level": 2,
|
||||||
|
"text": "SetTransitionSettings"
|
||||||
|
},
|
||||||
|
"lead": "",
|
||||||
|
"type": "class",
|
||||||
|
"examples": []
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
@ -255,6 +255,8 @@ You can also refer to any of the client libraries listed on the [README](README.
|
|||||||
+ [SetTransitionDuration](#settransitionduration)
|
+ [SetTransitionDuration](#settransitionduration)
|
||||||
+ [GetTransitionDuration](#gettransitionduration)
|
+ [GetTransitionDuration](#gettransitionduration)
|
||||||
+ [GetTransitionPosition](#gettransitionposition)
|
+ [GetTransitionPosition](#gettransitionposition)
|
||||||
|
+ [GetTransitionSettings](#gettransitionsettings)
|
||||||
|
+ [SetTransitionSettings](#settransitionsettings)
|
||||||
|
|
||||||
<!-- tocstop -->
|
<!-- tocstop -->
|
||||||
|
|
||||||
@ -4185,3 +4187,50 @@ _No specified parameters._
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
### GetTransitionSettings
|
||||||
|
|
||||||
|
|
||||||
|
- Unreleased
|
||||||
|
|
||||||
|
Get the current settings of a transition
|
||||||
|
|
||||||
|
**Request Fields:**
|
||||||
|
|
||||||
|
| Name | Type | Description |
|
||||||
|
| ---- | :---: | ------------|
|
||||||
|
| `transitionName` | _String_ | Transition name |
|
||||||
|
|
||||||
|
|
||||||
|
**Response Items:**
|
||||||
|
|
||||||
|
| Name | Type | Description |
|
||||||
|
| ---- | :---: | ------------|
|
||||||
|
| `transitionSettings` | _Object_ | Current transition settings |
|
||||||
|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### SetTransitionSettings
|
||||||
|
|
||||||
|
|
||||||
|
- Unreleased
|
||||||
|
|
||||||
|
Change the current settings of a transition
|
||||||
|
|
||||||
|
**Request Fields:**
|
||||||
|
|
||||||
|
| Name | Type | Description |
|
||||||
|
| ---- | :---: | ------------|
|
||||||
|
| `transitionName` | _String_ | Transition name |
|
||||||
|
| `transitionSettings` | _Object_ | Transition settings (they can be partial) |
|
||||||
|
|
||||||
|
|
||||||
|
**Response Items:**
|
||||||
|
|
||||||
|
| Name | Type | Description |
|
||||||
|
| ---- | :---: | ------------|
|
||||||
|
| `transitionSettings` | _Object_ | Updated transition settings |
|
||||||
|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user