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 - c428201 [skip ci]

Browse Source
This commit is contained in:
Azure CI 2020-05-26 21:49:10 +00:00
parent c4282011fa
commit 5d12dfa368
2 changed files with 222 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

153
docs/generated/comments.json
View File

@ -5467,6 +5467,159 @@
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Set a scene to use a specific transition override.",
"param": [
"{String} `sceneName` Name of the scene to switch to.",
"{String} `transitionName` Name of the transition to use.",
"{int (Optional)} `transitionDuration` Duration in milliseconds of the transition if transition is not fixed. Defaults to the current duration specified in the UI if there is no current override and this value is not given."
],
"api": "requests",
"name": "SetSceneTransitionOverride",
"category": "scenes",
"since": "4.9.0",
"params": [
{
"type": "String",
"name": "sceneName",
"description": "Name of the scene to switch to."
},
{
"type": "String",
"name": "transitionName",
"description": "Name of the transition to use."
},
{
"type": "int (Optional)",
"name": "transitionDuration",
"description": "Duration in milliseconds of the transition if transition is not fixed. Defaults to the current duration specified in the UI if there is no current override and this value is not given."
}
],
"names": [
{
"name": "",
"description": "SetSceneTransitionOverride"
}
],
"categories": [
{
"name": "",
"description": "scenes"
}
],
"sinces": [
{
"name": "",
"description": "4.9.0"
}
],
"heading": {
"level": 2,
"text": "SetSceneTransitionOverride"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Remove any transition override on a scene.",
"param": "{String} `sceneName` Name of the scene to switch to.",
"api": "requests",
"name": "RemoveSceneTransitionOverride",
"category": "scenes",
"since": "4.9.0",
"params": [
{
"type": "String",
"name": "sceneName",
"description": "Name of the scene to switch to."
}
],
"names": [
{
"name": "",
"description": "RemoveSceneTransitionOverride"
}
],
"categories": [
{
"name": "",
"description": "scenes"
}
],
"sinces": [
{
"name": "",
"description": "4.9.0"
}
],
"heading": {
"level": 2,
"text": "RemoveSceneTransitionOverride"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Get the current scene transition override.",
"param": "{String} `sceneName` Name of the scene to switch to.",
"return": [
"{String} `transitionName` Name of the current overriding transition. Empty string if no override is set.",
"{int} `transitionDuration` Transition duration. `-1` if no override is set."
],
"api": "requests",
"name": "GetSceneTransitionOverride",
"category": "scenes",
"since": "4.9.0",
"returns": [
{
"type": "String",
"name": "transitionName",
"description": "Name of the current overriding transition. Empty string if no override is set."
},
{
"type": "int",
"name": "transitionDuration",
"description": "Transition duration. `-1` if no override is set."
}
],
"params": [
{
"type": "String",
"name": "sceneName",
"description": "Name of the scene to switch to."
}
],
"names": [
{
"name": "",
"description": "GetSceneTransitionOverride"
}
],
"categories": [
{
"name": "",
"description": "scenes"
}
],
"sinces": [
{
"name": "",
"description": "4.9.0"
}
],
"heading": {
"level": 2,
"text": "GetSceneTransitionOverride"
},
"lead": "",
"type": "class",
"examples": []
}
],
"sources": [

69
docs/generated/protocol.md
View File

@ -164,6 +164,9 @@ auth_response = base64_encode(auth_response_hash)
+ [GetCurrentScene](#getcurrentscene)
+ [GetSceneList](#getscenelist)
+ [ReorderSceneItems](#reordersceneitems)
+ [SetSceneTransitionOverride](#setscenetransitionoverride)
+ [RemoveSceneTransitionOverride](#removescenetransitionoverride)
+ [GetSceneTransitionOverride](#getscenetransitionoverride)
* [Sources](#sources-1)
+ [GetSourcesList](#getsourceslist)
+ [GetSourceTypesList](#getsourcetypeslist)
@ -2207,6 +2210,72 @@ Changes the order of scene items in the requested scene.
_No additional response items._
---
### SetSceneTransitionOverride
- Added in v4.9.0
Set a scene to use a specific transition override.
**Request Fields:**
| Name | Type | Description |
| ---- | :---: | ------------|
| `sceneName` | _String_ | Name of the scene to switch to. |
| `transitionName` | _String_ | Name of the transition to use. |
| `transitionDuration` | _int (Optional)_ | Duration in milliseconds of the transition if transition is not fixed. Defaults to the current duration specified in the UI if there is no current override and this value is not given. |
**Response Items:**
_No additional response items._
---
### RemoveSceneTransitionOverride
- Added in v4.9.0
Remove any transition override on a scene.
**Request Fields:**
| Name | Type | Description |
| ---- | :---: | ------------|
| `sceneName` | _String_ | Name of the scene to switch to. |
**Response Items:**
_No additional response items._
---
### GetSceneTransitionOverride
- Added in v4.9.0
Get the current scene transition override.
**Request Fields:**
| Name | Type | Description |
| ---- | :---: | ------------|
| `sceneName` | _String_ | Name of the scene to switch to. |
**Response Items:**
| Name | Type | Description |
| ---- | :---: | ------------|
| `transitionName` | _String_ | Name of the current overriding transition. Empty string if no override is set. |
| `transitionDuration` | _int_ | Transition duration. `-1` if no override is set. |
---
## Sources