Requests: Add GetSceneItemList

Adds a new `GetSceneItemList` request to get all scene items in a
specified scene.

src/WSRequestHandler.cpp

@@ -52,6 +52,7 @@ const QHash<QString, RpcMethodHandler> WSRequestHandler::messageMap {
 	{ "GetSceneTransitionOverride", &WSRequestHandler::GetSceneTransitionOverride },
 
 	{ "SetSourceRender", &WSRequestHandler::SetSceneItemRender }, // Retrocompat
+	{ "GetSceneItemList", &WSRequestHandler::GetSceneItemList },
 	{ "SetSceneItemRender", &WSRequestHandler::SetSceneItemRender },
 	{ "SetSceneItemPosition", &WSRequestHandler::SetSceneItemPosition },
 	{ "SetSceneItemTransform", &WSRequestHandler::SetSceneItemTransform },

src/WSRequestHandler.h

@@ -69,6 +69,7 @@ class WSRequestHandler {
 		RpcResponse RemoveSceneTransitionOverride(const RpcRequest&);
 		RpcResponse GetSceneTransitionOverride(const RpcRequest&);
 
+		RpcResponse GetSceneItemList(const RpcRequest&);
 		RpcResponse SetSceneItemRender(const RpcRequest&);
 		RpcResponse SetSceneItemPosition(const RpcRequest&);
 		RpcResponse SetSceneItemTransform(const RpcRequest&);

src/WSRequestHandler_SceneItems.cpp

@@ -14,6 +14,73 @@ void AddSourceHelper(void *_data, obs_scene_t *scene) {
 	obs_sceneitem_set_visible(data->sceneItem, data->setVisible);
 }
 
+/**
+* Get a list of all scene items in a scene.
+*
+* @param {String} `sceneName` Name of the scene to get the list of scene items from.
+*
+* @return {Array<Object>} `sceneItems` Array of scene items
+* @return {int} `sceneItems.*.itemId` Unique item id of the source item
+* @return {String} `sceneItems.*.sourceId` ID if the scene item's source. For example `vlc_source` or `image_source`
+* @return {String} `sceneItems.*.sourceName` Name of the scene item's source
+* @return {String} `sceneItems.*.sourceType` Type of the scene item's source. Either `input` or `scene`
+* 
+* @api requests
+* @name GetSceneItemList
+* @category scene items
+* @since unreleased
+*/
+RpcResponse WSRequestHandler::GetSceneItemList(const RpcRequest& request) {
+	if (!request.hasField("sceneName")) {
+		return request.failed("missing request parameters");
+	}
+
+	const char* sceneName = obs_data_get_string(request.parameters(), "sceneName");
+	OBSSourceAutoRelease sceneSource = obs_get_source_by_name(sceneName);
+	OBSScene scene = obs_scene_from_source(sceneSource);
+	if (!scene) {
+		return request.failed("requested scene is invalid or doesnt exist");
+	}
+
+	OBSDataArrayAutoRelease sceneItemArray = obs_data_array_create();
+
+	auto sceneItemEnumProc = [](obs_scene_t *, obs_sceneitem_t* item, void* privateData) -> bool {
+		obs_data_array_t* sceneItemArray = (obs_data_array_t*)privateData;
+
+		OBSDataAutoRelease sceneItemData = obs_data_create();
+		obs_data_set_int(sceneItemData, "itemId", obs_sceneitem_get_id(item));
+		OBSSource source = obs_sceneitem_get_source(item);
+		obs_data_set_string(sceneItemData, "sourceId", obs_source_get_id(source));
+		obs_data_set_string(sceneItemData, "sourceName", obs_source_get_name(source));
+
+		QString typeString = "";
+		enum obs_source_type sourceType = obs_source_get_type(source);
+		switch (sourceType) {
+		case OBS_SOURCE_TYPE_INPUT:
+			typeString = "input";
+			break;
+
+		case OBS_SOURCE_TYPE_SCENE:
+			typeString = "scene";
+			break;
+
+		default:
+			typeString = "unknown";
+			break;
+		}
+		obs_data_set_string(sceneItemData, "sourceType", typeString.toUtf8());
+
+		obs_data_array_push_back(sceneItemArray, sceneItemData);
+		return true;
+	};
+	obs_scene_enum_items(scene, sceneItemEnumProc, sceneItemArray);
+
+	OBSDataAutoRelease response = obs_data_create();
+	obs_data_set_array(response, "sceneItems", sceneItemArray);
+
+	return request.success(response);
+}
+
 /**
 * Gets the scene specific properties of the specified source item.
 * Coordinates are relative to the item's parent (the scene or group it belongs to).