base: Update version to 5.4.0

New Features:
- Added `GetSourceFilterKindList` request
- Added `GetSceneItemSource` request
- Added `InputSettingsChanged` event
- Added `SourceFilterSettingsChanged` event
- Added UUID support to Sources (Inputs/Scenes), Inputs, Scenes,
Transitions
  - The `Source` requests/events use `sourceUuid`
  - The `Input` requests/events use `inputUuid`
  - The `Scene` requests/events use `sceneUuid`
  - The `Transition` requests/events use `transitionUuid`
  - Filters do not have support for UUIDs at this time.

Enhancements:
- Added `contextName` field to `TriggerHotkeyByName` (exeldro)

Bug Fixes:
- Fixed a crash on shutdown with notifications enabled (r1ch)
- Added safety check to prevent `null` `outputCongestion` values in
`GetStreamStatus`
- Fixed a memory leak when switching service kinds via
`SetStreamServiceSettings`

Other Notes:
- Documented missing `outputActive` `ToggleRecord` response field
- Added a few new client softwares to the README list
- Removed a mis-documented `imageData` field
- Added a note to the hotkey requests that they are as-is and we
will not provide support for them

CMakeLists.txt

@@ -2,7 +2,7 @@ cmake_minimum_required(VERSION 3.16...3.25)
 
 legacy_check()
 
-set(obs-websocket_VERSION 5.3.5)
+set(obs-websocket_VERSION 5.4.0)
 set(OBS_WEBSOCKET_RPC_VERSION 1)
 
 option(ENABLE_WEBSOCKET "Enable building OBS with websocket plugin" ON)

README.md

@@ -41,6 +41,8 @@ It is **highly recommended** to keep obs-websocket protected with a password aga
 - [Aitum](https://aitum.tv/)
 - [Kruiz Control](https://github.com/Kruiser8/Kruiz-Control)
 - [Bitfocus Companion Module](https://bitfocus.io/companion/)
+- [MacroGraph](https://github.com/Brendonovich/macrograph) - hosted client [here](https://macrograph.brendonovich.dev/)
+- [MATRIC](https://matricapp.com/)
 
 ### Client libraries (for developers)
 
@@ -49,7 +51,7 @@ Here's a list of available language APIs for obs-websocket:
 - Python 3.7+ (Asyncio): [simpleobsws](https://github.com/IRLToolkit/simpleobsws/tree/master) by IRLToolkit
 - Python 3.10+ (Non-Asyncio): [obsws-python](https://pypi.org/project/obsws-python) by aatikturk and onyx-and-iris
 - Rust: [obws](https://github.com/dnaka91/obws) by dnaka91
-- Godot 3.4.x: [obs-websocket-gd](https://github.com/you-win/obs-websocket-gd) by you-win
+- Godot 4.0.x: [obs-websocket-gd](https://github.com/you-win/obs-websocket-gd) by you-win
 - Javascript (Node and web): [obs-websocket-js](https://github.com/obs-websocket-community-projects/obs-websocket-js) by OBS Websocket Community
   - C (uses obs-websocket-js): [v8-libwebsocket-obs-websocket](https://github.com/dgatwood/v8-libwebsocket-obs-websocket)
 - Go: [goobs](https://github.com/andreykaipov/goobs) by andreykaipov

cmake/legacy.cmake

@@ -1,4 +1,4 @@
-project(obs-websocket VERSION 5.3.5)
+project(obs-websocket VERSION 5.4.0)
 set(OBS_WEBSOCKET_RPC_VERSION 1)
 
 option(ENABLE_WEBSOCKET "Enable building OBS with websocket plugin" ON)

lib/obs-websocket-api.h

@@ -44,7 +44,7 @@ struct obs_websocket_request_callback {
 	void *priv_data;
 };
 
-inline proc_handler_t *_ph;
+static proc_handler_t *_ph;
 
 /* ==================== INTERNAL API FUNCTIONS ==================== */
 
@@ -53,7 +53,7 @@ static inline proc_handler_t *obs_websocket_get_ph(void)
 	proc_handler_t *global_ph = obs_get_proc_handler();
 	assert(global_ph != NULL);
 
-	calldata_t cd = {0};
+	calldata_t cd = {0, 0, 0, 0};
 	if (!proc_handler_call(global_ph, "obs_websocket_api_get_ph", &cd))
 		blog(LOG_DEBUG, "Unable to fetch obs-websocket proc handler object. obs-websocket not installed?");
 	proc_handler_t *ret = (proc_handler_t *)calldata_ptr(&cd, "ph");
@@ -91,7 +91,7 @@ static inline unsigned int obs_websocket_get_api_version(void)
 	if (!obs_websocket_ensure_ph())
 		return 0;
 
-	calldata_t cd = {0};
+	calldata_t cd = {0, 0, 0, 0};
 
 	if (!proc_handler_call(_ph, "get_api_version", &cd))
 		return 1; // API v1 does not include get_api_version
@@ -104,7 +104,11 @@ static inline unsigned int obs_websocket_get_api_version(void)
 }
 
 // Calls an obs-websocket request. Free response with `obs_websocket_request_response_free()`
-static inline obs_websocket_request_response *obs_websocket_call_request(const char *request_type, obs_data_t *request_data = NULL)
+static inline struct obs_websocket_request_response *obs_websocket_call_request(const char *request_type, obs_data_t *request_data
+#ifdef __cplusplus
+													  = NULL
+#endif
+)
 {
 	if (!obs_websocket_ensure_ph())
 		return NULL;
@@ -113,14 +117,14 @@ static inline obs_websocket_request_response *obs_websocket_call_request(const c
 	if (request_data)
 		request_data_string = obs_data_get_json(request_data);
 
-	calldata_t cd = {0};
+	calldata_t cd = {0, 0, 0, 0};
 
 	calldata_set_string(&cd, "request_type", request_type);
 	calldata_set_string(&cd, "request_data", request_data_string);
 
 	proc_handler_call(_ph, "call_request", &cd);
 
-	auto ret = (struct obs_websocket_request_response *)calldata_ptr(&cd, "response");
+	struct obs_websocket_request_response *ret = (struct obs_websocket_request_response *)calldata_ptr(&cd, "response");
 
 	calldata_free(&cd);
 
@@ -149,7 +153,7 @@ static inline obs_websocket_vendor obs_websocket_register_vendor(const char *ven
 	if (!obs_websocket_ensure_ph())
 		return NULL;
 
-	calldata_t cd = {0};
+	calldata_t cd = {0, 0, 0, 0};
 
 	calldata_set_string(&cd, "name", vendor_name);
 
@@ -164,11 +168,9 @@ static inline obs_websocket_vendor obs_websocket_register_vendor(const char *ven
 static inline bool obs_websocket_vendor_register_request(obs_websocket_vendor vendor, const char *request_type,
 							 obs_websocket_request_callback_function request_callback, void *priv_data)
 {
-	calldata_t cd = {0};
+	calldata_t cd = {0, 0, 0, 0};
 
-	struct obs_websocket_request_callback cb = {};
-	cb.callback = request_callback;
-	cb.priv_data = priv_data;
+	struct obs_websocket_request_callback cb = {request_callback, priv_data};
 
 	calldata_set_string(&cd, "type", request_type);
 	calldata_set_ptr(&cd, "callback", &cb);
@@ -182,7 +184,7 @@ static inline bool obs_websocket_vendor_register_request(obs_websocket_vendor ve
 // Unregisters an existing vendor request
 static inline bool obs_websocket_vendor_unregister_request(obs_websocket_vendor vendor, const char *request_type)
 {
-	calldata_t cd = {0};
+	calldata_t cd = {0, 0, 0, 0};
 
 	calldata_set_string(&cd, "type", request_type);
 
@@ -196,7 +198,7 @@ static inline bool obs_websocket_vendor_unregister_request(obs_websocket_vendor
 // Emits an event under the vendor's name
 static inline bool obs_websocket_vendor_emit_event(obs_websocket_vendor vendor, const char *event_name, obs_data_t *event_data)
 {
-	calldata_t cd = {0};
+	calldata_t cd = {0, 0, 0, 0};
 
 	calldata_set_string(&cd, "type", event_name);
 	calldata_set_ptr(&cd, "data", (void *)event_data);

src/eventhandler/EventHandler.cpp

@@ -602,6 +602,9 @@ void EventHandler::SourceUpdatedMultiHandler(void *param, calldata_t *data)
 	case OBS_SOURCE_TYPE_INPUT:
 		eventHandler->HandleInputSettingsChanged(source);
 		break;
+	case OBS_SOURCE_TYPE_FILTER:
+		eventHandler->HandleSourceFilterSettingsChanged(source);
+		break;
 	default:
 		break;
 	}

src/eventhandler/EventHandler.h

@@ -147,6 +147,7 @@ private:
 	void HandleSourceFilterRemoved(obs_source_t *source, obs_source_t *filter);
 	static void HandleSourceFilterNameChanged(void *param,
 						  calldata_t *data);                     // Direct callback
+	void HandleSourceFilterSettingsChanged(obs_source_t *source);
 	static void HandleSourceFilterEnableStateChanged(void *param, calldata_t *data); // Direct callback
 
 	// Outputs

src/eventhandler/EventHandler_Filters.cpp

@@ -163,6 +163,32 @@ void EventHandler::HandleSourceFilterNameChanged(void *param, calldata_t *data)
 	eventHandler->BroadcastEvent(EventSubscription::Filters, "SourceFilterNameChanged", eventData);
 }
 
+/**
+ * An source filter's settings have changed (been updated).
+ *
+ * @dataField sourceName     | String | Name of the source the filter is on
+ * @dataField filterName     | String | Name of the filter
+ * @dataField filterSettings | Object | New settings object of the filter
+ *
+ * @eventType SourceFilterSettingsChanged
+ * @eventSubscription Filters
+ * @complexity 3
+ * @rpcVersion -1
+ * @initialVersion 5.4.0
+ * @api events
+ * @category filters
+ */
+void EventHandler::HandleSourceFilterSettingsChanged(obs_source_t *source)
+{
+	OBSDataAutoRelease filterSettings = obs_source_get_settings(source);
+
+	json eventData;
+	eventData["sourceName"] = obs_source_get_name(obs_filter_get_parent(source));
+	eventData["filterName"] = obs_source_get_name(source);
+	eventData["filterSettings"] = Utils::Json::ObsDataToJson(filterSettings);
+	BroadcastEvent(EventSubscription::Filters, "SourceFilterSettingsChanged", eventData);
+}
+
 /**
  * A source filter's enable state has changed.
  *

src/eventhandler/EventHandler_Inputs.cpp

@@ -23,6 +23,7 @@ with this program. If not, see <https://www.gnu.org/licenses/>
  * An input has been created.
  *
  * @dataField inputName            | String | Name of the input
+ * @dataField inputUuid            | String | UUID of the input
  * @dataField inputKind            | String | The kind of the input
  * @dataField unversionedInputKind | String | The unversioned kind of input (aka no `_v2` stuff)
  * @dataField inputSettings        | Object | The settings configured to the input when it was created
@@ -44,6 +45,7 @@ void EventHandler::HandleInputCreated(obs_source_t *source)
 
 	json eventData;
 	eventData["inputName"] = obs_source_get_name(source);
+	eventData["inputUuid"] = obs_source_get_uuid(source);
 	eventData["inputKind"] = inputKind;
 	eventData["unversionedInputKind"] = obs_source_get_unversioned_id(source);
 	eventData["inputSettings"] = Utils::Json::ObsDataToJson(inputSettings);
@@ -55,6 +57,7 @@ void EventHandler::HandleInputCreated(obs_source_t *source)
  * An input has been removed.
  *
  * @dataField inputName | String | Name of the input
+ * @dataField inputUuid | String | UUID of the input
  *
  * @eventType InputRemoved
  * @eventSubscription Inputs
@@ -68,12 +71,14 @@ void EventHandler::HandleInputRemoved(obs_source_t *source)
 {
 	json eventData;
 	eventData["inputName"] = obs_source_get_name(source);
+	eventData["inputUuid"] = obs_source_get_uuid(source);
 	BroadcastEvent(EventSubscription::Inputs, "InputRemoved", eventData);
 }
 
 /**
  * The name of an input has changed.
  *
+ * @dataField inputUuid    | String | UUID of the input
  * @dataField oldInputName | String | Old name of the input
  * @dataField inputName    | String | New name of the input
  *
@@ -85,9 +90,10 @@ void EventHandler::HandleInputRemoved(obs_source_t *source)
  * @api events
  * @category inputs
  */
-void EventHandler::HandleInputNameChanged(obs_source_t *, std::string oldInputName, std::string inputName)
+void EventHandler::HandleInputNameChanged(obs_source_t *source, std::string oldInputName, std::string inputName)
 {
 	json eventData;
+	eventData["inputUuid"] = obs_source_get_uuid(source);
 	eventData["oldInputName"] = oldInputName;
 	eventData["inputName"] = inputName;
 	BroadcastEvent(EventSubscription::Inputs, "InputNameChanged", eventData);
@@ -99,6 +105,7 @@ void EventHandler::HandleInputNameChanged(obs_source_t *, std::string oldInputNa
  * Note: On some inputs, changing values in the properties dialog will cause an immediate update. Pressing the "Cancel" button will revert the settings, resulting in another event being fired.
  *
  * @dataField inputName     | String | Name of the input
+ * @dataField inputUuid     | String | UUID of the input
  * @dataField inputSettings | Object | New settings object of the input
  *
  * @eventType InputSettingsChanged
@@ -115,6 +122,7 @@ void EventHandler::HandleInputSettingsChanged(obs_source_t *source)
 
 	json eventData;
 	eventData["inputName"] = obs_source_get_name(source);
+	eventData["inputUuid"] = obs_source_get_uuid(source);
 	eventData["inputSettings"] = Utils::Json::ObsDataToJson(inputSettings);
 	BroadcastEvent(EventSubscription::Inputs, "InputSettingsChanged", eventData);
 }
@@ -125,6 +133,7 @@ void EventHandler::HandleInputSettingsChanged(obs_source_t *source)
  * When an input is active, it means it's being shown by the program feed.
  *
  * @dataField inputName   | String  | Name of the input
+ * @dataField inputUuid   | String  | UUID of the input
  * @dataField videoActive | Boolean | Whether the input is active
  *
  * @eventType InputActiveStateChanged
@@ -151,6 +160,7 @@ void EventHandler::HandleInputActiveStateChanged(void *param, calldata_t *data)
 
 	json eventData;
 	eventData["inputName"] = obs_source_get_name(source);
+	eventData["inputUuid"] = obs_source_get_uuid(source);
 	eventData["videoActive"] = obs_source_active(source);
 	eventHandler->BroadcastEvent(EventSubscription::InputActiveStateChanged, "InputActiveStateChanged", eventData);
 }
@@ -161,6 +171,7 @@ void EventHandler::HandleInputActiveStateChanged(void *param, calldata_t *data)
  * When an input is showing, it means it's being shown by the preview or a dialog.
  *
  * @dataField inputName    | String  | Name of the input
+ * @dataField inputUuid    | String  | UUID of the input
  * @dataField videoShowing | Boolean | Whether the input is showing
  *
  * @eventType InputShowStateChanged
@@ -187,6 +198,7 @@ void EventHandler::HandleInputShowStateChanged(void *param, calldata_t *data)
 
 	json eventData;
 	eventData["inputName"] = obs_source_get_name(source);
+	eventData["inputUuid"] = obs_source_get_uuid(source);
 	eventData["videoShowing"] = obs_source_showing(source);
 	eventHandler->BroadcastEvent(EventSubscription::InputShowStateChanged, "InputShowStateChanged", eventData);
 }
@@ -195,6 +207,7 @@ void EventHandler::HandleInputShowStateChanged(void *param, calldata_t *data)
  * An input's mute state has changed.
  *
  * @dataField inputName  | String  | Name of the input
+ * @dataField inputUuid  | String  | UUID of the input
  * @dataField inputMuted | Boolean | Whether the input is muted
  *
  * @eventType InputMuteStateChanged
@@ -218,6 +231,7 @@ void EventHandler::HandleInputMuteStateChanged(void *param, calldata_t *data)
 
 	json eventData;
 	eventData["inputName"] = obs_source_get_name(source);
+	eventData["inputUuid"] = obs_source_get_uuid(source);
 	eventData["inputMuted"] = obs_source_muted(source);
 	eventHandler->BroadcastEvent(EventSubscription::Inputs, "InputMuteStateChanged", eventData);
 }
@@ -226,6 +240,7 @@ void EventHandler::HandleInputMuteStateChanged(void *param, calldata_t *data)
  * An input's volume level has changed.
  *
  * @dataField inputName      | String | Name of the input
+ * @dataField inputUuid      | String | UUID of the input
  * @dataField inputVolumeMul | Number | New volume level multiplier
  * @dataField inputVolumeDb  | Number | New volume level in dB
  *
@@ -257,6 +272,7 @@ void EventHandler::HandleInputVolumeChanged(void *param, calldata_t *data)
 
 	json eventData;
 	eventData["inputName"] = obs_source_get_name(source);
+	eventData["inputUuid"] = obs_source_get_uuid(source);
 	eventData["inputVolumeMul"] = inputVolumeMul;
 	eventData["inputVolumeDb"] = inputVolumeDb;
 	eventHandler->BroadcastEvent(EventSubscription::Inputs, "InputVolumeChanged", eventData);
@@ -265,7 +281,8 @@ void EventHandler::HandleInputVolumeChanged(void *param, calldata_t *data)
 /**
  * The audio balance value of an input has changed.
  *
- * @dataField inputName         | String | Name of the affected input
+ * @dataField inputName         | String | Name of the input
+ * @dataField inputUuid         | String | UUID of the input
  * @dataField inputAudioBalance | Number | New audio balance value of the input
  *
  * @eventType InputAudioBalanceChanged
@@ -291,6 +308,7 @@ void EventHandler::HandleInputAudioBalanceChanged(void *param, calldata_t *data)
 
 	json eventData;
 	eventData["inputName"] = obs_source_get_name(source);
+	eventData["inputUuid"] = obs_source_get_uuid(source);
 	eventData["inputAudioBalance"] = inputAudioBalance;
 	eventHandler->BroadcastEvent(EventSubscription::Inputs, "InputAudioBalanceChanged", eventData);
 }
@@ -299,6 +317,7 @@ void EventHandler::HandleInputAudioBalanceChanged(void *param, calldata_t *data)
  * The sync offset of an input has changed.
  *
  * @dataField inputName            | String | Name of the input
+ * @dataField inputUuid            | String | UUID of the input
  * @dataField inputAudioSyncOffset | Number | New sync offset in milliseconds
  *
  * @eventType InputAudioSyncOffsetChanged
@@ -324,6 +343,7 @@ void EventHandler::HandleInputAudioSyncOffsetChanged(void *param, calldata_t *da
 
 	json eventData;
 	eventData["inputName"] = obs_source_get_name(source);
+	eventData["inputUuid"] = obs_source_get_uuid(source);
 	eventData["inputAudioSyncOffset"] = inputAudioSyncOffset / 1000000;
 	eventHandler->BroadcastEvent(EventSubscription::Inputs, "InputAudioSyncOffsetChanged", eventData);
 }
@@ -332,6 +352,7 @@ void EventHandler::HandleInputAudioSyncOffsetChanged(void *param, calldata_t *da
  * The audio tracks of an input have changed.
  *
  * @dataField inputName        | String | Name of the input
+ * @dataField inputUuid        | String | UUID of the input
  * @dataField inputAudioTracks | Object | Object of audio tracks along with their associated enable states
  *
  * @eventType InputAudioTracksChanged
@@ -362,6 +383,7 @@ void EventHandler::HandleInputAudioTracksChanged(void *param, calldata_t *data)
 
 	json eventData;
 	eventData["inputName"] = obs_source_get_name(source);
+	eventData["inputUuid"] = obs_source_get_uuid(source);
 	eventData["inputAudioTracks"] = inputAudioTracks;
 	eventHandler->BroadcastEvent(EventSubscription::Inputs, "InputAudioTracksChanged", eventData);
 }
@@ -376,6 +398,7 @@ void EventHandler::HandleInputAudioTracksChanged(void *param, calldata_t *data)
  * - `OBS_MONITORING_TYPE_MONITOR_AND_OUTPUT`
  *
  * @dataField inputName   | String | Name of the input
+ * @dataField inputUuid   | String | UUID of the input
  * @dataField monitorType | String | New monitor type of the input
  *
  * @eventType InputAudioMonitorTypeChanged
@@ -401,6 +424,7 @@ void EventHandler::HandleInputAudioMonitorTypeChanged(void *param, calldata_t *d
 
 	json eventData;
 	eventData["inputName"] = obs_source_get_name(source);
+	eventData["inputUuid"] = obs_source_get_uuid(source);
 	eventData["monitorType"] = monitorType;
 	eventHandler->BroadcastEvent(EventSubscription::Inputs, "InputAudioMonitorTypeChanged", eventData);
 }

src/eventhandler/EventHandler_MediaInputs.cpp

@@ -124,6 +124,7 @@ void EventHandler::SourceMediaPreviousMultiHandler(void *param, calldata_t *data
  * A media input has started playing.
  *
  * @dataField inputName | String | Name of the input
+ * @dataField inputUuid | String | UUID of the input
  *
  * @eventType MediaInputPlaybackStarted
  * @eventSubscription MediaInputs
@@ -146,6 +147,7 @@ void EventHandler::HandleMediaInputPlaybackStarted(void *param, calldata_t *data
 
 	json eventData;
 	eventData["inputName"] = obs_source_get_name(source);
+	eventData["inputUuid"] = obs_source_get_uuid(source);
 	eventHandler->BroadcastEvent(EventSubscription::MediaInputs, "MediaInputPlaybackStarted", eventData);
 }
 
@@ -153,6 +155,7 @@ void EventHandler::HandleMediaInputPlaybackStarted(void *param, calldata_t *data
  * A media input has finished playing.
  *
  * @dataField inputName | String | Name of the input
+ * @dataField inputUuid | String | UUID of the input
  *
  * @eventType MediaInputPlaybackEnded
  * @eventSubscription MediaInputs
@@ -175,6 +178,7 @@ void EventHandler::HandleMediaInputPlaybackEnded(void *param, calldata_t *data)
 
 	json eventData;
 	eventData["inputName"] = obs_source_get_name(source);
+	eventData["inputUuid"] = obs_source_get_uuid(source);
 	eventHandler->BroadcastEvent(EventSubscription::MediaInputs, "MediaInputPlaybackEnded", eventData);
 }
 
@@ -182,6 +186,7 @@ void EventHandler::HandleMediaInputPlaybackEnded(void *param, calldata_t *data)
  * An action has been performed on an input.
  *
  * @dataField inputName   | String | Name of the input
+ * @dataField inputUuid   | String | UUID of the input
  * @dataField mediaAction | String | Action performed on the input. See `ObsMediaInputAction` enum
  *
  * @eventType MediaInputActionTriggered
@@ -196,6 +201,7 @@ void EventHandler::HandleMediaInputActionTriggered(obs_source_t *source, ObsMedi
 {
 	json eventData;
 	eventData["inputName"] = obs_source_get_name(source);
+	eventData["inputUuid"] = obs_source_get_uuid(source);
 	eventData["mediaAction"] = GetMediaInputActionString(action);
 	BroadcastEvent(EventSubscription::MediaInputs, "MediaInputActionTriggered", eventData);
 }

src/eventhandler/EventHandler_SceneItems.cpp

@@ -23,7 +23,9 @@ with this program. If not, see <https://www.gnu.org/licenses/>
  * A scene item has been created.
  *
  * @dataField sceneName      | String | Name of the scene the item was added to
+ * @dataField sceneUuid      | String | UUID of the scene the item was added to
  * @dataField sourceName     | String | Name of the underlying source (input/scene)
+ * @dataField sourceUuid     | String | UUID of the underlying source (input/scene)
  * @dataField sceneItemId    | Number | Numeric ID of the scene item
  * @dataField sceneItemIndex | Number | Index position of the item
  *
@@ -49,7 +51,9 @@ void EventHandler::HandleSceneItemCreated(void *param, calldata_t *data)
 
 	json eventData;
 	eventData["sceneName"] = obs_source_get_name(obs_scene_get_source(scene));
+	eventData["sceneUuid"] = obs_source_get_uuid(obs_scene_get_source(scene));
 	eventData["sourceName"] = obs_source_get_name(obs_sceneitem_get_source(sceneItem));
+	eventData["sourceUuid"] = obs_source_get_uuid(obs_sceneitem_get_source(sceneItem));
 	eventData["sceneItemId"] = obs_sceneitem_get_id(sceneItem);
 	eventData["sceneItemIndex"] = obs_sceneitem_get_order_position(sceneItem);
 	eventHandler->BroadcastEvent(EventSubscription::SceneItems, "SceneItemCreated", eventData);
@@ -61,7 +65,9 @@ void EventHandler::HandleSceneItemCreated(void *param, calldata_t *data)
  * This event is not emitted when the scene the item is in is removed.
  *
  * @dataField sceneName   | String | Name of the scene the item was removed from
+ * @dataField sceneUuid   | String | UUID of the scene the item was removed from
  * @dataField sourceName  | String | Name of the underlying source (input/scene)
+ * @dataField sourceUuid  | String | UUID of the underlying source (input/scene)
  * @dataField sceneItemId | Number | Numeric ID of the scene item
  *
  * @eventType SceneItemRemoved
@@ -86,7 +92,9 @@ void EventHandler::HandleSceneItemRemoved(void *param, calldata_t *data)
 
 	json eventData;
 	eventData["sceneName"] = obs_source_get_name(obs_scene_get_source(scene));
+	eventData["sceneUuid"] = obs_source_get_uuid(obs_scene_get_source(scene));
 	eventData["sourceName"] = obs_source_get_name(obs_sceneitem_get_source(sceneItem));
+	eventData["sourceUuid"] = obs_source_get_uuid(obs_sceneitem_get_source(sceneItem));
 	eventData["sceneItemId"] = obs_sceneitem_get_id(sceneItem);
 	eventHandler->BroadcastEvent(EventSubscription::SceneItems, "SceneItemRemoved", eventData);
 }
@@ -95,6 +103,7 @@ void EventHandler::HandleSceneItemRemoved(void *param, calldata_t *data)
  * A scene's item list has been reindexed.
  *
  * @dataField sceneName  | String        | Name of the scene
+ * @dataField sceneUuid  | String        | UUID of the scene
  * @dataField sceneItems | Array<Object> | Array of scene item objects
  *
  * @eventType SceneItemListReindexed
@@ -115,6 +124,7 @@ void EventHandler::HandleSceneItemListReindexed(void *param, calldata_t *data)
 
 	json eventData;
 	eventData["sceneName"] = obs_source_get_name(obs_scene_get_source(scene));
+	eventData["sceneUuid"] = obs_source_get_uuid(obs_scene_get_source(scene));
 	eventData["sceneItems"] = Utils::Obs::ArrayHelper::GetSceneItemList(scene, true);
 	eventHandler->BroadcastEvent(EventSubscription::SceneItems, "SceneItemListReindexed", eventData);
 }
@@ -123,6 +133,7 @@ void EventHandler::HandleSceneItemListReindexed(void *param, calldata_t *data)
  * A scene item's enable state has changed.
  *
  * @dataField sceneName        | String  | Name of the scene the item is in
+ * @dataField sceneUuid        | String  | UUID of the scene the item is in
  * @dataField sceneItemId      | Number  | Numeric ID of the scene item
  * @dataField sceneItemEnabled | Boolean | Whether the scene item is enabled (visible)
  *
@@ -150,6 +161,7 @@ void EventHandler::HandleSceneItemEnableStateChanged(void *param, calldata_t *da
 
 	json eventData;
 	eventData["sceneName"] = obs_source_get_name(obs_scene_get_source(scene));
+	eventData["sceneUuid"] = obs_source_get_uuid(obs_scene_get_source(scene));
 	eventData["sceneItemId"] = obs_sceneitem_get_id(sceneItem);
 	eventData["sceneItemEnabled"] = sceneItemEnabled;
 	eventHandler->BroadcastEvent(EventSubscription::SceneItems, "SceneItemEnableStateChanged", eventData);
@@ -159,6 +171,7 @@ void EventHandler::HandleSceneItemEnableStateChanged(void *param, calldata_t *da
  * A scene item's lock state has changed.
  *
  * @dataField sceneName       | String  | Name of the scene the item is in
+ * @dataField sceneUuid       | String  | UUID of the scene the item is in
  * @dataField sceneItemId     | Number  | Numeric ID of the scene item
  * @dataField sceneItemLocked | Boolean | Whether the scene item is locked
  *
@@ -186,6 +199,7 @@ void EventHandler::HandleSceneItemLockStateChanged(void *param, calldata_t *data
 
 	json eventData;
 	eventData["sceneName"] = obs_source_get_name(obs_scene_get_source(scene));
+	eventData["sceneUuid"] = obs_source_get_uuid(obs_scene_get_source(scene));
 	eventData["sceneItemId"] = obs_sceneitem_get_id(sceneItem);
 	eventData["sceneItemLocked"] = sceneItemLocked;
 	eventHandler->BroadcastEvent(EventSubscription::SceneItems, "SceneItemLockStateChanged", eventData);
@@ -195,6 +209,7 @@ void EventHandler::HandleSceneItemLockStateChanged(void *param, calldata_t *data
  * A scene item has been selected in the Ui.
  *
  * @dataField sceneName        | String  | Name of the scene the item is in
+ * @dataField sceneUuid        | String  | UUID of the scene the item is in
  * @dataField sceneItemId      | Number  | Numeric ID of the scene item
  *
  * @eventType SceneItemSelected
@@ -219,6 +234,7 @@ void EventHandler::HandleSceneItemSelected(void *param, calldata_t *data)
 
 	json eventData;
 	eventData["sceneName"] = obs_source_get_name(obs_scene_get_source(scene));
+	eventData["sceneUuid"] = obs_source_get_uuid(obs_scene_get_source(scene));
 	eventData["sceneItemId"] = obs_sceneitem_get_id(sceneItem);
 	eventHandler->BroadcastEvent(EventSubscription::SceneItems, "SceneItemSelected", eventData);
 }
@@ -227,6 +243,7 @@ void EventHandler::HandleSceneItemSelected(void *param, calldata_t *data)
  * The transform/crop of a scene item has changed.
  *
  * @dataField sceneName          | String | The name of the scene the item is in
+ * @dataField sceneUuid          | String | The UUID of the scene the item is in
  * @dataField sceneItemId        | Number | Numeric ID of the scene item
  * @dataField sceneItemTransform | Object | New transform/crop info of the scene item
  *
@@ -255,6 +272,7 @@ void EventHandler::HandleSceneItemTransformChanged(void *param, calldata_t *data
 
 	json eventData;
 	eventData["sceneName"] = obs_source_get_name(obs_scene_get_source(scene));
+	eventData["sceneUuid"] = obs_source_get_uuid(obs_scene_get_source(scene));
 	eventData["sceneItemId"] = obs_sceneitem_get_id(sceneItem);
 	eventData["sceneItemTransform"] = Utils::Obs::ObjectHelper::GetSceneItemTransform(sceneItem);
 	eventHandler->BroadcastEvent(EventSubscription::SceneItemTransformChanged, "SceneItemTransformChanged", eventData);

src/eventhandler/EventHandler_Scenes.cpp

@@ -23,6 +23,7 @@ with this program. If not, see <https://www.gnu.org/licenses/>
  * A new scene has been created.
  *
  * @dataField sceneName | String  | Name of the new scene
+ * @dataField sceneUuid | String  | UUID of the new scene
  * @dataField isGroup   | Boolean | Whether the new scene is a group
  *
  * @eventType SceneCreated
@@ -37,6 +38,7 @@ void EventHandler::HandleSceneCreated(obs_source_t *source)
 {
 	json eventData;
 	eventData["sceneName"] = obs_source_get_name(source);
+	eventData["sceneUuid"] = obs_source_get_uuid(source);
 	eventData["isGroup"] = obs_source_is_group(source);
 	BroadcastEvent(EventSubscription::Scenes, "SceneCreated", eventData);
 }
@@ -45,6 +47,7 @@ void EventHandler::HandleSceneCreated(obs_source_t *source)
  * A scene has been removed.
  *
  * @dataField sceneName | String  | Name of the removed scene
+ * @dataField sceneUuid | String  | UUID of the removed scene
  * @dataField isGroup   | Boolean | Whether the scene was a group
  *
  * @eventType SceneRemoved
@@ -59,6 +62,7 @@ void EventHandler::HandleSceneRemoved(obs_source_t *source)
 {
 	json eventData;
 	eventData["sceneName"] = obs_source_get_name(source);
+	eventData["sceneUuid"] = obs_source_get_uuid(source);
 	eventData["isGroup"] = obs_source_is_group(source);
 	BroadcastEvent(EventSubscription::Scenes, "SceneRemoved", eventData);
 }
@@ -66,6 +70,7 @@ void EventHandler::HandleSceneRemoved(obs_source_t *source)
 /**
  * The name of a scene has changed.
  *
+ * @dataField sceneUuid    | String | UUID of the scene
  * @dataField oldSceneName | String | Old name of the scene
  * @dataField sceneName    | String | New name of the scene
  *
@@ -77,9 +82,10 @@ void EventHandler::HandleSceneRemoved(obs_source_t *source)
  * @api events
  * @category scenes
  */
-void EventHandler::HandleSceneNameChanged(obs_source_t *, std::string oldSceneName, std::string sceneName)
+void EventHandler::HandleSceneNameChanged(obs_source_t *source, std::string oldSceneName, std::string sceneName)
 {
 	json eventData;
+	eventData["sceneUuid"] = obs_source_get_uuid(source);
 	eventData["oldSceneName"] = oldSceneName;
 	eventData["sceneName"] = sceneName;
 	BroadcastEvent(EventSubscription::Scenes, "SceneNameChanged", eventData);
@@ -89,6 +95,7 @@ void EventHandler::HandleSceneNameChanged(obs_source_t *, std::string oldSceneNa
  * The current program scene has changed.
  *
  * @dataField sceneName | String | Name of the scene that was switched to
+ * @dataField sceneUuid | String | UUID of the scene that was switched to
  *
  * @eventType CurrentProgramSceneChanged
  * @eventSubscription Scenes
@@ -104,6 +111,7 @@ void EventHandler::HandleCurrentProgramSceneChanged()
 
 	json eventData;
 	eventData["sceneName"] = obs_source_get_name(currentScene);
+	eventData["sceneUuid"] = obs_source_get_uuid(currentScene);
 	BroadcastEvent(EventSubscription::Scenes, "CurrentProgramSceneChanged", eventData);
 }
 
@@ -111,6 +119,7 @@ void EventHandler::HandleCurrentProgramSceneChanged()
  * The current preview scene has changed.
  *
  * @dataField sceneName | String | Name of the scene that was switched to
+ * @dataField sceneUuid | String | UUID of the scene that was switched to
  *
  * @eventType CurrentPreviewSceneChanged
  * @eventSubscription Scenes
@@ -130,6 +139,7 @@ void EventHandler::HandleCurrentPreviewSceneChanged()
 
 	json eventData;
 	eventData["sceneName"] = obs_source_get_name(currentPreviewScene);
+	eventData["sceneUuid"] = obs_source_get_uuid(currentPreviewScene);
 	BroadcastEvent(EventSubscription::Scenes, "CurrentPreviewSceneChanged", eventData);
 }
 

src/eventhandler/EventHandler_Transitions.cpp

@@ -23,6 +23,7 @@ with this program. If not, see <https://www.gnu.org/licenses/>
  * The current scene transition has changed.
  *
  * @dataField transitionName | String | Name of the new transition
+ * @dataField transitionUuid | String | UUID of the new transition
  *
  * @eventType CurrentSceneTransitionChanged
  * @eventSubscription Transitions
@@ -38,6 +39,7 @@ void EventHandler::HandleCurrentSceneTransitionChanged()
 
 	json eventData;
 	eventData["transitionName"] = obs_source_get_name(transition);
+	eventData["transitionUuid"] = obs_source_get_uuid(transition);
 	BroadcastEvent(EventSubscription::Transitions, "CurrentSceneTransitionChanged", eventData);
 }
 
@@ -65,6 +67,7 @@ void EventHandler::HandleCurrentSceneTransitionDurationChanged()
  * A scene transition has started.
  *
  * @dataField transitionName | String | Scene transition name
+ * @dataField transitionUuid | String | Scene transition UUID
  *
  * @eventType SceneTransitionStarted
  * @eventSubscription Transitions
@@ -84,6 +87,7 @@ void EventHandler::HandleSceneTransitionStarted(void *param, calldata_t *data)
 
 	json eventData;
 	eventData["transitionName"] = obs_source_get_name(source);
+	eventData["transitionUuid"] = obs_source_get_uuid(source);
 	eventHandler->BroadcastEvent(EventSubscription::Transitions, "SceneTransitionStarted", eventData);
 }
 
@@ -93,6 +97,7 @@ void EventHandler::HandleSceneTransitionStarted(void *param, calldata_t *data)
  * Note: Does not appear to trigger when the transition is interrupted by the user.
  *
  * @dataField transitionName | String | Scene transition name
+ * @dataField transitionUuid | String | Scene transition UUID
  *
  * @eventType SceneTransitionEnded
  * @eventSubscription Transitions
@@ -112,6 +117,7 @@ void EventHandler::HandleSceneTransitionEnded(void *param, calldata_t *data)
 
 	json eventData;
 	eventData["transitionName"] = obs_source_get_name(source);
+	eventData["transitionUuid"] = obs_source_get_uuid(source);
 	eventHandler->BroadcastEvent(EventSubscription::Transitions, "SceneTransitionEnded", eventData);
 }
 
@@ -124,6 +130,7 @@ void EventHandler::HandleSceneTransitionEnded(void *param, calldata_t *data)
  * Note: Appears to be called by every transition, regardless of relevance.
  *
  * @dataField transitionName | String | Scene transition name
+ * @dataField transitionUuid | String | Scene transition UUID
  *
  * @eventType SceneTransitionVideoEnded
  * @eventSubscription Transitions
@@ -143,5 +150,6 @@ void EventHandler::HandleSceneTransitionVideoEnded(void *param, calldata_t *data
 
 	json eventData;
 	eventData["transitionName"] = obs_source_get_name(source);
+	eventData["transitionUuid"] = obs_source_get_uuid(source);
 	eventHandler->BroadcastEvent(EventSubscription::Transitions, "SceneTransitionVideoEnded", eventData);
 }

src/requesthandler/RequestHandler.cpp

@@ -126,6 +126,7 @@ const std::unordered_map<std::string, RequestMethodHandler> RequestHandler::_han
 	{"GetSceneItemList", &RequestHandler::GetSceneItemList},
 	{"GetGroupSceneItemList", &RequestHandler::GetGroupSceneItemList},
 	{"GetSceneItemId", &RequestHandler::GetSceneItemId},
+	{"GetSceneItemSource", &RequestHandler::GetSceneItemSource},
 	{"CreateSceneItem", &RequestHandler::CreateSceneItem},
 	{"RemoveSceneItem", &RequestHandler::RemoveSceneItem},
 	{"DuplicateSceneItem", &RequestHandler::DuplicateSceneItem},

src/requesthandler/RequestHandler.h

@@ -145,6 +145,7 @@ private:
 	RequestResult GetSceneItemList(const Request &);
 	RequestResult GetGroupSceneItemList(const Request &);
 	RequestResult GetSceneItemId(const Request &);
+	RequestResult GetSceneItemSource(const Request &);
 	RequestResult CreateSceneItem(const Request &);
 	RequestResult RemoveSceneItem(const Request &);
 	RequestResult DuplicateSceneItem(const Request &);

src/requesthandler/RequestHandler_Config.cpp

@@ -198,10 +198,7 @@ RequestResult RequestHandler::CreateSceneCollection(const Request &request)
 	if (std::find(sceneCollections.begin(), sceneCollections.end(), sceneCollectionName) != sceneCollections.end())
 		return RequestResult::Error(RequestStatus::ResourceAlreadyExists);
 
-	QMainWindow *mainWindow = static_cast<QMainWindow *>(obs_frontend_get_main_window());
-	bool success = false;
-	QMetaObject::invokeMethod(mainWindow, "AddSceneCollection", Qt::BlockingQueuedConnection, Q_RETURN_ARG(bool, success),
-				  Q_ARG(bool, true), Q_ARG(QString, QString::fromStdString(sceneCollectionName)));
+	bool success = obs_frontend_add_scene_collection(sceneCollectionName.c_str());
 	if (!success)
 		return RequestResult::Error(RequestStatus::ResourceCreationFailed, "Failed to create the scene collection.");
 
@@ -599,8 +596,8 @@ RequestResult RequestHandler::SetStreamServiceSettings(const Request &request)
 
 		obs_service_update(currentStreamService, newStreamServiceSettings);
 	} else {
-		// TODO: This leaks memory. I have no idea why.
-		OBSService newStreamService = obs_service_create(requestedStreamServiceType.c_str(), "obs_websocket_custom_service",
+		OBSServiceAutoRelease newStreamService = obs_service_create(requestedStreamServiceType.c_str(),
+									    "obs_websocket_custom_service",
 									    requestedStreamServiceSettings, nullptr);
 		// TODO: Check service type here, instead of relying on service creation to fail.
 		if (!newStreamService)

src/requesthandler/RequestHandler_Filters.cpp

@@ -43,7 +43,8 @@ RequestResult RequestHandler::GetSourceFilterKindList(const Request &)
 /**
  * Gets an array of all of a source's filters.
  *
- * @requestField sourceName | String | Name of the source
+ * @requestField ?sourceName | String | Name of the source
+ * @requestField ?sourceUuid | String | UUID of the source
  *
  * @responseField filters | Array<Object> | Array of filters
  *
@@ -58,7 +59,7 @@ RequestResult RequestHandler::GetSourceFilterList(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSourceAutoRelease source = request.ValidateSource("sourceName", statusCode, comment);
+	OBSSourceAutoRelease source = request.ValidateSource("sourceName", "sourceUuid", statusCode, comment);
 	if (!source)
 		return RequestResult::Error(statusCode, comment);
 
@@ -106,7 +107,8 @@ RequestResult RequestHandler::GetSourceFilterDefaultSettings(const Request &requ
 /**
  * Creates a new filter, adding it to the specified source.
  *
- * @requestField sourceName      | String | Name of the source to add the filter to
+ * @requestField ?sourceName     | String | Name of the source to add the filter to
+ * @requestField ?sourceUuid     | String | UUID of the source to add the filter to
  * @requestField filterName      | String | Name of the new filter to be created
  * @requestField filterKind      | String | The kind of filter to be created
  * @requestField ?filterSettings | Object | Settings object to initialize the filter with | Default settings used
@@ -123,7 +125,7 @@ RequestResult RequestHandler::CreateSourceFilter(const Request &request)
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
 
-	OBSSourceAutoRelease source = request.ValidateSource("sourceName", statusCode, comment);
+	OBSSourceAutoRelease source = request.ValidateSource("sourceName", "sourceUuid", statusCode, comment);
 	if (!(source && request.ValidateString("filterName", statusCode, comment) &&
 	      request.ValidateString("filterKind", statusCode, comment)))
 		return RequestResult::Error(statusCode, comment);
@@ -159,7 +161,8 @@ RequestResult RequestHandler::CreateSourceFilter(const Request &request)
 /**
  * Removes a filter from a source.
  *
- * @requestField sourceName | String | Name of the source the filter is on
+ * @requestField ?sourceName | String | Name of the source the filter is on
+ * @requestField ?sourceUuid | String | UUID of the source the filter is on
  * @requestField filterName  | String | Name of the filter to remove
  *
  * @requestType RemoveSourceFilter
@@ -173,7 +176,7 @@ RequestResult RequestHandler::RemoveSourceFilter(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	FilterPair pair = request.ValidateFilter("sourceName", "filterName", statusCode, comment);
+	FilterPair pair = request.ValidateFilter(statusCode, comment);
 	if (!pair.filter)
 		return RequestResult::Error(statusCode, comment);
 
@@ -185,7 +188,8 @@ RequestResult RequestHandler::RemoveSourceFilter(const Request &request)
 /**
  * Sets the name of a source filter (rename).
  *
- * @requestField sourceName    | String | Name of the source the filter is on
+ * @requestField ?sourceName   | String | Name of the source the filter is on
+ * @requestField ?sourceUuid   | String | UUID of the source the filter is on
  * @requestField filterName    | String | Current name of the filter
  * @requestField newFilterName | String | New name for the filter
  *
@@ -200,7 +204,7 @@ RequestResult RequestHandler::SetSourceFilterName(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	FilterPair pair = request.ValidateFilter("sourceName", "filterName", statusCode, comment);
+	FilterPair pair = request.ValidateFilter(statusCode, comment);
 	if (!pair.filter || !request.ValidateString("newFilterName", statusCode, comment))
 		return RequestResult::Error(statusCode, comment);
 
@@ -218,7 +222,8 @@ RequestResult RequestHandler::SetSourceFilterName(const Request &request)
 /**
  * Gets the info for a specific source filter.
  *
- * @requestField sourceName | String | Name of the source
+ * @requestField ?sourceName | String | Name of the source
+ * @requestField ?sourceUuid | String | UUID of the source
  * @requestField filterName  | String | Name of the filter
  *
  * @responseField filterEnabled  | Boolean | Whether the filter is enabled
@@ -237,7 +242,7 @@ RequestResult RequestHandler::GetSourceFilter(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	FilterPair pair = request.ValidateFilter("sourceName", "filterName", statusCode, comment);
+	FilterPair pair = request.ValidateFilter(statusCode, comment);
 	if (!pair.filter)
 		return RequestResult::Error(statusCode, comment);
 
@@ -257,7 +262,8 @@ RequestResult RequestHandler::GetSourceFilter(const Request &request)
 /**
  * Sets the index position of a filter on a source.
  *
- * @requestField sourceName  | String | Name of the source the filter is on
+ * @requestField ?sourceName | String | Name of the source the filter is on
+ * @requestField ?sourceUuid | String | UUID of the source the filter is on
  * @requestField filterName  | String | Name of the filter
  * @requestField filterIndex | Number | New index position of the filter | >= 0
  *
@@ -272,7 +278,7 @@ RequestResult RequestHandler::SetSourceFilterIndex(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	FilterPair pair = request.ValidateFilter("sourceName", "filterName", statusCode, comment);
+	FilterPair pair = request.ValidateFilter(statusCode, comment);
 	if (!(pair.filter && request.ValidateNumber("filterIndex", statusCode, comment, 0, 8192)))
 		return RequestResult::Error(statusCode, comment);
 
@@ -286,7 +292,8 @@ RequestResult RequestHandler::SetSourceFilterIndex(const Request &request)
 /**
  * Sets the settings of a source filter.
  *
- * @requestField sourceName     | String  | Name of the source the filter is on
+ * @requestField ?sourceName    | String  | Name of the source the filter is on
+ * @requestField ?sourceUuid    | String  | UUID of the source the filter is on
  * @requestField filterName     | String  | Name of the filter to set the settings of
  * @requestField filterSettings | Object  | Object of settings to apply
  * @requestField ?overlay       | Boolean | True == apply the settings on top of existing ones, False == reset the input to its defaults, then apply settings. | true
@@ -302,7 +309,7 @@ RequestResult RequestHandler::SetSourceFilterSettings(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	FilterPair pair = request.ValidateFilter("sourceName", "filterName", statusCode, comment);
+	FilterPair pair = request.ValidateFilter(statusCode, comment);
 	if (!(pair.filter && request.ValidateObject("filterSettings", statusCode, comment, true)))
 		return RequestResult::Error(statusCode, comment);
 
@@ -334,7 +341,8 @@ RequestResult RequestHandler::SetSourceFilterSettings(const Request &request)
 /**
  * Sets the enable state of a source filter.
  *
- * @requestField sourceName    | String  | Name of the source the filter is on
+ * @requestField ?sourceName   | String  | Name of the source the filter is on
+ * @requestField ?sourceUuid   | String  | UUID of the source the filter is on
  * @requestField filterName    | String  | Name of the filter
  * @requestField filterEnabled | Boolean | New enable state of the filter
  *
@@ -349,7 +357,7 @@ RequestResult RequestHandler::SetSourceFilterEnabled(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	FilterPair pair = request.ValidateFilter("sourceName", "filterName", statusCode, comment);
+	FilterPair pair = request.ValidateFilter(statusCode, comment);
 	if (!(pair.filter && request.ValidateBoolean("filterEnabled", statusCode, comment)))
 		return RequestResult::Error(statusCode, comment);
 

src/requesthandler/RequestHandler_General.cpp

@@ -211,12 +211,14 @@ RequestResult RequestHandler::CallVendorRequest(const Request &request)
 }
 
 /**
- * Gets an array of all hotkey names in OBS
+ * Gets an array of all hotkey names in OBS.
+ *
+ * Note: Hotkey functionality in obs-websocket comes as-is, and we do not guarantee support if things are broken. In 9/10 usages of hotkey requests, there exists a better, more reliable method via other requests.
  *
  * @responseField hotkeys | Array<String> | Array of hotkey names
  *
  * @requestType GetHotkeyList
- * @complexity 3
+ * @complexity 4
  * @rpcVersion -1
  * @initialVersion 5.0.0
  * @category general
@@ -230,13 +232,15 @@ RequestResult RequestHandler::GetHotkeyList(const Request &)
 }
 
 /**
- * Triggers a hotkey using its name. See `GetHotkeyList`
+ * Triggers a hotkey using its name. See `GetHotkeyList`.
+ *
+ * Note: Hotkey functionality in obs-websocket comes as-is, and we do not guarantee support if things are broken. In 9/10 usages of hotkey requests, there exists a better, more reliable method via other requests.
  *
  * @requestField hotkeyName | String | Name of the hotkey to trigger
  * @requestField ?contextName | String | Name of context of the hotkey to trigger
  *
  * @requestType TriggerHotkeyByName
- * @complexity 3
+ * @complexity 4
  * @rpcVersion -1
  * @initialVersion 5.0.0
  * @category general
@@ -269,6 +273,8 @@ RequestResult RequestHandler::TriggerHotkeyByName(const Request &request)
 /**
  * Triggers a hotkey using a sequence of keys.
  *
+ * Note: Hotkey functionality in obs-websocket comes as-is, and we do not guarantee support if things are broken. In 9/10 usages of hotkey requests, there exists a better, more reliable method via other requests.
+ *
  * @requestField ?keyId                | String  | The OBS key ID to use. See https://github.com/obsproject/obs-studio/blob/master/libobs/obs-hotkeys.h | Not pressed
  * @requestField ?keyModifiers         | Object  | Object containing key modifiers to apply                                                             | Ignored
  * @requestField ?keyModifiers.shift   | Boolean | Press Shift                                                                                          | Not pressed

src/requesthandler/RequestHandler_Inputs.cpp

@@ -123,12 +123,14 @@ RequestResult RequestHandler::GetSpecialInputs(const Request &)
 /**
  * Creates a new input, adding it as a scene item to the specified scene.
  *
- * @requestField sceneName         | String | Name of the scene to add the input to as a scene item
+ * @requestField ?sceneName        | String | Name of the scene to add the input to as a scene item
+ * @requestField ?sceneUuid        | String | UUID of the scene to add the input to as a scene item
  * @requestField inputName         | String | Name of the new input to created
  * @requestField inputKind         | String | The kind of input to be created
  * @requestField ?inputSettings    | Object | Settings object to initialize the input with                  | Default settings used
  * @requestField ?sceneItemEnabled | Boolean | Whether to set the created scene item to enabled or disabled | True
  *
+ * @responseField inputUuid   | String | UUID of the newly created input
  * @responseField sceneItemId | Number | ID of the newly created scene item
  *
  * @requestType CreateInput
@@ -142,7 +144,7 @@ RequestResult RequestHandler::CreateInput(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSourceAutoRelease sceneSource = request.ValidateScene("sceneName", statusCode, comment);
+	OBSSourceAutoRelease sceneSource = request.ValidateScene(statusCode, comment);
 	if (!(sceneSource && request.ValidateString("inputName", statusCode, comment) &&
 	      request.ValidateString("inputKind", statusCode, comment)))
 		return RequestResult::Error(statusCode, comment);
@@ -185,6 +187,7 @@ RequestResult RequestHandler::CreateInput(const Request &request)
 		return RequestResult::Error(RequestStatus::ResourceCreationFailed, "Creation of the input or scene item failed.");
 
 	json responseData;
+	responseData["inputUuid"] = obs_source_get_uuid(obs_sceneitem_get_source(sceneItem));
 	responseData["sceneItemId"] = obs_sceneitem_get_id(sceneItem);
 	return RequestResult::Success(responseData);
 }
@@ -194,7 +197,8 @@ RequestResult RequestHandler::CreateInput(const Request &request)
  *
  * Note: Will immediately remove all associated scene items.
  *
- * @requestField inputName | String | Name of the input to remove
+ * @requestField ?inputName | String | Name of the input to remove
+ * @requestField ?inputUuid | String | UUID of the input to remove
  *
  * @requestType RemoveInput
  * @complexity 2
@@ -207,7 +211,7 @@ RequestResult RequestHandler::RemoveInput(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSourceAutoRelease input = request.ValidateInput("inputName", statusCode, comment);
+	OBSSourceAutoRelease input = request.ValidateInput(statusCode, comment);
 	if (!input)
 		return RequestResult::Error(statusCode, comment);
 
@@ -222,7 +226,8 @@ RequestResult RequestHandler::RemoveInput(const Request &request)
 /**
  * Sets the name of an input (rename).
  *
- * @requestField inputName    | String | Current input name
+ * @requestField ?inputName   | String | Current input name
+ * @requestField ?inputUuid   | String | Current input UUID
  * @requestField newInputName | String | New name for the input
  *
  * @requestType SetInputName
@@ -236,7 +241,7 @@ RequestResult RequestHandler::SetInputName(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSourceAutoRelease input = request.ValidateInput("inputName", statusCode, comment);
+	OBSSourceAutoRelease input = request.ValidateInput(statusCode, comment);
 	if (!(input && request.ValidateString("newInputName", statusCode, comment)))
 		return RequestResult::Error(statusCode, comment);
 
@@ -292,7 +297,8 @@ RequestResult RequestHandler::GetInputDefaultSettings(const Request &request)
  *
  * Note: Does not include defaults. To create the entire settings object, overlay `inputSettings` over the `defaultInputSettings` provided by `GetInputDefaultSettings`.
  *
- * @requestField inputName | String | Name of the input to get the settings of
+ * @requestField ?inputName | String | Name of the input to get the settings of
+ * @requestField ?inputUuid | String | UUID of the input to get the settings of
  *
  * @responseField inputSettings | Object | Object of settings for the input
  * @responseField inputKind     | String | The kind of the input
@@ -308,7 +314,7 @@ RequestResult RequestHandler::GetInputSettings(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSourceAutoRelease input = request.ValidateInput("inputName", statusCode, comment);
+	OBSSourceAutoRelease input = request.ValidateInput(statusCode, comment);
 	if (!input)
 		return RequestResult::Error(statusCode, comment);
 
@@ -323,7 +329,8 @@ RequestResult RequestHandler::GetInputSettings(const Request &request)
 /**
  * Sets the settings of an input.
  *
- * @requestField inputName     | String  | Name of the input to set the settings of
+ * @requestField ?inputName    | String  | Name of the input to set the settings of
+ * @requestField ?inputUuid    | String  | UUID of the input to set the settings of
  * @requestField inputSettings | Object  | Object of settings to apply
  * @requestField ?overlay      | Boolean | True == apply the settings on top of existing ones, False == reset the input to its defaults, then apply settings. | true
  *
@@ -338,7 +345,7 @@ RequestResult RequestHandler::SetInputSettings(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSourceAutoRelease input = request.ValidateInput("inputName", statusCode, comment);
+	OBSSourceAutoRelease input = request.ValidateInput(statusCode, comment);
 	if (!(input && request.ValidateObject("inputSettings", statusCode, comment, true)))
 		return RequestResult::Error(statusCode, comment);
 
@@ -373,7 +380,8 @@ RequestResult RequestHandler::SetInputSettings(const Request &request)
 /**
  * Gets the audio mute state of an input.
  *
- * @requestField inputName | String | Name of input to get the mute state of
+ * @requestField ?inputName | String | Name of input to get the mute state of
+ * @requestField ?inputUuid | String | UUID of input to get the mute state of
  *
  * @responseField inputMuted | Boolean | Whether the input is muted
  *
@@ -388,7 +396,7 @@ RequestResult RequestHandler::GetInputMute(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSourceAutoRelease input = request.ValidateInput("inputName", statusCode, comment);
+	OBSSourceAutoRelease input = request.ValidateInput(statusCode, comment);
 	if (!input)
 		return RequestResult::Error(statusCode, comment);
 
@@ -403,7 +411,8 @@ RequestResult RequestHandler::GetInputMute(const Request &request)
 /**
  * Sets the audio mute state of an input.
  *
- * @requestField inputName | String | Name of the input to set the mute state of
+ * @requestField ?inputName | String  | Name of the input to set the mute state of
+ * @requestField ?inputUuid | String  | UUID of the input to set the mute state of
  * @requestField inputMuted | Boolean | Whether to mute the input or not
  *
  * @requestType SetInputMute
@@ -417,7 +426,7 @@ RequestResult RequestHandler::SetInputMute(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSourceAutoRelease input = request.ValidateInput("inputName", statusCode, comment);
+	OBSSourceAutoRelease input = request.ValidateInput(statusCode, comment);
 	if (!(input && request.ValidateBoolean("inputMuted", statusCode, comment)))
 		return RequestResult::Error(statusCode, comment);
 
@@ -432,7 +441,8 @@ RequestResult RequestHandler::SetInputMute(const Request &request)
 /**
  * Toggles the audio mute state of an input.
  *
- * @requestField inputName | String | Name of the input to toggle the mute state of
+ * @requestField ?inputName | String | Name of the input to toggle the mute state of
+ * @requestField ?inputUuid | String | UUID of the input to toggle the mute state of
  *
  * @responseField inputMuted | Boolean | Whether the input has been muted or unmuted
  *
@@ -447,7 +457,7 @@ RequestResult RequestHandler::ToggleInputMute(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSourceAutoRelease input = request.ValidateInput("inputName", statusCode, comment);
+	OBSSourceAutoRelease input = request.ValidateInput(statusCode, comment);
 	if (!input)
 		return RequestResult::Error(statusCode, comment);
 
@@ -465,7 +475,8 @@ RequestResult RequestHandler::ToggleInputMute(const Request &request)
 /**
  * Gets the current volume setting of an input.
  *
- * @requestField inputName | String | Name of the input to get the volume of
+ * @requestField ?inputName | String | Name of the input to get the volume of
+ * @requestField ?inputUuid | String | UUID of the input to get the volume of
  *
  * @responseField inputVolumeMul | Number | Volume setting in mul
  * @responseField inputVolumeDb  | Number | Volume setting in dB
@@ -481,7 +492,7 @@ RequestResult RequestHandler::GetInputVolume(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSourceAutoRelease input = request.ValidateInput("inputName", statusCode, comment);
+	OBSSourceAutoRelease input = request.ValidateInput(statusCode, comment);
 	if (!input)
 		return RequestResult::Error(statusCode, comment);
 
@@ -502,7 +513,8 @@ RequestResult RequestHandler::GetInputVolume(const Request &request)
 /**
  * Sets the volume setting of an input.
  *
- * @requestField inputName       | String | Name of the input to set the volume of
+ * @requestField ?inputName      | String | Name of the input to set the volume of
+ * @requestField ?inputUuid      | String | UUID of the input to set the volume of
  * @requestField ?inputVolumeMul | Number | Volume setting in mul | >= 0, <= 20     | `inputVolumeDb` should be specified
  * @requestField ?inputVolumeDb  | Number | Volume setting in dB  | >= -100, <= 26 | `inputVolumeMul` should be specified
  *
@@ -517,7 +529,7 @@ RequestResult RequestHandler::SetInputVolume(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSourceAutoRelease input = request.ValidateInput("inputName", statusCode, comment);
+	OBSSourceAutoRelease input = request.ValidateInput(statusCode, comment);
 	if (!input)
 		return RequestResult::Error(statusCode, comment);
 
@@ -552,7 +564,8 @@ RequestResult RequestHandler::SetInputVolume(const Request &request)
 /**
  * Gets the audio balance of an input.
  *
- * @requestField inputName | String | Name of the input to get the audio balance of
+ * @requestField ?inputName | String | Name of the input to get the audio balance of
+ * @requestField ?inputUuid | String | UUID of the input to get the audio balance of
  *
  * @responseField inputAudioBalance | Number | Audio balance value from 0.0-1.0
  *
@@ -567,7 +580,7 @@ RequestResult RequestHandler::GetInputAudioBalance(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSourceAutoRelease input = request.ValidateInput("inputName", statusCode, comment);
+	OBSSourceAutoRelease input = request.ValidateInput(statusCode, comment);
 	if (!input)
 		return RequestResult::Error(statusCode, comment);
 
@@ -583,7 +596,8 @@ RequestResult RequestHandler::GetInputAudioBalance(const Request &request)
 /**
  * Sets the audio balance of an input.
  *
- * @requestField inputName         | String | Name of the input to set the audio balance of
+ * @requestField ?inputName        | String | Name of the input to set the audio balance of
+ * @requestField ?inputUuid        | String | UUID of the input to set the audio balance of
  * @requestField inputAudioBalance | Number | New audio balance value | >= 0.0, <= 1.0
  *
  * @requestType SetInputAudioBalance
@@ -597,7 +611,7 @@ RequestResult RequestHandler::SetInputAudioBalance(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSourceAutoRelease input = request.ValidateInput("inputName", statusCode, comment);
+	OBSSourceAutoRelease input = request.ValidateInput(statusCode, comment);
 	if (!(input && request.ValidateNumber("inputAudioBalance", statusCode, comment, 0.0, 1.0)))
 		return RequestResult::Error(statusCode, comment);
 
@@ -615,7 +629,8 @@ RequestResult RequestHandler::SetInputAudioBalance(const Request &request)
  *
  * Note: The audio sync offset can be negative too!
  *
- * @requestField inputName | String | Name of the input to get the audio sync offset of
+ * @requestField ?inputName | String | Name of the input to get the audio sync offset of
+ * @requestField ?inputUuid | String | UUID of the input to get the audio sync offset of
  *
  * @responseField inputAudioSyncOffset | Number | Audio sync offset in milliseconds
  *
@@ -630,7 +645,7 @@ RequestResult RequestHandler::GetInputAudioSyncOffset(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSourceAutoRelease input = request.ValidateInput("inputName", statusCode, comment);
+	OBSSourceAutoRelease input = request.ValidateInput(statusCode, comment);
 	if (!input)
 		return RequestResult::Error(statusCode, comment);
 
@@ -647,7 +662,8 @@ RequestResult RequestHandler::GetInputAudioSyncOffset(const Request &request)
 /**
  * Sets the audio sync offset of an input.
  *
- * @requestField inputName            | String | Name of the input to set the audio sync offset of
+ * @requestField ?inputName           | String | Name of the input to set the audio sync offset of
+ * @requestField ?inputUuid           | String | UUID of the input to set the audio sync offset of
  * @requestField inputAudioSyncOffset | Number | New audio sync offset in milliseconds | >= -950, <= 20000
  *
  * @requestType SetInputAudioSyncOffset
@@ -661,7 +677,7 @@ RequestResult RequestHandler::SetInputAudioSyncOffset(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSourceAutoRelease input = request.ValidateInput("inputName", statusCode, comment);
+	OBSSourceAutoRelease input = request.ValidateInput(statusCode, comment);
 	if (!(input && request.ValidateNumber("inputAudioSyncOffset", statusCode, comment, -950, 20000)))
 		return RequestResult::Error(statusCode, comment);
 
@@ -683,7 +699,8 @@ RequestResult RequestHandler::SetInputAudioSyncOffset(const Request &request)
  * - `OBS_MONITORING_TYPE_MONITOR_ONLY`
  * - `OBS_MONITORING_TYPE_MONITOR_AND_OUTPUT`
  *
- * @requestField inputName | String | Name of the input to get the audio monitor type of
+ * @requestField ?inputName | String | Name of the input to get the audio monitor type of
+ * @requestField ?inputUuid | String | UUID of the input to get the audio monitor type of
  *
  * @responseField monitorType | String | Audio monitor type
  *
@@ -698,7 +715,7 @@ RequestResult RequestHandler::GetInputAudioMonitorType(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSourceAutoRelease input = request.ValidateInput("inputName", statusCode, comment);
+	OBSSourceAutoRelease input = request.ValidateInput(statusCode, comment);
 	if (!input)
 		return RequestResult::Error(statusCode, comment);
 
@@ -714,7 +731,8 @@ RequestResult RequestHandler::GetInputAudioMonitorType(const Request &request)
 /**
  * Sets the audio monitor type of an input.
  *
- * @requestField inputName   | String | Name of the input to set the audio monitor type of
+ * @requestField ?inputName  | String | Name of the input to set the audio monitor type of
+ * @requestField ?inputUuid  | String | UUID of the input to set the audio monitor type of
  * @requestField monitorType | String | Audio monitor type
  *
  * @requestType SetInputAudioMonitorType
@@ -728,7 +746,7 @@ RequestResult RequestHandler::SetInputAudioMonitorType(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSourceAutoRelease input = request.ValidateInput("inputName", statusCode, comment);
+	OBSSourceAutoRelease input = request.ValidateInput(statusCode, comment);
 	if (!(input && request.ValidateString("monitorType", statusCode, comment)))
 		return RequestResult::Error(statusCode, comment);
 
@@ -759,7 +777,8 @@ RequestResult RequestHandler::SetInputAudioMonitorType(const Request &request)
 /**
  * Gets the enable state of all audio tracks of an input.
  *
- * @requestField inputName | String | Name of the input
+ * @requestField ?inputName | String | Name of the input
+ * @requestField ?inputUuid | String | UUID of the input
  *
  * @responseField inputAudioTracks | Object | Object of audio tracks and associated enable states
  *
@@ -774,7 +793,7 @@ RequestResult RequestHandler::GetInputAudioTracks(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSourceAutoRelease input = request.ValidateInput("inputName", statusCode, comment);
+	OBSSourceAutoRelease input = request.ValidateInput(statusCode, comment);
 	if (!input)
 		return RequestResult::Error(statusCode, comment);
 
@@ -797,7 +816,8 @@ RequestResult RequestHandler::GetInputAudioTracks(const Request &request)
 /**
  * Sets the enable state of audio tracks of an input.
  *
- * @requestField inputName        | String | Name of the input
+ * @requestField ?inputName       | String | Name of the input
+ * @requestField ?inputUuid       | String | UUID of the input
  * @requestField inputAudioTracks | Object | Track settings to apply
  *
  * @requestType SetInputAudioTracks
@@ -811,7 +831,7 @@ RequestResult RequestHandler::SetInputAudioTracks(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSourceAutoRelease input = request.ValidateInput("inputName", statusCode, comment);
+	OBSSourceAutoRelease input = request.ValidateInput(statusCode, comment);
 	if (!input || !request.ValidateObject("inputAudioTracks", statusCode, comment))
 		return RequestResult::Error(statusCode, comment);
 
@@ -851,7 +871,8 @@ RequestResult RequestHandler::SetInputAudioTracks(const Request &request)
  *
  * Note: Use this in cases where an input provides a dynamic, selectable list of items. For example, display capture, where it provides a list of available displays.
  *
- * @requestField inputName    | String | Name of the input
+ * @requestField ?inputName   | String | Name of the input
+ * @requestField ?inputUuid   | String | UUID of the input
  * @requestField propertyName | String | Name of the list property to get the items of
  *
  * @responseField propertyItems | Array<Object> | Array of items in the list property
@@ -867,7 +888,7 @@ RequestResult RequestHandler::GetInputPropertiesListPropertyItems(const Request
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSourceAutoRelease input = request.ValidateInput("inputName", statusCode, comment);
+	OBSSourceAutoRelease input = request.ValidateInput(statusCode, comment);
 	if (!(input && request.ValidateString("propertyName", statusCode, comment)))
 		return RequestResult::Error(statusCode, comment);
 
@@ -895,7 +916,8 @@ RequestResult RequestHandler::GetInputPropertiesListPropertyItems(const Request
  *
  * Note: Use this in cases where there is a button in the properties of an input that cannot be accessed in any other way. For example, browser sources, where there is a refresh button.
  *
- * @requestField inputName    | String | Name of the input
+ * @requestField ?inputName   | String | Name of the input
+ * @requestField ?inputUuid   | String | UUID of the input
  * @requestField propertyName | String | Name of the button property to press
  *
  * @requestType PressInputPropertiesButton
@@ -909,7 +931,7 @@ RequestResult RequestHandler::PressInputPropertiesButton(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSourceAutoRelease input = request.ValidateInput("inputName", statusCode, comment);
+	OBSSourceAutoRelease input = request.ValidateInput(statusCode, comment);
 	if (!(input && request.ValidateString("propertyName", statusCode, comment)))
 		return RequestResult::Error(statusCode, comment);
 

src/requesthandler/RequestHandler_MediaInputs.cpp

@@ -39,7 +39,8 @@ bool IsMediaTimeValid(obs_source_t *input)
  * - `OBS_MEDIA_STATE_ENDED`
  * - `OBS_MEDIA_STATE_ERROR`
  *
- * @requestField inputName | String | Name of the media input
+ * @requestField ?inputName | String | Name of the media input
+ * @requestField ?inputUuid | String | UUID of the media input
  *
  * @responseField mediaState    | String | State of the media input
  * @responseField mediaDuration | Number | Total duration of the playing media in milliseconds. `null` if not playing
@@ -56,7 +57,7 @@ RequestResult RequestHandler::GetMediaInputStatus(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSourceAutoRelease input = request.ValidateInput("inputName", statusCode, comment);
+	OBSSourceAutoRelease input = request.ValidateInput(statusCode, comment);
 	if (!input)
 		return RequestResult::Error(statusCode, comment);
 
@@ -80,7 +81,8 @@ RequestResult RequestHandler::GetMediaInputStatus(const Request &request)
  *
  * This request does not perform bounds checking of the cursor position.
  *
- * @requestField inputName   | String | Name of the media input
+ * @requestField ?inputName  | String | Name of the media input
+ * @requestField ?inputUuid  | String | UUID of the media input
  * @requestField mediaCursor | Number | New cursor position to set | >= 0
  *
  * @requestType SetMediaInputCursor
@@ -94,7 +96,7 @@ RequestResult RequestHandler::SetMediaInputCursor(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSourceAutoRelease input = request.ValidateInput("inputName", statusCode, comment);
+	OBSSourceAutoRelease input = request.ValidateInput(statusCode, comment);
 	if (!(input && request.ValidateNumber("mediaCursor", statusCode, comment, 0)))
 		return RequestResult::Error(statusCode, comment);
 
@@ -115,7 +117,8 @@ RequestResult RequestHandler::SetMediaInputCursor(const Request &request)
  *
  * This request does not perform bounds checking of the cursor position.
  *
- * @requestField inputName         | String | Name of the media input
+ * @requestField ?inputName        | String | Name of the media input
+ * @requestField ?inputUuid        | String | UUID of the media input
  * @requestField mediaCursorOffset | Number | Value to offset the current cursor position by | None
  *
  * @requestType OffsetMediaInputCursor
@@ -129,7 +132,7 @@ RequestResult RequestHandler::OffsetMediaInputCursor(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSourceAutoRelease input = request.ValidateInput("inputName", statusCode, comment);
+	OBSSourceAutoRelease input = request.ValidateInput(statusCode, comment);
 	if (!(input && request.ValidateNumber("mediaCursorOffset", statusCode, comment)))
 		return RequestResult::Error(statusCode, comment);
 
@@ -151,7 +154,8 @@ RequestResult RequestHandler::OffsetMediaInputCursor(const Request &request)
 /**
  * Triggers an action on a media input.
  *
- * @requestField inputName   | String | Name of the media input
+ * @requestField ?inputName  | String | Name of the media input
+ * @requestField ?inputUuid  | String | UUID of the media input
  * @requestField mediaAction | String | Identifier of the `ObsMediaInputAction` enum
  *
  * @requestType TriggerMediaInputAction
@@ -165,7 +169,7 @@ RequestResult RequestHandler::TriggerMediaInputAction(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSourceAutoRelease input = request.ValidateInput("inputName", statusCode, comment);
+	OBSSourceAutoRelease input = request.ValidateInput(statusCode, comment);
 	if (!(input && request.ValidateString("mediaAction", statusCode, comment)))
 		return RequestResult::Error(statusCode, comment);
 

src/requesthandler/RequestHandler_SceneItems.cpp

@@ -24,7 +24,8 @@ with this program. If not, see <https://www.gnu.org/licenses/>
  *
  * Scenes only
  *
- * @requestField sceneName | String | Name of the scene to get the items of
+ * @requestField ?sceneName | String | Name of the scene to get the items of
+ * @requestField ?sceneUuid | String | UUID of the scene to get the items of
  *
  * @responseField sceneItems | Array<Object> | Array of scene items in the scene
  *
@@ -39,7 +40,7 @@ RequestResult RequestHandler::GetSceneItemList(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSourceAutoRelease scene = request.ValidateScene("sceneName", statusCode, comment);
+	OBSSourceAutoRelease scene = request.ValidateScene(statusCode, comment);
 	if (!scene)
 		return RequestResult::Error(statusCode, comment);
 
@@ -56,7 +57,8 @@ RequestResult RequestHandler::GetSceneItemList(const Request &request)
  *
  * Groups only
  *
- * @requestField sceneName | String | Name of the group to get the items of
+ * @requestField ?sceneName | String | Name of the group to get the items of
+ * @requestField ?sceneUuid | String | UUID of the group to get the items of
  *
  * @responseField sceneItems | Array<Object> | Array of scene items in the group
  *
@@ -71,7 +73,7 @@ RequestResult RequestHandler::GetGroupSceneItemList(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSourceAutoRelease scene = request.ValidateScene("sceneName", statusCode, comment, OBS_WEBSOCKET_SCENE_FILTER_GROUP_ONLY);
+	OBSSourceAutoRelease scene = request.ValidateScene(statusCode, comment, OBS_WEBSOCKET_SCENE_FILTER_GROUP_ONLY);
 	if (!scene)
 		return RequestResult::Error(statusCode, comment);
 
@@ -86,7 +88,8 @@ RequestResult RequestHandler::GetGroupSceneItemList(const Request &request)
  *
  * Scenes and Groups
  *
- * @requestField sceneName     | String | Name of the scene or group to search in
+ * @requestField ?sceneName    | String | Name of the scene or group to search in
+ * @requestField ?sceneUuid    | String | UUID of the scene or group to search in
  * @requestField sourceName    | String | Name of the source to find
  * @requestField ?searchOffset | Number | Number of matches to skip during search. >= 0 means first forward. -1 means last (top) item | >= -1 | 0
  *
@@ -104,8 +107,8 @@ RequestResult RequestHandler::GetSceneItemId(const Request &request)
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
 	OBSSceneAutoRelease scene =
-		request.ValidateScene2("sceneName", statusCode, comment, OBS_WEBSOCKET_SCENE_FILTER_SCENE_OR_GROUP);
-	if (!(scene && request.ValidateString("sourceName", statusCode, comment)))
+		request.ValidateScene2(statusCode, comment, OBS_WEBSOCKET_SCENE_FILTER_SCENE_OR_GROUP);
+	if (!(scene && request.ValidateString("sourceName", statusCode, comment))) // TODO: Source UUID support
 		return RequestResult::Error(statusCode, comment);
 
 	std::string sourceName = request.RequestData["sourceName"];
@@ -128,13 +131,49 @@ RequestResult RequestHandler::GetSceneItemId(const Request &request)
 	return RequestResult::Success(responseData);
 }
 
+/**
+ * Gets the source associated with a scene item.
+ *
+ * @requestField ?sceneName  | String | Name of the scene the item is in
+ * @requestField ?sceneUuid  | String | UUID of the scene the item is in
+ * @requestField sceneItemId | Number | Numeric ID of the scene item | >= 0
+ *
+ * @responseField sourceName | String | Name of the source associated with the scene item
+ * @responseField sourceUuid | String | UUID of the source associated with the scene item
+ *
+ * @requestType GetSceneItemSource
+ * @complexity 3
+ * @rpcVersion -1
+ * @initialVersion 5.4.0
+ * @api requests
+ * @category scene items
+ */
+RequestResult RequestHandler::GetSceneItemSource(const Request &request)
+{
+	RequestStatus::RequestStatus statusCode;
+	std::string comment;
+	OBSSceneItemAutoRelease sceneItem = request.ValidateSceneItem(statusCode, comment);
+	if (!sceneItem)
+		return RequestResult::Error(statusCode, comment);
+
+	OBSSource source = obs_sceneitem_get_source(sceneItem);
+
+	json responseData;
+	responseData["sourceName"] = obs_source_get_name(source);
+	responseData["sourceUuid"] = obs_source_get_uuid(source);
+
+	return RequestResult::Success(responseData);
+}
+
 /**
  * Creates a new scene item using a source.
  *
  * Scenes only
  *
- * @requestField sceneName         | String  | Name of the scene to create the new item in
- * @requestField sourceName        | String  | Name of the source to add to the scene
+ * @requestField ?sceneName        | String  | Name of the scene to create the new item in
+ * @requestField ?sceneUuid        | String  | UUID of the scene to create the new item in
+ * @requestField ?sourceName       | String  | Name of the source to add to the scene
+ * @requestField ?sourceUuid       | String  | UUID of the source to add to the scene
  * @requestField ?sceneItemEnabled | Boolean | Enable state to apply to the scene item on creation | True
  *
  * @responseField sceneItemId | Number | Numeric ID of the scene item
@@ -150,17 +189,17 @@ RequestResult RequestHandler::CreateSceneItem(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSourceAutoRelease sceneSource = request.ValidateScene("sceneName", statusCode, comment);
+	OBSSourceAutoRelease sceneSource = request.ValidateScene(statusCode, comment);
 	if (!sceneSource)
 		return RequestResult::Error(statusCode, comment);
 
 	OBSScene scene = obs_scene_from_source(sceneSource);
 
-	OBSSourceAutoRelease source = request.ValidateSource("sourceName", statusCode, comment);
+	OBSSourceAutoRelease source = request.ValidateSource("sourceName", "sourceUuid", statusCode, comment);
 	if (!source)
 		return RequestResult::Error(statusCode, comment);
 
-	if (request.RequestData["sceneName"] == request.RequestData["sourceName"])
+	if (sceneSource == source)
 		return RequestResult::Error(RequestStatus::CannotAct, "You cannot create scene item of a scene within itself.");
 
 	bool sceneItemEnabled = true;
@@ -185,7 +224,8 @@ RequestResult RequestHandler::CreateSceneItem(const Request &request)
  *
  * Scenes only
  *
- * @requestField sceneName   | String | Name of the scene the item is in
+ * @requestField ?sceneName  | String | Name of the scene the item is in
+ * @requestField ?sceneUuid  | String | UUID of the scene the item is in
  * @requestField sceneItemId | Number | Numeric ID of the scene item | >= 0
  *
  * @requestType RemoveSceneItem
@@ -199,7 +239,7 @@ RequestResult RequestHandler::RemoveSceneItem(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSceneItemAutoRelease sceneItem = request.ValidateSceneItem("sceneName", "sceneItemId", statusCode, comment);
+	OBSSceneItemAutoRelease sceneItem = request.ValidateSceneItem(statusCode, comment);
 	if (!sceneItem)
 		return RequestResult::Error(statusCode, comment);
 
@@ -214,9 +254,11 @@ RequestResult RequestHandler::RemoveSceneItem(const Request &request)
  *
  * Scenes only
  *
- * @requestField sceneName             | String | Name of the scene the item is in
+ * @requestField ?sceneName            | String | Name of the scene the item is in
+ * @requestField ?sceneUuid            | String | UUID of the scene the item is in
  * @requestField sceneItemId           | Number | Numeric ID of the scene item | >= 0
- * @requestField ?destinationSceneName | String | Name of the scene to create the duplicated item in | `sceneName` is assumed
+ * @requestField ?destinationSceneName | String | Name of the scene to create the duplicated item in | From scene is assumed
+ * @requestField ?destinationSceneUuid | String | UUID of the scene to create the duplicated item in | From scene is assumed
  *
  * @responseField sceneItemId | Number | Numeric ID of the duplicated scene item
  *
@@ -231,16 +273,24 @@ RequestResult RequestHandler::DuplicateSceneItem(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSceneItemAutoRelease sceneItem = request.ValidateSceneItem("sceneName", "sceneItemId", statusCode, comment);
+	OBSSceneItemAutoRelease sceneItem = request.ValidateSceneItem(statusCode, comment);
 	if (!sceneItem)
 		return RequestResult::Error(statusCode, comment);
 
 	// Get destination scene
 	obs_scene_t *destinationScene;
 	if (request.Contains("destinationSceneName")) {
-		destinationScene = request.ValidateScene2("destinationSceneName", statusCode, comment);
-		if (!destinationScene)
+		OBSSourceAutoRelease destinationSceneSource = request.ValidateSource("destinationSceneName", "destinationSceneUuid", statusCode, comment);
+		if (!destinationSceneSource)
 			return RequestResult::Error(statusCode, comment);
+
+		// Reimplementation of ValidateScene2
+		if (obs_source_get_type(destinationSceneSource) != OBS_SOURCE_TYPE_SCENE)
+			return RequestResult::Error(RequestStatus::InvalidResourceType, "The specified source is not a scene.");
+		if (obs_source_is_group(destinationSceneSource))
+			return RequestResult::Error(RequestStatus::InvalidResourceType, "The specified source is not a scene. (Is group)");
+
+		destinationScene = obs_scene_get_ref(obs_scene_from_source(destinationSceneSource));
 	} else {
 		destinationScene = obs_scene_get_ref(obs_sceneitem_get_scene(sceneItem));
 		if (!destinationScene)
@@ -279,7 +329,8 @@ RequestResult RequestHandler::DuplicateSceneItem(const Request &request)
  *
  * Scenes and Groups
  *
- * @requestField sceneName   | String | Name of the scene the item is in
+ * @requestField ?sceneName  | String | Name of the scene the item is in
+ * @requestField ?sceneUuid  | String | UUID of the scene the item is in
  * @requestField sceneItemId | Number | Numeric ID of the scene item | >= 0
  *
  * @responseField sceneItemTransform | Object | Object containing scene item transform info
@@ -295,8 +346,7 @@ RequestResult RequestHandler::GetSceneItemTransform(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSceneItemAutoRelease sceneItem = request.ValidateSceneItem("sceneName", "sceneItemId", statusCode, comment,
-								      OBS_WEBSOCKET_SCENE_FILTER_SCENE_OR_GROUP);
+	OBSSceneItemAutoRelease sceneItem = request.ValidateSceneItem(statusCode, comment, OBS_WEBSOCKET_SCENE_FILTER_SCENE_OR_GROUP);
 	if (!sceneItem)
 		return RequestResult::Error(statusCode, comment);
 
@@ -309,7 +359,8 @@ RequestResult RequestHandler::GetSceneItemTransform(const Request &request)
 /**
  * Sets the transform and crop info of a scene item.
  *
- * @requestField sceneName          | String | Name of the scene the item is in
+ * @requestField ?sceneName         | String | Name of the scene the item is in
+ * @requestField ?sceneUuid         | String | UUID of the scene the item is in
  * @requestField sceneItemId        | Number | Numeric ID of the scene item | >= 0
  * @requestField sceneItemTransform | Object | Object containing scene item transform info to update
  *
@@ -324,8 +375,7 @@ RequestResult RequestHandler::SetSceneItemTransform(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSceneItemAutoRelease sceneItem = request.ValidateSceneItem("sceneName", "sceneItemId", statusCode, comment,
-								      OBS_WEBSOCKET_SCENE_FILTER_SCENE_OR_GROUP);
+	OBSSceneItemAutoRelease sceneItem = request.ValidateSceneItem(statusCode, comment, OBS_WEBSOCKET_SCENE_FILTER_SCENE_OR_GROUP);
 	if (!(sceneItem && request.ValidateObject("sceneItemTransform", statusCode, comment)))
 		return RequestResult::Error(statusCode, comment);
 
@@ -466,7 +516,8 @@ RequestResult RequestHandler::SetSceneItemTransform(const Request &request)
  *
  * Scenes and Groups
  *
- * @requestField sceneName   | String | Name of the scene the item is in
+ * @requestField ?sceneName  | String | Name of the scene the item is in
+ * @requestField ?sceneUuid  | String | UUID of the scene the item is in
  * @requestField sceneItemId | Number | Numeric ID of the scene item | >= 0
  *
  * @responseField sceneItemEnabled | Boolean | Whether the scene item is enabled. `true` for enabled, `false` for disabled
@@ -482,8 +533,7 @@ RequestResult RequestHandler::GetSceneItemEnabled(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSceneItemAutoRelease sceneItem = request.ValidateSceneItem("sceneName", "sceneItemId", statusCode, comment,
-								      OBS_WEBSOCKET_SCENE_FILTER_SCENE_OR_GROUP);
+	OBSSceneItemAutoRelease sceneItem = request.ValidateSceneItem(statusCode, comment, OBS_WEBSOCKET_SCENE_FILTER_SCENE_OR_GROUP);
 	if (!sceneItem)
 		return RequestResult::Error(statusCode, comment);
 
@@ -498,7 +548,8 @@ RequestResult RequestHandler::GetSceneItemEnabled(const Request &request)
  *
  * Scenes and Groups
  *
- * @requestField sceneName        | String  | Name of the scene the item is in
+ * @requestField ?sceneName       | String  | Name of the scene the item is in
+ * @requestField ?sceneUuid       | String  | UUID of the scene the item is in
  * @requestField sceneItemId      | Number  | Numeric ID of the scene item | >= 0
  * @requestField sceneItemEnabled | Boolean | New enable state of the scene item
  *
@@ -513,8 +564,7 @@ RequestResult RequestHandler::SetSceneItemEnabled(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSceneItemAutoRelease sceneItem = request.ValidateSceneItem("sceneName", "sceneItemId", statusCode, comment,
-								      OBS_WEBSOCKET_SCENE_FILTER_SCENE_OR_GROUP);
+	OBSSceneItemAutoRelease sceneItem = request.ValidateSceneItem(statusCode, comment, OBS_WEBSOCKET_SCENE_FILTER_SCENE_OR_GROUP);
 	if (!(sceneItem && request.ValidateBoolean("sceneItemEnabled", statusCode, comment)))
 		return RequestResult::Error(statusCode, comment);
 
@@ -530,7 +580,8 @@ RequestResult RequestHandler::SetSceneItemEnabled(const Request &request)
  *
  * Scenes and Groups
  *
- * @requestField sceneName   | String | Name of the scene the item is in
+ * @requestField ?sceneName  | String | Name of the scene the item is in
+ * @requestField ?sceneUuid  | String | UUID of the scene the item is in
  * @requestField sceneItemId | Number | Numeric ID of the scene item | >= 0
  *
  * @responseField sceneItemLocked | Boolean | Whether the scene item is locked. `true` for locked, `false` for unlocked
@@ -546,8 +597,7 @@ RequestResult RequestHandler::GetSceneItemLocked(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSceneItemAutoRelease sceneItem = request.ValidateSceneItem("sceneName", "sceneItemId", statusCode, comment,
-								      OBS_WEBSOCKET_SCENE_FILTER_SCENE_OR_GROUP);
+	OBSSceneItemAutoRelease sceneItem = request.ValidateSceneItem(statusCode, comment, OBS_WEBSOCKET_SCENE_FILTER_SCENE_OR_GROUP);
 	if (!sceneItem)
 		return RequestResult::Error(statusCode, comment);
 
@@ -562,7 +612,8 @@ RequestResult RequestHandler::GetSceneItemLocked(const Request &request)
  *
  * Scenes and Group
  *
- * @requestField sceneName       | String | Name of the scene the item is in
+ * @requestField ?sceneName      | String  | Name of the scene the item is in
+ * @requestField ?sceneUuid      | String  | UUID of the scene the item is in
  * @requestField sceneItemId     | Number  | Numeric ID of the scene item | >= 0
  * @requestField sceneItemLocked | Boolean | New lock state of the scene item
  *
@@ -577,8 +628,7 @@ RequestResult RequestHandler::SetSceneItemLocked(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSceneItemAutoRelease sceneItem = request.ValidateSceneItem("sceneName", "sceneItemId", statusCode, comment,
-								      OBS_WEBSOCKET_SCENE_FILTER_SCENE_OR_GROUP);
+	OBSSceneItemAutoRelease sceneItem = request.ValidateSceneItem(statusCode, comment, OBS_WEBSOCKET_SCENE_FILTER_SCENE_OR_GROUP);
 	if (!(sceneItem && request.ValidateBoolean("sceneItemLocked", statusCode, comment)))
 		return RequestResult::Error(statusCode, comment);
 
@@ -596,7 +646,8 @@ RequestResult RequestHandler::SetSceneItemLocked(const Request &request)
  *
  * Scenes and Groups
  *
- * @requestField sceneName   | String | Name of the scene the item is in
+ * @requestField ?sceneName  | String | Name of the scene the item is in
+ * @requestField ?sceneUuid  | String | UUID of the scene the item is in
  * @requestField sceneItemId | Number | Numeric ID of the scene item | >= 0
  *
  * @responseField sceneItemIndex | Number | Index position of the scene item
@@ -612,8 +663,7 @@ RequestResult RequestHandler::GetSceneItemIndex(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSceneItemAutoRelease sceneItem = request.ValidateSceneItem("sceneName", "sceneItemId", statusCode, comment,
-								      OBS_WEBSOCKET_SCENE_FILTER_SCENE_OR_GROUP);
+	OBSSceneItemAutoRelease sceneItem = request.ValidateSceneItem(statusCode, comment, OBS_WEBSOCKET_SCENE_FILTER_SCENE_OR_GROUP);
 	if (!sceneItem)
 		return RequestResult::Error(statusCode, comment);
 
@@ -628,7 +678,8 @@ RequestResult RequestHandler::GetSceneItemIndex(const Request &request)
  *
  * Scenes and Groups
  *
- * @requestField sceneName      | String | Name of the scene the item is in
+ * @requestField ?sceneName     | String | Name of the scene the item is in
+ * @requestField ?sceneUuid     | String | UUID of the scene the item is in
  * @requestField sceneItemId    | Number | Numeric ID of the scene item         | >= 0
  * @requestField sceneItemIndex | Number | New index position of the scene item | >= 0
  *
@@ -643,8 +694,7 @@ RequestResult RequestHandler::SetSceneItemIndex(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSceneItemAutoRelease sceneItem = request.ValidateSceneItem("sceneName", "sceneItemId", statusCode, comment,
-								      OBS_WEBSOCKET_SCENE_FILTER_SCENE_OR_GROUP);
+	OBSSceneItemAutoRelease sceneItem = request.ValidateSceneItem(statusCode, comment, OBS_WEBSOCKET_SCENE_FILTER_SCENE_OR_GROUP);
 	if (!(sceneItem && request.ValidateNumber("sceneItemIndex", statusCode, comment, 0, 8192)))
 		return RequestResult::Error(statusCode, comment);
 
@@ -670,7 +720,8 @@ RequestResult RequestHandler::SetSceneItemIndex(const Request &request)
  *
  * Scenes and Groups
  *
- * @requestField sceneName   | String | Name of the scene the item is in
+ * @requestField ?sceneName  | String | Name of the scene the item is in
+ * @requestField ?sceneUuid  | String | UUID of the scene the item is in
  * @requestField sceneItemId | Number | Numeric ID of the scene item | >= 0
  *
  * @responseField sceneItemBlendMode | String | Current blend mode
@@ -686,8 +737,7 @@ RequestResult RequestHandler::GetSceneItemBlendMode(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSceneItemAutoRelease sceneItem = request.ValidateSceneItem("sceneName", "sceneItemId", statusCode, comment,
-								      OBS_WEBSOCKET_SCENE_FILTER_SCENE_OR_GROUP);
+	OBSSceneItemAutoRelease sceneItem = request.ValidateSceneItem(statusCode, comment, OBS_WEBSOCKET_SCENE_FILTER_SCENE_OR_GROUP);
 	if (!sceneItem)
 		return RequestResult::Error(statusCode, comment);
 
@@ -704,7 +754,8 @@ RequestResult RequestHandler::GetSceneItemBlendMode(const Request &request)
  *
  * Scenes and Groups
  *
- * @requestField sceneName          | String | Name of the scene the item is in
+ * @requestField ?sceneName         | String | Name of the scene the item is in
+ * @requestField ?sceneUuid         | String | UUID of the scene the item is in
  * @requestField sceneItemId        | Number | Numeric ID of the scene item | >= 0
  * @requestField sceneItemBlendMode | String | New blend mode
  *
@@ -719,8 +770,7 @@ RequestResult RequestHandler::SetSceneItemBlendMode(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSceneItemAutoRelease sceneItem = request.ValidateSceneItem("sceneName", "sceneItemId", statusCode, comment,
-								      OBS_WEBSOCKET_SCENE_FILTER_SCENE_OR_GROUP);
+	OBSSceneItemAutoRelease sceneItem = request.ValidateSceneItem(statusCode, comment, OBS_WEBSOCKET_SCENE_FILTER_SCENE_OR_GROUP);
 	if (!(sceneItem && request.ValidateString("sceneItemBlendMode", statusCode, comment)))
 		return RequestResult::Error(statusCode, comment);
 
@@ -739,8 +789,7 @@ RequestResult RequestHandler::GetSceneItemPrivateSettings(const Request &request
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSceneItemAutoRelease sceneItem = request.ValidateSceneItem("sceneName", "sceneItemId", statusCode, comment,
-								      OBS_WEBSOCKET_SCENE_FILTER_SCENE_OR_GROUP);
+	OBSSceneItemAutoRelease sceneItem = request.ValidateSceneItem(statusCode, comment, OBS_WEBSOCKET_SCENE_FILTER_SCENE_OR_GROUP);
 	if (!sceneItem)
 		return RequestResult::Error(statusCode, comment);
 
@@ -757,8 +806,7 @@ RequestResult RequestHandler::SetSceneItemPrivateSettings(const Request &request
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSceneItemAutoRelease sceneItem = request.ValidateSceneItem("sceneName", "sceneItemId", statusCode, comment,
-								      OBS_WEBSOCKET_SCENE_FILTER_SCENE_OR_GROUP);
+	OBSSceneItemAutoRelease sceneItem = request.ValidateSceneItem(statusCode, comment, OBS_WEBSOCKET_SCENE_FILTER_SCENE_OR_GROUP);
 	if (!sceneItem || !request.ValidateObject("sceneItemSettings", statusCode, comment, true))
 		return RequestResult::Error(statusCode, comment);
 

src/requesthandler/RequestHandler_Scenes.cpp

@@ -22,8 +22,10 @@ with this program. If not, see <https://www.gnu.org/licenses/>
 /**
  * Gets an array of all scenes in OBS.
  *
- * @responseField currentProgramSceneName | String        | Current program scene
- * @responseField currentPreviewSceneName | String        | Current preview scene. `null` if not in studio mode
+ * @responseField currentProgramSceneName | String        | Current program scene name. Can be `null` if internal state desync
+ * @responseField currentProgramSceneUuid | String        | Current program scene UUID. Can be `null` if internal state desync
+ * @responseField currentPreviewSceneName | String        | Current preview scene name. `null` if not in studio mode
+ * @responseField currentPreviewSceneUuid | String        | Current preview scene UUID. `null` if not in studio mode
  * @responseField scenes                  | Array<Object> | Array of scenes
  *
  * @requestType GetSceneList
@@ -38,16 +40,22 @@ RequestResult RequestHandler::GetSceneList(const Request &)
 	json responseData;
 
 	OBSSourceAutoRelease currentProgramScene = obs_frontend_get_current_scene();
-	if (currentProgramScene)
+	if (currentProgramScene) {
 		responseData["currentProgramSceneName"] = obs_source_get_name(currentProgramScene);
-	else
+		responseData["currentProgramSceneUuid"] = obs_source_get_uuid(currentProgramScene);
+	} else {
 		responseData["currentProgramSceneName"] = nullptr;
+		responseData["currentProgramSceneUuid"] = nullptr;
+	}
 
 	OBSSourceAutoRelease currentPreviewScene = obs_frontend_get_current_preview_scene();
-	if (currentPreviewScene)
+	if (currentPreviewScene) {
 		responseData["currentPreviewSceneName"] = obs_source_get_name(currentPreviewScene);
-	else
+		responseData["currentPreviewSceneUuid"] = obs_source_get_uuid(currentPreviewScene);
+	} else {
 		responseData["currentPreviewSceneName"] = nullptr;
+		responseData["currentPreviewSceneUuid"] = nullptr;
+	}
 
 	responseData["scenes"] = Utils::Obs::ArrayHelper::GetSceneList();
 
@@ -80,7 +88,12 @@ RequestResult RequestHandler::GetGroupList(const Request &)
 /**
  * Gets the current program scene.
  *
- * @responseField currentProgramSceneName | String | Current program scene
+ * Note: This request is slated to have the `currentProgram`-prefixed fields removed from in an upcoming RPC version.
+ *
+ * @responseField sceneName               | String | Current program scene name
+ * @responseField sceneUuid               | String | Current program scene UUID
+ * @responseField currentProgramSceneName | String | Current program scene name (Deprecated)
+ * @responseField currentProgramSceneUuid | String | Current program scene UUID (Deprecated)
  *
  * @requestType GetCurrentProgramScene
  * @complexity 1
@@ -93,7 +106,8 @@ RequestResult RequestHandler::GetCurrentProgramScene(const Request &)
 {
 	json responseData;
 	OBSSourceAutoRelease currentProgramScene = obs_frontend_get_current_scene();
-	responseData["currentProgramSceneName"] = obs_source_get_name(currentProgramScene);
+	responseData["sceneName"] = responseData["currentProgramSceneName"] = obs_source_get_name(currentProgramScene);
+	responseData["sceneUuid"] = responseData["currentProgramSceneUuid"] = obs_source_get_uuid(currentProgramScene);
 
 	return RequestResult::Success(responseData);
 }
@@ -101,7 +115,8 @@ RequestResult RequestHandler::GetCurrentProgramScene(const Request &)
 /**
  * Sets the current program scene.
  *
- * @requestField sceneName | String | Scene to set as the current program scene
+ * @requestField ?sceneName | String | Scene name to set as the current program scene
+ * @requestField ?sceneUuid | String | Scene UUID to set as the current program scene
  *
  * @requestType SetCurrentProgramScene
  * @complexity 1
@@ -114,7 +129,7 @@ RequestResult RequestHandler::SetCurrentProgramScene(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSourceAutoRelease scene = request.ValidateScene("sceneName", statusCode, comment);
+	OBSSourceAutoRelease scene = request.ValidateScene(statusCode, comment);
 	if (!scene)
 		return RequestResult::Error(statusCode, comment);
 
@@ -128,7 +143,12 @@ RequestResult RequestHandler::SetCurrentProgramScene(const Request &request)
  *
  * Only available when studio mode is enabled.
  *
- * @responseField currentPreviewSceneName | String | Current preview scene
+ * Note: This request is slated to have the `currentPreview`-prefixed fields removed from in an upcoming RPC version.
+ *
+ * @responseField sceneName               | String | Current preview scene name
+ * @responseField sceneUuid               | String | Current preview scene UUID
+ * @responseField currentPreviewSceneName | String | Current preview scene name
+ * @responseField currentPreviewSceneUuid | String | Current preview scene UUID
  *
  * @requestType GetCurrentPreviewScene
  * @complexity 1
@@ -145,7 +165,8 @@ RequestResult RequestHandler::GetCurrentPreviewScene(const Request &)
 	OBSSourceAutoRelease currentPreviewScene = obs_frontend_get_current_preview_scene();
 
 	json responseData;
-	responseData["currentPreviewSceneName"] = obs_source_get_name(currentPreviewScene);
+	responseData["sceneName"] = responseData["currentPreviewSceneName"] = obs_source_get_name(currentPreviewScene);
+	responseData["sceneUuid"] = responseData["currentPreviewSceneUuid"] = obs_source_get_uuid(currentPreviewScene);
 
 	return RequestResult::Success(responseData);
 }
@@ -155,7 +176,8 @@ RequestResult RequestHandler::GetCurrentPreviewScene(const Request &)
  *
  * Only available when studio mode is enabled.
  *
- * @requestField sceneName | String | Scene to set as the current preview scene
+ * @requestField ?sceneName | String | Scene name to set as the current preview scene
+ * @requestField ?sceneUuid | String | Scene UUID to set as the current preview scene
  *
  * @requestType SetCurrentPreviewScene
  * @complexity 1
@@ -171,7 +193,7 @@ RequestResult RequestHandler::SetCurrentPreviewScene(const Request &request)
 
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSourceAutoRelease scene = request.ValidateScene("sceneName", statusCode, comment);
+	OBSSourceAutoRelease scene = request.ValidateScene(statusCode, comment);
 	if (!scene)
 		return RequestResult::Error(statusCode, comment);
 
@@ -185,6 +207,8 @@ RequestResult RequestHandler::SetCurrentPreviewScene(const Request &request)
  *
  * @requestField sceneName | String | Name for the new scene
  *
+ * @responseField sceneUuid | String | UUID of the created scene
+ *
  * @requestType CreateScene
  * @complexity 2
  * @rpcVersion -1
@@ -205,19 +229,21 @@ RequestResult RequestHandler::CreateScene(const Request &request)
 	if (scene)
 		return RequestResult::Error(RequestStatus::ResourceAlreadyExists, "A source already exists by that scene name.");
 
-	obs_scene_t *createdScene = obs_scene_create(sceneName.c_str());
+	OBSSceneAutoRelease createdScene = obs_scene_create(sceneName.c_str());
 	if (!createdScene)
 		return RequestResult::Error(RequestStatus::ResourceCreationFailed, "Failed to create the scene.");
 
-	obs_scene_release(createdScene);
+	json responseData;
+	responseData["sceneUuid"] = obs_source_get_uuid(obs_scene_get_source(createdScene));
 
-	return RequestResult::Success();
+	return RequestResult::Success(responseData);
 }
 
 /**
  * Removes a scene from OBS.
  *
- * @requestField sceneName | String | Name of the scene to remove
+ * @requestField ?sceneName | String | Name of the scene to remove
+ * @requestField ?sceneUuid | String | UUID of the scene to remove
  *
  * @requestType RemoveScene
  * @complexity 2
@@ -230,7 +256,7 @@ RequestResult RequestHandler::RemoveScene(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSourceAutoRelease scene = request.ValidateScene("sceneName", statusCode, comment);
+	OBSSourceAutoRelease scene = request.ValidateScene(statusCode, comment);
 	if (!scene)
 		return RequestResult::Error(statusCode, comment);
 
@@ -246,7 +272,8 @@ RequestResult RequestHandler::RemoveScene(const Request &request)
 /**
  * Sets the name of a scene (rename).
  *
- * @requestField sceneName    | String | Name of the scene to be renamed
+ * @requestField ?sceneName   | String | Name of the scene to be renamed
+ * @requestField ?sceneUuid   | String | UUID of the scene to be renamed
  * @requestField newSceneName | String | New name for the scene
  *
  * @requestType SetSceneName
@@ -260,7 +287,7 @@ RequestResult RequestHandler::SetSceneName(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSourceAutoRelease scene = request.ValidateScene("sceneName", statusCode, comment);
+	OBSSourceAutoRelease scene = request.ValidateScene(statusCode, comment);
 	if (!(scene && request.ValidateString("newSceneName", statusCode, comment)))
 		return RequestResult::Error(statusCode, comment);
 
@@ -279,7 +306,10 @@ RequestResult RequestHandler::SetSceneName(const Request &request)
 /**
  * Gets the scene transition overridden for a scene.
  *
- * @requestField sceneName | String | Name of the scene
+ * Note: A transition UUID response field is not currently able to be implemented as of 2024-1-18.
+ *
+ * @requestField ?sceneName | String | Name of the scene
+ * @requestField ?sceneUuid | String | UUID of the scene
  *
  * @responseField transitionName     | String | Name of the overridden scene transition, else `null`
  * @responseField transitionDuration | Number | Duration of the overridden scene transition, else `null`
@@ -295,7 +325,7 @@ RequestResult RequestHandler::GetSceneSceneTransitionOverride(const Request &req
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSourceAutoRelease scene = request.ValidateScene("sceneName", statusCode, comment);
+	OBSSourceAutoRelease scene = request.ValidateScene(statusCode, comment);
 	if (!scene)
 		return RequestResult::Error(statusCode, comment);
 
@@ -319,7 +349,8 @@ RequestResult RequestHandler::GetSceneSceneTransitionOverride(const Request &req
 /**
  * Sets the scene transition overridden for a scene.
  *
- * @requestField sceneName           | String | Name of the scene
+ * @requestField ?sceneName          | String | Name of the scene
+ * @requestField ?sceneUuid          | String | UUID of the scene
  * @requestField ?transitionName     | String | Name of the scene transition to use as override. Specify `null` to remove | Unchanged
  * @requestField ?transitionDuration | Number | Duration to use for any overridden transition. Specify `null` to remove | >= 50, <= 20000 | Unchanged
  *
@@ -334,7 +365,7 @@ RequestResult RequestHandler::SetSceneSceneTransitionOverride(const Request &req
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSourceAutoRelease scene = request.ValidateScene("sceneName", statusCode, comment);
+	OBSSourceAutoRelease scene = request.ValidateScene(statusCode, comment);
 	if (!scene)
 		return RequestResult::Error(statusCode, comment);
 

src/requesthandler/RequestHandler_Sources.cpp

@@ -114,7 +114,8 @@ bool IsImageFormatValid(std::string format)
  *
  * **Compatible with inputs and scenes.**
  *
- * @requestField sourceName | String | Name of the source to get the active state of
+ * @requestField ?sourceName | String | Name of the source to get the active state of
+ * @requestField ?sourceUuid | String | UUID of the source to get the active state of
  *
  * @responseField videoActive  | Boolean | Whether the source is showing in Program
  * @responseField videoShowing | Boolean | Whether the source is showing in the UI (Preview, Projector, Properties)
@@ -130,7 +131,7 @@ RequestResult RequestHandler::GetSourceActive(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSourceAutoRelease source = request.ValidateSource("sourceName", statusCode, comment);
+	OBSSourceAutoRelease source = request.ValidateSource("sourceName", "sourceUuid", statusCode, comment);
 	if (!source)
 		return RequestResult::Error(statusCode, comment);
 
@@ -151,7 +152,8 @@ RequestResult RequestHandler::GetSourceActive(const Request &request)
  *
  * **Compatible with inputs and scenes.**
  *
- * @requestField sourceName               | String | Name of the source to take a screenshot of
+ * @requestField ?sourceName              | String | Name of the source to take a screenshot of
+ * @requestField ?sourceUuid              | String | UUID of the source to take a screenshot of
  * @requestField imageFormat              | String | Image compression format to use. Use `GetVersion` to get compatible image formats
  * @requestField ?imageWidth              | Number | Width to scale the screenshot to                                                                                         | >= 8, <= 4096 | Source value is used
  * @requestField ?imageHeight             | Number | Height to scale the screenshot to                                                                                        | >= 8, <= 4096 | Source value is used
@@ -170,7 +172,7 @@ RequestResult RequestHandler::GetSourceScreenshot(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSourceAutoRelease source = request.ValidateSource("sourceName", statusCode, comment);
+	OBSSourceAutoRelease source = request.ValidateSource("sourceName", "sourceUuid", statusCode, comment);
 	if (!(source && request.ValidateString("imageFormat", statusCode, comment)))
 		return RequestResult::Error(statusCode, comment);
 
@@ -238,15 +240,14 @@ RequestResult RequestHandler::GetSourceScreenshot(const Request &request)
  *
  * **Compatible with inputs and scenes.**
  *
- * @requestField sourceName               | String | Name of the source to take a screenshot of
+ * @requestField ?sourceName              | String | Name of the source to take a screenshot of
+ * @requestField ?sourceUuid              | String | UUID of the source to take a screenshot of
  * @requestField imageFormat              | String | Image compression format to use. Use `GetVersion` to get compatible image formats
  * @requestField imageFilePath            | String | Path to save the screenshot file to. Eg. `C:\Users\user\Desktop\screenshot.png`
  * @requestField ?imageWidth              | Number | Width to scale the screenshot to                                                                                         | >= 8, <= 4096 | Source value is used
  * @requestField ?imageHeight             | Number | Height to scale the screenshot to                                                                                        | >= 8, <= 4096 | Source value is used
  * @requestField ?imageCompressionQuality | Number | Compression quality to use. 0 for high compression, 100 for uncompressed. -1 to use "default" (whatever that means, idk) | >= -1, <= 100 | -1
  *
- * @responseField imageData | String | Base64-encoded screenshot
- *
  * @requestType SaveSourceScreenshot
  * @complexity 3
  * @rpcVersion -1
@@ -258,7 +259,7 @@ RequestResult RequestHandler::SaveSourceScreenshot(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSourceAutoRelease source = request.ValidateSource("sourceName", statusCode, comment);
+	OBSSourceAutoRelease source = request.ValidateSource("sourceName", "sourceUuid", statusCode, comment);
 	if (!(source && request.ValidateString("imageFormat", statusCode, comment) &&
 	      request.ValidateString("imageFilePath", statusCode, comment)))
 		return RequestResult::Error(statusCode, comment);
@@ -321,7 +322,7 @@ RequestResult RequestHandler::GetSourcePrivateSettings(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSourceAutoRelease source = request.ValidateSource("sourceName", statusCode, comment);
+	OBSSourceAutoRelease source = request.ValidateSource("sourceName", "sourceUuid", statusCode, comment);
 	if (!source)
 		return RequestResult::Error(statusCode, comment);
 
@@ -338,7 +339,7 @@ RequestResult RequestHandler::SetSourcePrivateSettings(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSourceAutoRelease source = request.ValidateSource("sourceName", statusCode, comment);
+	OBSSourceAutoRelease source = request.ValidateSource("sourceName", "sourceUuid", statusCode, comment);
 	if (!source || !request.ValidateObject("sourceSettings", statusCode, comment, true))
 		return RequestResult::Error(statusCode, comment);
 

src/requesthandler/RequestHandler_Transitions.cpp

@@ -46,6 +46,7 @@ RequestResult RequestHandler::GetTransitionKindList(const Request &)
  * Gets an array of all scene transitions in OBS.
  *
  * @responseField currentSceneTransitionName | String         | Name of the current scene transition. Can be null
+ * @responseField currentSceneTransitionUuid | String         | UUID of the current scene transition. Can be null
  * @responseField currentSceneTransitionKind | String         | Kind of the current scene transition. Can be null
  * @responseField transitions                | Array<Object> | Array of transitions
  *
@@ -63,9 +64,11 @@ RequestResult RequestHandler::GetSceneTransitionList(const Request &)
 	OBSSourceAutoRelease transition = obs_frontend_get_current_transition();
 	if (transition) {
 		responseData["currentSceneTransitionName"] = obs_source_get_name(transition);
+		responseData["currentSceneTransitionUuid"] = obs_source_get_uuid(transition);
 		responseData["currentSceneTransitionKind"] = obs_source_get_id(transition);
 	} else {
 		responseData["currentSceneTransitionName"] = nullptr;
+		responseData["currentSceneTransitionUuid"] = nullptr;
 		responseData["currentSceneTransitionKind"] = nullptr;
 	}
 
@@ -78,6 +81,7 @@ RequestResult RequestHandler::GetSceneTransitionList(const Request &)
  * Gets information about the current scene transition.
  *
  * @responseField transitionName         | String  | Name of the transition
+ * @responseField transitionUuid         | String  | UUID of the transition
  * @responseField transitionKind         | String  | Kind of the transition
  * @responseField transitionFixed        | Boolean | Whether the transition uses a fixed (unconfigurable) duration
  * @responseField transitionDuration     | Number  | Configured transition duration in milliseconds. `null` if transition is fixed
@@ -100,6 +104,7 @@ RequestResult RequestHandler::GetCurrentSceneTransition(const Request &)
 
 	json responseData;
 	responseData["transitionName"] = obs_source_get_name(transition);
+	responseData["transitionUuid"] = obs_source_get_uuid(transition);
 	responseData["transitionKind"] = obs_source_get_id(transition);
 
 	if (obs_transition_fixed(transition)) {

src/requesthandler/RequestHandler_Ui.cpp

@@ -82,7 +82,8 @@ RequestResult RequestHandler::SetStudioModeEnabled(const Request &request)
 /**
  * Opens the properties dialog of an input.
  *
- * @requestField inputName | String | Name of the input to open the dialog of
+ * @requestField ?inputName | String | Name of the input to open the dialog of
+ * @requestField ?inputUuid | String | UUID of the input to open the dialog of
  *
  * @requestType OpenInputPropertiesDialog
  * @complexity 1
@@ -95,7 +96,7 @@ RequestResult RequestHandler::OpenInputPropertiesDialog(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSourceAutoRelease input = request.ValidateInput("inputName", statusCode, comment);
+	OBSSourceAutoRelease input = request.ValidateInput(statusCode, comment);
 	if (!input)
 		return RequestResult::Error(statusCode, comment);
 
@@ -107,7 +108,8 @@ RequestResult RequestHandler::OpenInputPropertiesDialog(const Request &request)
 /**
  * Opens the filters dialog of an input.
  *
- * @requestField inputName | String | Name of the input to open the dialog of
+ * @requestField ?inputName | String | Name of the input to open the dialog of
+ * @requestField ?inputUuid | String | UUID of the input to open the dialog of
  *
  * @requestType OpenInputFiltersDialog
  * @complexity 1
@@ -120,7 +122,7 @@ RequestResult RequestHandler::OpenInputFiltersDialog(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSourceAutoRelease input = request.ValidateInput("inputName", statusCode, comment);
+	OBSSourceAutoRelease input = request.ValidateInput(statusCode, comment);
 	if (!input)
 		return RequestResult::Error(statusCode, comment);
 
@@ -132,7 +134,8 @@ RequestResult RequestHandler::OpenInputFiltersDialog(const Request &request)
 /**
  * Opens the interact dialog of an input.
  *
- * @requestField inputName | String | Name of the input to open the dialog of
+ * @requestField ?inputName | String | Name of the input to open the dialog of
+ * @requestField ?inputUuid | String | UUID of the input to open the dialog of
  *
  * @requestType OpenInputInteractDialog
  * @complexity 1
@@ -145,7 +148,7 @@ RequestResult RequestHandler::OpenInputInteractDialog(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSourceAutoRelease input = request.ValidateInput("inputName", statusCode, comment);
+	OBSSourceAutoRelease input = request.ValidateInput(statusCode, comment);
 	if (!input)
 		return RequestResult::Error(statusCode, comment);
 
@@ -262,7 +265,8 @@ RequestResult RequestHandler::OpenVideoMixProjector(const Request &request)
  *
  * Note: This request serves to provide feature parity with 4.x. It is very likely to be changed/deprecated in a future release.
  *
- * @requestField sourceName         | String | Name of the source to open a projector for
+ * @requestField ?sourceName        | String | Name of the source to open a projector for
+ * @requestField ?sourceUuid        | String | UUID of the source to open a projector for
  * @requestField ?monitorIndex      | Number | Monitor index, use `GetMonitorList` to obtain index | None | -1: Opens projector in windowed mode
  * @requestField ?projectorGeometry | String | Size/Position data for a windowed projector, in Qt Base64 encoded format. Mutually exclusive with `monitorIndex` | N/A
  *
@@ -277,7 +281,7 @@ RequestResult RequestHandler::OpenSourceProjector(const Request &request)
 {
 	RequestStatus::RequestStatus statusCode;
 	std::string comment;
-	OBSSourceAutoRelease source = request.ValidateSource("sourceName", statusCode, comment);
+	OBSSourceAutoRelease source = request.ValidateSource("sourceName", "sourceUuid", statusCode, comment);
 	if (!source)
 		return RequestResult::Error(statusCode, comment);
 

src/requesthandler/rpc/Request.cpp

@@ -211,28 +211,39 @@ bool Request::ValidateArray(const std::string &keyName, RequestStatus::RequestSt
 	return true;
 }
 
-obs_source_t *Request::ValidateSource(const std::string &keyName, RequestStatus::RequestStatus &statusCode,
+obs_source_t *Request::ValidateSource(const std::string &nameKeyName, const std::string &uuidKeyName, RequestStatus::RequestStatus &statusCode,
 				      std::string &comment) const
 {
-	if (!ValidateString(keyName, statusCode, comment))
-		return nullptr;
-
-	std::string sourceName = RequestData[keyName];
-
+	if (ValidateString(nameKeyName, statusCode, comment)) {
+		std::string sourceName = RequestData[nameKeyName];
 		obs_source_t *ret = obs_get_source_by_name(sourceName.c_str());
 		if (!ret) {
 			statusCode = RequestStatus::ResourceNotFound;
 			comment = std::string("No source was found by the name of `") + sourceName + "`.";
 			return nullptr;
 		}
-
 		return ret;
 	}
 
-obs_source_t *Request::ValidateScene(const std::string &keyName, RequestStatus::RequestStatus &statusCode, std::string &comment,
-				     const ObsWebSocketSceneFilter filter) const
+	if (ValidateString(uuidKeyName, statusCode, comment)) {
+		std::string sourceUuid = RequestData[uuidKeyName];
+		obs_source_t *ret = obs_get_source_by_uuid(sourceUuid.c_str());
+		if (!ret) {
+			statusCode = RequestStatus::ResourceNotFound;
+			comment = std::string("No source was found by the UUID of `") + sourceUuid + "`.";
+			return nullptr;
+		}
+		return ret;
+	}
+
+	statusCode = RequestStatus::MissingRequestField;
+	comment = std::string("Your request must contain at least one of the following fields: `") + nameKeyName + "` or `" + uuidKeyName + "`.";
+	return nullptr;
+}
+
+obs_source_t *Request::ValidateScene(RequestStatus::RequestStatus &statusCode, std::string &comment, const ObsWebSocketSceneFilter filter) const
 {
-	obs_source_t *ret = ValidateSource(keyName, statusCode, comment);
+	obs_source_t *ret = ValidateSource("sceneName", "sceneUuid", statusCode, comment);
 	if (!ret)
 		return nullptr;
 
@@ -259,10 +270,9 @@ obs_source_t *Request::ValidateScene(const std::string &keyName, RequestStatus::
 	return ret;
 }
 
-obs_scene_t *Request::ValidateScene2(const std::string &keyName, RequestStatus::RequestStatus &statusCode, std::string &comment,
-				     const ObsWebSocketSceneFilter filter) const
+obs_scene_t *Request::ValidateScene2(RequestStatus::RequestStatus &statusCode, std::string &comment, const ObsWebSocketSceneFilter filter) const
 {
-	OBSSourceAutoRelease sceneSource = ValidateSource(keyName, statusCode, comment);
+	OBSSourceAutoRelease sceneSource = ValidateSource("sceneName", "sceneUuid", statusCode, comment);
 	if (!sceneSource)
 		return nullptr;
 
@@ -290,10 +300,9 @@ obs_scene_t *Request::ValidateScene2(const std::string &keyName, RequestStatus::
 	}
 }
 
-obs_source_t *Request::ValidateInput(const std::string &keyName, RequestStatus::RequestStatus &statusCode,
-				     std::string &comment) const
+obs_source_t *Request::ValidateInput(RequestStatus::RequestStatus &statusCode, std::string &comment) const
 {
-	obs_source_t *ret = ValidateSource(keyName, statusCode, comment);
+	obs_source_t *ret = ValidateSource("inputName", "inputUuid", statusCode, comment);
 	if (!ret)
 		return nullptr;
 
@@ -307,47 +316,44 @@ obs_source_t *Request::ValidateInput(const std::string &keyName, RequestStatus::
 	return ret;
 }
 
-FilterPair Request::ValidateFilter(const std::string &sourceKeyName, const std::string &filterKeyName,
-				   RequestStatus::RequestStatus &statusCode, std::string &comment) const
+FilterPair Request::ValidateFilter(RequestStatus::RequestStatus &statusCode, std::string &comment) const
 {
-	obs_source_t *source = ValidateSource(sourceKeyName, statusCode, comment);
+	obs_source_t *source = ValidateSource("sourceName", "sourceUuid", statusCode, comment);
 	if (!source)
 		return FilterPair{source, nullptr};
 
-	if (!ValidateString(filterKeyName, statusCode, comment))
+	if (!ValidateString("filterName", statusCode, comment))
 		return FilterPair{source, nullptr};
 
-	std::string filterName = RequestData[filterKeyName];
+	std::string filterName = RequestData["filterName"];
 
 	obs_source_t *filter = obs_source_get_filter_by_name(source, filterName.c_str());
 	if (!filter) {
+		std::string sourceName = obs_source_get_name(source);
 		statusCode = RequestStatus::ResourceNotFound;
-		comment = std::string("No filter was found in the source `") + RequestData[sourceKeyName].get<std::string>() +
-			  "` with the name `" + filterName + "`.";
+		comment = std::string("No filter was found in the source `") + sourceName + "` with the name `" + filterName + "`.";
 		return FilterPair{source, nullptr};
 	}
 
 	return FilterPair{source, filter};
 }
 
-obs_sceneitem_t *Request::ValidateSceneItem(const std::string &sceneKeyName, const std::string &sceneItemIdKeyName,
-					    RequestStatus::RequestStatus &statusCode, std::string &comment,
-					    const ObsWebSocketSceneFilter filter) const
+obs_sceneitem_t *Request::ValidateSceneItem(RequestStatus::RequestStatus &statusCode, std::string &comment, const ObsWebSocketSceneFilter filter) const
 {
-	OBSSceneAutoRelease scene = ValidateScene2(sceneKeyName, statusCode, comment, filter);
+	OBSSceneAutoRelease scene = ValidateScene2(statusCode, comment, filter);
 	if (!scene)
 		return nullptr;
 
-	if (!ValidateNumber(sceneItemIdKeyName, statusCode, comment, 0))
+	if (!ValidateNumber("sceneItemId", statusCode, comment, 0))
 		return nullptr;
 
-	int64_t sceneItemId = RequestData[sceneItemIdKeyName];
+	int64_t sceneItemId = RequestData["sceneItemId"];
 
 	OBSSceneItem sceneItem = obs_scene_find_sceneitem_by_id(scene, sceneItemId);
 	if (!sceneItem) {
+		std::string sceneName = obs_source_get_name(obs_scene_get_source(scene));
 		statusCode = RequestStatus::ResourceNotFound;
-		comment = std::string("No scene items were found in scene `") + RequestData[sceneKeyName].get<std::string>() +
-			  "` with the ID `" + std::to_string(sceneItemId) + "`.";
+		comment = std::string("No scene items were found in scene `") + sceneName + "` with the ID `" + std::to_string(sceneItemId) + "`.";
 		return nullptr;
 	}
 

src/requesthandler/rpc/Request.h

@@ -64,21 +64,13 @@ struct Request {
 			   const bool allowEmpty = false) const;
 
 	// All return values have incremented refcounts
-	obs_source_t *ValidateSource(const std::string &keyName, RequestStatus::RequestStatus &statusCode,
-				     std::string &comment) const;
-	obs_source_t *ValidateScene(const std::string &keyName, RequestStatus::RequestStatus &statusCode, std::string &comment,
-				    const ObsWebSocketSceneFilter filter = OBS_WEBSOCKET_SCENE_FILTER_SCENE_ONLY) const;
-	obs_scene_t *ValidateScene2(const std::string &keyName, RequestStatus::RequestStatus &statusCode, std::string &comment,
-				    const ObsWebSocketSceneFilter filter = OBS_WEBSOCKET_SCENE_FILTER_SCENE_ONLY) const;
-	obs_source_t *ValidateInput(const std::string &keyName, RequestStatus::RequestStatus &statusCode,
-				    std::string &comment) const;
-	FilterPair ValidateFilter(const std::string &sourceKeyName, const std::string &filterKeyName,
-				  RequestStatus::RequestStatus &statusCode, std::string &comment) const;
-	obs_sceneitem_t *ValidateSceneItem(const std::string &sceneKeyName, const std::string &sceneItemIdKeyName,
-					   RequestStatus::RequestStatus &statusCode, std::string &comment,
-					   const ObsWebSocketSceneFilter filter = OBS_WEBSOCKET_SCENE_FILTER_SCENE_ONLY) const;
-	obs_output_t *ValidateOutput(const std::string &keyName, RequestStatus::RequestStatus &statusCode,
-				     std::string &comment) const;
+	obs_source_t *ValidateSource(const std::string &nameKeyName, const std::string &uuidKeyName, RequestStatus::RequestStatus &statusCode, std::string &comment) const;
+	obs_source_t *ValidateScene(RequestStatus::RequestStatus &statusCode, std::string &comment, const ObsWebSocketSceneFilter filter = OBS_WEBSOCKET_SCENE_FILTER_SCENE_ONLY) const;
+	obs_scene_t *ValidateScene2(RequestStatus::RequestStatus &statusCode, std::string &comment, const ObsWebSocketSceneFilter filter = OBS_WEBSOCKET_SCENE_FILTER_SCENE_ONLY) const;
+	obs_source_t *ValidateInput(RequestStatus::RequestStatus &statusCode, std::string &comment) const;
+	FilterPair ValidateFilter(RequestStatus::RequestStatus &statusCode, std::string &comment) const;
+	obs_sceneitem_t *ValidateSceneItem(RequestStatus::RequestStatus &statusCode, std::string &comment, const ObsWebSocketSceneFilter filter = OBS_WEBSOCKET_SCENE_FILTER_SCENE_ONLY) const;
+	obs_output_t *ValidateOutput(const std::string &keyName, RequestStatus::RequestStatus &statusCode, std::string &comment) const;
 
 	std::string RequestType;
 	bool HasRequestData;

src/utils/Obs_ArrayHelper.cpp

@@ -96,6 +96,7 @@ std::vector<json> Utils::Obs::ArrayHelper::GetSceneList()
 
 		json sceneJson;
 		sceneJson["sceneName"] = obs_source_get_name(scene);
+		sceneJson["sceneUuid"] = obs_source_get_uuid(scene);
 		sceneJson["sceneIndex"] = sceneList.sources.num - i - 1;
 
 		ret.push_back(sceneJson);
@@ -150,6 +151,7 @@ std::vector<json> Utils::Obs::ArrayHelper::GetSceneItemList(obs_scene_t *scene,
 			item["sceneItemBlendMode"] = obs_sceneitem_get_blending_mode(sceneItem);
 			OBSSource itemSource = obs_sceneitem_get_source(sceneItem);
 			item["sourceName"] = obs_source_get_name(itemSource);
+			item["sourceUuid"] = obs_source_get_uuid(itemSource);
 			item["sourceType"] = obs_source_get_type(itemSource);
 			if (obs_source_get_type(itemSource) == OBS_SOURCE_TYPE_INPUT)
 				item["inputKind"] = obs_source_get_id(itemSource);
@@ -195,6 +197,7 @@ std::vector<json> Utils::Obs::ArrayHelper::GetInputList(std::string inputKind)
 
 		json inputJson;
 		inputJson["inputName"] = obs_source_get_name(input);
+		inputJson["inputUuid"] = obs_source_get_uuid(input);
 		inputJson["inputKind"] = inputKind;
 		inputJson["unversionedInputKind"] = obs_source_get_unversioned_id(input);
 
@@ -281,6 +284,7 @@ std::vector<json> Utils::Obs::ArrayHelper::GetSceneTransitionList()
 		obs_source_t *transition = transitionList.sources.array[i];
 		json transitionJson;
 		transitionJson["transitionName"] = obs_source_get_name(transition);
+		transitionJson["transitionUuid"] = obs_source_get_uuid(transition);
 		transitionJson["transitionKind"] = obs_source_get_id(transition);
 		transitionJson["transitionFixed"] = obs_transition_fixed(transition);
 		transitionJson["transitionConfigurable"] = obs_source_configurable(transition);

src/utils/Obs_StringHelper.cpp

@@ -20,6 +20,8 @@ with this program. If not, see <https://www.gnu.org/licenses/>
 #include <inttypes.h>
 #include <QString>
 
+#include <util/util.hpp>
+
 #include "Obs.h"
 #include "plugin-macros.generated.h"
 
@@ -42,33 +44,29 @@ std::string Utils::Obs::StringHelper::GetObsVersion()
 
 std::string Utils::Obs::StringHelper::GetCurrentSceneCollection()
 {
-	char *sceneCollectionName = obs_frontend_get_current_scene_collection();
-	std::string ret = sceneCollectionName;
-	bfree(sceneCollectionName);
+	BPtr<char> sceneCollectionName = obs_frontend_get_current_scene_collection();
+	std::string ret = sceneCollectionName.Get();
 	return ret;
 }
 
 std::string Utils::Obs::StringHelper::GetCurrentProfile()
 {
-	char *profileName = obs_frontend_get_current_profile();
-	std::string ret = profileName;
-	bfree(profileName);
+	BPtr<char> profileName = obs_frontend_get_current_profile();
+	std::string ret = profileName.Get();
 	return ret;
 }
 
 std::string Utils::Obs::StringHelper::GetCurrentProfilePath()
 {
-	char *profilePath = obs_frontend_get_current_profile_path();
-	std::string ret = profilePath;
-	bfree(profilePath);
+	BPtr<char> profilePath = obs_frontend_get_current_profile_path();
+	std::string ret = profilePath.Get();
 	return ret;
 }
 
 std::string Utils::Obs::StringHelper::GetCurrentRecordOutputPath()
 {
-	char *recordOutputPath = obs_frontend_get_current_record_output_path();
-	std::string ret = recordOutputPath;
-	bfree(recordOutputPath);
+	BPtr<char> recordOutputPath = obs_frontend_get_current_record_output_path();
+	std::string ret = recordOutputPath.Get();
 	return ret;
 }
 
@@ -94,17 +92,15 @@ std::string Utils::Obs::StringHelper::GetLastRecordFileName()
 
 std::string Utils::Obs::StringHelper::GetLastReplayBufferFileName()
 {
-	char *replayBufferPath = obs_frontend_get_last_replay();
-	std::string ret = replayBufferPath;
-	bfree(replayBufferPath);
+	BPtr<char> replayBufferPath = obs_frontend_get_last_replay();
+	std::string ret = replayBufferPath.Get();
 	return ret;
 }
 
 std::string Utils::Obs::StringHelper::GetLastScreenshotFileName()
 {
-	char *screenshotPath = obs_frontend_get_last_screenshot();
-	std::string ret = screenshotPath;
-	bfree(screenshotPath);
+	BPtr<char> screenshotPath = obs_frontend_get_last_screenshot();
+	std::string ret = screenshotPath.Get();
 	return ret;
 }
 

src/utils/Obs_VolumeMeter.cpp

@@ -93,6 +93,7 @@ json Utils::Obs::VolumeMeter::Meter::GetMeterData()
 	l.unlock();
 
 	ret["inputName"] = obs_source_get_name(input);
+	ret["inputUuid"] = obs_source_get_uuid(input);
 	ret["inputLevelsMul"] = levels;
 
 	return ret;