docs(travis): Update protocol.md - 6bed39e [skip ci]

This commit is contained in:
Travis CI 2020-03-15 22:22:42 +00:00
parent 6bed39e4fa
commit 86191aff7f
2 changed files with 170 additions and 0 deletions

View File

@ -841,6 +841,134 @@
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "A transition (other than \"cut\") has ended.\nPlease note that the `from-scene` field is not available in TransitionEnd.",
"return": [
"{String} `name` Transition name.",
"{String} `type` Transition type.",
"{int} `duration` Transition duration (in milliseconds).",
"{String} `to-scene` Destination scene of the transition"
],
"api": "events",
"name": "TransitionEnd",
"category": "transitions",
"since": "4.8.0",
"returns": [
{
"type": "String",
"name": "name",
"description": "Transition name."
},
{
"type": "String",
"name": "type",
"description": "Transition type."
},
{
"type": "int",
"name": "duration",
"description": "Transition duration (in milliseconds)."
},
{
"type": "String",
"name": "to-scene",
"description": "Destination scene of the transition"
}
],
"names": [
{
"name": "",
"description": "TransitionEnd"
}
],
"categories": [
{
"name": "",
"description": "transitions"
}
],
"sinces": [
{
"name": "",
"description": "4.8.0"
}
],
"heading": {
"level": 2,
"text": "TransitionEnd"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "A stinger transition has finished playing its video.",
"return": [
"{String} `name` Transition name.",
"{String} `type` Transition type.",
"{int} `duration` Transition duration (in milliseconds).",
"{String} `from-scene` Source scene of the transition",
"{String} `to-scene` Destination scene of the transition"
],
"api": "events",
"name": "TransitionVideoEnd",
"category": "transitions",
"since": "4.8.0",
"returns": [
{
"type": "String",
"name": "name",
"description": "Transition name."
},
{
"type": "String",
"name": "type",
"description": "Transition type."
},
{
"type": "int",
"name": "duration",
"description": "Transition duration (in milliseconds)."
},
{
"type": "String",
"name": "from-scene",
"description": "Source scene of the transition"
},
{
"type": "String",
"name": "to-scene",
"description": "Destination scene of the transition"
}
],
"names": [
{
"name": "",
"description": "TransitionVideoEnd"
}
],
"categories": [
{
"name": "",
"description": "transitions"
}
],
"sinces": [
{
"name": "",
"description": "4.8.0"
}
],
"heading": {
"level": 2,
"text": "TransitionVideoEnd"
},
"lead": "",
"type": "class",
"examples": []
}
],
"profiles": [

View File

@ -59,6 +59,8 @@ auth_response = base64_encode(auth_response_hash)
+ [TransitionListChanged](#transitionlistchanged)
+ [TransitionDurationChanged](#transitiondurationchanged)
+ [TransitionBegin](#transitionbegin)
+ [TransitionEnd](#transitionend)
+ [TransitionVideoEnd](#transitionvideoend)
* [Profiles](#profiles)
+ [ProfileChanged](#profilechanged)
+ [ProfileListChanged](#profilelistchanged)
@ -442,6 +444,46 @@ A transition (other than "cut") has begun.
| `to-scene` | _String_ | Destination scene of the transition |
---
### TransitionEnd
- Added in v4.8.0
A transition (other than "cut") has ended.
Please note that the `from-scene` field is not available in TransitionEnd.
**Response Items:**
| Name | Type | Description |
| ---- | :---: | ------------|
| `name` | _String_ | Transition name. |
| `type` | _String_ | Transition type. |
| `duration` | _int_ | Transition duration (in milliseconds). |
| `to-scene` | _String_ | Destination scene of the transition |
---
### TransitionVideoEnd
- Added in v4.8.0
A stinger transition has finished playing its video.
**Response Items:**
| Name | Type | Description |
| ---- | :---: | ------------|
| `name` | _String_ | Transition name. |
| `type` | _String_ | Transition type. |
| `duration` | _int_ | Transition duration (in milliseconds). |
| `from-scene` | _String_ | Source scene of the transition |
| `to-scene` | _String_ | Destination scene of the transition |
---
## Profiles