Skip to content

Commit 5d12dfa

Browse files
author
Azure CI
committed
docs(ci): Update protocol.md - c428201 [skip ci]
1 parent c428201 commit 5d12dfa

File tree

2 files changed

+222
-0
lines changed

2 files changed

+222
-0
lines changed

‎docs/generated/comments.json‎

Lines changed: 153 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5467,6 +5467,159 @@
54675467
"lead": "",
54685468
"type": "class",
54695469
"examples": []
5470+
},
5471+
{
5472+
"subheads": [],
5473+
"description": "Set a scene to use a specific transition override.",
5474+
"param": [
5475+
"{String} `sceneName` Name of the scene to switch to.",
5476+
"{String} `transitionName` Name of the transition to use.",
5477+
"{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."
5478+
],
5479+
"api": "requests",
5480+
"name": "SetSceneTransitionOverride",
5481+
"category": "scenes",
5482+
"since": "4.9.0",
5483+
"params": [
5484+
{
5485+
"type": "String",
5486+
"name": "sceneName",
5487+
"description": "Name of the scene to switch to."
5488+
},
5489+
{
5490+
"type": "String",
5491+
"name": "transitionName",
5492+
"description": "Name of the transition to use."
5493+
},
5494+
{
5495+
"type": "int (Optional)",
5496+
"name": "transitionDuration",
5497+
"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."
5498+
}
5499+
],
5500+
"names": [
5501+
{
5502+
"name": "",
5503+
"description": "SetSceneTransitionOverride"
5504+
}
5505+
],
5506+
"categories": [
5507+
{
5508+
"name": "",
5509+
"description": "scenes"
5510+
}
5511+
],
5512+
"sinces": [
5513+
{
5514+
"name": "",
5515+
"description": "4.9.0"
5516+
}
5517+
],
5518+
"heading": {
5519+
"level": 2,
5520+
"text": "SetSceneTransitionOverride"
5521+
},
5522+
"lead": "",
5523+
"type": "class",
5524+
"examples": []
5525+
},
5526+
{
5527+
"subheads": [],
5528+
"description": "Remove any transition override on a scene.",
5529+
"param": "{String} `sceneName` Name of the scene to switch to.",
5530+
"api": "requests",
5531+
"name": "RemoveSceneTransitionOverride",
5532+
"category": "scenes",
5533+
"since": "4.9.0",
5534+
"params": [
5535+
{
5536+
"type": "String",
5537+
"name": "sceneName",
5538+
"description": "Name of the scene to switch to."
5539+
}
5540+
],
5541+
"names": [
5542+
{
5543+
"name": "",
5544+
"description": "RemoveSceneTransitionOverride"
5545+
}
5546+
],
5547+
"categories": [
5548+
{
5549+
"name": "",
5550+
"description": "scenes"
5551+
}
5552+
],
5553+
"sinces": [
5554+
{
5555+
"name": "",
5556+
"description": "4.9.0"
5557+
}
5558+
],
5559+
"heading": {
5560+
"level": 2,
5561+
"text": "RemoveSceneTransitionOverride"
5562+
},
5563+
"lead": "",
5564+
"type": "class",
5565+
"examples": []
5566+
},
5567+
{
5568+
"subheads": [],
5569+
"description": "Get the current scene transition override.",
5570+
"param": "{String} `sceneName` Name of the scene to switch to.",
5571+
"return": [
5572+
"{String} `transitionName` Name of the current overriding transition. Empty string if no override is set.",
5573+
"{int} `transitionDuration` Transition duration. `-1` if no override is set."
5574+
],
5575+
"api": "requests",
5576+
"name": "GetSceneTransitionOverride",
5577+
"category": "scenes",
5578+
"since": "4.9.0",
5579+
"returns": [
5580+
{
5581+
"type": "String",
5582+
"name": "transitionName",
5583+
"description": "Name of the current overriding transition. Empty string if no override is set."
5584+
},
5585+
{
5586+
"type": "int",
5587+
"name": "transitionDuration",
5588+
"description": "Transition duration. `-1` if no override is set."
5589+
}
5590+
],
5591+
"params": [
5592+
{
5593+
"type": "String",
5594+
"name": "sceneName",
5595+
"description": "Name of the scene to switch to."
5596+
}
5597+
],
5598+
"names": [
5599+
{
5600+
"name": "",
5601+
"description": "GetSceneTransitionOverride"
5602+
}
5603+
],
5604+
"categories": [
5605+
{
5606+
"name": "",
5607+
"description": "scenes"
5608+
}
5609+
],
5610+
"sinces": [
5611+
{
5612+
"name": "",
5613+
"description": "4.9.0"
5614+
}
5615+
],
5616+
"heading": {
5617+
"level": 2,
5618+
"text": "GetSceneTransitionOverride"
5619+
},
5620+
"lead": "",
5621+
"type": "class",
5622+
"examples": []
54705623
}
54715624
],
54725625
"sources": [

‎docs/generated/protocol.md‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,9 @@ auth_response = base64_encode(auth_response_hash)
164164
+ [GetCurrentScene](#getcurrentscene)
165165
+ [GetSceneList](#getscenelist)
166166
+ [ReorderSceneItems](#reordersceneitems)
167+
+ [SetSceneTransitionOverride](#setscenetransitionoverride)
168+
+ [RemoveSceneTransitionOverride](#removescenetransitionoverride)
169+
+ [GetSceneTransitionOverride](#getscenetransitionoverride)
167170
* [Sources](#sources-1)
168171
+ [GetSourcesList](#getsourceslist)
169172
+ [GetSourceTypesList](#getsourcetypeslist)
@@ -2207,6 +2210,72 @@ Changes the order of scene items in the requested scene.
22072210

22082211
_No additional response items._
22092212

2213+
---
2214+
2215+
### SetSceneTransitionOverride
2216+
2217+
2218+
- Added in v4.9.0
2219+
2220+
Set a scene to use a specific transition override.
2221+
2222+
**Request Fields:**
2223+
2224+
| Name | Type | Description |
2225+
| ---- | :---: | ------------|
2226+
| `sceneName` | _String_ | Name of the scene to switch to. |
2227+
| `transitionName` | _String_ | Name of the transition to use. |
2228+
| `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. |
2229+
2230+
2231+
**Response Items:**
2232+
2233+
_No additional response items._
2234+
2235+
---
2236+
2237+
### RemoveSceneTransitionOverride
2238+
2239+
2240+
- Added in v4.9.0
2241+
2242+
Remove any transition override on a scene.
2243+
2244+
**Request Fields:**
2245+
2246+
| Name | Type | Description |
2247+
| ---- | :---: | ------------|
2248+
| `sceneName` | _String_ | Name of the scene to switch to. |
2249+
2250+
2251+
**Response Items:**
2252+
2253+
_No additional response items._
2254+
2255+
---
2256+
2257+
### GetSceneTransitionOverride
2258+
2259+
2260+
- Added in v4.9.0
2261+
2262+
Get the current scene transition override.
2263+
2264+
**Request Fields:**
2265+
2266+
| Name | Type | Description |
2267+
| ---- | :---: | ------------|
2268+
| `sceneName` | _String_ | Name of the scene to switch to. |
2269+
2270+
2271+
**Response Items:**
2272+
2273+
| Name | Type | Description |
2274+
| ---- | :---: | ------------|
2275+
| `transitionName` | _String_ | Name of the current overriding transition. Empty string if no override is set. |
2276+
| `transitionDuration` | _int_ | Transition duration. `-1` if no override is set. |
2277+
2278+
22102279
---
22112280

22122281
## Sources

0 commit comments

Comments
 (0)