eventhandler: Implement input, scene, and transition UUID support

Adds `inputUuid` next to `inputName` etc.

Author: tt2468

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,13 +147,15 @@ 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);
 }
 
 /**
  * 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,13 +178,15 @@ 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);
 }
 
 /**
  * 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);