Skip to content

Commit

Permalink
docs(ci): Update protocol.md - c428201 [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
Azure CI committed May 26, 2020
1 parent c428201 commit 5d12dfa
Show file tree
Hide file tree
Showing 2 changed files with 222 additions and 0 deletions.
153 changes: 153 additions & 0 deletions docs/generated/comments.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
Expand Down
69 changes: 69 additions & 0 deletions docs/generated/protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 5d12dfa

Please sign in to comment.