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

38
src/WSEvents.cpp
View File

@ -124,7 +124,7 @@ void WSEvents::FrontendEventHandler(enum obs_frontend_event event, void* private
case OBS_FRONTEND_EVENT_FINISHED_LOADING: case OBS_FRONTEND_EVENT_FINISHED_LOADING:
owner->hookTransitionPlaybackEvents(); owner->hookTransitionPlaybackEvents();
break; break;
case OBS_FRONTEND_EVENT_SCENE_CHANGED: case OBS_FRONTEND_EVENT_SCENE_CHANGED:
owner->OnSceneChange(); owner->OnSceneChange();
break; break;
@ -278,7 +278,7 @@ void WSEvents::connectSourceSignals(obs_source_t* source) {
signal_handler_connect(sh, "filter_add", OnSourceFilterAdded, this); signal_handler_connect(sh, "filter_add", OnSourceFilterAdded, this);
signal_handler_connect(sh, "filter_remove", OnSourceFilterRemoved, this); signal_handler_connect(sh, "filter_remove", OnSourceFilterRemoved, this);
signal_handler_connect(sh, "reorder_filters", OnSourceFilterOrderChanged, this); signal_handler_connect(sh, "reorder_filters", OnSourceFilterOrderChanged, this);
signal_handler_connect(sh, "media_play", OnMediaPlaying, this); signal_handler_connect(sh, "media_play", OnMediaPlaying, this);
signal_handler_connect(sh, "media_pause", OnMediaPaused, this); signal_handler_connect(sh, "media_pause", OnMediaPaused, this);
signal_handler_connect(sh, "media_restart", OnMediaRestarted, this); signal_handler_connect(sh, "media_restart", OnMediaRestarted, this);
@ -336,7 +336,7 @@ void WSEvents::disconnectSourceSignals(obs_source_t* source) {
signal_handler_disconnect(sh, "transition_start", OnTransitionBegin, this); signal_handler_disconnect(sh, "transition_start", OnTransitionBegin, this);
signal_handler_disconnect(sh, "transition_stop", OnTransitionEnd, this); signal_handler_disconnect(sh, "transition_stop", OnTransitionEnd, this);
signal_handler_disconnect(sh, "transition_video_stop", OnTransitionVideoEnd, this); signal_handler_disconnect(sh, "transition_video_stop", OnTransitionVideoEnd, this);
signal_handler_disconnect(sh, "media_play", OnMediaPlaying, this); signal_handler_disconnect(sh, "media_play", OnMediaPlaying, this);
signal_handler_disconnect(sh, "media_pause", OnMediaPaused, this); signal_handler_disconnect(sh, "media_pause", OnMediaPaused, this);
signal_handler_disconnect(sh, "media_restart", OnMediaRestarted, this); signal_handler_disconnect(sh, "media_restart", OnMediaRestarted, this);
@ -469,7 +469,7 @@ void WSEvents::OnSceneChange() {
* Note: This event is not fired when the scenes are reordered. * Note: This event is not fired when the scenes are reordered.
* *
* @return {Array<Scene>} `scenes` Scenes list. * @return {Array<Scene>} `scenes` Scenes list.
* *
* @api events * @api events
* @name ScenesChanged * @name ScenesChanged
* @category scenes * @category scenes
@ -487,7 +487,7 @@ void WSEvents::OnSceneListChange() {
* Triggered when switching to another scene collection or when renaming the current scene collection. * Triggered when switching to another scene collection or when renaming the current scene collection.
* *
* @return {String} `sceneCollection` Name of the new current scene collection. * @return {String} `sceneCollection` Name of the new current scene collection.
* *
* @api events * @api events
* @name SceneCollectionChanged * @name SceneCollectionChanged
* @category scenes * @category scenes
@ -510,7 +510,7 @@ void WSEvents::OnSceneCollectionChange() {
* *
* @return {Array<Object>} `sceneCollections` Scene collections list. * @return {Array<Object>} `sceneCollections` Scene collections list.
* @return {String} `sceneCollections.*.name` Scene collection name. * @return {String} `sceneCollections.*.name` Scene collection name.
* *
* @api events * @api events
* @name SceneCollectionListChanged * @name SceneCollectionListChanged
* @category scenes * @category scenes
@ -553,7 +553,7 @@ void WSEvents::OnTransitionChange() {
* *
* @return {Array<Object>} `transitions` Transitions list. * @return {Array<Object>} `transitions` Transitions list.
* @return {String} `transitions.*.name` Transition name. * @return {String} `transitions.*.name` Transition name.
* *
* @api events * @api events
* @name TransitionListChanged * @name TransitionListChanged
* @category transitions * @category transitions
@ -582,7 +582,7 @@ void WSEvents::OnTransitionListChange() {
* Triggered when switching to another profile or when renaming the current profile. * Triggered when switching to another profile or when renaming the current profile.
* *
* @return {String} `profile` Name of the new current profile. * @return {String} `profile` Name of the new current profile.
* *
* @api events * @api events
* @name ProfileChanged * @name ProfileChanged
* @category profiles * @category profiles
@ -599,7 +599,7 @@ void WSEvents::OnProfileChange() {
* *
* @return {Array<Object>} `profiles` Profiles list. * @return {Array<Object>} `profiles` Profiles list.
* @return {String} `profiles.*.name` Profile name. * @return {String} `profiles.*.name` Profile name.
* *
* @api events * @api events
* @name ProfileListChanged * @name ProfileListChanged
* @category profiles * @category profiles
@ -679,10 +679,10 @@ void WSEvents::OnStreamStopped() {
/** /**
* A request to start recording has been issued. * A request to start recording has been issued.
* *
* Note: `recordingFilename` is not provided in this event because this information * Note: `recordingFilename` is not provided in this event because this information
* is not available at the time this event is emitted. * is not available at the time this event is emitted.
* *
* @api events * @api events
* @name RecordingStarting * @name RecordingStarting
* @category recording * @category recording
@ -696,7 +696,7 @@ void WSEvents::OnRecordingStarting() {
* Recording started successfully. * Recording started successfully.
* *
* @return {String} `recordingFilename` Absolute path to the file of the current recording. * @return {String} `recordingFilename` Absolute path to the file of the current recording.
* *
* @api events * @api events
* @name RecordingStarted * @name RecordingStarted
* @category recording * @category recording
@ -712,7 +712,7 @@ void WSEvents::OnRecordingStarted() {
* A request to stop recording has been issued. * A request to stop recording has been issued.
* *
* @return {String} `recordingFilename` Absolute path to the file of the current recording. * @return {String} `recordingFilename` Absolute path to the file of the current recording.
* *
* @api events * @api events
* @name RecordingStopping * @name RecordingStopping
* @category recording * @category recording
@ -728,7 +728,7 @@ void WSEvents::OnRecordingStopping() {
* Recording stopped successfully. * Recording stopped successfully.
* *
* @return {String} `recordingFilename` Absolute path to the file of the current recording. * @return {String} `recordingFilename` Absolute path to the file of the current recording.
* *
* @api events * @api events
* @name RecordingStopped * @name RecordingStopped
* @category recording * @category recording
@ -999,10 +999,10 @@ void WSEvents::TransitionDurationChanged(int ms) {
* *
* @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).
* 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
@ -1387,7 +1387,7 @@ void WSEvents::OnSourceFilterAdded(void* param, calldata_t* data) {
if (!filter) { if (!filter) {
return; return;
} }
self->connectFilterSignals(filter); self->connectFilterSignals(filter);
OBSDataAutoRelease filterSettings = obs_source_get_settings(filter); OBSDataAutoRelease filterSettings = obs_source_get_settings(filter);