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: Mark from-scene as optional

Browse Source
This commit is contained in:
Dominik Nakamura
2021-03-21 14:53:45 +09:00
parent 035767bbbb
commit 7e0bc1fd10
4 changed files with 5193 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/generated/comments.json
View File

@ -861,7 +861,7 @@
"{String} `name` Transition name.", "{String} `name` Transition name.",
"{String} `type` Transition type.", "{String} `type` Transition type.",
"{int} `duration` Transition duration (in milliseconds). Will be -1 for any transition with a fixed duration, such as a Stinger, due to limitations of the OBS API.", "{int} `duration` Transition duration (in milliseconds). Will be -1 for any transition with a fixed duration, such as a Stinger, due to limitations of the OBS API.",
"{String} `from-scene` Source scene of the transition", "{String (optional)} `from-scene` Source scene of the transition",
"{String} `to-scene` Destination scene of the transition" "{String} `to-scene` Destination scene of the transition"
], ],
"api": "events", "api": "events",
@ -885,7 +885,7 @@
"description": "Transition duration (in milliseconds). Will be -1 for any transition with a fixed duration, such as a Stinger, due to limitations of the OBS API." "description": "Transition duration (in milliseconds). Will be -1 for any transition with a fixed duration, such as a Stinger, due to limitations of the OBS API."
}, },
{ {
"type": "String", "type": "String (optional)",
"name": "from-scene", "name": "from-scene",
"description": "Source scene of the transition" "description": "Source scene of the transition"
}, },
@ -989,7 +989,7 @@
"{String} `name` Transition name.", "{String} `name` Transition name.",
"{String} `type` Transition type.", "{String} `type` Transition type.",
"{int} `duration` Transition duration (in milliseconds).", "{int} `duration` Transition duration (in milliseconds).",
"{String} `from-scene` Source scene of the transition", "{String (optional)} `from-scene` Source scene of the transition",
"{String} `to-scene` Destination scene of the transition" "{String} `to-scene` Destination scene of the transition"
], ],
"api": "events", "api": "events",
@ -1013,7 +1013,7 @@
"description": "Transition duration (in milliseconds)." "description": "Transition duration (in milliseconds)."
}, },
{ {
"type": "String", "type": "String (optional)",
"name": "from-scene", "name": "from-scene",
"description": "Source scene of the transition" "description": "Source scene of the transition"
}, },

4
docs/generated/protocol.md
View File

@ -516,7 +516,7 @@ A transition (other than "cut") has begun.
| `name` | _String_ | Transition name. | | `name` | _String_ | Transition name. |
| `type` | _String_ | Transition type. | | `type` | _String_ | Transition type. |
| `duration` | _int_ | Transition duration (in milliseconds). Will be -1 for any transition with a fixed duration, such as a Stinger, due to limitations of the OBS API. | | `duration` | _int_ | Transition duration (in milliseconds). Will be -1 for any transition with a fixed duration, such as a Stinger, due to limitations of the OBS API. |
| `from-scene` | _String_ | Source scene of the transition | | `from-scene` | _String (optional)_ | Source scene of the transition |
| `to-scene` | _String_ | Destination scene of the transition | | `to-scene` | _String_ | Destination scene of the transition |
@ -556,7 +556,7 @@ A stinger transition has finished playing its video.
| `name` | _String_ | Transition name. | | `name` | _String_ | Transition name. |
| `type` | _String_ | Transition type. | | `type` | _String_ | Transition type. |
| `duration` | _int_ | Transition duration (in milliseconds). | | `duration` | _int_ | Transition duration (in milliseconds). |
| `from-scene` | _String_ | Source scene of the transition | | `from-scene` | _String (optional)_ | Source scene of the transition |
| `to-scene` | _String_ | Destination scene of the transition | | `to-scene` | _String_ | Destination scene of the transition |

5168
docs/npm-shrinkwrap.json generated Normal file
View File

File diff suppressed because it is too large Load Diff

4
src/WSEvents.cpp
View File

@ -1002,7 +1002,7 @@ void WSEvents::TransitionDurationChanged(int ms) {
* @return {int} `duration` Transition duration (in milliseconds). * @return {int} `duration` Transition duration (in milliseconds).
* Will be -1 for any transition with a fixed duration, * Will be -1 for any transition with a fixed duration,
* such as a Stinger, due to limitations of the OBS API. * such as a Stinger, due to limitations of the OBS API.
* @return {String} `from-scene` Source scene of the transition * @return {String (optional)} `from-scene` Source scene of the transition
* @return {String} `to-scene` Destination scene of the transition * @return {String} `to-scene` Destination scene of the transition
* *
* @api events * @api events
@ -1054,7 +1054,7 @@ void WSEvents::OnTransitionEnd(void* param, calldata_t* data) {
* @return {String} `name` Transition name. * @return {String} `name` Transition name.
* @return {String} `type` Transition type. * @return {String} `type` Transition type.
* @return {int} `duration` Transition duration (in milliseconds). * @return {int} `duration` Transition duration (in milliseconds).
* @return {String} `from-scene` Source scene of the transition * @return {String (optional)} `from-scene` Source scene of the transition
* @return {String} `to-scene` Destination scene of the transition * @return {String} `to-scene` Destination scene of the transition
* *
* @api events * @api events