Merge pull request #330 from Palakis/transitionbegin-hotfix

Fix TransitionBegin event

.gitmodules

@@ -0,0 +1,6 @@
+[submodule "deps/websocketpp"]
+	path = deps/websocketpp
+	url = https://github.com/zaphoyd/websocketpp.git
+[submodule "deps/asio"]
+	path = deps/asio
+	url = https://github.com/chriskohlhoff/asio.git

BUILDING.md

@@ -1,21 +1,26 @@
 # Compiling obs-websocket
+
 ## Prerequisites
+
 You'll need [Qt 5.10.x](https://download.qt.io/official_releases/qt/5.10/),
-[CMake](https://cmake.org/download/), and a working [development environment for
+[CMake](https://cmake.org/download/), [Boost](https://www.boost.org/) and a working [OBS Studio development environment](https://obsproject.com/wiki/install-instructions) installed on your
-OBS Studio](https://obsproject.com/wiki/install-instructions) installed on your
 computer.
 
 ## Windows
+
 In cmake-gui, you'll have to set the following variables :
+
 - **QTDIR** (path) : location of the Qt environment suited for your compiler and architecture
 - **LIBOBS_INCLUDE_DIR** (path) : location of the libobs subfolder in the source code of OBS Studio
 - **LIBOBS_LIB** (filepath) : location of the obs.lib file
 - **OBS_FRONTEND_LIB** (filepath) : location of the obs-frontend-api.lib file
 
 ## Linux
+
 On Debian/Ubuntu :
-```
+
-sudo apt-get install libqt5websockets5-dev
+```shell
+sudo apt-get install libboost-all-dev
 git clone --recursive https://github.com/Palakis/obs-websocket.git
 cd obs-websocket
 mkdir build && cd build
@@ -25,7 +30,8 @@ sudo make install
 ```
 
 ## OS X
-As a prerequisite, you will need Xcode for your current OSX version, the command line tools, and [Homebrew](https://brew.sh/).
+
+As a prerequisite, you will need Xcode for your current OSX version, the Xcode command line tools, and [Homebrew](https://brew.sh/).
 Homebrew's setup will guide you in getting your system set up, you should be good to go once Homebrew is successfully up and running.
 
 Use of the Travis macOS CI scripts is recommended. Please note that these
@@ -38,7 +44,7 @@ skip that script.
 Of course, you're encouraged to dig through the contents of these scripts to
 look for issues or specificities.
 
-```
+```shell
 git clone --recursive https://github.com/Palakis/obs-websocket.git
 cd obs-websocket
 ./CI/install-dependencies-macos.sh
@@ -46,6 +52,7 @@ cd obs-websocket
 ./CI/build-macos.sh
 ./CI/package-macos.sh
 ```
+
 This will result in a ready-to-use `obs-websocket.pkg` installer in the `release` subfolder.
 
 ## Automated Builds

CI/install-build-obs-macos.sh

@@ -34,8 +34,10 @@ git checkout $OBSLatestTag
 mkdir build && cd build
 echo "[obs-websocket] Building obs-studio.."
 cmake .. \
+	-DBUILD_CAPTIONS=true \
 	-DCMAKE_OSX_DEPLOYMENT_TARGET=10.11 \
 	-DDISABLE_PLUGINS=true \
+    -DENABLE_SCRIPTING=0 \
 	-DDepsPath=/tmp/obsdeps \
 	-DCMAKE_PREFIX_PATH=/usr/local/opt/qt/lib/cmake \
 && make -j4

CI/install-build-obs.cmd

@@ -108,12 +108,12 @@ if defined BuildOBS (
 	mkdir build64
 	echo   Running cmake for obs-studio %OBSLatestTag% 32-bit...
 	cd ./build32
-	cmake -G "Visual Studio 14 2015" -DDISABLE_PLUGINS=true -DCOPIED_DEPENDENCIES=false -DCOPY_DEPENDENCIES=true ..
+	cmake -G "Visual Studio 14 2015" -DBUILD_CAPTIONS=true -DDISABLE_PLUGINS=true -DCOPIED_DEPENDENCIES=false -DCOPY_DEPENDENCIES=true ..
 	echo:
 	echo:
 	echo   Running cmake for obs-studio %OBSLatestTag% 64-bit...
 	cd ../build64
-	cmake -G "Visual Studio 14 2015 Win64" -DDISABLE_PLUGINS=true -DCOPIED_DEPENDENCIES=false -DCOPY_DEPENDENCIES=true ..
+	cmake -G "Visual Studio 14 2015 Win64" -DBUILD_CAPTIONS=true -DDISABLE_PLUGINS=true -DCOPIED_DEPENDENCIES=false -DCOPY_DEPENDENCIES=true ..
 	echo:
 	echo:
 	echo   Building obs-studio %OBSLatestTag% 32-bit ^(Build Config: %build_config%^)...

CI/install-dependencies-xenial.sh

@@ -11,7 +11,7 @@ apt-get install -y \
 	checkinstall \
 	cmake \
 	obs-studio \
-	libqt5websockets5-dev
+	qtbase5-dev
 
 # Dirty hack
 wget -O /usr/include/obs/obs-frontend-api.h https://raw.githubusercontent.com/obsproject/obs-studio/master/UI/obs-frontend-api/obs-frontend-api.h

CI/macos/obs-websocket.pkgproj

@@ -12,123 +12,6 @@
 			<dict>
 				<key>CHILDREN</key>
 				<array>
-					<dict>
-						<key>CHILDREN</key>
-						<array>
-							<dict>
-								<key>CHILDREN</key>
-								<array>
-									<dict>
-										<key>CHILDREN</key>
-										<array>
-											<dict>
-												<key>CHILDREN</key>
-												<array>
-													<dict>
-														<key>CHILDREN</key>
-														<array>
-															<dict>
-																<key>CHILDREN</key>
-																<array/>
-																<key>GID</key>
-																<integer>80</integer>
-																<key>PATH</key>
-																<string>../../build/QtNetwork</string>
-																<key>PATH_TYPE</key>
-																<integer>1</integer>
-																<key>PERMISSIONS</key>
-																<integer>292</integer>
-																<key>TYPE</key>
-																<integer>3</integer>
-																<key>UID</key>
-																<integer>0</integer>
-															</dict>
-															<dict>
-																<key>CHILDREN</key>
-																<array/>
-																<key>GID</key>
-																<integer>80</integer>
-																<key>PATH</key>
-																<string>../../build/QtWebSockets</string>
-																<key>PATH_TYPE</key>
-																<integer>1</integer>
-																<key>PERMISSIONS</key>
-																<integer>292</integer>
-																<key>TYPE</key>
-																<integer>3</integer>
-																<key>UID</key>
-																<integer>0</integer>
-															</dict>
-														</array>
-														<key>GID</key>
-														<integer>80</integer>
-														<key>PATH</key>
-														<string>bin</string>
-														<key>PATH_TYPE</key>
-														<integer>0</integer>
-														<key>PERMISSIONS</key>
-														<integer>509</integer>
-														<key>TYPE</key>
-														<integer>2</integer>
-														<key>UID</key>
-														<integer>0</integer>
-													</dict>
-												</array>
-												<key>GID</key>
-												<integer>80</integer>
-												<key>PATH</key>
-												<string>Resources</string>
-												<key>PATH_TYPE</key>
-												<integer>0</integer>
-												<key>PERMISSIONS</key>
-												<integer>509</integer>
-												<key>TYPE</key>
-												<integer>2</integer>
-												<key>UID</key>
-												<integer>0</integer>
-											</dict>
-										</array>
-										<key>GID</key>
-										<integer>80</integer>
-										<key>PATH</key>
-										<string>Contents</string>
-										<key>PATH_TYPE</key>
-										<integer>0</integer>
-										<key>PERMISSIONS</key>
-										<integer>509</integer>
-										<key>TYPE</key>
-										<integer>2</integer>
-										<key>UID</key>
-										<integer>0</integer>
-									</dict>
-								</array>
-								<key>GID</key>
-								<integer>80</integer>
-								<key>PATH</key>
-								<string>OBS.app</string>
-								<key>PATH_TYPE</key>
-								<integer>0</integer>
-								<key>PERMISSIONS</key>
-								<integer>509</integer>
-								<key>TYPE</key>
-								<integer>2</integer>
-								<key>UID</key>
-								<integer>0</integer>
-							</dict>
-						</array>
-						<key>GID</key>
-						<integer>80</integer>
-						<key>PATH</key>
-						<string>Applications</string>
-						<key>PATH_TYPE</key>
-						<integer>0</integer>
-						<key>PERMISSIONS</key>
-						<integer>509</integer>
-						<key>TYPE</key>
-						<integer>1</integer>
-						<key>UID</key>
-						<integer>0</integer>
-					</dict>
 					<dict>
 						<key>CHILDREN</key>
 						<array>
@@ -635,7 +518,7 @@
 			<key>OVERWRITE_PERMISSIONS</key>
 			<false/>
 			<key>VERSION</key>
-			<string>4.5.1</string>
+			<string>4.6.1</string>
 		</dict>
 		<key>PROJECT_COMMENTS</key>
 		<dict>

CI/package-macos.sh

@@ -12,9 +12,6 @@ fi
 echo "[obs-websocket] Preparing package build"
 export QT_CELLAR_PREFIX="$(/usr/bin/find /usr/local/Cellar/qt -d 1 | sort -t '.' -k 1,1n -k 2,2n -k 3,3n | tail -n 1)"
 
-export WS_LIB="/usr/local/opt/qt/lib/QtWebSockets.framework/QtWebSockets"
-export NET_LIB="/usr/local/opt/qt/lib/QtNetwork.framework/QtNetwork"
-
 export GIT_HASH=$(git rev-parse --short HEAD)
 export GIT_BRANCH_OR_TAG=$(git name-rev --name-only HEAD | awk -F/ '{print $NF}')
 
@@ -24,46 +21,17 @@ export LATEST_VERSION="$GIT_BRANCH_OR_TAG"
 export FILENAME="obs-websocket-$VERSION.pkg"
 export LATEST_FILENAME="obs-websocket-latest-$LATEST_VERSION.pkg"
 
-echo "[obs-websocket] Copying Qt dependencies"
-if [ ! -f ./build/$(basename $WS_LIB) ]; then cp $WS_LIB ./build; fi
-if [ ! -f ./build/$(basename $NET_LIB) ]; then cp $NET_LIB ./build; fi
-
-chmod +rw ./build/QtWebSockets ./build/QtNetwork
-
-echo "[obs-websocket] Modifying QtNetwork"
-install_name_tool \
-	-id @rpath/QtNetwork \
-	-change /usr/local/opt/qt/lib/QtNetwork.framework/Versions/5/QtNetwork @rpath/QtNetwork \
-	-change $QT_CELLAR_PREFIX/lib/QtCore.framework/Versions/5/QtCore @rpath/QtCore \
-	./build/QtNetwork
-
-echo "[obs-websocket] Modifying QtWebSockets"
-install_name_tool \
-	-id @rpath/QtWebSockets \
-	-change /usr/local/opt/qt/lib/QtWebSockets.framework/Versions/5/QtWebSockets @rpath/QtWebSockets \
-	-change $QT_CELLAR_PREFIX/lib/QtNetwork.framework/Versions/5/QtNetwork @rpath/QtNetwork \
-	-change $QT_CELLAR_PREFIX/lib/QtCore.framework/Versions/5/QtCore @rpath/QtCore \
-	./build/QtWebSockets
-
 echo "[obs-websocket] Modifying obs-websocket.so"
 install_name_tool \
-	-change /usr/local/opt/qt/lib/QtWebSockets.framework/Versions/5/QtWebSockets @rpath/QtWebSockets \
 	-change /usr/local/opt/qt/lib/QtWidgets.framework/Versions/5/QtWidgets @rpath/QtWidgets \
-	-change /usr/local/opt/qt/lib/QtNetwork.framework/Versions/5/QtNetwork @rpath/QtNetwork \
 	-change /usr/local/opt/qt/lib/QtGui.framework/Versions/5/QtGui @rpath/QtGui \
 	-change /usr/local/opt/qt/lib/QtCore.framework/Versions/5/QtCore @rpath/QtCore \
 	./build/obs-websocket.so
 
 # Check if replacement worked
-echo "[obs-websocket] Dependencies for QtNetwork"
-otool -L ./build/QtNetwork
-echo "[obs-websocket] Dependencies for QtWebSockets"
-otool -L ./build/QtWebSockets
 echo "[obs-websocket] Dependencies for obs-websocket"
 otool -L ./build/obs-websocket.so
 
-chmod -w ./build/QtWebSockets ./build/QtNetwork
-
 echo "[obs-websocket] Actual package build"
 packagesbuild ./CI/macos/obs-websocket.pkgproj
 

CI/package-xenial.sh

@@ -17,7 +17,7 @@ PAGER=cat checkinstall -y --type=debian --fstrans=no --nodoc \
 	--backup=no --deldoc=yes --install=no \
 	--pkgname=obs-websocket --pkgversion="$PKG_VERSION" \
 	--pkglicense="GPLv2.0" --maintainer="contact@slepin.fr" \
-	--requires="libqt5websockets5" --pkggroup="video" \
+	--pkggroup="video" \
 	--pkgsource="https://github.com/Palakis/obs-websocket" \
 	--pakdir="/package"
 

CMakeLists.txt

@@ -6,18 +6,30 @@ set(CMAKE_INCLUDE_CURRENT_DIR ON)
 set(CMAKE_AUTOMOC ON)
 set(CMAKE_AUTOUIC ON)
 
+set(CMAKE_CXX_STANDARD 11)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+if (WIN32 OR APPLE)
+include(external/FindLibObs.cmake)
+endif()
+
+add_definitions(-DASIO_STANDALONE)
+
+if (UNIX)
+	set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11")
+endif()
+
 if (WIN32 OR APPLE)
 	include(external/FindLibObs.cmake)
 endif()
 
 find_package(LibObs REQUIRED)
 find_package(Qt5Core REQUIRED)
-find_package(Qt5WebSockets REQUIRED)
 find_package(Qt5Widgets REQUIRED)
 
 set(obs-websocket_SOURCES
 	src/obs-websocket.cpp
 	src/WSServer.cpp
+	src/ConnectionProperties.cpp
 	src/WSRequestHandler.cpp
 	src/WSRequestHandler_General.cpp
 	src/WSRequestHandler_Profiles.cpp
@@ -38,6 +50,7 @@ set(obs-websocket_SOURCES
 set(obs-websocket_HEADERS
 	src/obs-websocket.h
 	src/WSServer.h
+	src/ConnectionProperties.h
 	src/WSRequestHandler.h
 	src/WSEvents.h
 	src/Config.h
@@ -52,13 +65,13 @@ add_library(obs-websocket MODULE
 include_directories(
 	"${LIBOBS_INCLUDE_DIR}/../UI/obs-frontend-api"
 	${Qt5Core_INCLUDES}
-	${Qt5WebSockets_INCLUDES}
+	${Qt5Widgets_INCLUDES}
-	${Qt5Widgets_INCLUDES})
+	"${CMAKE_SOURCE_DIR}/deps/asio/asio/include"
+	"${CMAKE_SOURCE_DIR}/deps/websocketpp")
 
 target_link_libraries(obs-websocket
 	libobs
 	Qt5::Core
-	Qt5::WebSockets
 	Qt5::Widgets)
 
 # --- End of section ---
@@ -70,6 +83,8 @@ if(WIN32)
 		message(FATAL_ERROR "Could not find OBS Frontend API's library !")
 	endif()
 
+	add_definitions(-D_WEBSOCKETPP_CPP11_STL_)
+
 	if(CMAKE_SIZEOF_VOID_P EQUAL 8)
 		set(ARCH_NAME "64bit")
 		set(OBS_BUILDDIR_ARCH "build64")
@@ -102,8 +117,6 @@ if(WIN32)
 
 		COMMAND if $<CONFIG:Release>==1 ("${CMAKE_COMMAND}" -E copy
 			"$<TARGET_FILE:obs-websocket>"
-			"${QTDIR}/bin/Qt5WebSockets.dll"
-			"${QTDIR}/bin/Qt5Network.dll"
 			"${RELEASE_DIR}/obs-plugins/${ARCH_NAME}")
 
 		# If config is RelWithDebInfo, package release files
@@ -118,8 +131,6 @@ if(WIN32)
 
 		COMMAND if $<CONFIG:RelWithDebInfo>==1 ("${CMAKE_COMMAND}" -E copy
 			"$<TARGET_FILE:obs-websocket>"
-			"${QTDIR}/bin/Qt5WebSockets.dll"
-			"${QTDIR}/bin/Qt5Network.dll"
 			"${RELEASE_DIR}/obs-plugins/${ARCH_NAME}")
 
 		COMMAND if $<CONFIG:RelWithDebInfo>==1 ("${CMAKE_COMMAND}" -E copy
@@ -130,8 +141,6 @@ if(WIN32)
 		COMMAND if $<CONFIG:Debug>==1 (
 			"${CMAKE_COMMAND}" -E copy
 				"$<TARGET_FILE:obs-websocket>"
-				"${QTDIR}/bin/Qt5WebSocketsd.dll"
-				"${QTDIR}/bin/Qt5Networkd.dll"
 				"${LIBOBS_INCLUDE_DIR}/../${OBS_BUILDDIR_ARCH}/rundir/$<CONFIG>/obs-plugins/${ARCH_NAME}")
 
 		COMMAND if $<CONFIG:Debug>==1 (
@@ -155,11 +164,8 @@ endif()
 
 # --- Linux-specific build settings and tasks ---
 if(UNIX AND NOT APPLE)
-	set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11")
-
 	set_target_properties(obs-websocket PROPERTIES PREFIX "")
-	target_link_libraries(obs-websocket
+	target_link_libraries(obs-websocket obs-frontend-api)
-		obs-frontend-api)
 
 	file(GLOB locale_files data/locale/*.ini)
 	execute_process(COMMAND uname -m COMMAND tr -d '\n' OUTPUT_VARIABLE UNAME_MACHINE)

README.md

@@ -2,9 +2,9 @@ obs-websocket
 ==============
 Remote control of OBS Studio made easy.
 
-Follow the project on Twitter for news & updates : [@obswebsocket](https://twitter.com/obswebsocket)
+Follow the main author on Twitter for news & updates : [@LePalakis](https://twitter.com/LePalakis)
 
-[![Gitter chat](https://badges.gitter.im/obs-websocket/obs-websocket.png)](https://gitter.im/obs-websocket/obs-websocket) [![Build Status - Windows](https://ci.appveyor.com/api/projects/status/github/Palakis/obs-websocket)](https://ci.appveyor.com/project/Palakis/obs-websocket/history) [![Build Status - Linux & OS X](https://travis-ci.org/Palakis/obs-websocket.svg?branch=master)](https://travis-ci.org/Palakis/obs-websocket)
+[![Build Status - Windows](https://ci.appveyor.com/api/projects/status/github/Palakis/obs-websocket)](https://ci.appveyor.com/project/Palakis/obs-websocket/history) [![Build Status - Linux & OS X](https://travis-ci.org/Palakis/obs-websocket.svg?branch=master)](https://travis-ci.org/Palakis/obs-websocket)
 
 ## Downloads
 Binaries for Windows and Linux are available in the [Releases](https://github.com/Palakis/obs-websocket/releases) section.
@@ -20,6 +20,7 @@ It is **highly recommended** to protect obs-websocket with a password against un
 - Automate scene switching with a third-party program (e.g. : auto-pilot, foot pedal, ...)
 
 ### For developers
+
 The server is a typical Websockets server running by default on port 4444 (the port number can be changed in the Settings dialog).
 The protocol understood by the server is documented in [PROTOCOL.md](docs/generated/protocol.md).  
 
@@ -29,23 +30,72 @@ Here's a list of available language APIs for obs-websocket :
 - Python 2 and 3: [obs-websocket-py](https://github.com/Elektordi/obs-websocket-py) by Guillaume Genty a.k.a Elektordi
 - Python 3.5+ with asyncio: [obs-ws-rc](https://github.com/KirillMysnik/obs-ws-rc) by Kirill Mysnik
 
-I'd like to know what you're building with or for obs-websocket. If you do something in this fashion, feel free to drop me an email at `contact at slepin dot fr` !
+I'd like to know what you're building with or for obs-websocket. If you do something in this fashion, feel free to drop me an email at `stephane /dot/ lepin /at/ gmail /dot/ com` !
 
 ## Compiling obs-websocket
+
 See the [build instructions](BUILDING.md).
 
+## Contributing
+
+### Branches
+
+The two main development branches are:
+
+- `4.x-current`: actively-maintained codebase for 4.x releases. Backwards-compatible (unless stated otherwise) with existing clients until 5.0.
+- `5.x`: upcoming 5.0 version
+
+**New features and fixes must be based off and contributed to `4.x-current`**, as obs-websocket 5.0 is not in active development yet.
+
+### Pull Requests
+
+Pull Requests must never be based off your fork's main branch (in our case, `4.x-current` or `5.x`). Start your work in a new branch
+based on the main one (e.g.: `cool-new-feature`, `fix-palakis-mistakes`, ...) and open a Pull Request once you feel ready to show your work.
+
+If your Pull Request is not ready to merge yet, tag it with the `work in progress` label. You can also use the `help needed` label if you have questions, need a hand or want to ask for input.
+
+### Code style & formatting
+
+Source code is indented with tabs, with spaces allowed for alignment.
+
+Regarding protocol changes: new and updated request types / events must always come with accompanying documentation comments (see existing protocol elements for examples).
+These are using to automatically generate the [protocol specification](docs/generated/protocol.md).
+
+Among other recommendations: favor return-early code and avoid wrapping huge portions of code in conditionals. As an example, this:
+
+```cpp
+if (success) {
+    return req->SendOKResponse();
+} else {
+    return req->SendErrorResponse("something went wrong");
+}
+```
+
+is better like this:
+
+```cpp
+if (!success) {
+    return req->SendErrorResponse("something went wrong");
+}
+return req->SendOKResponse();
+```
+
+
 ## Translations
-**We need your help on translations**. Please join the localization project on Crowdin: https://crowdin.com/project/obs-websocket
+
+**Your help is welcome on translations**. Please join the localization project on Crowdin: https://crowdin.com/project/obs-websocket
 
 ## Special thanks
-In order of appearance:
+
+In (almost) order of appearance:
+
 - [Brendan H.](https://github.com/haganbmj): Code contributions and gooder English in the Protocol specification
 - [Mikhail Swift](https://github.com/mikhailswift): Code contributions
-- [Tobias Frahmer](https://github.com/Frahmer) : German localization
+- [Tobias Frahmer](https://github.com/Frahmer): Initial German localization
-- [Genture](https://github.com/Genteure) : Simplified Chinese and Traditional Chinese localizations
+- [Genture](https://github.com/Genteure): Initial Simplified Chinese and Traditional Chinese localizations
-- [Larissa Gabilan](https://github.com/laris151) : Portuguese localization
+- [Larissa Gabilan](https://github.com/laris151): Initial Portuguese localization
-- [Andy Asquelt](https://github.com/asquelt) : Polish localization
+- [Andy Asquelt](https://github.com/asquelt): Initial Polish localization
-- [Marcel Haazen](https://github.com/inpothet) : Dutch localization
+- [Marcel Haazen](https://github.com/nekocentral): Initial Dutch localization
 - [Peter Antonvich](https://github.com/pantonvich): Code contributions
 - [yinzara](https://github.com/yinzara): Code contributions
 - [Chris Angelico](https://github.com/Rosuav): Code contributions
@@ -56,10 +106,16 @@ In order of appearance:
 - [RytoEX](https://github.com/RytoEX): CI script and code contributions
 - [Theodore Stoddard](https://github.com/TStod): Code contributions
 - [Philip Loche](https://github.com/PicoCentauri): Code contributions
+- [Patrick Heyer](https://github.com/PatTheMav): Code contributions and CI fixes
+- [Alex Van Camp](https://github.com/Lange): Code contributions
+- [Freddie Meyer](https://github.com/DungFu): Code contributions
+- [Casey Muller](https://github.com/caseymrm): CI fixes
+- [Chris Angelico](https://github.com/Rosuav): Documentation fixes
 
 And also: special thanks to supporters of the project!
 
 ## Supporters
+
 They have contributed financially to the project and made possible the addition of several features into obs-websocket. Many thanks to them!
 
 ---

azure-pipelines.yml

@@ -2,6 +2,9 @@ pool:
   vmImage: 'macOS-10.13'
 
 steps:
+- checkout: self
+  submodules: true
+
 - script: ./CI/install-dependencies-macos.sh
   displayName: 'Install Dependencies'
 

data/locale/de-DE.ini

@@ -1,14 +1,16 @@
-OBSWebsocket.Menu.SettingsItem="Websocket-Server Einstellungen"
+OBSWebsocket.Settings.DialogTitle="WebSockets-Servereinstellungen"
-OBSWebsocket.Settings.DialogTitle="Websocket-Server Einstellungen"
+OBSWebsocket.Settings.ServerEnable="WebSockets-Server aktivieren"
-OBSWebsocket.Settings.ServerEnable="Websocket-Server aktivieren"
+OBSWebsocket.Settings.ServerPort="Server-Port"
-OBSWebsocket.Settings.ServerPort="Server Port"
+OBSWebsocket.Settings.AuthRequired="Authentifizierung aktivieren"
-OBSWebsocket.Settings.AuthRequired="Authentifizierung erforderlich"
 OBSWebsocket.Settings.Password="Passwort"
 OBSWebsocket.Settings.DebugEnable="Debug-Protokollierung aktivieren"
-OBSWebsocket.Settings.AlertsEnable="Infobereich-Benachrichtigungen aktivieren"
+OBSWebsocket.Settings.AlertsEnable="Infobereichbenachrichtigungen aktivieren"
-OBSWebsocket.NotifyConnect.Title="Neue WebSocket Verbindung"
+OBSWebsocket.NotifyConnect.Title="Neue Websocket-Verbindung"
 OBSWebsocket.NotifyConnect.Message="Client %1 verbunden"
-OBSWebsocket.NotifyDisconnect.Title="WebSocket-Client getrennt"
+OBSWebsocket.NotifyDisconnect.Title="Websocket-Client getrennt"
 OBSWebsocket.NotifyDisconnect.Message="Client %1 getrennt"
-OBSWebsocket.Server.StartFailed.Title="WebSocket-Server Fehler"
+OBSWebsocket.Server.StartFailed.Title="Websocket-Serverfehler"
-OBSWebsocket.Server.StartFailed.Message="Der WebSocket-Server konnte nicht gestartet werden, mögliche Gründe:\n - TCP Port %1 wird möglicherweise gerade von einem anderen Programm verwendet. Versuchen Sie einen anderen Port in den WebSocket-Server Einstellungen zu setzten oder alle Programme zu beenden, die den Port möglicherweise verwenden.\n - Ein unbekannter Netzwerkfehler ist aufgetreten. Versuchen Sie es erneut mit anderen Einstellungen, einem OBS neustart oder einem System neustart."
+OBSWebsocket.Server.StartFailed.Message="Der WebSockets-Server konnte nicht gestartet werden, mögliche Gründe:\n - Der TCP-Port %1 wird möglicherweise gerade von einem anderen Programm verwendet. Versuchen Sie einen anderen Port in den Websocket-Servereinstellungen zu setzen oder alle Programme zu beenden, die den Port möglicherweise verwenden.\n - Ein unbekannter Netzwerkfehler ist aufgetreten. Versuchen Sie es mit anderen Einstellungen, einem OBS-Neustart oder einem Systemneustart erneut."
+OBSWebsocket.ProfileChanged.Started="WebSockets-Server in diesem Profil aktiviert. Server gestartet."
+OBSWebsocket.ProfileChanged.Stopped="WebSockets-Server in diesem Profil deaktiviert. Server gestoppt."
+OBSWebsocket.ProfileChanged.Restarted="WebSockets-Server in diesem Profil geändert. Server startet neu."

data/locale/en-US.ini

@@ -1,6 +1,5 @@
-OBSWebsocket.Menu.SettingsItem="Websocket server settings"
+OBSWebsocket.Settings.DialogTitle="WebSockets Server Settings"
-OBSWebsocket.Settings.DialogTitle="obs-websocket"
+OBSWebsocket.Settings.ServerEnable="Enable WebSockets server"
-OBSWebsocket.Settings.ServerEnable="Enable Websocket server"
 OBSWebsocket.Settings.ServerPort="Server Port"
 OBSWebsocket.Settings.AuthRequired="Enable authentication"
 OBSWebsocket.Settings.Password="Password"
@@ -10,5 +9,8 @@ OBSWebsocket.NotifyConnect.Title="New WebSocket connection"
 OBSWebsocket.NotifyConnect.Message="Client %1 connected"
 OBSWebsocket.NotifyDisconnect.Title="WebSocket client disconnected"
 OBSWebsocket.NotifyDisconnect.Message="Client %1 disconnected"
-OBSWebsocket.Server.StartFailed.Title="WebSocket Server failure"
+OBSWebsocket.Server.StartFailed.Title="WebSockets Server failure"
-OBSWebsocket.Server.StartFailed.Message="The obs-websocket server failed to start, maybe because:\n - TCP port %1 may currently be in use elsewhere on this system, possibly by another application. Try setting a different TCP port in the WebSocket server settings, or stop any application that could be using this port.\n - An unknown network error happened on your system. Try again by changing settings, restarting OBS or restarting your system."
+OBSWebsocket.Server.StartFailed.Message="The WebSockets server failed to start, maybe because:\n - TCP port %1 may currently be in use elsewhere on this system, possibly by another application. Try setting a different TCP port in the WebSocket server settings, or stop any application that could be using this port.\n - An unknown network error happened on your system. Try again by changing settings, restarting OBS or restarting your system."
+OBSWebsocket.ProfileChanged.Started="WebSockets server enabled in this profile. Server started."
+OBSWebsocket.ProfileChanged.Stopped="WebSockets server disabled in this profile. Server stopped."
+OBSWebsocket.ProfileChanged.Restarted="WebSockets server port changed in this profile. Server restarted."

data/locale/es-ES.ini

@@ -1,14 +1,12 @@
-OBSWebsocket.Menu.SettingsItem="Configuración del servidor obs-websocket"
+OBSWebsocket.Settings.ServerEnable="Habilitar el servidor WebSockets"
-OBSWebsocket.Settings.DialogTitle="obs-websocket"
-OBSWebsocket.Settings.ServerEnable="Habilitar el servidor Websocket"
 OBSWebsocket.Settings.ServerPort="Puerto del Servidor"
 OBSWebsocket.Settings.AuthRequired="Habilitar autenticación"
 OBSWebsocket.Settings.Password="Contraseña"
 OBSWebsocket.Settings.DebugEnable="Habilitar registro de depuración"
-OBSWebsocket.Settings.AlertsEnable="Habilitar alertas de la bandeja de sistema"
+OBSWebsocket.Settings.AlertsEnable="Habilitar alertas en la bandeja de sistema"
 OBSWebsocket.NotifyConnect.Title="Nueva conexión WebSocket"
 OBSWebsocket.NotifyConnect.Message="Cliente %1 conectado"
 OBSWebsocket.NotifyDisconnect.Title="Cliente WebSocket desconectado"
 OBSWebsocket.NotifyDisconnect.Message="Cliente %1 desconectado"
-OBSWebsocket.Server.StartFailed.Title="Fallo del servidor WebSocket"
+OBSWebsocket.Server.StartFailed.Title="Falla en el servidor WebSockets"
-OBSWebsocket.Server.StartFailed.Message="El servidor obs-websocket no se pudo iniciar, tal vez porque: \n - el puerto TCP %1 podría estar actualmente en uso en este sistema, posiblemente por otra aplicación. Intente configurar un puerto TCP diferente en la configuración del servidor WebSocket, o detenga cualquier aplicación que pudiese estar utilizando este puerto \n - Un error de red desconocido ha ocurrido en su sistema. Inténtalo de nuevo cambiando la configuración, reiniciando OBS o reiniciando su sistema."
+OBSWebsocket.Server.StartFailed.Message="El servidor obs-websocket no se pudo iniciar, tal vez porque: \n - el puerto TCP %1 podría estar actualmente siendo usado este sistema, posiblemente por otra aplicación. Intente configurar un puerto TCP diferente en la configuración del servidor WebSocket, o detenga cualquier aplicación que pudiese estar utilizando este puerto \n - Un error de red desconocido ha afectado su sistema. Inténtelo de nuevo cambiando la configuración, reiniciando OBS o reiniciando su sistema."

data/locale/fr-FR.ini

@@ -1,4 +1,4 @@
-OBSWebsocket.Menu.SettingsItem="Paramètres du serveur Websocket"
+OBSWebsocket.Settings.DialogTitle="Paramètres du serveur WebSockets"
 OBSWebsocket.Settings.ServerEnable="Activer le serveur WebSocket"
 OBSWebsocket.Settings.ServerPort="Port du serveur"
 OBSWebsocket.Settings.AuthRequired="Activer l'authentification"
@@ -9,5 +9,8 @@ OBSWebsocket.NotifyConnect.Title="Nouvelle connexion WebSocket"
 OBSWebsocket.NotifyConnect.Message="Le client %1 s'est connecté"
 OBSWebsocket.NotifyDisconnect.Title="Déconnexion WebSocket"
 OBSWebsocket.NotifyDisconnect.Message="Le client %1 s'est déconnecté"
-OBSWebsocket.Server.StartFailed.Title="Impossible de démarrer le serveur WebSocket"
+OBSWebsocket.Server.StartFailed.Title="Impossible de démarrer le serveur WebSockets"
-OBSWebsocket.Server.StartFailed.Message="Le serveur WebSocket n'a pas pu démarrer, peut-être parce que :\n - Le port TCP %1 est en cours d'utilisation sur ce système, certainement par un autre programme. Essayez un port différent dans les réglages du serveur WebSocket, ou arrêtez tout programme susceptible d'utiliser ce port.\n - Une erreur réseau inconnue est survenue. Essayez à nouveau en modifiant vos réglages, en redémarrant OBS ou en redémarrant votre ordinateur."
+OBSWebsocket.Server.StartFailed.Message="Le serveur WebSockets n'a pas pu démarrer, peut-être parce que :\n - Le port TCP %1 est en cours d'utilisation sur ce système, certainement par un autre programme. Essayez un port différent dans les réglages du serveur WebSocket, ou arrêtez tout programme susceptible d'utiliser ce port.\n - Une erreur réseau inconnue est survenue. Essayez à nouveau en modifiant vos réglages, en redémarrant OBS ou en redémarrant votre ordinateur."
+OBSWebsocket.ProfileChanged.Started="Serveur WebSockets actif dans ce profil."
+OBSWebsocket.ProfileChanged.Stopped="Serveur WebSockets désactivé dans ce profil."
+OBSWebsocket.ProfileChanged.Restarted="Le port actuel diffère du port configuré dans ce profil. Serveur WebSockets redémarré."

data/locale/it-IT.ini

@@ -1,6 +1,4 @@
-OBSWebsocket.Menu.SettingsItem="Impostazioni del server di WebSocket"
+OBSWebsocket.Settings.ServerEnable="Abilitare il server WebSockets"
-OBSWebsocket.Settings.DialogTitle="obs-websocket"
-OBSWebsocket.Settings.ServerEnable="Abilitare il server Websocket"
 OBSWebsocket.Settings.ServerPort="Porta del server"
 OBSWebsocket.Settings.AuthRequired="Abilitare l'autenticazione"
 OBSWebsocket.Settings.Password="Password"
@@ -11,4 +9,4 @@ OBSWebsocket.NotifyConnect.Message="%1 cliente collegato"
 OBSWebsocket.NotifyDisconnect.Title="WebSocket cliente disconnesso"
 OBSWebsocket.NotifyDisconnect.Message="%1 cliente disconnesso"
 OBSWebsocket.Server.StartFailed.Title="Errore del WebSocket Server"
-OBSWebsocket.Server.StartFailed.Message="Impossibile avviare, forse perché il server di obs-websocket: \n - %1 porta TCP potrebbe essere attualmente in uso altrove su questo sistema, possibilmente da un'altra applicazione. Provare a impostare una porta TCP diversa nelle impostazioni del server di WebSocket, o arrestare tutte le applicazioni che potrebbero utilizzare questa porta. \n - è verificato un errore di rete sconosciuto sul sistema. Riprova modificando le impostazioni, riavviare OBS o riavvio del sistema."
+OBSWebsocket.Server.StartFailed.Message="Impossibile avviare, forse perché il server di WebSockets: \n - %1 porta TCP potrebbe essere attualmente in uso altrove su questo sistema, possibilmente da un'altra applicazione. Provare a impostare una porta TCP diversa nelle impostazioni del server di WebSockets, o arrestare tutte le applicazioni che potrebbero utilizzare questa porta. \n - è verificato un errore di rete sconosciuto sul sistema. Riprova modificando le impostazioni, riavviare OBS o riavvio del sistema."

data/locale/ja-JP.ini

@@ -1,8 +1,11 @@
-OBSWebsocket.Menu.SettingsItem="Websocket サーバー設定"
+OBSWebsocket.Settings.ServerEnable="WebSockets サーバーを有効にする"
-OBSWebsocket.Settings.DialogTitle="obs-websocket"
-OBSWebsocket.Settings.ServerEnable="Websocket サーバーを有効にする"
 OBSWebsocket.Settings.ServerPort="サーバーポート"
 OBSWebsocket.Settings.AuthRequired="認証を有効にする"
 OBSWebsocket.Settings.Password="パスワード"
 OBSWebsocket.Settings.DebugEnable="デバッグログを有効にする"
+OBSWebsocket.Settings.AlertsEnable="システムトレイ通知を有効にする"
 OBSWebsocket.NotifyConnect.Title="新しい WebSocket 接続"
+OBSWebsocket.NotifyConnect.Message="接続されているクライアント %1"
+OBSWebsocket.NotifyDisconnect.Title="WebSocket クライアントが切断されました"
+OBSWebsocket.NotifyDisconnect.Message="切断されたクライアント %1"
+OBSWebsocket.Server.StartFailed.Title="WebSockets サーバー障害"

data/locale/nl-NL.ini

@@ -1,14 +1,9 @@
-OBSWebsocket.Menu.SettingsItem="Websocket server instellingen"
-OBSWebsocket.Settings.DialogTitle="obs-websocket"
-OBSWebsocket.Settings.ServerEnable="Activeer Websocket server"
 OBSWebsocket.Settings.ServerPort="Serverpoort"
-OBSWebsocket.Settings.AuthRequired="Activeer authenticatie"
-OBSWebsocket.Settings.Password="Wachtwoord"
 OBSWebsocket.Settings.DebugEnable="Activeer debug logs"
 OBSWebsocket.Settings.AlertsEnable="Systemvak waarschuwingen inschakelen"
 OBSWebsocket.NotifyConnect.Title="Nieuwe WebSocket verbinding"
 OBSWebsocket.NotifyConnect.Message="Client %1 verbonden"
 OBSWebsocket.NotifyDisconnect.Title="WebSocket client connectie verbroken"
 OBSWebsocket.NotifyDisconnect.Message="Client %1 losgekoppeld"
-OBSWebsocket.Server.StartFailed.Title="WebSocket Server mislukt"
+OBSWebsocket.Server.StartFailed.Title="Fout in WebSocket server"
-OBSWebsocket.Server.StartFailed.Message="De obs-websocket server kan niet worden gestart, misschien omdat: \n - TCP-poort %1 momenteel wordt gebruikt elders op dit systeem, eventueel door een andere toepassing. Probeer een andere TCP-poort instellen in de WebSocket Server-instellingen of stoppen van elke toepassing die deze poort zouden kunnen gebruiken.\n Een onbekende netwerkfout gebeurde op uw systeem. Probeer het opnieuw door de instellingen wijzigen, OBS herstarten of opnieuw opstarten van uw systeem."
+OBSWebsocket.Server.StartFailed.Message="De obs-websocket server kan niet worden gestart, misschien omdat: \n - TCP-poort %1 momenteel elders wordt gebruikt op dit systeem, eventueel door een andere toepassing. Probeer een andere TCP-poort in te stellen in de WebSocket Server-instellingen of stop elke toepassing die deze poort zou kunnen gebruiken.\n Een onbekende Netwerkfout op uw systeem. Probeer het opnieuw door de instellingen te wijzigen, OBS te herstarten of uw systeem te herstarten."

data/locale/pl-PL.ini

@@ -1,14 +1,10 @@
-OBSWebsocket.Menu.SettingsItem="Ustawienia serwera zdalnego sterowania"
+OBSWebsocket.Settings.ServerEnable="Włącz serwer WebSockets"
-OBSWebsocket.Settings.DialogTitle="Serwer zdalnego sterowania"
+OBSWebsocket.Settings.AuthRequired="Wymagaj uwierzytelniania"
-OBSWebsocket.Settings.ServerEnable="Włącz serwer zdalnego sterowania (Websocket)"
-OBSWebsocket.Settings.ServerPort="Port serwera"
-OBSWebsocket.Settings.AuthRequired="Wymagaj hasła"
-OBSWebsocket.Settings.Password="Hasło"
 OBSWebsocket.Settings.DebugEnable="Włącz rejestrowanie debugowania"
-OBSWebsocket.Settings.AlertsEnable="Włącz powiadomienia o zasobniku systemowym"
+OBSWebsocket.Settings.AlertsEnable="Włącz powiadomienia w zasobniku systemowym"
 OBSWebsocket.NotifyConnect.Title="Nowe połączenie WebSocket"
 OBSWebsocket.NotifyConnect.Message="Klient %1 połączony"
 OBSWebsocket.NotifyDisconnect.Title="Klient WebSocket odłączony"
-OBSWebsocket.NotifyDisconnect.Message="Klient %1 połączony"
+OBSWebsocket.NotifyDisconnect.Message="Klient %1 rozłączony"
-OBSWebsocket.Server.StartFailed.Title="Awaria serwera WebSocket"
+OBSWebsocket.Server.StartFailed.Title="Awaria serwera WebSockets"
-OBSWebsocket.Server.StartFailed.Message="Nie udało się uruchomić serwera obs-websocket, może a powodu: \n - TCP port %1 może być obecnie używany gdzie indziej w tym systemie, możliwie przez inną aplikację. Spróbuj ustawić inny port TCP w ustawieniach serwera WebSocket, lub zatrzymać dowolną aplikację, która może używać tego portu \n -nieznany błąd sieci wydarzył się w systemie. Spróbuj ponownie, zmieniając ustawienia, ponownie uruchamiając OBS lub ponownie uruchamiając system."
+OBSWebsocket.Server.StartFailed.Message="Nie udało się uruchomić serwera WebSockets, może a powodu: \n - TCP port %1 może być obecnie używany gdzie indziej w tym systemie, możliwie przez inną aplikację. Spróbuj ustawić inny port TCP w ustawieniach serwera WebSockets, lub zatrzymać dowolną aplikację, która może używać tego portu \n -nieznany błąd sieci wydarzył się w systemie. Spróbuj ponownie, zmieniając ustawienia, ponownie uruchamiając OBS lub ponownie uruchamiając system."

data/locale/pt-BR.ini

@@ -1,5 +0,0 @@
-OBSWebsocket.Menu.SettingsItem="Configuraçes do Servidor Websocket"
-OBSWebsocket.Settings.ServerEnable="Habilitar o Servidor Websocket"
-OBSWebsocket.Settings.ServerPort="Porta do Servidor"
-OBSWebsocket.Settings.AuthRequired="Autenticação Requerida"
-OBSWebsocket.Settings.Password="Senha"

data/locale/pt-PT.ini

@@ -1,5 +1,3 @@
-OBSWebsocket.Menu.SettingsItem="Configurações do servidor Websocket"
-OBSWebsocket.Settings.DialogTitle="obs-websocket"
 OBSWebsocket.Settings.ServerEnable="Habilitar servidor de WebSockets"
 OBSWebsocket.Settings.ServerPort="Porta do Servidor"
 OBSWebsocket.Settings.AuthRequired="Activar autenticação"
@@ -11,4 +9,4 @@ OBSWebsocket.NotifyConnect.Message="Cliente %1 conectado"
 OBSWebsocket.NotifyDisconnect.Title="WebSocket cliente desconectado"
 OBSWebsocket.NotifyDisconnect.Message="Cliente %1 desconectado"
 OBSWebsocket.Server.StartFailed.Title="Falha do servidor de WebSocket"
-OBSWebsocket.Server.StartFailed.Message="O servidor obs-websocket falhou ao iniciar, talvez porque: \n - TCP port %1 pode estar atualmente em uso em outro lugar sobre este sistema, possivelmente por outro aplicativo. Tente definir uma porta TCP diferente nas configurações do servidor de WebSocket, ou parar qualquer aplicativo que poderia estar usando este porto \n - um erro de rede desconhecido aconteceu no seu sistema. Tente novamente alterar configurações, reiniciando OBS ou reiniciando o sistema."
+OBSWebsocket.Server.StartFailed.Message="O servidor de WebSockets falhou ao iniciar, talvez porque: \n - TCP port %1 pode estar atualmente em uso em outro lugar sobre este sistema, possivelmente por outro aplicativo. Tente definir uma porta TCP diferente nas configurações do servidor de WebSockets, ou parar qualquer aplicativo que poderia estar usando este porto \n - um erro de rede desconhecido aconteceu no seu sistema. Tente novamente alterar configurações, reiniciando OBS ou reiniciando o sistema."

data/locale/ru-RU.ini

@@ -1,8 +1,7 @@
-OBSWebsocket.Menu.SettingsItem="Параметры сервера Websocket"
+OBSWebsocket.Settings.DialogTitle="Настройки сервера WebSockets"
-OBSWebsocket.Settings.DialogTitle="obs-websocket"
+OBSWebsocket.Settings.ServerEnable="Включить сервер WebSockets"
-OBSWebsocket.Settings.ServerEnable="Включить сервер Websocket"
 OBSWebsocket.Settings.ServerPort="Порт сервера"
-OBSWebsocket.Settings.AuthRequired="Включить аутентификацию"
+OBSWebsocket.Settings.AuthRequired="Включить авторизацию"
 OBSWebsocket.Settings.Password="Пароль"
 OBSWebsocket.Settings.DebugEnable="Включить ведение журнала отладки"
 OBSWebsocket.Settings.AlertsEnable="Включить оповещения в системном трее"
@@ -10,5 +9,5 @@ OBSWebsocket.NotifyConnect.Title="Новое соединение WebSocket"
 OBSWebsocket.NotifyConnect.Message="Клиент %1 подключен"
 OBSWebsocket.NotifyDisconnect.Title="Клиент WebSocket отключён"
 OBSWebsocket.NotifyDisconnect.Message="Клиент %1 отключен"
-OBSWebsocket.Server.StartFailed.Title="Сбой сервера WebSocket"
+OBSWebsocket.Server.StartFailed.Title="Сбой сервера WebSockets"
-OBSWebsocket.Server.StartFailed.Message="Сбой запуска сервера obs-websocket. Вероятные причины:\n - Возможно, TCP-порт %1 занят другим приложением в системе. Попробуйте задать другой TCP-порт в настройках сервера WebSocket или закройте приложение, которое может использовать данный порт.\n - Произошла неизвестная сетевая ошибка в системе. Попробуйте снова после изменения настроек, перезапуска OBS или перезапуска системы."
+OBSWebsocket.Server.StartFailed.Message="Ошибка запуска сервера WebSockets. Вероятные причины:\n - Возможно, TCP-порт %1 занят другим приложением в системе. Попробуйте задать другой TCP-порт в настройках сервера WebSockets или закройте приложение, которое может использовать данный порт.\n - Произошла неизвестная сетевая ошибка в системе. Попробуйте снова после изменения настроек, перезапуска OBS или системы."

data/locale/zh-CN.ini

@@ -1,6 +1,12 @@
-OBSWebsocket.Menu.SettingsItem="Websocket 服务器设置"
+OBSWebsocket.Settings.ServerEnable="启用 WebSockets 服务器"
-OBSWebsocket.Settings.DialogTitle="obs-websocket 设置"
-OBSWebsocket.Settings.ServerEnable="启用 Websocket 服务器"
 OBSWebsocket.Settings.ServerPort="服务器端口"
-OBSWebsocket.Settings.AuthRequired="启用密码认证"
+OBSWebsocket.Settings.AuthRequired="启用身份验证"
 OBSWebsocket.Settings.Password="密码"
+OBSWebsocket.Settings.DebugEnable="启用调试日志"
+OBSWebsocket.Settings.AlertsEnable="启用系统托盘通知"
+OBSWebsocket.NotifyConnect.Title="新 WebSocket 连接"
+OBSWebsocket.NotifyConnect.Message="客户端 %1 已连接"
+OBSWebsocket.NotifyDisconnect.Title="WebSocket 客户端已断开"
+OBSWebsocket.NotifyDisconnect.Message="客户端 %1 已断开连接"
+OBSWebsocket.Server.StartFailed.Title="WebSockets 服务器错误"
+OBSWebsocket.Server.StartFailed.Message="WebSockets 服务器启动失败，可能是因为：\n - TCP 端口 %1 可能被本机的另一个应用程序占用。尝试在 WebSockets 服务器设置中设置不同的 TCP 端口，或关闭任何可能使用此端口的应用程序。\n - 在您的系统上发生了未知的网络错误。请尝试更改设置、重新启动 OBS 或重新启动系统。"

data/locale/zh-TW.ini

@@ -1,6 +1,9 @@
-OBSWebsocket.Menu.SettingsItem="Websocket 伺服器設定"
+OBSWebsocket.Settings.ServerPort="伺服器連接埠"
-OBSWebsocket.Settings.DialogTitle="obs-websocket 設定"
+OBSWebsocket.Settings.DebugEnable="啟用除錯日誌"
-OBSWebsocket.Settings.ServerEnable="啟用 Websocket 伺服器"
+OBSWebsocket.Settings.AlertsEnable="啟用系統列通知"
-OBSWebsocket.Settings.ServerPort="伺服器端口"
+OBSWebsocket.NotifyConnect.Title="新的 WebSocket 連線"
-OBSWebsocket.Settings.AuthRequired="啟用密碼認證"
+OBSWebsocket.NotifyConnect.Message="客戶端 %1 已連線"
-OBSWebsocket.Settings.Password="密碼"
+OBSWebsocket.NotifyDisconnect.Title="WebSocket 客戶端已離線"
+OBSWebsocket.NotifyDisconnect.Message="客戶端 %1 已離線"
+OBSWebsocket.Server.StartFailed.Title="WebSocket 伺服器錯誤"
+OBSWebsocket.Server.StartFailed.Message="WebSockets 伺服器啟動失敗，可能的原因有：\n - TCP 連接埠 %1 被系統的其他程式所使用，試著為 WebSockets 伺服器指定不同的 TCP 連接埠，或是關閉任何可能使用此連接埠的程式。\n - 發生的未知的網路錯誤，試著更改設定、重新啟動 OBS 或是重新啟動您的系統。"

docs/generated/protocol.md

@@ -1,6 +1,6 @@
 <!-- This file was generated based on handlebars templates. Do not edit directly! -->
 
-# obs-websocket 4.5.0 protocol reference
+# obs-websocket 4.6.0 protocol reference
 
 # General Introduction
 Messages are exchanged between the client and the server as JSON objects.
@@ -43,8 +43,10 @@ auth_response = base64_encode(auth_response_hash)
 <!-- toc -->
 
 - [Typedefs](#typedefs)
+  * [SceneItem](#sceneitem)
+  * [SceneItemTransform](#sceneitemtransform)
+  * [OBSStats](#obsstats)
   * [Scene](#scene)
-  * [Source](#source)
 - [Events](#events)
   * [Scenes](#scenes)
     + [SwitchScenes](#switchscenes)
@@ -80,10 +82,23 @@ auth_response = base64_encode(auth_response_hash)
   * [General](#general)
     + [Heartbeat](#heartbeat)
   * [Sources](#sources)
+    + [SourceCreated](#sourcecreated)
+    + [SourceDestroyed](#sourcedestroyed)
+    + [SourceVolumeChanged](#sourcevolumechanged)
+    + [SourceMuteStateChanged](#sourcemutestatechanged)
+    + [SourceAudioSyncOffsetChanged](#sourceaudiosyncoffsetchanged)
+    + [SourceAudioMixersChanged](#sourceaudiomixerschanged)
+    + [SourceRenamed](#sourcerenamed)
+    + [SourceFilterAdded](#sourcefilteradded)
+    + [SourceFilterRemoved](#sourcefilterremoved)
+    + [SourceFiltersReordered](#sourcefiltersreordered)
     + [SourceOrderChanged](#sourceorderchanged)
     + [SceneItemAdded](#sceneitemadded)
     + [SceneItemRemoved](#sceneitemremoved)
     + [SceneItemVisibilityChanged](#sceneitemvisibilitychanged)
+    + [SceneItemTransformChanged](#sceneitemtransformchanged)
+    + [SceneItemSelected](#sceneitemselected)
+    + [SceneItemDeselected](#sceneitemdeselected)
   * [Studio Mode](#studio-mode)
     + [PreviewSceneChanged](#previewscenechanged)
     + [StudioModeSwitched](#studiomodeswitched)
@@ -95,6 +110,8 @@ auth_response = base64_encode(auth_response_hash)
     + [SetHeartbeat](#setheartbeat)
     + [SetFilenameFormatting](#setfilenameformatting)
     + [GetFilenameFormatting](#getfilenameformatting)
+    + [GetStats](#getstats)
+    + [GetVideoInfo](#getvideoinfo)
   * [Profiles](#profiles-1)
     + [SetCurrentProfile](#setcurrentprofile)
     + [GetCurrentProfile](#getcurrentprofile)
@@ -131,7 +148,7 @@ auth_response = base64_encode(auth_response_hash)
     + [ReorderSceneItems](#reordersceneitems)
   * [Sources](#sources-1)
     + [GetSourcesList](#getsourceslist)
-    + [GetSourcesTypesList](#getsourcestypeslist)
+    + [GetSourceTypesList](#getsourcetypeslist)
     + [GetVolume](#getvolume)
     + [SetVolume](#setvolume)
     + [GetMute](#getmute)
@@ -154,6 +171,7 @@ auth_response = base64_encode(auth_response_hash)
     + [ReorderSourceFilter](#reordersourcefilter)
     + [MoveSourceFilter](#movesourcefilter)
     + [SetSourceFilterSettings](#setsourcefiltersettings)
+    + [TakeSourceScreenshot](#takesourcescreenshot)
   * [Streaming](#streaming-1)
     + [GetStreamingStatus](#getstreamingstatus)
     + [StartStopStreaming](#startstopstreaming)
@@ -162,6 +180,7 @@ auth_response = base64_encode(auth_response_hash)
     + [SetStreamSettings](#setstreamsettings)
     + [GetStreamSettings](#getstreamsettings)
     + [SaveStreamSettings](#savestreamsettings)
+    + [SendCaptions](#sendcaptions)
   * [Studio Mode](#studio-mode-1)
     + [GetStudioModeStatus](#getstudiomodestatus)
     + [GetPreviewScene](#getpreviewscene)
@@ -183,24 +202,65 @@ auth_response = base64_encode(auth_response_hash)
 These are complex types, such as `Source` and `Scene`, which are used as arguments or return values in multiple requests and/or events. 
 
 
-## Scene
+## SceneItem
-| Name | Type  | Description |
-| ---- | :---: | ------------|
-| `name` | _String_ | Name of the currently active scene. |
-| `sources` | _Array&lt;Source&gt;_ | Ordered list of the current scene's source items. |
-## Source
 | Name | Type  | Description |
 | ---- | :---: | ------------|
 | `cy` | _Number_ |  |
 | `cx` | _Number_ |  |
 | `name` | _String_ | The name of this Scene Item. |
+| `id` | _int_ | Scene item ID |
 | `render` | _Boolean_ | Whether or not this Scene Item is set to "visible". |
+| `locked` | _Boolean_ | Whether or not this Scene Item is locked and can't be moved around |
 | `source_cx` | _Number_ |  |
 | `source_cy` | _Number_ |  |
 | `type` | _String_ | Source type. Value is one of the following: "input", "filter", "transition", "scene" or "unknown" |
 | `volume` | _Number_ |  |
 | `x` | _Number_ |  |
 | `y` | _Number_ |  |
+| `parentGroupName` | _String (optional)_ | Name of the item's parent (if this item belongs to a group) |
+| `groupChildren` | _Array&lt;SceneItem&gt; (optional)_ | List of children (if this item is a group) |
+## SceneItemTransform
+| Name | Type  | Description |
+| ---- | :---: | ------------|
+| `position.x` | _int_ | The x position of the scene item from the left. |
+| `position.y` | _int_ | The y position of the scene item from the top. |
+| `position.alignment` | _int_ | The point on the scene item that the item is manipulated from. |
+| `rotation` | _double_ | The clockwise rotation of the scene item in degrees around the point of alignment. |
+| `scale.x` | _double_ | The x-scale factor of the scene item. |
+| `scale.y` | _double_ | The y-scale factor of the scene item. |
+| `crop.top` | _int_ | The number of pixels cropped off the top of the scene item before scaling. |
+| `crop.right` | _int_ | The number of pixels cropped off the right of the scene item before scaling. |
+| `crop.bottom` | _int_ | The number of pixels cropped off the bottom of the scene item before scaling. |
+| `crop.left` | _int_ | The number of pixels cropped off the left of the scene item before scaling. |
+| `visible` | _bool_ | If the scene item is visible. |
+| `locked` | _bool_ | If the scene item is locked in position. |
+| `bounds.type` | _String_ | Type of bounding box. Can be "OBS_BOUNDS_STRETCH", "OBS_BOUNDS_SCALE_INNER", "OBS_BOUNDS_SCALE_OUTER", "OBS_BOUNDS_SCALE_TO_WIDTH", "OBS_BOUNDS_SCALE_TO_HEIGHT", "OBS_BOUNDS_MAX_ONLY" or "OBS_BOUNDS_NONE". |
+| `bounds.alignment` | _int_ | Alignment of the bounding box. |
+| `bounds.x` | _double_ | Width of the bounding box. |
+| `bounds.y` | _double_ | Height of the bounding box. |
+| `sourceWidth` | _int_ | Base width (without scaling) of the source |
+| `sourceHeight` | _int_ | Base source (without scaling) of the source |
+| `width` | _double_ | Scene item width (base source width multiplied by the horizontal scaling factor) |
+| `height` | _double_ | Scene item height (base source height multiplied by the vertical scaling factor) |
+| `parentGroupName` | _String (optional)_ | Name of the item's parent (if this item belongs to a group) |
+| `groupChildren` | _Array&lt;SceneItemTransform&gt; (optional)_ | List of children (if this item is a group) |
+## OBSStats
+| Name | Type  | Description |
+| ---- | :---: | ------------|
+| `fps` | _double_ | Current framerate. |
+| `render-total-frames` | _int_ | Number of frames rendered |
+| `render-missed-frames` | _int_ | Number of frames missed due to rendering lag |
+| `output-total-frames` | _int_ | Number of frames outputted |
+| `output-skipped-frames` | _int_ | Number of frames skipped due to encoding lag |
+| `average-frame-time` | _double_ | Average frame render time (in milliseconds) |
+| `cpu-usage` | _double_ | Current CPU usage (percentage) |
+| `memory-usage` | _double_ | Current RAM usage (in megabytes) |
+| `free-disk-space` | _double_ | Free recording disk space (in megabytes) |
+## Scene
+| Name | Type  | Description |
+| ---- | :---: | ------------|
+| `name` | _String_ | Name of the currently active scene. |
+| `sources` | _Array&lt;SceneItem&gt;_ | Ordered list of the current scene's source items. |
 
 
 
@@ -231,7 +291,7 @@ Indicates a scene change.
 | Name | Type  | Description |
 | ---- | :---: | ------------|
 | `scene-name` | _String_ | The new scene. |
-| `sources` | _Array&lt;Source&gt;_ | List of sources in the new scene. Same specification as [`GetCurrentScene`](#getcurrentscene). |
+| `sources` | _Array&lt;SceneItem&gt;_ | List of scene items in the new scene. Same specification as [`GetCurrentScene`](#getcurrentscene). |
 
 
 ---
@@ -444,7 +504,7 @@ Emit every 2 seconds.
 | ---- | :---: | ------------|
 | `streaming` | _boolean_ | Current streaming state. |
 | `recording` | _boolean_ | Current recording state. |
-| `preview-only` | _boolean_ | Always false (retrocompatibility). |
+| `replay-buffer-active` | _boolean_ | Replay Buffer status |
 | `bytes-per-sec` | _int_ | Amount of data per second (in bytes) transmitted by the stream encoder. |
 | `kbits-per-sec` | _int_ | Amount of data per second (in kilobits) transmitted by the stream encoder. |
 | `strain` | _double_ | Percentage of dropped frames. |
@@ -452,6 +512,15 @@ Emit every 2 seconds.
 | `num-total-frames` | _int_ | Total number of frames transmitted since the stream started. |
 | `num-dropped-frames` | _int_ | Number of frames dropped by the encoder since the stream started. |
 | `fps` | _double_ | Current framerate. |
+| `render-total-frames` | _int_ | Number of frames rendered |
+| `render-missed-frames` | _int_ | Number of frames missed due to rendering lag |
+| `output-total-frames` | _int_ | Number of frames outputted |
+| `output-skipped-frames` | _int_ | Number of frames skipped due to encoding lag |
+| `average-frame-time` | _double_ | Average frame time (in milliseconds) |
+| `cpu-usage` | _double_ | Current CPU usage (percentage) |
+| `memory-usage` | _double_ | Current RAM usage (in megabytes) |
+| `free-disk-space` | _double_ | Free recording disk space (in megabytes) |
+| `preview-only` | _boolean_ | Always false (retrocompatibility). |
 
 
 ---
@@ -603,12 +672,194 @@ Emitted every 2 seconds after enabling it by calling SetHeartbeat.
 | `total-record-time` | _int (optional)_ | Total time (in seconds) since recording started. |
 | `total-record-bytes` | _int (optional)_ | Total bytes recorded since the recording started. |
 | `total-record-frames` | _int (optional)_ | Total frames recorded since the recording started. |
+| `stats` | _OBSStats_ | OBS Stats |
 
 
 ---
 
 ## Sources
 
+### SourceCreated
+
+
+- Added in v4.6.0
+
+A source has been created. A source can be an input, a scene or a transition.
+
+**Response Items:**
+
+| Name | Type  | Description |
+| ---- | :---: | ------------|
+| `sourceName` | _String_ | Source name |
+| `sourceType` | _String_ | Source type. Can be "input", "scene", "transition" or "filter". |
+| `sourceKind` | _String_ | Source kind. |
+| `sourceSettings` | _Object_ | Source settings |
+
+
+---
+
+### SourceDestroyed
+
+
+- Added in v4.6.0
+
+A source has been destroyed/removed. A source can be an input, a scene or a transition.
+
+**Response Items:**
+
+| Name | Type  | Description |
+| ---- | :---: | ------------|
+| `sourceName` | _String_ | Source name |
+| `sourceType` | _String_ | Source type. Can be "input", "scene", "transition" or "filter". |
+| `sourceKind` | _String_ | Source kind. |
+
+
+---
+
+### SourceVolumeChanged
+
+
+- Added in v4.6.0
+
+The volume of a source has changed.
+
+**Response Items:**
+
+| Name | Type  | Description |
+| ---- | :---: | ------------|
+| `sourceName` | _String_ | Source name |
+| `volume` | _float_ | Source volume |
+
+
+---
+
+### SourceMuteStateChanged
+
+
+- Added in v4.6.0
+
+A source has been muted or unmuted.
+
+**Response Items:**
+
+| Name | Type  | Description |
+| ---- | :---: | ------------|
+| `sourceName` | _String_ | Source name |
+| `muted` | _boolean_ | Mute status of the source |
+
+
+---
+
+### SourceAudioSyncOffsetChanged
+
+
+- Added in v4.6.0
+
+The audio sync offset of a source has changed.
+
+**Response Items:**
+
+| Name | Type  | Description |
+| ---- | :---: | ------------|
+| `sourceName` | _String_ | Source name |
+| `syncOffset` | _int_ | Audio sync offset of the source (in nanoseconds) |
+
+
+---
+
+### SourceAudioMixersChanged
+
+
+- Added in v4.6.0
+
+Audio mixer routing changed on a source.
+
+**Response Items:**
+
+| Name | Type  | Description |
+| ---- | :---: | ------------|
+| `sourceName` | _String_ | Source name |
+| `routingStatus` | _Array&lt;Object&gt;_ | Routing status of the source for each audio mixer (array of 6 values) |
+| `routingStatus.*.id` | _int_ | Mixer number |
+| `routingStatus.*.enabled` | _boolean_ | Routing status |
+| `hexMixersValue` | _String_ | Raw mixer flags (little-endian, one bit per mixer) as an hexadecimal value |
+
+
+---
+
+### SourceRenamed
+
+
+- Added in v4.6.0
+
+A source has been renamed.
+
+**Response Items:**
+
+| Name | Type  | Description |
+| ---- | :---: | ------------|
+| `previousName` | _String_ | Previous source name |
+| `newName` | _String_ | New source name |
+
+
+---
+
+### SourceFilterAdded
+
+
+- Added in v4.6.0
+
+A filter was added to a source.
+
+**Response Items:**
+
+| Name | Type  | Description |
+| ---- | :---: | ------------|
+| `sourceName` | _String_ | Source name |
+| `filterName` | _String_ | Filter name |
+| `filterType` | _String_ | Filter type |
+| `filterSettings` | _Object_ | Filter settings |
+
+
+---
+
+### SourceFilterRemoved
+
+
+- Added in v4.6.0
+
+A filter was removed from a source.
+
+**Response Items:**
+
+| Name | Type  | Description |
+| ---- | :---: | ------------|
+| `sourceName` | _String_ | Source name |
+| `filterName` | _String_ | Filter name |
+| `filterType` | _String_ | Filter type |
+
+
+---
+
+### SourceFiltersReordered
+
+
+- Added in v4.6.0
+
+Filters in a source have been reordered.
+
+**Response Items:**
+
+| Name | Type  | Description |
+| ---- | :---: | ------------|
+| `sourceName` | _String_ | Source name |
+| `filters` | _Array&lt;Object&gt;_ | Ordered Filters list |
+| `filters.*.name` | _String_ | Filter name |
+| `filters.*.type` | _String_ | Filter type |
+
+
+---
+
 ### SourceOrderChanged
 
 
@@ -621,6 +872,9 @@ Scene items have been reordered.
 | Name | Type  | Description |
 | ---- | :---: | ------------|
 | `scene-name` | _String_ | Name of the scene where items have been reordered. |
+| `scene-items` | _Array&lt;Object&gt;_ | Ordered list of scene items |
+| `scene-items.*.source-name` | _String_ | Item source name |
+| `scene-items.*.item-id` | _int_ | Scene item unique ID |
 
 
 ---
@@ -638,6 +892,7 @@ An item has been added to the current scene.
 | ---- | :---: | ------------|
 | `scene-name` | _String_ | Name of the scene. |
 | `item-name` | _String_ | Name of the item added to the scene. |
+| `item-id` | _int_ | Scene item ID |
 
 
 ---
@@ -655,6 +910,7 @@ An item has been removed from the current scene.
 | ---- | :---: | ------------|
 | `scene-name` | _String_ | Name of the scene. |
 | `item-name` | _String_ | Name of the item removed from the scene. |
+| `item-id` | _int_ | Scene item ID |
 
 
 ---
@@ -672,9 +928,65 @@ An item's visibility has been toggled.
 | ---- | :---: | ------------|
 | `scene-name` | _String_ | Name of the scene. |
 | `item-name` | _String_ | Name of the item in the scene. |
+| `item-id` | _int_ | Scene item ID |
 | `item-visible` | _boolean_ | New visibility state of the item. |
 
 
+---
+
+### SceneItemTransformChanged
+
+
+- Added in v4.6.0
+
+An item's transform has been changed.
+
+**Response Items:**
+
+| Name | Type  | Description |
+| ---- | :---: | ------------|
+| `scene-name` | _String_ | Name of the scene. |
+| `item-name` | _String_ | Name of the item in the scene. |
+| `item-id` | _int_ | Scene item ID |
+| `transform` | _SceneItemTransform_ | Scene item transform properties |
+
+
+---
+
+### SceneItemSelected
+
+
+- Added in v4.6.0
+
+A scene item is selected.
+
+**Response Items:**
+
+| Name | Type  | Description |
+| ---- | :---: | ------------|
+| `scene-name` | _String_ | Name of the scene. |
+| `item-name` | _String_ | Name of the item in the scene. |
+| `item-id` | _int_ | Name of the item in the scene. |
+
+
+---
+
+### SceneItemDeselected
+
+
+- Added in v4.6.0
+
+A scene item is deselected.
+
+**Response Items:**
+
+| Name | Type  | Description |
+| ---- | :---: | ------------|
+| `scene-name` | _String_ | Name of the scene. |
+| `item-name` | _String_ | Name of the item in the scene. |
+| `item-id` | _int_ | Name of the item in the scene. |
+
+
 ---
 
 ## Studio Mode
@@ -691,7 +1003,7 @@ The selected preview scene has changed (only available in Studio Mode).
 | Name | Type  | Description |
 | ---- | :---: | ------------|
 | `scene-name` | _String_ | Name of the scene being previewed. |
-| `sources` | _Array&lt;Source&gt;_ | List of sources composing the scene. Same specification as [`GetCurrentScene`](#getcurrentscene). |
+| `sources` | _Array&lt;SceneItem&gt;_ | List of sources composing the scene. Same specification as [`GetCurrentScene`](#getcurrentscene). |
 
 
 ---
@@ -854,6 +1166,54 @@ _No specified parameters._
 | `filename-formatting` | _String_ | Current filename formatting string. |
 
 
+---
+
+### GetStats
+
+
+- Added in v4.6.0
+
+Get OBS stats (almost the same info as provided in OBS' stats window)
+
+**Request Fields:**
+
+_No specified parameters._
+
+**Response Items:**
+
+| Name | Type  | Description |
+| ---- | :---: | ------------|
+| `stats` | _OBSStats_ | OBS stats |
+
+
+---
+
+### GetVideoInfo
+
+
+- Added in v4.6.0
+
+Get basic OBS video information
+
+**Request Fields:**
+
+_No specified parameters._
+
+**Response Items:**
+
+| Name | Type  | Description |
+| ---- | :---: | ------------|
+| `baseWidth` | _int_ | Base (canvas) width |
+| `baseHeight` | _int_ | Base (canvas) height |
+| `outputWidth` | _int_ | Output width |
+| `outputHeight` | _int_ | Output height |
+| `scaleType` | _String_ | Scaling method used if output size differs from base size |
+| `fps` | _double_ | Frames rendered per second |
+| `videoFormat` | _String_ | Video color format |
+| `colorSpace` | _String_ | Color space for YUV |
+| `colorRange` | _String_ | Color range (full or partial) |
+
+
 ---
 
 ## Profiles
@@ -978,7 +1338,11 @@ _No additional response items._
 
 - Added in v4.1.0
 
-Change the current recording folder.
+
+
+Please note: if `SetRecordingFolder` is called while a recording is
+in progress, the change won't be applied immediately and will be
+effective on the next recording.
 
 **Request Fields:**
 
@@ -1160,6 +1524,7 @@ _No specified parameters._
 - Added in v4.3.0
 
 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).
 
 **Request Fields:**
 
@@ -1185,10 +1550,15 @@ Gets the scene specific properties of the specified source item.
 | `crop.bottom` | _int_ | The number of pixels cropped off the bottom of the source before scaling. |
 | `crop.left` | _int_ | The number of pixels cropped off the left of the source before scaling. |
 | `visible` | _bool_ | If the source is visible. |
-| `bounds.type` | _String_ | Type of bounding box. |
+| `locked` | _bool_ | If the source's transform is locked. |
+| `bounds.type` | _String_ | Type of bounding box. Can be "OBS_BOUNDS_STRETCH", "OBS_BOUNDS_SCALE_INNER", "OBS_BOUNDS_SCALE_OUTER", "OBS_BOUNDS_SCALE_TO_WIDTH", "OBS_BOUNDS_SCALE_TO_HEIGHT", "OBS_BOUNDS_MAX_ONLY" or "OBS_BOUNDS_NONE". |
 | `bounds.alignment` | _int_ | Alignment of the bounding box. |
 | `bounds.x` | _double_ | Width of the bounding box. |
 | `bounds.y` | _double_ | Height of the bounding box. |
+| `sourceWidth` | _int_ | Base width (without scaling) of the source |
+| `sourceHeight` | _int_ | Base source (without scaling) of the source |
+| `width` | _double_ | Scene item width (base source width multiplied by the horizontal scaling factor) |
+| `height` | _double_ | Scene item height (base source height multiplied by the vertical scaling factor) |
 
 
 ---
@@ -1199,6 +1569,7 @@ Gets the scene specific properties of the specified source item.
 - Added in v4.3.0
 
 Sets the scene specific properties of a source. Unspecified properties will remain unchanged.
+Coordinates are relative to the item's parent (the scene or group it belongs to).
 
 **Request Fields:**
 
@@ -1206,21 +1577,22 @@ Sets the scene specific properties of a source. Unspecified properties will rema
 | ---- | :---: | ------------|
 | `scene-name` | _String (optional)_ | the name of the scene that the source item belongs to. Defaults to the current scene. |
 | `item` | _String_ | The name of the source. |
-| `position.x` | _int_ | The new x position of the source. |
+| `position.x` | _int (optional)_ | The new x position of the source. |
-| `position.y` | _int_ | The new y position of the source. |
+| `position.y` | _int (optional)_ | The new y position of the source. |
-| `position.alignment` | _int_ | The new alignment of the source. |
+| `position.alignment` | _int (optional)_ | The new alignment of the source. |
-| `rotation` | _double_ | The new clockwise rotation of the item in degrees. |
+| `rotation` | _double (optional)_ | The new clockwise rotation of the item in degrees. |
-| `scale.x` | _double_ | The new x scale of the item. |
+| `scale.x` | _double (optional)_ | The new x scale of the item. |
-| `scale.y` | _double_ | The new y scale of the item. |
+| `scale.y` | _double (optional)_ | The new y scale of the item. |
-| `crop.top` | _int_ | The new amount of pixels cropped off the top of the source before scaling. |
+| `crop.top` | _int (optional)_ | The new amount of pixels cropped off the top of the source before scaling. |
-| `crop.bottom` | _int_ | The new amount of pixels cropped off the bottom of the source before scaling. |
+| `crop.bottom` | _int (optional)_ | The new amount of pixels cropped off the bottom of the source before scaling. |
-| `crop.left` | _int_ | The new amount of pixels cropped off the left of the source before scaling. |
+| `crop.left` | _int (optional)_ | The new amount of pixels cropped off the left of the source before scaling. |
-| `crop.right` | _int_ | The new amount of pixels cropped off the right of the source before scaling. |
+| `crop.right` | _int (optional)_ | The new amount of pixels cropped off the right of the source before scaling. |
-| `visible` | _bool_ | The new visibility of the source. 'true' shows source, 'false' hides source. |
+| `visible` | _bool (optional)_ | The new visibility of the source. 'true' shows source, 'false' hides source. |
-| `bounds.type` | _String_ | The new bounds type of the source. |
+| `locked` | _bool (optional)_ | The new locked status of the source. 'true' keeps it in its current position, 'false' allows movement. |
-| `bounds.alignment` | _int_ | The new alignment of the bounding box. (0-2, 4-6, 8-10) |
+| `bounds.type` | _String (optional)_ | The new bounds type of the source. Can be "OBS_BOUNDS_STRETCH", "OBS_BOUNDS_SCALE_INNER", "OBS_BOUNDS_SCALE_OUTER", "OBS_BOUNDS_SCALE_TO_WIDTH", "OBS_BOUNDS_SCALE_TO_HEIGHT", "OBS_BOUNDS_MAX_ONLY" or "OBS_BOUNDS_NONE". |
-| `bounds.x` | _double_ | The new width of the bounding box. |
+| `bounds.alignment` | _int (optional)_ | The new alignment of the bounding box. (0-2, 4-6, 8-10) |
-| `bounds.y` | _double_ | The new height of the bounding box. |
+| `bounds.x` | _double (optional)_ | The new width of the bounding box. |
+| `bounds.y` | _double (optional)_ | The new height of the bounding box. |
 
 
 **Response Items:**
@@ -1395,7 +1767,7 @@ Duplicates a scene item.
 | ---- | :---: | ------------|
 | `scene` | _String_ | Name of the scene where the new item was created |
 | `item` | _Object_ | New item info |
-| `̀item.id` | _int_ | New item ID |
+| `item.id` | _int_ | New item ID |
 | `item.name` | _String_ | New item name |
 
 
@@ -1439,7 +1811,7 @@ _No specified parameters._
 | Name | Type  | Description |
 | ---- | :---: | ------------|
 | `name` | _String_ | Name of the currently active scene. |
-| `sources` | _Array&lt;Source&gt;_ | Ordered list of the current scene's source items. |
+| `sources` | _Array&lt;SceneItem&gt;_ | Ordered list of the current scene's source items. |
 
 
 ---
@@ -1513,7 +1885,7 @@ _No specified parameters._
 
 ---
 
-### GetSourcesTypesList
+### GetSourceTypesList
 
 
 - Added in v4.3.0
@@ -2143,6 +2515,40 @@ Update settings of a filter
 
 _No additional response items._
 
+---
+
+### TakeSourceScreenshot
+
+
+- Added in v4.6.0
+
+
+
+At least `embedPictureFormat` or `saveToFilePath` must be specified.
+
+Clients can specify `width` and `height` parameters to receive scaled pictures. Aspect ratio is
+preserved if only one of these two parameters is specified.
+
+**Request Fields:**
+
+| Name | Type  | Description |
+| ---- | :---: | ------------|
+| `sourceName` | _String_ | Source name |
+| `embedPictureFormat` | _String (optional)_ | Format of the Data URI encoded picture. Can be "png", "jpg", "jpeg" or "bmp" (or any other value supported by Qt's Image module) |
+| `saveToFilePath` | _String (optional)_ | Full file path (file extension included) where the captured image is to be saved. Can be in a format different from `pictureFormat`. Can be a relative path. |
+| `width` | _int (optional)_ | Screenshot width. Defaults to the source's base width. |
+| `height` | _int (optional)_ | Screenshot height. Defaults to the source's base height. |
+
+
+**Response Items:**
+
+| Name | Type  | Description |
+| ---- | :---: | ------------|
+| `sourceName` | _String_ | Source name |
+| `img` | _String_ | Image Data URI (if `embedPictureFormat` was specified in the request) |
+| `imageFile` | _String_ | Absolute path to the saved image file (if `saveToFilePath` was specified in the request) |
+
+
 ---
 
 ## Streaming
@@ -2299,6 +2705,27 @@ Save the current streaming server settings to disk.
 
 _No specified parameters._
 
+**Response Items:**
+
+_No additional response items._
+
+---
+
+### SendCaptions
+
+
+- Added in v4.6.0
+
+Send the provided text as embedded CEA-608 caption data.
+As of OBS Studio 23.1, captions are not yet available on Linux.
+
+**Request Fields:**
+
+| Name | Type  | Description |
+| ---- | :---: | ------------|
+| `text` | _String_ | Captions text |
+
+
 **Response Items:**
 
 _No additional response items._
@@ -2344,7 +2771,7 @@ _No specified parameters._
 | Name | Type  | Description |
 | ---- | :---: | ------------|
 | `name` | _String_ | The name of the active preview scene. |
-| `sources` | _Array&lt;Source&gt;_ |  |
+| `sources` | _Array&lt;SceneItem&gt;_ |  |
 
 
 ---

docs/partials/introduction.md

@@ -1,4 +1,4 @@
-# obs-websocket 4.5.0 protocol reference
+# obs-websocket 4.6.0 protocol reference
 
 # General Introduction
 Messages are exchanged between the client and the server as JSON objects.

installer/installer.iss

@@ -2,7 +2,7 @@
 ; SEE THE DOCUMENTATION FOR DETAILS ON CREATING INNO SETUP SCRIPT FILES!
 
 #define MyAppName "obs-websocket"
-#define MyAppVersion "4.5.1"
+#define MyAppVersion "4.6.1"
 #define MyAppPublisher "Stephane Lepin"
 #define MyAppURL "http://github.com/Palakis/obs-websocket"
 
@@ -23,14 +23,13 @@ DefaultGroupName={#MyAppName}
 OutputBaseFilename=obs-websocket-Windows-Installer
 Compression=lzma
 SolidCompression=yes
-LicenseFile=..\LICENSE
 
 [Languages]
 Name: "english"; MessagesFile: "compiler:Default.isl"
-Name: "french"; MessagesFile: "compiler:Languages\French.isl"
 
 [Files]
 Source: "..\release\*"; DestDir: "{app}"; Flags: ignoreversion recursesubdirs createallsubdirs
+Source: "..\LICENSE"; Flags: dontcopy
 ; NOTE: Don't use "Flags: ignoreversion" on any shared system files
 
 [Icons]
@@ -38,6 +37,21 @@ Name: "{group}\{cm:ProgramOnTheWeb,{#MyAppName}}"; Filename: "{#MyAppURL}"
 Name: "{group}\{cm:UninstallProgram,{#MyAppName}}"; Filename: "{uninstallexe}"
 
 [Code]
+procedure InitializeWizard();
+var
+  GPLText: AnsiString;
+  Page: TOutputMsgMemoWizardPage;
+begin
+  ExtractTemporaryFile('LICENSE');
+  LoadStringFromFile(ExpandConstant('{tmp}\LICENSE'), GPLText);
+
+  Page := CreateOutputMsgMemoPage(wpWelcome,
+    'License Information', 'Please review the license terms before installing obs-websocket',
+    'Press Page Down to see the rest of the agreement. Once you are aware of your rights, click Next to continue.',
+    String(GPLText)
+  );
+end;
+
 // credit where it's due :
 // following function come from https://github.com/Xaymar/obs-studio_amf-encoder-plugin/blob/master/%23Resources/Installer.in.iss#L45
 function GetDirName(Value: string): string;

src/Config.cpp

@@ -17,10 +17,10 @@ with this program. If not, see <https://www.gnu.org/licenses/>
 */
 
 #include <obs-frontend-api.h>
-#include <util/config-file.h>
 
-#include <QCryptographicHash>
+#include <QtCore/QCryptographicHash>
-#include <QTime>
+#include <QtCore/QTime>
+#include <QtWidgets/QSystemTrayIcon>
 
 #define SECTION_NAME "WebsocketAPI"
 #define PARAM_ENABLE "ServerEnabled"
@@ -31,13 +31,13 @@ with this program. If not, see <https://www.gnu.org/licenses/>
 #define PARAM_SECRET "AuthSecret"
 #define PARAM_SALT "AuthSalt"
 
-#include "Config.h"
 #include "Utils.h"
+#include "WSServer.h"
+
+#include "Config.h"
 
 #define QT_TO_UTF8(str) str.toUtf8().constData()
 
-Config* Config::_instance = new Config();
-
 Config::Config() :
 	ServerEnabled(true),
 	ServerPort(4444),
@@ -50,8 +50,55 @@ Config::Config() :
 {
 	qsrand(QTime::currentTime().msec());
 
+	SetDefaults();
+	SessionChallenge = GenerateSalt();
+
+	obs_frontend_add_event_callback(OnFrontendEvent, this);
+}
+
+Config::~Config()
+{
+	obs_frontend_remove_event_callback(OnFrontendEvent, this);
+}
+
+void Config::Load()
+{
+	config_t* obsConfig = GetConfigStore();
+
+	ServerEnabled = config_get_bool(obsConfig, SECTION_NAME, PARAM_ENABLE);
+	ServerPort = config_get_uint(obsConfig, SECTION_NAME, PARAM_PORT);
+
+	DebugEnabled = config_get_bool(obsConfig, SECTION_NAME, PARAM_DEBUG);
+	AlertsEnabled = config_get_bool(obsConfig, SECTION_NAME, PARAM_ALERT);
+
+	AuthRequired = config_get_bool(obsConfig, SECTION_NAME, PARAM_AUTHREQUIRED);
+	Secret = config_get_string(obsConfig, SECTION_NAME, PARAM_SECRET);
+	Salt = config_get_string(obsConfig, SECTION_NAME, PARAM_SALT);
+}
+
+void Config::Save()
+{
+	config_t* obsConfig = GetConfigStore();
+
+	config_set_bool(obsConfig, SECTION_NAME, PARAM_ENABLE, ServerEnabled);
+	config_set_uint(obsConfig, SECTION_NAME, PARAM_PORT, ServerPort);
+
+	config_set_bool(obsConfig, SECTION_NAME, PARAM_DEBUG, DebugEnabled);
+	config_set_bool(obsConfig, SECTION_NAME, PARAM_ALERT, AlertsEnabled);
+
+	config_set_bool(obsConfig, SECTION_NAME, PARAM_AUTHREQUIRED, AuthRequired);
+	config_set_string(obsConfig, SECTION_NAME, PARAM_SECRET,
+		QT_TO_UTF8(Secret));
+	config_set_string(obsConfig, SECTION_NAME, PARAM_SALT,
+		QT_TO_UTF8(Salt));
+
+	config_save(obsConfig);
+}
+
+void Config::SetDefaults()
+{
 	// OBS Config defaults
-	config_t* obsConfig = obs_frontend_get_global_config();
+	config_t* obsConfig = GetConfigStore();
 	if (obsConfig) {
 		config_set_default_bool(obsConfig,
 			SECTION_NAME, PARAM_ENABLE, ServerEnabled);
@@ -70,46 +117,11 @@ Config::Config() :
 		config_set_default_string(obsConfig,
 			SECTION_NAME, PARAM_SALT, QT_TO_UTF8(Salt));
 	}
-
-	SessionChallenge = GenerateSalt();
 }
 
-Config::~Config()
+config_t* Config::GetConfigStore()
 {
-}
+	return obs_frontend_get_profile_config();
-
-void Config::Load()
-{
-	config_t* obsConfig = obs_frontend_get_global_config();
-
-	ServerEnabled = config_get_bool(obsConfig, SECTION_NAME, PARAM_ENABLE);
-	ServerPort = config_get_uint(obsConfig, SECTION_NAME, PARAM_PORT);
-
-	DebugEnabled = config_get_bool(obsConfig, SECTION_NAME, PARAM_DEBUG);
-	AlertsEnabled = config_get_bool(obsConfig, SECTION_NAME, PARAM_ALERT);
-
-	AuthRequired = config_get_bool(obsConfig, SECTION_NAME, PARAM_AUTHREQUIRED);
-	Secret = config_get_string(obsConfig, SECTION_NAME, PARAM_SECRET);
-	Salt = config_get_string(obsConfig, SECTION_NAME, PARAM_SALT);
-}
-
-void Config::Save() 
-{
-	config_t* obsConfig = obs_frontend_get_global_config();
-
-	config_set_bool(obsConfig, SECTION_NAME, PARAM_ENABLE, ServerEnabled);
-	config_set_uint(obsConfig, SECTION_NAME, PARAM_PORT, ServerPort);
-
-	config_set_bool(obsConfig, SECTION_NAME, PARAM_DEBUG, DebugEnabled);
-	config_set_bool(obsConfig, SECTION_NAME, PARAM_ALERT, AlertsEnabled);
-
-	config_set_bool(obsConfig, SECTION_NAME, PARAM_AUTHREQUIRED, AuthRequired);
-	config_set_string(obsConfig, SECTION_NAME, PARAM_SECRET,
-		QT_TO_UTF8(Secret));
-	config_set_string(obsConfig, SECTION_NAME, PARAM_SALT,
-		QT_TO_UTF8(Salt));
-
-	config_save(obsConfig);
 }
 
 QString Config::GenerateSalt()
@@ -180,7 +192,95 @@ bool Config::CheckAuth(QString response)
 	return authSuccess;
 }
 
-Config* Config::Current()
+void Config::OnFrontendEvent(enum obs_frontend_event event, void* param)
 {
-	return _instance;
+	auto config = reinterpret_cast<Config*>(param);
+
+	if (event == OBS_FRONTEND_EVENT_PROFILE_CHANGED) {
+		obs_frontend_push_ui_translation(obs_module_get_string);
+		QString startMessage = QObject::tr("OBSWebsocket.ProfileChanged.Started");
+		QString stopMessage = QObject::tr("OBSWebsocket.ProfileChanged.Stopped");
+		QString restartMessage = QObject::tr("OBSWebsocket.ProfileChanged.Restarted");
+		obs_frontend_pop_ui_translation();
+
+		bool previousEnabled = config->ServerEnabled;
+		uint64_t previousPort = config->ServerPort;
+
+		config->SetDefaults();
+		config->Load();
+
+		if (config->ServerEnabled != previousEnabled || config->ServerPort != previousPort) {
+			auto server = GetServer();
+			server->stop();
+
+			if (config->ServerEnabled) {
+				server->start(config->ServerPort);
+
+				if (previousEnabled != config->ServerEnabled) {
+					Utils::SysTrayNotify(startMessage, QSystemTrayIcon::MessageIcon::Information);
+				} else {
+					Utils::SysTrayNotify(restartMessage, QSystemTrayIcon::MessageIcon::Information);
+				}
+			} else {
+				Utils::SysTrayNotify(stopMessage, QSystemTrayIcon::MessageIcon::Information);
+			}
+		}
+	}
+}
+
+void Config::MigrateFromGlobalSettings()
+{
+	config_t* source = obs_frontend_get_global_config();
+	config_t* destination = obs_frontend_get_profile_config();
+
+	if(config_has_user_value(source, SECTION_NAME, PARAM_ENABLE)) {
+		bool value = config_get_bool(source, SECTION_NAME, PARAM_ENABLE);
+		config_set_bool(destination, SECTION_NAME, PARAM_ENABLE, value);
+
+		config_remove_value(source, SECTION_NAME, PARAM_ENABLE);
+	}
+
+	if(config_has_user_value(source, SECTION_NAME, PARAM_PORT)) {
+		uint64_t value = config_get_uint(source, SECTION_NAME, PARAM_PORT);
+		config_set_uint(destination, SECTION_NAME, PARAM_PORT, value);
+
+		config_remove_value(source, SECTION_NAME, PARAM_PORT);
+	}
+
+	if(config_has_user_value(source, SECTION_NAME, PARAM_DEBUG)) {
+		bool value = config_get_bool(source, SECTION_NAME, PARAM_DEBUG);
+		config_set_bool(destination, SECTION_NAME, PARAM_DEBUG, value);
+
+		config_remove_value(source, SECTION_NAME, PARAM_DEBUG);
+	}
+
+	if(config_has_user_value(source, SECTION_NAME, PARAM_ALERT)) {
+		bool value = config_get_bool(source, SECTION_NAME, PARAM_ALERT);
+		config_set_bool(destination, SECTION_NAME, PARAM_ALERT, value);
+
+		config_remove_value(source, SECTION_NAME, PARAM_ALERT);
+	}
+
+	if(config_has_user_value(source, SECTION_NAME, PARAM_AUTHREQUIRED)) {
+		bool value = config_get_bool(source, SECTION_NAME, PARAM_AUTHREQUIRED);
+		config_set_bool(destination, SECTION_NAME, PARAM_AUTHREQUIRED, value);
+
+		config_remove_value(source, SECTION_NAME, PARAM_AUTHREQUIRED);
+	}
+
+	if(config_has_user_value(source, SECTION_NAME, PARAM_SECRET)) {
+		const char* value = config_get_string(source, SECTION_NAME, PARAM_SECRET);
+		config_set_string(destination, SECTION_NAME, PARAM_SECRET, value);
+
+		config_remove_value(source, SECTION_NAME, PARAM_SECRET);
+	}
+
+	if(config_has_user_value(source, SECTION_NAME, PARAM_SALT)) {
+		const char* value = config_get_string(source, SECTION_NAME, PARAM_SALT);
+		config_set_string(destination, SECTION_NAME, PARAM_SALT, value);
+
+		config_remove_value(source, SECTION_NAME, PARAM_SALT);
+	}
+
+	config_save(destination);
 }

src/Config.h

@@ -1,6 +1,6 @@
 /*
 obs-websocket
-Copyright (C) 2016-2017	Stéphane Lepin <stephane.lepin@gmail.com>
+Copyright (C) 2016-2019	Stéphane Lepin <stephane.lepin@gmail.com>
 
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -16,10 +16,12 @@ You should have received a copy of the GNU General Public License along
 with this program. If not, see <https://www.gnu.org/licenses/>
 */
 
-#ifndef CONFIG_H
+#pragma once
-#define CONFIG_H
 
-#include <QString>
+#include <obs-frontend-api.h>
+#include <util/config-file.h>
+#include <QtCore/QString>
+#include <QtCore/QSharedPointer>
 
 class Config {
 	public:
@@ -27,6 +29,10 @@ class Config {
 		~Config();
 		void Load();
 		void Save();
+		void SetDefaults();
+		config_t* GetConfigStore();
+
+		void MigrateFromGlobalSettings();
 
 		void SetPassword(QString password);
 		bool CheckAuth(QString userChallenge);
@@ -46,10 +52,6 @@ class Config {
 		QString SessionChallenge;
 		bool SettingsLoaded;
 
-		static Config* Current();
-
 	private:
-		static Config* _instance;
+		static void OnFrontendEvent(enum obs_frontend_event event, void* param);
 };
-
-#endif // CONFIG_H

src/ConnectionProperties.cpp

@@ -0,0 +1,34 @@
+/*
+obs-websocket
+Copyright (C) 2016-2019	Stéphane Lepin <stephane.lepin@gmail.com>
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along
+with this program. If not, see <https://www.gnu.org/licenses/>
+*/
+
+#include "ConnectionProperties.h"
+
+ConnectionProperties::ConnectionProperties()
+    : _authenticated(false)
+{
+}
+
+bool ConnectionProperties::isAuthenticated()
+{
+    return _authenticated.load();
+}
+
+void ConnectionProperties::setAuthenticated(bool authenticated)
+{
+    _authenticated.store(authenticated);
+}

src/ConnectionProperties.h

@@ -0,0 +1,31 @@
+/*
+obs-websocket
+Copyright (C) 2016-2019	Stéphane Lepin <stephane.lepin@gmail.com>
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along
+with this program. If not, see <https://www.gnu.org/licenses/>
+*/
+
+#pragma once
+
+#include <atomic>
+
+class ConnectionProperties
+{
+public:
+    explicit ConnectionProperties();
+    bool isAuthenticated();
+    void setAuthenticated(bool authenticated);
+private:
+    std::atomic<bool> _authenticated;
+};

src/Utils.cpp

@@ -16,9 +16,10 @@ You should have received a copy of the GNU General Public License along
 with this program. If not, see <https://www.gnu.org/licenses/>
 */
 
-#include <QMainWindow>
+#include <QtWidgets/QMainWindow>
-#include <QDir>
+#include <QtCore/QDir>
-#include <QUrl>
+#include <QtCore/QUrl>
+
 #include <obs-frontend-api.h>
 #include <obs.hpp>
 #include "obs-websocket.h"
@@ -28,23 +29,48 @@ with this program. If not, see <https://www.gnu.org/licenses/>
 
 Q_DECLARE_METATYPE(OBSScene);
 
-obs_data_array_t* Utils::StringListToArray(char** strings, char* key) {
+const QHash<obs_bounds_type, QString> boundTypeNames = {
-	if (!strings)
+	{ OBS_BOUNDS_STRETCH, "OBS_BOUNDS_STRETCH" },
-		return obs_data_array_create();
+	{ OBS_BOUNDS_SCALE_INNER, "OBS_BOUNDS_SCALE_INNER" },
+	{ OBS_BOUNDS_SCALE_OUTER, "OBS_BOUNDS_SCALE_OUTER" },
+	{ OBS_BOUNDS_SCALE_TO_WIDTH, "OBS_BOUNDS_SCALE_TO_WIDTH" },
+	{ OBS_BOUNDS_SCALE_TO_HEIGHT, "OBS_BOUNDS_SCALE_TO_HEIGHT" },
+	{ OBS_BOUNDS_MAX_ONLY, "OBS_BOUNDS_MAX_ONLY" },
+	{ OBS_BOUNDS_NONE, "OBS_BOUNDS_NONE" },
+};
 
+QString getBoundsNameFromType(obs_bounds_type type) {
+	QString fallback = boundTypeNames.value(OBS_BOUNDS_NONE);
+	return boundTypeNames.value(type, fallback);
+}
+
+obs_bounds_type getBoundsTypeFromName(QString name) {
+	return boundTypeNames.key(name);
+}
+
+obs_data_array_t* Utils::StringListToArray(char** strings, const char* key) {
 	obs_data_array_t* list = obs_data_array_create();
 
-	char* value = "";
+	if (!strings || !key) {
-	for (int i = 0; value != nullptr; i++) {
+		return list; // empty list
-		value = strings[i];
+	}
+
+	size_t index = 0;
+	char* value = nullptr;
+
+	do {
+		value = strings[index];
 
 		OBSDataAutoRelease item = obs_data_create();
 		obs_data_set_string(item, key, value);
 
-		if (value)
+		if (value) {
 			obs_data_array_push_back(list, item);
 		}
 
+		index++;
+	} while (value != nullptr);
+
 	return list;
 }
 
@@ -52,15 +78,16 @@ obs_data_array_t* Utils::GetSceneItems(obs_source_t* source) {
 	obs_data_array_t* items = obs_data_array_create();
 	OBSScene scene = obs_scene_from_source(source);
 
-	if (!scene)
+	if (!scene) {
 		return nullptr;
+	}
 
 	obs_scene_enum_items(scene, [](
 			obs_scene_t* scene,
 			obs_sceneitem_t* currentItem,
 			void* param)
 	{
-		obs_data_array_t* data = static_cast<obs_data_array_t*>(param);
+		obs_data_array_t* data = reinterpret_cast<obs_data_array_t*>(param);
 
 		OBSDataAutoRelease itemData = GetSceneItemData(currentItem);
 		obs_data_array_insert(data, 0, itemData);
@@ -70,9 +97,27 @@ obs_data_array_t* Utils::GetSceneItems(obs_source_t* source) {
 	return items;
 }
 
+/**
+ * @typedef {Object} `SceneItem` An OBS Scene Item.
+ * @property {Number} `cy`
+ * @property {Number} `cx`
+ * @property {String} `name` The name of this Scene Item.
+ * @property {int} `id` Scene item ID
+ * @property {Boolean} `render` Whether or not this Scene Item is set to "visible".
+ * @property {Boolean} `locked` Whether or not this Scene Item is locked and can't be moved around
+ * @property {Number} `source_cx`
+ * @property {Number} `source_cy`
+ * @property {String} `type` Source type. Value is one of the following: "input", "filter", "transition", "scene" or "unknown"
+ * @property {Number} `volume`
+ * @property {Number} `x`
+ * @property {Number} `y`
+ * @property {String (optional)} `parentGroupName` Name of the item's parent (if this item belongs to a group)
+ * @property {Array<SceneItem> (optional)} `groupChildren` List of children (if this item is a group)
+ */
 obs_data_t* Utils::GetSceneItemData(obs_sceneitem_t* item) {
-	if (!item)
+	if (!item) {
 		return nullptr;
+	}
 
 	vec2 pos;
 	obs_sceneitem_get_pos(item, &pos);
@@ -87,11 +132,13 @@ obs_data_t* Utils::GetSceneItemData(obs_sceneitem_t* item) {
 
 	obs_data_t* data = obs_data_create();
 	obs_data_set_string(data, "name",
-		obs_source_get_name(obs_sceneitem_get_source(item)));
+		obs_source_get_name(itemSource));
+	obs_data_set_int(data, "id",
+		obs_sceneitem_get_id(item));
 	obs_data_set_string(data, "type",
-		obs_source_get_id(obs_sceneitem_get_source(item)));
+		obs_source_get_id(itemSource));
 	obs_data_set_double(data, "volume",
-		obs_source_get_volume(obs_sceneitem_get_source(item)));
+		obs_source_get_volume(itemSource));
 	obs_data_set_double(data, "x", pos.x);
 	obs_data_set_double(data, "y", pos.y);
 	obs_data_set_int(data, "source_cx", (int)item_width);
@@ -99,6 +146,29 @@ obs_data_t* Utils::GetSceneItemData(obs_sceneitem_t* item) {
 	obs_data_set_double(data, "cx", item_width * scale.x);
 	obs_data_set_double(data, "cy", item_height * scale.y);
 	obs_data_set_bool(data, "render", obs_sceneitem_visible(item));
+	obs_data_set_bool(data, "locked", obs_sceneitem_locked(item));
+
+	obs_scene_t* parent = obs_sceneitem_get_scene(item);
+	if (parent) {
+		OBSSource parentSource = obs_scene_get_source(parent);
+		QString parentKind = obs_source_get_id(parentSource);
+		if (parentKind == "group") {
+			obs_data_set_string(data, "parentGroupName", obs_source_get_name(parentSource));
+		}
+	}
+
+	if (obs_sceneitem_is_group(item)) {
+		OBSDataArrayAutoRelease children = obs_data_array_create();
+		obs_sceneitem_group_enum_items(item, [](obs_scene_t*, obs_sceneitem_t* currentItem, void* param) {
+			obs_data_array_t* items = reinterpret_cast<obs_data_array_t*>(param);
+
+			OBSDataAutoRelease itemData = GetSceneItemData(currentItem);
+			obs_data_array_push_back(items, itemData);
+
+			return true;
+		}, children);
+		obs_data_set_array(data, "groupChildren", children);
+	}
 
 	return data;
 }
@@ -123,22 +193,31 @@ obs_sceneitem_t* Utils::GetSceneItemFromName(obs_source_t* source, QString name)
 	struct current_search {
 		QString query;
 		obs_sceneitem_t* result;
+		bool (*enumCallback)(obs_scene_t*, obs_sceneitem_t*, void*);
 	};
 
 	current_search search;
 	search.query = name;
 	search.result = nullptr;
+	search.enumCallback = nullptr;
 
 	OBSScene scene = obs_scene_from_source(source);
 	if (!scene)
 		return nullptr;
 
-	obs_scene_enum_items(scene, [](
+	search.enumCallback = [](
 			obs_scene_t* scene,
 			obs_sceneitem_t* currentItem,
 			void* param)
 	{
-		current_search* search = static_cast<current_search*>(param);
+		current_search* search = reinterpret_cast<current_search*>(param);
+
+		if (obs_sceneitem_is_group(currentItem)) {
+			obs_sceneitem_group_enum_items(currentItem, search->enumCallback, search);
+			if (search->result) {
+				return false;
+			}
+		}
 
 		QString currentItemName =
 			obs_source_get_name(obs_sceneitem_get_source(currentItem));
@@ -150,31 +229,43 @@ obs_sceneitem_t* Utils::GetSceneItemFromName(obs_source_t* source, QString name)
 		}
 
 		return true;
-	}, &search);
+	};
+
+	obs_scene_enum_items(scene, search.enumCallback, &search);
 
 	return search.result;
 }
 
+// TODO refactor this to unify it with GetSceneItemFromName
 obs_sceneitem_t* Utils::GetSceneItemFromId(obs_source_t* source, size_t id) {
 	struct current_search {
 		size_t query;
 		obs_sceneitem_t* result;
+		bool (*enumCallback)(obs_scene_t*, obs_sceneitem_t*, void*);
 	};
 
 	current_search search;
 	search.query = id;
 	search.result = nullptr;
+	search.enumCallback = nullptr;
 
 	OBSScene scene = obs_scene_from_source(source);
 	if (!scene)
 		return nullptr;
 
-	obs_scene_enum_items(scene, [](
+	search.enumCallback = [](
 			obs_scene_t* scene,
 			obs_sceneitem_t* currentItem,
 			void* param)
 	{
-		current_search* search = static_cast<current_search*>(param);
+		current_search* search = reinterpret_cast<current_search*>(param);
+
+		if (obs_sceneitem_is_group(currentItem)) {
+			obs_sceneitem_group_enum_items(currentItem, search->enumCallback, param);
+			if (search->result) {
+				return false;
+			}
+		}
 
 		if (obs_sceneitem_get_id(currentItem) == search->query) {
 			search->result = currentItem;
@@ -183,7 +274,9 @@ obs_sceneitem_t* Utils::GetSceneItemFromId(obs_source_t* source, size_t id) {
 		}
 
 		return true;
-	}, &search);
+	};
+
+	obs_scene_enum_items(scene, search.enumCallback, &search);
 
 	return search.result;
 }
@@ -299,19 +392,6 @@ QPushButton* Utils::GetPreviewModeButtonControl() {
 	return main->findChild<QPushButton*>("modeSwitch");
 }
 
-QListWidget* Utils::GetSceneListControl() {
-	QMainWindow* main = (QMainWindow*)obs_frontend_get_main_window();
-	return main->findChild<QListWidget*>("scenes");
-}
-
-obs_scene_t* Utils::SceneListItemToScene(QListWidgetItem* item) {
-	if (!item)
-		return nullptr;
-
-	QVariant itemData = item->data(static_cast<int>(Qt::UserRole));
-	return itemData.value<OBSScene>();
-}
-
 QLayout* Utils::GetPreviewLayout() {
 	QMainWindow* main = (QMainWindow*)obs_frontend_get_main_window();
 	return main->findChild<QLayout*>("previewLayout");
@@ -359,12 +439,13 @@ QSystemTrayIcon* Utils::GetTrayIcon() {
 	QMainWindow* main = (QMainWindow*)obs_frontend_get_main_window();
 	if (!main) return nullptr;
 
-	return main->findChildren<QSystemTrayIcon*>().first();
+	QList<QSystemTrayIcon*> trays = main->findChildren<QSystemTrayIcon*>();
+	return trays.isEmpty() ? nullptr : trays.first();
 }
 
-void Utils::SysTrayNotify(QString &text,
+void Utils::SysTrayNotify(QString text,
 	QSystemTrayIcon::MessageIcon icon, QString title) {
-	if (!Config::Current()->AlertsEnabled ||
+	if (!GetConfig()->AlertsEnabled ||
 		!QSystemTrayIcon::isSystemTrayAvailable() ||
 		!QSystemTrayIcon::supportsMessages())
 	{
@@ -376,15 +457,6 @@ void Utils::SysTrayNotify(QString &text,
 		trayIcon->showMessage(title, text, icon);
 }
 
-QString Utils::FormatIPAddress(QHostAddress &addr) {
-	QRegExp v4regex("(::ffff:)(((\\d).){3})", Qt::CaseInsensitive);
-	QString addrString = addr.toString();
-	if (addrString.contains(v4regex)) {
-		addrString = QHostAddress(addr.toIPv4Address()).toString();
-	}
-	return addrString;
-}
-
 const char* Utils::GetRecordingFolder() {
 	config_t* profile = obs_frontend_get_profile_config();
 	QString outputMode = config_get_string(profile, "Output", "Mode");
@@ -400,17 +472,13 @@ const char* Utils::GetRecordingFolder() {
 
 bool Utils::SetRecordingFolder(const char* path) {
 	QDir dir(path);
-	if (!dir.exists())
+	if (!dir.exists()) {
 		dir.mkpath(".");
+	}
 
 	config_t* profile = obs_frontend_get_profile_config();
-	QString outputMode = config_get_string(profile, "Output", "Mode");
-
-	if (outputMode == "Advanced") {
 	config_set_string(profile, "AdvOut", "RecFilePath", path);
-	} else {
 	config_set_string(profile, "SimpleOutput", "FilePath", path);
-	}
 
 	config_save(profile);
 	return true;
@@ -484,7 +552,7 @@ obs_hotkey_t* Utils::FindHotkeyByName(QString name) {
 	search.result = nullptr;
 
 	obs_enum_hotkeys([](void* data, obs_hotkey_id id, obs_hotkey_t* hotkey) {
-		current_search* search = static_cast<current_search*>(data);
+		current_search* search = reinterpret_cast<current_search*>(data);
 
 		const char* hk_name = obs_hotkey_get_name(hotkey);
 		if (hk_name == search->query) {
@@ -562,3 +630,148 @@ bool Utils::SetFilenameFormatting(const char* filenameFormatting) {
 	config_save(profile);
 	return true;
 }
+
+// Transform properties copy-pasted from WSRequestHandler_SceneItems.cpp because typedefs can't be extended yet
+
+/**
+ * @typedef {Object} `SceneItemTransform`
+ * @property {int} `position.x` The x position of the scene item from the left.
+ * @property {int} `position.y` The y position of the scene item from the top.
+ * @property {int} `position.alignment` The point on the scene item that the item is manipulated from.
+ * @property {double} `rotation` The clockwise rotation of the scene item in degrees around the point of alignment.
+ * @property {double} `scale.x` The x-scale factor of the scene item.
+ * @property {double} `scale.y` The y-scale factor of the scene item.
+ * @property {int} `crop.top` The number of pixels cropped off the top of the scene item before scaling.
+ * @property {int} `crop.right` The number of pixels cropped off the right of the scene item before scaling.
+ * @property {int} `crop.bottom` The number of pixels cropped off the bottom of the scene item before scaling.
+ * @property {int} `crop.left` The number of pixels cropped off the left of the scene item before scaling.
+ * @property {bool} `visible` If the scene item is visible.
+ * @property {bool} `locked` If the scene item is locked in position.
+ * @property {String} `bounds.type` Type of bounding box. Can be "OBS_BOUNDS_STRETCH", "OBS_BOUNDS_SCALE_INNER", "OBS_BOUNDS_SCALE_OUTER", "OBS_BOUNDS_SCALE_TO_WIDTH", "OBS_BOUNDS_SCALE_TO_HEIGHT", "OBS_BOUNDS_MAX_ONLY" or "OBS_BOUNDS_NONE".
+ * @property {int} `bounds.alignment` Alignment of the bounding box.
+ * @property {double} `bounds.x` Width of the bounding box.
+ * @property {double} `bounds.y` Height of the bounding box.
+ * @property {int} `sourceWidth` Base width (without scaling) of the source
+ * @property {int} `sourceHeight` Base source (without scaling) of the source
+ * @property {double} `width` Scene item width (base source width multiplied by the horizontal scaling factor)
+ * @property {double} `height` Scene item height (base source height multiplied by the vertical scaling factor)
+ * @property {String (optional)} `parentGroupName` Name of the item's parent (if this item belongs to a group)
+ * @property {Array<SceneItemTransform> (optional)} `groupChildren` List of children (if this item is a group) 
+ */
+obs_data_t* Utils::GetSceneItemPropertiesData(obs_sceneitem_t* sceneItem) {
+	if (!sceneItem) {
+		return nullptr;
+	}
+
+	OBSSource source = obs_sceneitem_get_source(sceneItem);
+	uint32_t baseSourceWidth = obs_source_get_width(source);
+	uint32_t baseSourceHeight = obs_source_get_height(source);
+
+	vec2 pos, scale, bounds;
+	obs_sceneitem_crop crop;
+
+	obs_sceneitem_get_pos(sceneItem, &pos);
+	obs_sceneitem_get_scale(sceneItem, &scale);
+	obs_sceneitem_get_crop(sceneItem, &crop);
+	obs_sceneitem_get_bounds(sceneItem, &bounds);
+
+	uint32_t alignment = obs_sceneitem_get_alignment(sceneItem);
+	float rotation = obs_sceneitem_get_rot(sceneItem);
+	bool isVisible = obs_sceneitem_visible(sceneItem);
+	bool isLocked = obs_sceneitem_locked(sceneItem);
+
+	obs_bounds_type boundsType = obs_sceneitem_get_bounds_type(sceneItem);
+	uint32_t boundsAlignment = obs_sceneitem_get_bounds_alignment(sceneItem);
+	QString boundsTypeName = getBoundsNameFromType(boundsType);
+
+	OBSDataAutoRelease posData = obs_data_create();
+	obs_data_set_double(posData, "x", pos.x);
+	obs_data_set_double(posData, "y", pos.y);
+	obs_data_set_int(posData, "alignment", alignment);
+
+	OBSDataAutoRelease scaleData = obs_data_create();
+	obs_data_set_double(scaleData, "x", scale.x);
+	obs_data_set_double(scaleData, "y", scale.y);
+
+	OBSDataAutoRelease cropData = obs_data_create();
+	obs_data_set_int(cropData, "left", crop.left);
+	obs_data_set_int(cropData, "top", crop.top);
+	obs_data_set_int(cropData, "right", crop.right);
+	obs_data_set_int(cropData, "bottom", crop.bottom);
+
+	OBSDataAutoRelease boundsData = obs_data_create();
+	obs_data_set_string(boundsData, "type", boundsTypeName.toUtf8());
+	obs_data_set_int(boundsData, "alignment", boundsAlignment);
+	obs_data_set_double(boundsData, "x", bounds.x);
+	obs_data_set_double(boundsData, "y", bounds.y);
+
+	obs_data_t* data = obs_data_create();
+	obs_data_set_obj(data, "position", posData);
+	obs_data_set_double(data, "rotation", rotation);
+	obs_data_set_obj(data, "scale", scaleData);
+	obs_data_set_obj(data, "crop", cropData);
+	obs_data_set_bool(data, "visible", isVisible);
+	obs_data_set_bool(data, "locked", isLocked);
+	obs_data_set_obj(data, "bounds", boundsData);
+
+	obs_data_set_int(data, "sourceWidth", baseSourceWidth);
+	obs_data_set_int(data, "sourceHeight", baseSourceHeight);
+	obs_data_set_double(data, "width", baseSourceWidth * scale.x);
+	obs_data_set_double(data, "height", baseSourceHeight * scale.y);
+
+	obs_scene_t* parent = obs_sceneitem_get_scene(sceneItem);
+	if (parent) {
+		OBSSource parentSource = obs_scene_get_source(parent);
+		QString parentKind = obs_source_get_id(parentSource);
+		if (parentKind == "group") {
+			obs_data_set_string(data, "parentGroupName", obs_source_get_name(parentSource));
+		}
+	}
+
+	if (obs_sceneitem_is_group(sceneItem)) {
+		OBSDataArrayAutoRelease children = obs_data_array_create();
+		obs_sceneitem_group_enum_items(sceneItem, [](obs_scene_t*, obs_sceneitem_t* subItem, void* param) {
+			obs_data_array_t* items = reinterpret_cast<obs_data_array_t*>(param);
+
+			OBSDataAutoRelease itemData = GetSceneItemPropertiesData(subItem);
+			obs_data_array_push_back(items, itemData);
+
+			return true;
+		}, children);
+		obs_data_set_array(data, "groupChildren", children);
+	}
+
+	return data;
+}
+
+obs_data_array_t* Utils::GetSourceFiltersList(obs_source_t* source, bool includeSettings)
+{
+	struct enum_params {
+		obs_data_array_t* filters;
+		bool includeSettings;
+	};
+
+	if (!source) {
+		return nullptr;
+	}
+
+	struct enum_params enumParams;
+
+	enumParams.filters = obs_data_array_create();
+	enumParams.includeSettings = includeSettings;
+
+	obs_source_enum_filters(source, [](obs_source_t* parent, obs_source_t* child, void* param)
+	{
+		auto enumParams = reinterpret_cast<struct enum_params*>(param);
+
+		OBSDataAutoRelease filter = obs_data_create();
+		obs_data_set_string(filter, "type", obs_source_get_id(child));
+		obs_data_set_string(filter, "name", obs_source_get_name(child));
+		if (enumParams->includeSettings) {
+			obs_data_set_obj(filter, "settings", obs_source_get_settings(child));
+		}
+		obs_data_array_push_back(enumParams->filters, filter);
+	}, &enumParams);
+
+	return enumParams.filters;
+}

src/Utils.h

@@ -1,6 +1,6 @@
 /*
 obs-websocket
-Copyright (C) 2016-2017	Stéphane Lepin <stephane.lepin@gmail.com>
+Copyright (C) 2016-2019	Stéphane Lepin <stephane.lepin@gmail.com>
 
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -16,17 +16,16 @@ You should have received a copy of the GNU General Public License along
 with this program. If not, see <https://www.gnu.org/licenses/>
 */
 
-#ifndef UTILS_H
+#pragma once
-#define UTILS_H
 
 #include <stdio.h>
 
-#include <QSpinBox>
+#include <QtCore/QString>
-#include <QPushButton>
+#include <QtWidgets/QSpinBox>
-#include <QLayout>
+#include <QtWidgets/QPushButton>
-#include <QListWidget>
+#include <QtWidgets/QLayout>
-#include <QSystemTrayIcon>
+#include <QtWidgets/QListWidget>
-#include <QHostAddress>
+#include <QtWidgets/QSystemTrayIcon>
 
 #include <obs.hpp>
 #include <obs-module.h>
@@ -34,7 +33,7 @@ with this program. If not, see <https://www.gnu.org/licenses/>
 
 class Utils {
   public:
-	static obs_data_array_t* StringListToArray(char** strings, char* key);
+	static obs_data_array_t* StringListToArray(char** strings, const char* key);
 	static obs_data_array_t* GetSceneItems(obs_source_t* source);
 	static obs_data_t* GetSceneItemData(obs_sceneitem_t* item);
 	static obs_sceneitem_t* GetSceneItemFromName(
@@ -43,12 +42,16 @@ class Utils {
 	static obs_sceneitem_t* GetSceneItemFromItem(obs_source_t* source, obs_data_t* item);
 	static obs_source_t* GetTransitionFromName(QString transitionName);
 	static obs_source_t* GetSceneFromNameOrCurrent(QString sceneName);
+	static obs_data_t* GetSceneItemPropertiesData(obs_sceneitem_t* item);
+
+	static obs_data_array_t* GetSourceFiltersList(obs_source_t* source, bool includeSettings);
 
 	static bool IsValidAlignment(const uint32_t alignment);
 
 	static obs_data_array_t* GetScenes();
 	static obs_data_t* GetSceneData(obs_source_t* source);
 
+	// TODO contribute a proper frontend API method for this to OBS and remove this hack
 	static QSpinBox* GetTransitionDurationControl();
 	static int GetTransitionDuration();
 	static void SetTransitionDuration(int ms);
@@ -57,21 +60,18 @@ class Utils {
 
 	static QPushButton* GetPreviewModeButtonControl();
 	static QLayout* GetPreviewLayout();
-	static QListWidget* GetSceneListControl();
-	static obs_scene_t* SceneListItemToScene(QListWidgetItem* item);
 
+	// TODO contribute a proper frontend API method for this to OBS and remove this hack
 	static void TransitionToProgram();
 
 	static QString OBSVersionString();
 
 	static QSystemTrayIcon* GetTrayIcon();
 	static void SysTrayNotify(
-		QString &text,
+		QString text,
 		QSystemTrayIcon::MessageIcon n,
 		QString title = QString("obs-websocket"));
 
-	static QString FormatIPAddress(QHostAddress &addr);
-
 	static const char* GetRecordingFolder();
 	static bool SetRecordingFolder(const char* path);
 
@@ -83,5 +83,3 @@ class Utils {
 	static const char* GetFilenameFormatting();
 	static bool SetFilenameFormatting(const char* filenameFormatting);
 };
-
-#endif // UTILS_H

src/WSEvents.h

@@ -1,6 +1,6 @@
 /*
 obs-websocket
-Copyright (C) 2016-2017	Stéphane Lepin <stephane.lepin@gmail.com>
+Copyright (C) 2016-2019	Stéphane Lepin <stephane.lepin@gmail.com>
 Copyright (C) 2017	Brendan Hagan <https://github.com/haganbmj>
 
 This program is free software; you can redistribute it and/or modify
@@ -17,48 +17,53 @@ You should have received a copy of the GNU General Public License along
 with this program. If not, see <https://www.gnu.org/licenses/>
 */
 
-#ifndef WSEVENTS_H
+#pragma once
-#define WSEVENTS_H
 
 #include <obs.hpp>
 #include <obs-frontend-api.h>
-#include <QListWidgetItem>
+#include <util/platform.h>
+
+#include <QtWidgets/QListWidgetItem>
+#include <QtCore/QSharedPointer>
+#include <QtCore/QTimer>
+
 #include "WSServer.h"
 
-class WSEvents : public QObject {
+class WSEvents : public QObject
+{
 Q_OBJECT
+
 public:
-	explicit WSEvents(WSServer* srv);
+	explicit WSEvents(WSServerPtr srv);
 	~WSEvents();
-	static void FrontendEventHandler(
+
-		enum obs_frontend_event event, void* privateData);
+	void connectSourceSignals(obs_source_t* source);
-	static WSEvents* Instance;
+	void disconnectSourceSignals(obs_source_t* source);
-	void connectSceneSignals(obs_source_t* scene);
 
 	void hookTransitionBeginEvent();
+	void unhookTransitionBeginEvent();
 
 	uint64_t GetStreamingTime();
 	const char* GetStreamingTimecode();
 	uint64_t GetRecordingTime();
 	const char* GetRecordingTimecode();
+	obs_data_t* GetStats();
 
 	bool HeartbeatIsActive;
 
 private slots:
-	void deferredInitOperations();
 	void StreamStatus();
 	void Heartbeat();
 	void TransitionDurationChanged(int ms);
 
 private:
-	WSServer* _srv;
+	WSServerPtr _srv;
-	OBSSource currentScene;
+	QTimer streamStatusTimer;
+	QTimer heartbeatTimer;
+	os_cpu_usage_info_t* cpuUsageInfo;
 
 	bool pulse;
 
-	bool _streamingActive;
-	bool _recordingActive;
-
 	uint64_t _streamStarttime;
 	uint64_t _recStarttime;
 
@@ -99,12 +104,30 @@ class WSEvents : public QObject {
 
 	void OnExit();
 
+	static void FrontendEventHandler(
+		enum obs_frontend_event event, void* privateData);
+
 	static void OnTransitionBegin(void* param, calldata_t* data);
 
+	static void OnSourceCreate(void* param, calldata_t* data);
+	static void OnSourceDestroy(void* param, calldata_t* data);
+
+	static void OnSourceVolumeChange(void* param, calldata_t* data);
+	static void OnSourceMuteStateChange(void* param, calldata_t* data);
+	static void OnSourceAudioSyncOffsetChanged(void* param, calldata_t* data);
+	static void OnSourceAudioMixersChanged(void* param, calldata_t* data);
+
+	static void OnSourceRename(void* param, calldata_t* data);
+
+	static void OnSourceFilterAdded(void* param, calldata_t* data);
+	static void OnSourceFilterRemoved(void* param, calldata_t* data);
+	static void OnSourceFilterOrderChanged(void* param, calldata_t* data);
+
 	static void OnSceneReordered(void* param, calldata_t* data);
 	static void OnSceneItemAdd(void* param, calldata_t* data);
 	static void OnSceneItemDelete(void* param, calldata_t* data);
 	static void OnSceneItemVisibilityChanged(void* param, calldata_t* data);
+	static void OnSceneItemTransform(void* param, calldata_t* data);
+	static void OnSceneItemSelected(void* param, calldata_t* data);
+	static void OnSceneItemDeselected(void* param, calldata_t* data);
 };
-
-#endif // WSEVENTS_H

src/WSRequestHandler.cpp

@@ -24,12 +24,14 @@
 
 #include "WSRequestHandler.h"
 
-QHash<QString, void(*)(WSRequestHandler*)> WSRequestHandler::messageMap {
+QHash<QString, HandlerResponse(*)(WSRequestHandler*)> WSRequestHandler::messageMap {
 	{ "GetVersion", WSRequestHandler::HandleGetVersion },
 	{ "GetAuthRequired", WSRequestHandler::HandleGetAuthRequired },
 	{ "Authenticate", WSRequestHandler::HandleAuthenticate },
 
+	{ "GetStats", WSRequestHandler::HandleGetStats },
 	{ "SetHeartbeat", WSRequestHandler::HandleSetHeartbeat },
+	{ "GetVideoInfo", WSRequestHandler::HandleGetVideoInfo },
 
 	{ "SetFilenameFormatting", WSRequestHandler::HandleSetFilenameFormatting },
 	{ "GetFilenameFormatting", WSRequestHandler::HandleGetFilenameFormatting },
@@ -84,6 +86,7 @@ QHash<QString, void(*)(WSRequestHandler*)> WSRequestHandler::messageMap {
 	{ "GetSourceTypesList", WSRequestHandler::HandleGetSourceTypesList },
 	{ "GetSourceSettings", WSRequestHandler::HandleGetSourceSettings },
 	{ "SetSourceSettings", WSRequestHandler::HandleSetSourceSettings },
+	{ "TakeSourceScreenshot", WSRequestHandler::HandleTakeSourceScreenshot },
 
 	{ "GetSourceFilters", WSRequestHandler::HandleGetSourceFilters },
 	{ "AddFilterToSource", WSRequestHandler::HandleAddFilterToSource },
@@ -103,6 +106,9 @@ QHash<QString, void(*)(WSRequestHandler*)> WSRequestHandler::messageMap {
 	{ "SetStreamSettings", WSRequestHandler::HandleSetStreamSettings },
 	{ "GetStreamSettings", WSRequestHandler::HandleGetStreamSettings },
 	{ "SaveStreamSettings", WSRequestHandler::HandleSaveStreamSettings },
+#if BUILD_CAPTIONS
+	{ "SendCaptions", WSRequestHandler::HandleSendCaptions },
+#endif
 
 	{ "GetStudioModeStatus", WSRequestHandler::HandleGetStudioModeStatus },
 	{ "GetPreviewScene", WSRequestHandler::HandleGetPreviewScene },
@@ -128,98 +134,89 @@ QSet<QString> WSRequestHandler::authNotRequired {
 	"Authenticate"
 };
 
-WSRequestHandler::WSRequestHandler(QWebSocket* client) :
+WSRequestHandler::WSRequestHandler(ConnectionProperties& connProperties) :
 	_messageId(0),
 	_requestType(""),
 	data(nullptr),
-	_client(client)
+	_connProperties(connProperties)
 {
 }
 
-void WSRequestHandler::processIncomingMessage(QString textMessage) {
+std::string WSRequestHandler::processIncomingMessage(std::string& textMessage) {
-	QByteArray msgData = textMessage.toUtf8();
+	if (GetConfig()->DebugEnabled) {
-	const char* msg = msgData.constData();
+		blog(LOG_INFO, "Request >> '%s'", textMessage.c_str());
+	}
+
+	OBSDataAutoRelease responseData = processRequest(textMessage);
+	std::string response = obs_data_get_json(responseData);
+
+	if (GetConfig()->DebugEnabled) {
+		blog(LOG_INFO, "Response << '%s'", response.c_str());
+	}
+
+	return response;
+}
+
+HandlerResponse WSRequestHandler::processRequest(std::string& textMessage){
+	std::string msgContainer(textMessage);
+	const char* msg = msgContainer.c_str();
 
 	data = obs_data_create_from_json(msg);
 	if (!data) {
-		if (!msg)
-			msg = "<null pointer>";
-
 		blog(LOG_ERROR, "invalid JSON payload received for '%s'", msg);
-		SendErrorResponse("invalid JSON payload");
+		return SendErrorResponse("invalid JSON payload");
-		return;
 	}
 
-	if (Config::Current()->DebugEnabled) {
+	if (!hasField("request-type") || !hasField("message-id")) {
-		blog(LOG_DEBUG, "Request >> '%s'", msg);
+		return SendErrorResponse("missing request parameters");
-	}
-
-	if (!hasField("request-type")
-		|| !hasField("message-id"))
-	{
-		SendErrorResponse("missing request parameters");
-		return;
 	}
 
 	_requestType = obs_data_get_string(data, "request-type");
 	_messageId = obs_data_get_string(data, "message-id");
 
-	if (Config::Current()->AuthRequired
+	if (GetConfig()->AuthRequired
-		&& (_client->property(PROP_AUTHENTICATED).toBool() == false)
+		&& (!authNotRequired.contains(_requestType))
-		&& (authNotRequired.find(_requestType) == authNotRequired.end()))
+		&& (!_connProperties.isAuthenticated()))
 	{
-		SendErrorResponse("Not Authenticated");
+		return SendErrorResponse("Not Authenticated");
-		return;
 	}
 
-	void (*handlerFunc)(WSRequestHandler*) = (messageMap[_requestType]);
+	HandlerResponse (*handlerFunc)(WSRequestHandler*) = (messageMap[_requestType]);
+	if (!handlerFunc) {
+		return SendErrorResponse("invalid request type");
+	}
 
-	if (handlerFunc != nullptr)
+	return handlerFunc(this);
-		handlerFunc(this);
-	else
-		SendErrorResponse("invalid request type");
 }
 
 WSRequestHandler::~WSRequestHandler() {
 }
 
-void WSRequestHandler::SendOKResponse(obs_data_t* additionalFields) {
+HandlerResponse WSRequestHandler::SendOKResponse(obs_data_t* additionalFields) {
-	OBSDataAutoRelease response = obs_data_create();
+	return SendResponse("ok", additionalFields);
-	obs_data_set_string(response, "status", "ok");
-	obs_data_set_string(response, "message-id", _messageId);
-
-	if (additionalFields)
-		obs_data_apply(response, additionalFields);
-
-	SendResponse(response);
 }
 
-void WSRequestHandler::SendErrorResponse(const char* errorMessage) {
+HandlerResponse WSRequestHandler::SendErrorResponse(const char* errorMessage) {
-	OBSDataAutoRelease response = obs_data_create();
+	OBSDataAutoRelease fields = obs_data_create();
-	obs_data_set_string(response, "status", "error");
+	obs_data_set_string(fields, "error", errorMessage);
-	obs_data_set_string(response, "error", errorMessage);
-	obs_data_set_string(response, "message-id", _messageId);
 
-	SendResponse(response);
+	return SendResponse("error", fields);
 }
 
-void WSRequestHandler::SendErrorResponse(obs_data_t* additionalFields) {
+HandlerResponse WSRequestHandler::SendErrorResponse(obs_data_t* additionalFields) {
-	OBSDataAutoRelease response = obs_data_create();
+	return SendResponse("error", additionalFields);
-	obs_data_set_string(response, "status", "error");
-	obs_data_set_string(response, "message-id", _messageId);
-
-	if (additionalFields)
-		obs_data_set_obj(response, "error", additionalFields);
-
-	SendResponse(response);
 }
 
-void WSRequestHandler::SendResponse(obs_data_t* response)  {
+HandlerResponse WSRequestHandler::SendResponse(const char* status, obs_data_t* fields) {
-	QString json = obs_data_get_json(response);
+	obs_data_t* response = obs_data_create();
-	_client->sendTextMessage(json);
+	obs_data_set_string(response, "message-id", _messageId);
+	obs_data_set_string(response, "status", status);
 
-	if (Config::Current()->DebugEnabled)
+	if (fields) {
-		blog(LOG_DEBUG, "Response << '%s'", json.toUtf8().constData());
+		obs_data_apply(response, fields);
+	}
+
+	return response;
 }
 
 bool WSRequestHandler::hasField(QString name) {

src/WSRequestHandler.h

@@ -1,6 +1,6 @@
 /*
 obs-websocket
-Copyright (C) 2016-2017	Stéphane Lepin <stephane.lepin@gmail.com>
+Copyright (C) 2016-2019	Stéphane Lepin <stephane.lepin@gmail.com>
 Copyright (C) 2017	Mikhail Swift <https://github.com/mikhailswift>
 
 This program is free software; you can redistribute it and/or modify
@@ -17,137 +17,147 @@ You should have received a copy of the GNU General Public License along
 with this program. If not, see <https://www.gnu.org/licenses/>
 */
 
-#ifndef WSREQUESTHANDLER_H
+#pragma once
-#define WSREQUESTHANDLER_H
 
-#include <QHash>
+#include <QtCore/QHash>
-#include <QSet>
+#include <QtCore/QSet>
-#include <QWebSocket>
+#include <QtCore/QVariantHash>
-#include <QWebSocketServer>
+#include <QtCore/QString>
+#include <QtCore/QSharedPointer>
 
 #include <obs.hpp>
 #include <obs-frontend-api.h>
 
+#include "ConnectionProperties.h"
+
 #include "obs-websocket.h"
 
+typedef obs_data_t* HandlerResponse;
+
 class WSRequestHandler : public QObject {
 	Q_OBJECT
 
 	public:
-		explicit WSRequestHandler(QWebSocket* client);
+		explicit WSRequestHandler(ConnectionProperties& connProperties);
 		~WSRequestHandler();
-		void processIncomingMessage(QString textMessage);
+		std::string processIncomingMessage(std::string& textMessage);
 		bool hasField(QString name);
 
 	private:
-		QWebSocket* _client;
 		const char* _messageId;
 		const char* _requestType;
+		ConnectionProperties& _connProperties;
 		OBSDataAutoRelease data;
 
-		void SendOKResponse(obs_data_t* additionalFields = NULL);
+		HandlerResponse processRequest(std::string& textMessage);
-		void SendErrorResponse(const char* errorMessage);
-		void SendErrorResponse(obs_data_t* additionalFields = NULL);
-		void SendResponse(obs_data_t* response);
 
-		static QHash<QString, void(*)(WSRequestHandler*)> messageMap;
+		HandlerResponse SendOKResponse(obs_data_t* additionalFields = nullptr);
+		HandlerResponse SendErrorResponse(const char* errorMessage);
+		HandlerResponse SendErrorResponse(obs_data_t* additionalFields = nullptr);
+		HandlerResponse SendResponse(const char* status, obs_data_t* additionalFields = nullptr);
+
+		static QHash<QString, HandlerResponse(*)(WSRequestHandler*)> messageMap;
 		static QSet<QString> authNotRequired;
 
-		static void HandleGetVersion(WSRequestHandler* req);
+		static HandlerResponse HandleGetVersion(WSRequestHandler* req);
-		static void HandleGetAuthRequired(WSRequestHandler* req);
+		static HandlerResponse HandleGetAuthRequired(WSRequestHandler* req);
-		static void HandleAuthenticate(WSRequestHandler* req);
+		static HandlerResponse HandleAuthenticate(WSRequestHandler* req);
 
-		static void HandleSetHeartbeat(WSRequestHandler* req);
+		static HandlerResponse HandleGetStats(WSRequestHandler* req);
+		static HandlerResponse HandleSetHeartbeat(WSRequestHandler* req);
+		static HandlerResponse HandleGetVideoInfo(WSRequestHandler* req);
 
-		static void HandleSetFilenameFormatting(WSRequestHandler* req);
+		static HandlerResponse HandleSetFilenameFormatting(WSRequestHandler* req);
-		static void HandleGetFilenameFormatting(WSRequestHandler* req);
+		static HandlerResponse HandleGetFilenameFormatting(WSRequestHandler* req);
 
-		static void HandleSetCurrentScene(WSRequestHandler* req);
+		static HandlerResponse HandleSetCurrentScene(WSRequestHandler* req);
-		static void HandleGetCurrentScene(WSRequestHandler* req);
+		static HandlerResponse HandleGetCurrentScene(WSRequestHandler* req);
-		static void HandleGetSceneList(WSRequestHandler* req);
+		static HandlerResponse HandleGetSceneList(WSRequestHandler* req);
 
-		static void HandleSetSceneItemRender(WSRequestHandler* req);
+		static HandlerResponse HandleSetSceneItemRender(WSRequestHandler* req);
-		static void HandleSetSceneItemPosition(WSRequestHandler* req);
+		static HandlerResponse HandleSetSceneItemPosition(WSRequestHandler* req);
-		static void HandleSetSceneItemTransform(WSRequestHandler* req);
+		static HandlerResponse HandleSetSceneItemTransform(WSRequestHandler* req);
-		static void HandleSetSceneItemCrop(WSRequestHandler* req);
+		static HandlerResponse HandleSetSceneItemCrop(WSRequestHandler* req);
-		static void HandleGetSceneItemProperties(WSRequestHandler* req);
+		static HandlerResponse HandleGetSceneItemProperties(WSRequestHandler* req);
-		static void HandleSetSceneItemProperties(WSRequestHandler* req);
+		static HandlerResponse HandleSetSceneItemProperties(WSRequestHandler* req);
-		static void HandleResetSceneItem(WSRequestHandler* req);
+		static HandlerResponse HandleResetSceneItem(WSRequestHandler* req);
-		static void HandleDuplicateSceneItem(WSRequestHandler* req);
+		static HandlerResponse HandleDuplicateSceneItem(WSRequestHandler* req);
-		static void HandleDeleteSceneItem(WSRequestHandler* req);
+		static HandlerResponse HandleDeleteSceneItem(WSRequestHandler* req);
-		static void HandleReorderSceneItems(WSRequestHandler* req);
+		static HandlerResponse HandleReorderSceneItems(WSRequestHandler* req);
 
-		static void HandleGetStreamingStatus(WSRequestHandler* req);
+		static HandlerResponse HandleGetStreamingStatus(WSRequestHandler* req);
-		static void HandleStartStopStreaming(WSRequestHandler* req);
+		static HandlerResponse HandleStartStopStreaming(WSRequestHandler* req);
-		static void HandleStartStopRecording(WSRequestHandler* req);
+		static HandlerResponse HandleStartStopRecording(WSRequestHandler* req);
-		static void HandleStartStreaming(WSRequestHandler* req);
+		static HandlerResponse HandleStartStreaming(WSRequestHandler* req);
-		static void HandleStopStreaming(WSRequestHandler* req);
+		static HandlerResponse HandleStopStreaming(WSRequestHandler* req);
-		static void HandleStartRecording(WSRequestHandler* req);
+		static HandlerResponse HandleStartRecording(WSRequestHandler* req);
-		static void HandleStopRecording(WSRequestHandler* req);
+		static HandlerResponse HandleStopRecording(WSRequestHandler* req);
 
-		static void HandleStartStopReplayBuffer(WSRequestHandler* req);
+		static HandlerResponse HandleStartStopReplayBuffer(WSRequestHandler* req);
-		static void HandleStartReplayBuffer(WSRequestHandler* req);
+		static HandlerResponse HandleStartReplayBuffer(WSRequestHandler* req);
-		static void HandleStopReplayBuffer(WSRequestHandler* req);
+		static HandlerResponse HandleStopReplayBuffer(WSRequestHandler* req);
-		static void HandleSaveReplayBuffer(WSRequestHandler* req);
+		static HandlerResponse HandleSaveReplayBuffer(WSRequestHandler* req);
 
-		static void HandleSetRecordingFolder(WSRequestHandler* req);
+		static HandlerResponse HandleSetRecordingFolder(WSRequestHandler* req);
-		static void HandleGetRecordingFolder(WSRequestHandler* req);
+		static HandlerResponse HandleGetRecordingFolder(WSRequestHandler* req);
 
-		static void HandleGetTransitionList(WSRequestHandler* req);
+		static HandlerResponse HandleGetTransitionList(WSRequestHandler* req);
-		static void HandleGetCurrentTransition(WSRequestHandler* req);
+		static HandlerResponse HandleGetCurrentTransition(WSRequestHandler* req);
-		static void HandleSetCurrentTransition(WSRequestHandler* req);
+		static HandlerResponse HandleSetCurrentTransition(WSRequestHandler* req);
 
-		static void HandleSetVolume(WSRequestHandler* req);
+		static HandlerResponse HandleSetVolume(WSRequestHandler* req);
-		static void HandleGetVolume(WSRequestHandler* req);
+		static HandlerResponse HandleGetVolume(WSRequestHandler* req);
-		static void HandleToggleMute(WSRequestHandler* req);
+		static HandlerResponse HandleToggleMute(WSRequestHandler* req);
-		static void HandleSetMute(WSRequestHandler* req);
+		static HandlerResponse HandleSetMute(WSRequestHandler* req);
-		static void HandleGetMute(WSRequestHandler* req);
+		static HandlerResponse HandleGetMute(WSRequestHandler* req);
-		static void HandleSetSyncOffset(WSRequestHandler* req);
+		static HandlerResponse HandleSetSyncOffset(WSRequestHandler* req);
-		static void HandleGetSyncOffset(WSRequestHandler* req);
+		static HandlerResponse HandleGetSyncOffset(WSRequestHandler* req);
-		static void HandleGetSpecialSources(WSRequestHandler* req);
+		static HandlerResponse HandleGetSpecialSources(WSRequestHandler* req);
-		static void HandleGetSourcesList(WSRequestHandler* req);
+		static HandlerResponse HandleGetSourcesList(WSRequestHandler* req);
-		static void HandleGetSourceTypesList(WSRequestHandler* req);
+		static HandlerResponse HandleGetSourceTypesList(WSRequestHandler* req);
-		static void HandleGetSourceSettings(WSRequestHandler* req);
+		static HandlerResponse HandleGetSourceSettings(WSRequestHandler* req);
-		static void HandleSetSourceSettings(WSRequestHandler* req);
+		static HandlerResponse HandleSetSourceSettings(WSRequestHandler* req);
+		static HandlerResponse HandleTakeSourceScreenshot(WSRequestHandler* req);
 
-		static void HandleGetSourceFilters(WSRequestHandler* req);
+		static HandlerResponse HandleGetSourceFilters(WSRequestHandler* req);
-		static void HandleAddFilterToSource(WSRequestHandler* req);
+		static HandlerResponse HandleAddFilterToSource(WSRequestHandler* req);
-		static void HandleRemoveFilterFromSource(WSRequestHandler* req);
+		static HandlerResponse HandleRemoveFilterFromSource(WSRequestHandler* req);
-		static void HandleReorderSourceFilter(WSRequestHandler* req);
+		static HandlerResponse HandleReorderSourceFilter(WSRequestHandler* req);
-		static void HandleMoveSourceFilter(WSRequestHandler* req);
+		static HandlerResponse HandleMoveSourceFilter(WSRequestHandler* req);
-		static void HandleSetSourceFilterSettings(WSRequestHandler* req);
+		static HandlerResponse HandleSetSourceFilterSettings(WSRequestHandler* req);
 
-		static void HandleSetCurrentSceneCollection(WSRequestHandler* req);
+		static HandlerResponse HandleSetCurrentSceneCollection(WSRequestHandler* req);
-		static void HandleGetCurrentSceneCollection(WSRequestHandler* req);
+		static HandlerResponse HandleGetCurrentSceneCollection(WSRequestHandler* req);
-		static void HandleListSceneCollections(WSRequestHandler* req);
+		static HandlerResponse HandleListSceneCollections(WSRequestHandler* req);
 
-		static void HandleSetCurrentProfile(WSRequestHandler* req);
+		static HandlerResponse HandleSetCurrentProfile(WSRequestHandler* req);
-		static void HandleGetCurrentProfile(WSRequestHandler* req);
+		static HandlerResponse HandleGetCurrentProfile(WSRequestHandler* req);
-		static void HandleListProfiles(WSRequestHandler* req);
+		static HandlerResponse HandleListProfiles(WSRequestHandler* req);
 
-		static void HandleSetStreamSettings(WSRequestHandler* req);
+		static HandlerResponse HandleSetStreamSettings(WSRequestHandler* req);
-		static void HandleGetStreamSettings(WSRequestHandler* req);
+		static HandlerResponse HandleGetStreamSettings(WSRequestHandler* req);
-		static void HandleSaveStreamSettings(WSRequestHandler* req);
+		static HandlerResponse HandleSaveStreamSettings(WSRequestHandler* req);
+#if BUILD_CAPTIONS
+		static HandlerResponse HandleSendCaptions(WSRequestHandler * req);
+#endif
 
-		static void HandleSetTransitionDuration(WSRequestHandler* req);
+		static HandlerResponse HandleSetTransitionDuration(WSRequestHandler* req);
-		static void HandleGetTransitionDuration(WSRequestHandler* req);
+		static HandlerResponse HandleGetTransitionDuration(WSRequestHandler* req);
 
-		static void HandleGetStudioModeStatus(WSRequestHandler* req);
+		static HandlerResponse HandleGetStudioModeStatus(WSRequestHandler* req);
-		static void HandleGetPreviewScene(WSRequestHandler* req);
+		static HandlerResponse HandleGetPreviewScene(WSRequestHandler* req);
-		static void HandleSetPreviewScene(WSRequestHandler* req);
+		static HandlerResponse HandleSetPreviewScene(WSRequestHandler* req);
-		static void HandleTransitionToProgram(WSRequestHandler* req);
+		static HandlerResponse HandleTransitionToProgram(WSRequestHandler* req);
-		static void HandleEnableStudioMode(WSRequestHandler* req);
+		static HandlerResponse HandleEnableStudioMode(WSRequestHandler* req);
-		static void HandleDisableStudioMode(WSRequestHandler* req);
+		static HandlerResponse HandleDisableStudioMode(WSRequestHandler* req);
-		static void HandleToggleStudioMode(WSRequestHandler* req);
+		static HandlerResponse HandleToggleStudioMode(WSRequestHandler* req);
 
-		static void HandleSetTextGDIPlusProperties(WSRequestHandler* req);
+		static HandlerResponse HandleSetTextGDIPlusProperties(WSRequestHandler* req);
-		static void HandleGetTextGDIPlusProperties(WSRequestHandler* req);
+		static HandlerResponse HandleGetTextGDIPlusProperties(WSRequestHandler* req);
 
-		static void HandleSetTextFreetype2Properties(WSRequestHandler* req);
+		static HandlerResponse HandleSetTextFreetype2Properties(WSRequestHandler* req);
-		static void HandleGetTextFreetype2Properties(WSRequestHandler* req);
+		static HandlerResponse HandleGetTextFreetype2Properties(WSRequestHandler* req);
 
-		static void HandleSetBrowserSourceProperties(WSRequestHandler* req);
+		static HandlerResponse HandleSetBrowserSourceProperties(WSRequestHandler* req);
-		static void HandleGetBrowserSourceProperties(WSRequestHandler* req);
+		static HandlerResponse HandleGetBrowserSourceProperties(WSRequestHandler* req);
 };
-
-#endif // WSPROTOCOL_H

src/WSRequestHandler_General.cpp

@@ -1,11 +1,58 @@
-#include <QString>
+#include "obs-websocket.h"
-
 #include "Config.h"
 #include "Utils.h"
 #include "WSEvents.h"
 
 #include "WSRequestHandler.h"
 
+#define CASE(x) case x: return #x;
+const char *describe_output_format(int format) {
+	switch (format) {
+		default:
+		CASE(VIDEO_FORMAT_NONE)
+		CASE(VIDEO_FORMAT_I420)
+		CASE(VIDEO_FORMAT_NV12)
+		CASE(VIDEO_FORMAT_YVYU)
+		CASE(VIDEO_FORMAT_YUY2)
+		CASE(VIDEO_FORMAT_UYVY)
+		CASE(VIDEO_FORMAT_RGBA)
+		CASE(VIDEO_FORMAT_BGRA)
+		CASE(VIDEO_FORMAT_BGRX)
+		CASE(VIDEO_FORMAT_Y800)
+		CASE(VIDEO_FORMAT_I444)
+	}
+}
+
+const char *describe_color_space(int cs) {
+	switch (cs) {
+		default:
+		CASE(VIDEO_CS_DEFAULT)
+		CASE(VIDEO_CS_601)
+		CASE(VIDEO_CS_709)
+	}
+}
+
+const char *describe_color_range(int range) {
+	switch (range) {
+		default:
+		CASE(VIDEO_RANGE_DEFAULT)
+		CASE(VIDEO_RANGE_PARTIAL)
+		CASE(VIDEO_RANGE_FULL)
+	}
+}
+
+const char *describe_scale_type(int scale) {
+	switch (scale) {
+		default:
+		CASE(VIDEO_SCALE_DEFAULT)
+		CASE(VIDEO_SCALE_POINT)
+		CASE(VIDEO_SCALE_FAST_BILINEAR)
+		CASE(VIDEO_SCALE_BILINEAR)
+		CASE(VIDEO_SCALE_BICUBIC)
+	}
+}
+#undef CASE
+
 /**
  * Returns the latest version of the plugin and the API.
  *
@@ -19,7 +66,7 @@
  * @category general
  * @since 0.3
  */
- void WSRequestHandler::HandleGetVersion(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleGetVersion(WSRequestHandler* req) {
 	QString obsVersion = Utils::OBSVersionString();
 
 	QList<QString> names = req->messageMap.keys();
@@ -33,11 +80,12 @@
 	}
 
 	OBSDataAutoRelease data = obs_data_create();
+	obs_data_set_double(data, "version", 1.1);
 	obs_data_set_string(data, "obs-websocket-version", OBS_WEBSOCKET_VERSION);
 	obs_data_set_string(data, "obs-studio-version", obsVersion.toUtf8());
 	obs_data_set_string(data, "available-requests", requests.toUtf8());
 
-	req->SendOKResponse(data);
+	return req->SendOKResponse(data);
 }
 
 /**
@@ -53,20 +101,21 @@
  * @category general
  * @since 0.3
  */
-void WSRequestHandler::HandleGetAuthRequired(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleGetAuthRequired(WSRequestHandler* req) {
-	bool authRequired = Config::Current()->AuthRequired;
+	bool authRequired = GetConfig()->AuthRequired;
 
 	OBSDataAutoRelease data = obs_data_create();
 	obs_data_set_bool(data, "authRequired", authRequired);
 
 	if (authRequired) {
+		auto config = GetConfig();
 		obs_data_set_string(data, "challenge",
-			Config::Current()->SessionChallenge.toUtf8());
+			config->SessionChallenge.toUtf8());
 		obs_data_set_string(data, "salt",
-			Config::Current()->Salt.toUtf8());
+			config->Salt.toUtf8());
 	}
 
-	req->SendOKResponse(data);
+	return req->SendOKResponse(data);
 }
 
 /**
@@ -79,26 +128,26 @@ void WSRequestHandler::HandleGetAuthRequired(WSRequestHandler* req) {
  * @category general
  * @since 0.3
  */
-void WSRequestHandler::HandleAuthenticate(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleAuthenticate(WSRequestHandler* req) {
 	if (!req->hasField("auth")) {
-		req->SendErrorResponse("missing request parameters");
+		return req->SendErrorResponse("missing request parameters");
-		return;
+	}
+
+	if (req->_connProperties.isAuthenticated()) {
+		return req->SendErrorResponse("already authenticated");
 	}
 
 	QString auth = obs_data_get_string(req->data, "auth");
 	if (auth.isEmpty()) {
-		req->SendErrorResponse("auth not specified!");
+		return req->SendErrorResponse("auth not specified!");
-		return;
 	}
 
-	if ((req->_client->property(PROP_AUTHENTICATED).toBool() == false)
+	if (GetConfig()->CheckAuth(auth) == false) {
-		&& Config::Current()->CheckAuth(auth))
+		return req->SendErrorResponse("Authentication Failed.");
-	{
-		req->_client->setProperty(PROP_AUTHENTICATED, true);
-		req->SendOKResponse();
-	} else {
-		req->SendErrorResponse("Authentication Failed.");
 	}
+
+	req->_connProperties.setAuthenticated(true);
+	return req->SendOKResponse();
 }
 
 /**
@@ -111,19 +160,17 @@ void WSRequestHandler::HandleAuthenticate(WSRequestHandler* req) {
  * @category general
  * @since 4.3.0
  */
- void WSRequestHandler::HandleSetHeartbeat(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleSetHeartbeat(WSRequestHandler* req) {
 	if (!req->hasField("enable")) {
-		req->SendErrorResponse("Heartbeat <enable> parameter missing");
+		return req->SendErrorResponse("Heartbeat <enable> parameter missing");
-		return;
 	}
 
-	WSEvents::Instance->HeartbeatIsActive =
+	auto events = GetEventsSystem();
-		obs_data_get_bool(req->data, "enable");
+	events->HeartbeatIsActive = obs_data_get_bool(req->data, "enable");
 
 	OBSDataAutoRelease response = obs_data_create();
-	obs_data_set_bool(response, "enable",
+	obs_data_set_bool(response, "enable", events->HeartbeatIsActive);
-		WSEvents::Instance->HeartbeatIsActive);
+	return req->SendOKResponse(response);
-	req->SendOKResponse(response);
 }
 
 /**
@@ -136,19 +183,18 @@ void WSRequestHandler::HandleAuthenticate(WSRequestHandler* req) {
  * @category general
  * @since 4.3.0
  */
-void WSRequestHandler::HandleSetFilenameFormatting(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleSetFilenameFormatting(WSRequestHandler* req) {
 	if (!req->hasField("filename-formatting")) {
-		req->SendErrorResponse("<filename-formatting> parameter missing");
+		return req->SendErrorResponse("<filename-formatting> parameter missing");
-		return;
 	}
 
 	QString filenameFormatting = obs_data_get_string(req->data, "filename-formatting");
-	if (!filenameFormatting.isEmpty()) {
+	if (filenameFormatting.isEmpty()) {
-		Utils::SetFilenameFormatting(filenameFormatting.toUtf8());
+		return req->SendErrorResponse("invalid request parameters");
-		req->SendOKResponse();
-	} else {
-		req->SendErrorResponse("invalid request parameters");
 	}
+
+	Utils::SetFilenameFormatting(filenameFormatting.toUtf8());
+	return req->SendOKResponse();
 }
 
 /**
@@ -161,8 +207,60 @@ void WSRequestHandler::HandleSetFilenameFormatting(WSRequestHandler* req) {
  * @category general
  * @since 4.3.0
  */
-void WSRequestHandler::HandleGetFilenameFormatting(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleGetFilenameFormatting(WSRequestHandler* req) {
 	OBSDataAutoRelease response = obs_data_create();
 	obs_data_set_string(response, "filename-formatting", Utils::GetFilenameFormatting());
-	req->SendOKResponse(response);
+	return req->SendOKResponse(response);
+}
+
+/**
+ * Get OBS stats (almost the same info as provided in OBS' stats window)
+ *
+ * @return {OBSStats} `stats` OBS stats
+ *
+ * @api requests
+ * @name GetStats
+ * @category general
+ * @since 4.6.0
+ */
+HandlerResponse WSRequestHandler::HandleGetStats(WSRequestHandler* req) {
+	OBSDataAutoRelease stats = GetEventsSystem()->GetStats();
+
+	OBSDataAutoRelease response = obs_data_create();
+	obs_data_set_obj(response, "stats", stats);
+	return req->SendOKResponse(response);
+}
+
+/**
+ * Get basic OBS video information
+ * 
+ * @return {int} `baseWidth` Base (canvas) width
+ * @return {int} `baseHeight` Base (canvas) height
+ * @return {int} `outputWidth` Output width
+ * @return {int} `outputHeight` Output height
+ * @return {String} `scaleType` Scaling method used if output size differs from base size
+ * @return {double} `fps` Frames rendered per second
+ * @return {String} `videoFormat` Video color format
+ * @return {String} `colorSpace` Color space for YUV
+ * @return {String} `colorRange` Color range (full or partial)
+ * 
+ * @api requests
+ * @name GetVideoInfo
+ * @category general
+ * @since 4.6.0 
+ */
+HandlerResponse WSRequestHandler::HandleGetVideoInfo(WSRequestHandler* req) {
+	obs_video_info ovi;
+	obs_get_video_info(&ovi);
+	OBSDataAutoRelease response = obs_data_create();
+	obs_data_set_int(response, "baseWidth", ovi.base_width);
+	obs_data_set_int(response, "baseHeight", ovi.base_height);
+	obs_data_set_int(response, "outputWidth", ovi.output_width);
+	obs_data_set_int(response, "outputHeight", ovi.output_height);
+	obs_data_set_double(response, "fps", (double)ovi.fps_num / ovi.fps_den);
+	obs_data_set_string(response, "videoFormat", describe_output_format(ovi.output_format));
+	obs_data_set_string(response, "colorSpace", describe_color_space(ovi.colorspace));
+	obs_data_set_string(response, "colorRange", describe_color_range(ovi.range));
+	obs_data_set_string(response, "scaleType", describe_scale_type(ovi.scale_type));
+	return req->SendOKResponse(response);
 }

src/WSRequestHandler_Profiles.cpp

@@ -1,4 +1,3 @@
-#include <QString>
 #include "Utils.h"
 
 #include "WSRequestHandler.h"
@@ -13,20 +12,19 @@
  * @category profiles
  * @since 4.0.0
  */
- void WSRequestHandler::HandleSetCurrentProfile(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleSetCurrentProfile(WSRequestHandler* req) {
 	if (!req->hasField("profile-name")) {
-		req->SendErrorResponse("missing request parameters");
+		return req->SendErrorResponse("missing request parameters");
-		return;
 	}
 
 	QString profileName = obs_data_get_string(req->data, "profile-name");
-	if (!profileName.isEmpty()) {
+	if (profileName.isEmpty()) {
+		return req->SendErrorResponse("invalid request parameters");
+	}
+
 	// TODO : check if profile exists
 	obs_frontend_set_current_profile(profileName.toUtf8());
-		req->SendOKResponse();
+	return req->SendOKResponse();
-	} else {
-		req->SendErrorResponse("invalid request parameters");
-	}
 }
 
  /**
@@ -39,12 +37,10 @@
  * @category profiles
  * @since 4.0.0
  */
-void WSRequestHandler::HandleGetCurrentProfile(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleGetCurrentProfile(WSRequestHandler* req) {
 	OBSDataAutoRelease response = obs_data_create();
-	obs_data_set_string(response, "profile-name",
+	obs_data_set_string(response, "profile-name", obs_frontend_get_current_profile());
-		obs_frontend_get_current_profile());
+	return req->SendOKResponse(response);
-
-	req->SendOKResponse(response);
 }
 
 /**
@@ -57,14 +53,13 @@ void WSRequestHandler::HandleGetCurrentProfile(WSRequestHandler* req) {
  * @category profiles
  * @since 4.0.0
  */
-void WSRequestHandler::HandleListProfiles(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleListProfiles(WSRequestHandler* req) {
 	char** profiles = obs_frontend_get_profiles();
-	OBSDataArrayAutoRelease list =
+	OBSDataArrayAutoRelease list = Utils::StringListToArray(profiles, "profile-name");
-		Utils::StringListToArray(profiles, "profile-name");
 	bfree(profiles);
 
 	OBSDataAutoRelease response = obs_data_create();
 	obs_data_set_array(response, "profiles", list);
 
-	req->SendOKResponse(response);
+	return req->SendOKResponse(response);
 }

src/WSRequestHandler_Recording.cpp

@@ -1,4 +1,3 @@
-#include <QString>
 #include "Utils.h"
 
 #include "WSRequestHandler.h"
@@ -11,13 +10,13 @@
  * @category recording
  * @since 0.3
  */
- void WSRequestHandler::HandleStartStopRecording(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleStartStopRecording(WSRequestHandler* req) {
 	if (obs_frontend_recording_active())
 		obs_frontend_recording_stop();
 	else
 		obs_frontend_recording_start();
 
-	req->SendOKResponse();
+	return req->SendOKResponse();
 }
 
 /**
@@ -29,12 +28,12 @@
  * @category recording
  * @since 4.1.0
  */
- void WSRequestHandler::HandleStartRecording(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleStartRecording(WSRequestHandler* req) {
 	if (obs_frontend_recording_active() == false) {
 		obs_frontend_recording_start();
-		req->SendOKResponse();
+		return req->SendOKResponse();
 	} else {
-		req->SendErrorResponse("recording already active");
+		return req->SendErrorResponse("recording already active");
 	}
 }
 
@@ -47,17 +46,23 @@
  * @category recording
  * @since 4.1.0
  */
-void WSRequestHandler::HandleStopRecording(WSRequestHandler* req) {
+ HandlerResponse WSRequestHandler::HandleStopRecording(WSRequestHandler* req) {
 	if (obs_frontend_recording_active() == true) {
 		obs_frontend_recording_stop();
-		req->SendOKResponse();
+		return req->SendOKResponse();
 	} else {
-		req->SendErrorResponse("recording not active");
+		return req->SendErrorResponse("recording not active");
 	}
 }
 
 /**
- * Change the current recording folder.
+ * In the current profile, sets the recording folder of the Simple and Advanced
+ * output modes to the specified value.
+ * 
+ * Please note: if `SetRecordingFolder` is called while a recording is
+ * in progress, the change won't be applied immediately and will be
+ * effective on the next recording.
+ * 
  * 
  * @param {String} `rec-folder` Path of the recording folder.
  *
@@ -66,18 +71,18 @@ void WSRequestHandler::HandleStopRecording(WSRequestHandler* req) {
  * @category recording
  * @since 4.1.0
  */
- void WSRequestHandler::HandleSetRecordingFolder(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleSetRecordingFolder(WSRequestHandler* req) {
 	if (!req->hasField("rec-folder")) {
-		req->SendErrorResponse("missing request parameters");
+		return req->SendErrorResponse("missing request parameters");
-		return;
 	}
 
 	const char* newRecFolder = obs_data_get_string(req->data, "rec-folder");
 	bool success = Utils::SetRecordingFolder(newRecFolder);
-	if (success)
+	if (!success) {
-		req->SendOKResponse();
+		return req->SendErrorResponse("invalid request parameters");
-	else
+	}
-		req->SendErrorResponse("invalid request parameters");
+
+	return req->SendOKResponse();
 }
 
 /**
@@ -90,11 +95,11 @@ void WSRequestHandler::HandleStopRecording(WSRequestHandler* req) {
  * @category recording
  * @since 4.1.0
  */
-void WSRequestHandler::HandleGetRecordingFolder(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleGetRecordingFolder(WSRequestHandler* req) {
 	const char* recFolder = Utils::GetRecordingFolder();
 
 	OBSDataAutoRelease response = obs_data_create();
 	obs_data_set_string(response, "rec-folder", recFolder);
 
-	req->SendOKResponse(response);
+	return req->SendOKResponse(response);
 }

src/WSRequestHandler_ReplayBuffer.cpp

@@ -1,4 +1,3 @@
-#include <QString>
 #include "Utils.h"
 
 #include "WSRequestHandler.h"
@@ -11,13 +10,13 @@
 * @category replay buffer
 * @since 4.2.0
 */
-void WSRequestHandler::HandleStartStopReplayBuffer(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleStartStopReplayBuffer(WSRequestHandler* req) {
 	if (obs_frontend_replay_buffer_active()) {
 		obs_frontend_replay_buffer_stop();
 	} else {
 		Utils::StartReplayBuffer();
 	}
-	req->SendOKResponse();
+	return req->SendOKResponse();
 }
 
 /**
@@ -32,19 +31,17 @@ void WSRequestHandler::HandleStartStopReplayBuffer(WSRequestHandler* req) {
 * @category replay buffer
 * @since 4.2.0
 */
-void WSRequestHandler::HandleStartReplayBuffer(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleStartReplayBuffer(WSRequestHandler* req) {
 	if (!Utils::ReplayBufferEnabled()) {
-		req->SendErrorResponse("replay buffer disabled in settings");
+		return req->SendErrorResponse("replay buffer disabled in settings");
-		return;
 	}
 
 	if (obs_frontend_replay_buffer_active() == true) {
-		req->SendErrorResponse("replay buffer already active");
+		return req->SendErrorResponse("replay buffer already active");
-		return;
 	}
 
 	Utils::StartReplayBuffer();
-	req->SendOKResponse();
+	return req->SendOKResponse();
 }
 
 /**
@@ -56,12 +53,12 @@ void WSRequestHandler::HandleStartReplayBuffer(WSRequestHandler* req) {
 * @category replay buffer
 * @since 4.2.0
 */
-void WSRequestHandler::HandleStopReplayBuffer(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleStopReplayBuffer(WSRequestHandler* req) {
 	if (obs_frontend_replay_buffer_active() == true) {
 		obs_frontend_replay_buffer_stop();
-		req->SendOKResponse();
+		return req->SendOKResponse();
 	} else {
-		req->SendErrorResponse("replay buffer not active");
+		return req->SendErrorResponse("replay buffer not active");
 	}
 }
 
@@ -75,10 +72,9 @@ void WSRequestHandler::HandleStopReplayBuffer(WSRequestHandler* req) {
 * @category replay buffer
 * @since 4.2.0
 */
-void WSRequestHandler::HandleSaveReplayBuffer(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleSaveReplayBuffer(WSRequestHandler* req) {
 	if (!obs_frontend_replay_buffer_active()) {
-		req->SendErrorResponse("replay buffer not active");
+		return req->SendErrorResponse("replay buffer not active");
-		return;
 	}
 
 	OBSOutputAutoRelease replayOutput = obs_frontend_get_replay_buffer_output();
@@ -88,5 +84,5 @@ void WSRequestHandler::HandleSaveReplayBuffer(WSRequestHandler* req) {
 	proc_handler_call(ph, "save", &cd);
 	calldata_free(&cd);
 
-	req->SendOKResponse();
+	return req->SendOKResponse();
 }

src/WSRequestHandler_SceneCollections.cpp

@@ -1,4 +1,3 @@
-#include <QString>
 #include "Utils.h"
 
 #include "WSRequestHandler.h"
@@ -13,20 +12,19 @@
  * @category scene collections
  * @since 4.0.0
  */
- void WSRequestHandler::HandleSetCurrentSceneCollection(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleSetCurrentSceneCollection(WSRequestHandler* req) {
 	if (!req->hasField("sc-name")) {
-		req->SendErrorResponse("missing request parameters");
+		return req->SendErrorResponse("missing request parameters");
-		return;
 	}
 
 	QString sceneCollection = obs_data_get_string(req->data, "sc-name");
-	if (!sceneCollection.isEmpty()) {
+	if (sceneCollection.isEmpty()) {
+		return req->SendErrorResponse("invalid request parameters");
+	}
+
 	// TODO : Check if specified profile exists and if changing is allowed
 	obs_frontend_set_current_scene_collection(sceneCollection.toUtf8());
-		req->SendOKResponse();
+	return req->SendOKResponse();
-	} else {
-		req->SendErrorResponse("invalid request parameters");
-	}
 }
 
 /**
@@ -39,12 +37,12 @@
  * @category scene collections
  * @since 4.0.0
  */
-void WSRequestHandler::HandleGetCurrentSceneCollection(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleGetCurrentSceneCollection(WSRequestHandler* req) {
 	OBSDataAutoRelease response = obs_data_create();
 	obs_data_set_string(response, "sc-name",
 		obs_frontend_get_current_scene_collection());
 
-	req->SendOKResponse(response);
+	return req->SendOKResponse(response);
 }
 
 /**
@@ -57,7 +55,7 @@ void WSRequestHandler::HandleGetCurrentSceneCollection(WSRequestHandler* req) {
  * @category scene collections
  * @since 4.0.0
  */
-void WSRequestHandler::HandleListSceneCollections(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleListSceneCollections(WSRequestHandler* req) {
 	char** sceneCollections = obs_frontend_get_scene_collections();
 	OBSDataArrayAutoRelease list =
 		Utils::StringListToArray(sceneCollections, "sc-name");
@@ -66,5 +64,5 @@ void WSRequestHandler::HandleListSceneCollections(WSRequestHandler* req) {
 	OBSDataAutoRelease response = obs_data_create();
 	obs_data_set_array(response, "scene-collections", list);
 
-	req->SendOKResponse(response);
+	return req->SendOKResponse(response);
 }

src/WSRequestHandler_SceneItems.cpp

@@ -1,10 +1,10 @@
-#include <QString>
 #include "Utils.h"
 
 #include "WSRequestHandler.h"
 
 /**
 * 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).
 *
 * @param {String (optional)} `scene-name` the name of the scene that the source item belongs to. Defaults to the current scene.
 * @param {String} `item` The name of the source.
@@ -21,171 +21,106 @@
 * @return {int} `crop.bottom` The number of pixels cropped off the bottom of the source before scaling.
 * @return {int} `crop.left` The number of pixels cropped off the left of the source before scaling.
 * @return {bool} `visible` If the source is visible.
-* @return {String} `bounds.type` Type of bounding box.
+* @return {bool} `locked` If the source's transform is locked.
+* @return {String} `bounds.type` Type of bounding box. Can be "OBS_BOUNDS_STRETCH", "OBS_BOUNDS_SCALE_INNER", "OBS_BOUNDS_SCALE_OUTER", "OBS_BOUNDS_SCALE_TO_WIDTH", "OBS_BOUNDS_SCALE_TO_HEIGHT", "OBS_BOUNDS_MAX_ONLY" or "OBS_BOUNDS_NONE".
 * @return {int} `bounds.alignment` Alignment of the bounding box.
 * @return {double} `bounds.x` Width of the bounding box.
 * @return {double} `bounds.y` Height of the bounding box.
+* @return {int} `sourceWidth` Base width (without scaling) of the source
+* @return {int} `sourceHeight` Base source (without scaling) of the source
+* @return {double} `width` Scene item width (base source width multiplied by the horizontal scaling factor)
+* @return {double} `height` Scene item height (base source height multiplied by the vertical scaling factor)
+* @property {String (optional)} `parentGroupName` Name of the item's parent (if this item belongs to a group)
+* @property {Array<SceneItemTransform> (optional)} `groupChildren` List of children (if this item is a group)
 * 
 * @api requests
 * @name GetSceneItemProperties
 * @category scene items
 * @since 4.3.0
 */
-void WSRequestHandler::HandleGetSceneItemProperties(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleGetSceneItemProperties(WSRequestHandler* req) {
 	if (!req->hasField("item")) {
-		req->SendErrorResponse("missing request parameters");
+		return req->SendErrorResponse("missing request parameters");
-		return;
 	}
 
 	QString itemName = obs_data_get_string(req->data, "item");
 	if (itemName.isEmpty()) {
-		req->SendErrorResponse("invalid request parameters");
+		return req->SendErrorResponse("invalid request parameters");
-		return;
 	}
 
 	QString sceneName = obs_data_get_string(req->data, "scene-name");
 	OBSSourceAutoRelease scene = Utils::GetSceneFromNameOrCurrent(sceneName);
 	if (!scene) {
-		req->SendErrorResponse("requested scene doesn't exist");
+		return req->SendErrorResponse("requested scene doesn't exist");
-		return;
 	}
 
 	OBSSceneItemAutoRelease sceneItem =
 		Utils::GetSceneItemFromName(scene, itemName);
 	if (!sceneItem) {
-		req->SendErrorResponse("specified scene item doesn't exist");
+		return req->SendErrorResponse("specified scene item doesn't exist");
-		return;
 	}
 
-	OBSDataAutoRelease data = obs_data_create();
+	OBSDataAutoRelease data = Utils::GetSceneItemPropertiesData(sceneItem);
 	obs_data_set_string(data, "name", itemName.toUtf8());
 
-	OBSDataAutoRelease posData = obs_data_create();
+	return req->SendOKResponse(data);
-	vec2 pos;
-	obs_sceneitem_get_pos(sceneItem, &pos);
-	obs_data_set_double(posData, "x", pos.x);
-	obs_data_set_double(posData, "y", pos.y);
-	obs_data_set_int(posData, "alignment", obs_sceneitem_get_alignment(sceneItem));
-	obs_data_set_obj(data, "position", posData);
-
-	obs_data_set_double(data, "rotation", obs_sceneitem_get_rot(sceneItem));
-
-	OBSDataAutoRelease scaleData = obs_data_create();
-	vec2 scale;
-	obs_sceneitem_get_scale(sceneItem, &scale);
-	obs_data_set_double(scaleData, "x", scale.x);
-	obs_data_set_double(scaleData, "y", scale.y);
-	obs_data_set_obj(data, "scale", scaleData);
-
-	OBSDataAutoRelease cropData = obs_data_create();
-	obs_sceneitem_crop crop;
-	obs_sceneitem_get_crop(sceneItem, &crop);
-	obs_data_set_int(cropData, "left", crop.left);
-	obs_data_set_int(cropData, "top", crop.top);
-	obs_data_set_int(cropData, "right", crop.right);
-	obs_data_set_int(cropData, "bottom", crop.bottom);
-	obs_data_set_obj(data, "crop", cropData);
-
-	obs_data_set_bool(data, "visible", obs_sceneitem_visible(sceneItem));
-
-	OBSDataAutoRelease boundsData = obs_data_create();
-	obs_bounds_type boundsType = obs_sceneitem_get_bounds_type(sceneItem);
-	if (boundsType == OBS_BOUNDS_NONE) {
-		obs_data_set_string(boundsData, "type", "OBS_BOUNDS_NONE");
-	}
-	else {
-		switch (boundsType) {
-		case OBS_BOUNDS_STRETCH: {
-			obs_data_set_string(boundsData, "type", "OBS_BOUNDS_STRETCH");
-			break;
-		}
-		case OBS_BOUNDS_SCALE_INNER: {
-			obs_data_set_string(boundsData, "type", "OBS_BOUNDS_SCALE_INNER");
-			break;
-		}
-		case OBS_BOUNDS_SCALE_OUTER: {
-			obs_data_set_string(boundsData, "type", "OBS_BOUNDS_SCALE_OUTER");
-			break;
-		}
-		case OBS_BOUNDS_SCALE_TO_WIDTH: {
-			obs_data_set_string(boundsData, "type", "OBS_BOUNDS_SCALE_TO_WIDTH");
-			break;
-		}
-		case OBS_BOUNDS_SCALE_TO_HEIGHT: {
-			obs_data_set_string(boundsData, "type", "OBS_BOUNDS_SCALE_TO_HEIGHT");
-			break;
-		}
-		case OBS_BOUNDS_MAX_ONLY: {
-			obs_data_set_string(boundsData, "type", "OBS_BOUNDS_MAX_ONLY");
-			break;
-		}
-		}
-		obs_data_set_int(boundsData, "alignment", obs_sceneitem_get_bounds_alignment(sceneItem));
-		vec2 bounds;
-		obs_sceneitem_get_bounds(sceneItem, &bounds);
-		obs_data_set_double(boundsData, "x", bounds.x);
-		obs_data_set_double(boundsData, "y", bounds.y);
-	}
-	obs_data_set_obj(data, "bounds", boundsData);
-
-	req->SendOKResponse(data);
 }
 
 /**
 * Sets the scene specific properties of a source. Unspecified properties will remain unchanged.
+* Coordinates are relative to the item's parent (the scene or group it belongs to).
 *
 * @param {String (optional)} `scene-name` the name of the scene that the source item belongs to. Defaults to the current scene.
 * @param {String} `item` The name of the source.
-* @param {int} `position.x` The new x position of the source.
+* @param {int (optional)} `position.x` The new x position of the source.
-* @param {int} `position.y` The new y position of the source.
+* @param {int (optional)} `position.y` The new y position of the source.
-* @param {int} `position.alignment` The new alignment of the source.
+* @param {int (optional)} `position.alignment` The new alignment of the source.
-* @param {double} `rotation` The new clockwise rotation of the item in degrees.
+* @param {double (optional)} `rotation` The new clockwise rotation of the item in degrees.
-* @param {double} `scale.x` The new x scale of the item.
+* @param {double (optional)} `scale.x` The new x scale of the item.
-* @param {double} `scale.y` The new y scale of the item.
+* @param {double (optional)} `scale.y` The new y scale of the item.
-* @param {int} `crop.top` The new amount of pixels cropped off the top of the source before scaling.
+* @param {int (optional)} `crop.top` The new amount of pixels cropped off the top of the source before scaling.
-* @param {int} `crop.bottom` The new amount of pixels cropped off the bottom of the source before scaling.
+* @param {int (optional)} `crop.bottom` The new amount of pixels cropped off the bottom of the source before scaling.
-* @param {int} `crop.left` The new amount of pixels cropped off the left of the source before scaling.
+* @param {int (optional)} `crop.left` The new amount of pixels cropped off the left of the source before scaling.
-* @param {int} `crop.right` The new amount of pixels cropped off the right of the source before scaling.
+* @param {int (optional)} `crop.right` The new amount of pixels cropped off the right of the source before scaling.
-* @param {bool} `visible` The new visibility of the source. 'true' shows source, 'false' hides source.
+* @param {bool (optional)} `visible` The new visibility of the source. 'true' shows source, 'false' hides source.
-* @param {String} `bounds.type` The new bounds type of the source.
+* @param {bool (optional)} `locked` The new locked status of the source. 'true' keeps it in its current position, 'false' allows movement.
-* @param {int} `bounds.alignment` The new alignment of the bounding box. (0-2, 4-6, 8-10)
+* @param {String (optional)} `bounds.type` The new bounds type of the source. Can be "OBS_BOUNDS_STRETCH", "OBS_BOUNDS_SCALE_INNER", "OBS_BOUNDS_SCALE_OUTER", "OBS_BOUNDS_SCALE_TO_WIDTH", "OBS_BOUNDS_SCALE_TO_HEIGHT", "OBS_BOUNDS_MAX_ONLY" or "OBS_BOUNDS_NONE".
-* @param {double} `bounds.x` The new width of the bounding box.
+* @param {int (optional)} `bounds.alignment` The new alignment of the bounding box. (0-2, 4-6, 8-10)
-* @param {double} `bounds.y` The new height of the bounding box.
+* @param {double (optional)} `bounds.x` The new width of the bounding box.
+* @param {double (optional)} `bounds.y` The new height of the bounding box.
 *
 * @api requests
 * @name SetSceneItemProperties
 * @category scene items
 * @since 4.3.0
 */
-void WSRequestHandler::HandleSetSceneItemProperties(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleSetSceneItemProperties(WSRequestHandler* req) {
 	if (!req->hasField("item")) {
-		req->SendErrorResponse("missing request parameters");
+		return req->SendErrorResponse("missing request parameters");
-		return;
 	}
 
 	QString itemName = obs_data_get_string(req->data, "item");
 	if (itemName.isEmpty()) {
-		req->SendErrorResponse("invalid request parameters");
+		return req->SendErrorResponse("invalid request parameters");
-		return;
 	}
 
 	QString sceneName = obs_data_get_string(req->data, "scene-name");
 	OBSSourceAutoRelease scene = Utils::GetSceneFromNameOrCurrent(sceneName);
 	if (!scene) {
-		req->SendErrorResponse("requested scene doesn't exist");
+		return req->SendErrorResponse("requested scene doesn't exist");
-		return;
 	}
 
 	OBSSceneItemAutoRelease sceneItem =
 		Utils::GetSceneItemFromName(scene, itemName);
 	if (!sceneItem) {
-		req->SendErrorResponse("specified scene item doesn't exist");
+		return req->SendErrorResponse("specified scene item doesn't exist");
-		return;
 	}
 
 	bool badRequest = false;
 	OBSDataAutoRelease errorMessage = obs_data_create();
 
+	obs_sceneitem_defer_update_begin(sceneItem);
+
 	if (req->hasField("position")) {
 		vec2 oldPosition;
 		OBSDataAutoRelease positionError = obs_data_create();
@@ -254,12 +189,16 @@ void WSRequestHandler::HandleSetSceneItemProperties(WSRequestHandler* req) {
 		obs_sceneitem_set_visible(sceneItem, obs_data_get_bool(req->data, "visible"));
 	}
 
+	if (req->hasField("locked")) {
+		obs_sceneitem_set_locked(sceneItem, obs_data_get_bool(req->data, "locked"));
+	}
+
 	if (req->hasField("bounds")) {
 		bool badBounds = false;
 		OBSDataAutoRelease boundsError = obs_data_create();
 		OBSDataAutoRelease reqBounds = obs_data_get_obj(req->data, "bounds");
 		if (obs_data_has_user_value(reqBounds, "type")) {
-			const char* newBoundsType = obs_data_get_string(reqBounds, "type");
+			QString newBoundsType = obs_data_get_string(reqBounds, "type");
 			if (newBoundsType == "OBS_BOUNDS_NONE") {
 				obs_sceneitem_set_bounds_type(sceneItem, OBS_BOUNDS_NONE);
 			}
@@ -311,12 +250,13 @@ void WSRequestHandler::HandleSetSceneItemProperties(WSRequestHandler* req) {
 		}
 	}
 
+	obs_sceneitem_defer_update_end(sceneItem);
+
 	if (badRequest) {
-		req->SendErrorResponse(errorMessage);
+		return req->SendErrorResponse(errorMessage);
-	}
-	else {
-		req->SendOKResponse();
 	}
+
+	return req->SendOKResponse();
 }
 
 /**
@@ -330,39 +270,35 @@ void WSRequestHandler::HandleSetSceneItemProperties(WSRequestHandler* req) {
 * @category scene items
 * @since 4.2.0
 */
-void WSRequestHandler::HandleResetSceneItem(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleResetSceneItem(WSRequestHandler* req) {
 	// TODO: remove this request, or refactor it to ResetSource
 
 	if (!req->hasField("item")) {
-		req->SendErrorResponse("missing request parameters");
+		return req->SendErrorResponse("missing request parameters");
-		return;
 	}
 
 	const char* itemName = obs_data_get_string(req->data, "item");
 	if (!itemName) {
-		req->SendErrorResponse("invalid request parameters");
+		return req->SendErrorResponse("invalid request parameters");
-		return;
 	}
 
 	const char* sceneName = obs_data_get_string(req->data, "scene-name");
 	OBSSourceAutoRelease scene = Utils::GetSceneFromNameOrCurrent(sceneName);
 	if (!scene) {
-		req->SendErrorResponse("requested scene doesn't exist");
+		return req->SendErrorResponse("requested scene doesn't exist");
-		return;
 	}
 
 	OBSSceneItemAutoRelease sceneItem = Utils::GetSceneItemFromName(scene, itemName);
-	if (sceneItem) {
+	if (!sceneItem) {
+		return req->SendErrorResponse("specified scene item doesn't exist");
+	}
+
 	OBSSource sceneItemSource = obs_sceneitem_get_source(sceneItem);
 
 	OBSDataAutoRelease settings = obs_source_get_settings(sceneItemSource);
 	obs_source_update(sceneItemSource, settings);
 
-		req->SendOKResponse();
+	return req->SendOKResponse();
-	}
-	else {
-		req->SendErrorResponse("specified scene item doesn't exist");
-	}
 }
 
 /**
@@ -378,38 +314,34 @@ void WSRequestHandler::HandleResetSceneItem(WSRequestHandler* req) {
 * @since 0.3
 * @deprecated Since 4.3.0. Prefer the use of SetSceneItemProperties.
 */
-void WSRequestHandler::HandleSetSceneItemRender(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleSetSceneItemRender(WSRequestHandler* req) {
 	if (!req->hasField("source") ||
 		!req->hasField("render"))
 	{
-		req->SendErrorResponse("missing request parameters");
+		return req->SendErrorResponse("missing request parameters");
-		return;
 	}
 
 	const char* itemName = obs_data_get_string(req->data, "source");
 	bool isVisible = obs_data_get_bool(req->data, "render");
 
 	if (!itemName) {
-		req->SendErrorResponse("invalid request parameters");
+		return req->SendErrorResponse("invalid request parameters");
-		return;
 	}
 
 	const char* sceneName = obs_data_get_string(req->data, "scene-name");
 	OBSSourceAutoRelease scene = Utils::GetSceneFromNameOrCurrent(sceneName);
 	if (!scene) {
-		req->SendErrorResponse("requested scene doesn't exist");
+		return req->SendErrorResponse("requested scene doesn't exist");
-		return;
 	}
 
 	OBSSceneItemAutoRelease sceneItem =
 		Utils::GetSceneItemFromName(scene, itemName);
-	if (sceneItem) {
+	if (!sceneItem) {
+		return req->SendErrorResponse("specified scene item doesn't exist");
+	}
+
 	obs_sceneitem_set_visible(sceneItem, isVisible);
-		req->SendOKResponse();
+	return req->SendOKResponse();
-	}
-	else {
-		req->SendErrorResponse("specified scene item doesn't exist");
-	}
 }
 
 /**
@@ -427,38 +359,34 @@ void WSRequestHandler::HandleSetSceneItemRender(WSRequestHandler* req) {
 * @since 4.0.0
 * @deprecated Since 4.3.0. Prefer the use of SetSceneItemProperties.
 */
-void WSRequestHandler::HandleSetSceneItemPosition(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleSetSceneItemPosition(WSRequestHandler* req) {
 	if (!req->hasField("item") ||
 		!req->hasField("x") || !req->hasField("y")) {
-		req->SendErrorResponse("missing request parameters");
+		return req->SendErrorResponse("missing request parameters");
-		return;
 	}
 
 	QString itemName = obs_data_get_string(req->data, "item");
 	if (itemName.isEmpty()) {
-		req->SendErrorResponse("invalid request parameters");
+		return req->SendErrorResponse("invalid request parameters");
-		return;
 	}
 
 	QString sceneName = obs_data_get_string(req->data, "scene-name");
 	OBSSourceAutoRelease scene = Utils::GetSceneFromNameOrCurrent(sceneName);
 	if (!scene) {
-		req->SendErrorResponse("requested scene could not be found");
+		return req->SendErrorResponse("requested scene could not be found");
-		return;
 	}
 
 	OBSSceneItem sceneItem = Utils::GetSceneItemFromName(scene, itemName);
-	if (sceneItem) {
+	if (!sceneItem) {
+		return req->SendErrorResponse("specified scene item doesn't exist");
+	}
+
 	vec2 item_position = { 0 };
 	item_position.x = obs_data_get_double(req->data, "x");
 	item_position.y = obs_data_get_double(req->data, "y");
 	obs_sceneitem_set_pos(sceneItem, &item_position);
 
-		req->SendOKResponse();
+	return req->SendOKResponse();
-	}
-	else {
-		req->SendErrorResponse("specified scene item doesn't exist");
-	}
 }
 
 /**
@@ -476,27 +404,24 @@ void WSRequestHandler::HandleSetSceneItemPosition(WSRequestHandler* req) {
 * @since 4.0.0
 * @deprecated Since 4.3.0. Prefer the use of SetSceneItemProperties.
 */
-void WSRequestHandler::HandleSetSceneItemTransform(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleSetSceneItemTransform(WSRequestHandler* req) {
 	if (!req->hasField("item") ||
 		!req->hasField("x-scale") ||
 		!req->hasField("y-scale") ||
 		!req->hasField("rotation"))
 	{
-		req->SendErrorResponse("missing request parameters");
+		return req->SendErrorResponse("missing request parameters");
-		return;
 	}
 
 	QString itemName = obs_data_get_string(req->data, "item");
 	if (itemName.isEmpty()) {
-		req->SendErrorResponse("invalid request parameters");
+		return req->SendErrorResponse("invalid request parameters");
-		return;
 	}
 
 	QString sceneName = obs_data_get_string(req->data, "scene-name");
 	OBSSourceAutoRelease scene = Utils::GetSceneFromNameOrCurrent(sceneName);
 	if (!scene) {
-		req->SendErrorResponse("requested scene doesn't exist");
+		return req->SendErrorResponse("requested scene doesn't exist");
-		return;
 	}
 
 	vec2 scale;
@@ -505,14 +430,18 @@ void WSRequestHandler::HandleSetSceneItemTransform(WSRequestHandler* req) {
 	float rotation = obs_data_get_double(req->data, "rotation");
 
 	OBSSceneItemAutoRelease sceneItem = Utils::GetSceneItemFromName(scene, itemName);
-	if (sceneItem) {
+	if (!sceneItem) {
+		return req->SendErrorResponse("specified scene item doesn't exist");
+	}
+
+	obs_sceneitem_defer_update_begin(sceneItem);
+
 	obs_sceneitem_set_scale(sceneItem, &scale);
 	obs_sceneitem_set_rot(sceneItem, rotation);
-		req->SendOKResponse();
+	
-	}
+	obs_sceneitem_defer_update_end(sceneItem);
-	else {
+
-		req->SendErrorResponse("specified scene item doesn't exist");
+	return req->SendOKResponse();
-	}
 }
 
 /**
@@ -531,27 +460,27 @@ void WSRequestHandler::HandleSetSceneItemTransform(WSRequestHandler* req) {
 * @since 4.1.0
 * @deprecated Since 4.3.0. Prefer the use of SetSceneItemProperties.
 */
-void WSRequestHandler::HandleSetSceneItemCrop(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleSetSceneItemCrop(WSRequestHandler* req) {
 	if (!req->hasField("item")) {
-		req->SendErrorResponse("missing request parameters");
+		return req->SendErrorResponse("missing request parameters");
-		return;
 	}
 
 	QString itemName = obs_data_get_string(req->data, "item");
 	if (itemName.isEmpty()) {
-		req->SendErrorResponse("invalid request parameters");
+		return req->SendErrorResponse("invalid request parameters");
-		return;
 	}
 
 	QString sceneName = obs_data_get_string(req->data, "scene-name");
 	OBSSourceAutoRelease scene = Utils::GetSceneFromNameOrCurrent(sceneName);
 	if (!scene) {
-		req->SendErrorResponse("requested scene doesn't exist");
+		return req->SendErrorResponse("requested scene doesn't exist");
-		return;
 	}
 
 	OBSSceneItemAutoRelease sceneItem = Utils::GetSceneItemFromName(scene, itemName);
-	if (sceneItem) {
+	if (!sceneItem) {
+		return req->SendErrorResponse("specified scene item doesn't exist");
+	}
+
 	struct obs_sceneitem_crop crop = { 0 };
 	crop.top = obs_data_get_int(req->data, "top");
 	crop.bottom = obs_data_get_int(req->data, "bottom");
@@ -560,11 +489,7 @@ void WSRequestHandler::HandleSetSceneItemCrop(WSRequestHandler* req) {
 
 	obs_sceneitem_set_crop(sceneItem, &crop);
 
-		req->SendOKResponse();
+	return req->SendOKResponse();
-	}
-	else {
-		req->SendErrorResponse("specified scene item doesn't exist");
-	}
 }
 
 /**
@@ -580,29 +505,26 @@ void WSRequestHandler::HandleSetSceneItemCrop(WSRequestHandler* req) {
  * @category scene items
  * @since 4.5.0
  */
-void WSRequestHandler::HandleDeleteSceneItem(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleDeleteSceneItem(WSRequestHandler* req) {
 	if (!req->hasField("item")) {
-		req->SendErrorResponse("missing request parameters");
+		return req->SendErrorResponse("missing request parameters");
-		return;
 	}
 
 	const char* sceneName = obs_data_get_string(req->data, "scene");
 	OBSSourceAutoRelease scene = Utils::GetSceneFromNameOrCurrent(sceneName);
 	if (!scene) {
-		req->SendErrorResponse("requested scene doesn't exist");
+		return req->SendErrorResponse("requested scene doesn't exist");
-		return;
 	}
 
 	OBSDataAutoRelease item = obs_data_get_obj(req->data, "item");
 	OBSSceneItemAutoRelease sceneItem = Utils::GetSceneItemFromItem(scene, item);
 	if (!sceneItem) {
-		req->SendErrorResponse("item with id/name combination not found in specified scene");
+		return req->SendErrorResponse("item with id/name combination not found in specified scene");
-		return;
 	}
 
 	obs_sceneitem_remove(sceneItem);
 
-	req->SendOKResponse();
+	return req->SendOKResponse();
 }
 
 struct DuplicateSceneItemData {
@@ -628,7 +550,7 @@ static void DuplicateSceneItem(void *_data, obs_scene_t *scene) {
  *
  * @return {String} `scene` Name of the scene where the new item was created
  * @return {Object} `item` New item info
- * @return {int} `̀item.id` New item ID
+ * @return {int} `item.id` New item ID
  * @return {String} `item.name` New item name
  *
  * @api requests
@@ -636,31 +558,27 @@ static void DuplicateSceneItem(void *_data, obs_scene_t *scene) {
  * @category scene items
  * @since 4.5.0
  */
-void WSRequestHandler::HandleDuplicateSceneItem(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleDuplicateSceneItem(WSRequestHandler* req) {
 	if (!req->hasField("item")) {
-		req->SendErrorResponse("missing request parameters");
+		return req->SendErrorResponse("missing request parameters");
-		return;
 	}
 
 	const char* fromSceneName = obs_data_get_string(req->data, "fromScene");
 	OBSSourceAutoRelease fromScene = Utils::GetSceneFromNameOrCurrent(fromSceneName);
 	if (!fromScene) {
-		req->SendErrorResponse("requested fromScene doesn't exist");
+		return req->SendErrorResponse("requested fromScene doesn't exist");
-		return;
 	}
 
 	const char* toSceneName = obs_data_get_string(req->data, "toScene");
 	OBSSourceAutoRelease toScene = Utils::GetSceneFromNameOrCurrent(toSceneName);
 	if (!toScene) {
-		req->SendErrorResponse("requested toScene doesn't exist");
+		return req->SendErrorResponse("requested toScene doesn't exist");
-		return;
 	}
 
 	OBSDataAutoRelease item = obs_data_get_obj(req->data, "item");
 	OBSSceneItemAutoRelease referenceItem = Utils::GetSceneItemFromItem(fromScene, item);
 	if (!referenceItem) {
-		req->SendErrorResponse("item with id/name combination not found in specified scene");
+		return req->SendErrorResponse("item with id/name combination not found in specified scene");
-		return;
 	}
 
 	DuplicateSceneItemData data;
@@ -673,8 +591,7 @@ void WSRequestHandler::HandleDuplicateSceneItem(WSRequestHandler* req) {
 
 	obs_sceneitem_t *newItem = data.newItem;
 	if (!newItem) {
-		req->SendErrorResponse("Error duplicating scene item");
+		return req->SendErrorResponse("Error duplicating scene item");
-		return;
 	}
 
 	OBSDataAutoRelease itemData = obs_data_create();
@@ -685,5 +602,5 @@ void WSRequestHandler::HandleDuplicateSceneItem(WSRequestHandler* req) {
 	obs_data_set_obj(responseData, "item", itemData);
 	obs_data_set_string(responseData, "scene", obs_source_get_name(toScene));
 
-	req->SendOKResponse(responseData);
+	return req->SendOKResponse(responseData);
 }

src/WSRequestHandler_Scenes.cpp

@@ -1,4 +1,3 @@
-#include <QString>
 #include "Utils.h"
 
 #include "WSRequestHandler.h"
@@ -6,7 +5,7 @@
 /**
 * @typedef {Object} `Scene`
 * @property {String} `name` Name of the currently active scene.
-* @property {Array<Source>} `sources` Ordered list of the current scene's source items.
+* @property {Array<SceneItem>} `sources` Ordered list of the current scene's source items.
 */
 
 /**
@@ -19,10 +18,9 @@
  * @category scenes
  * @since 0.3
  */
- void WSRequestHandler::HandleSetCurrentScene(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleSetCurrentScene(WSRequestHandler* req) {
 	if (!req->hasField("scene-name")) {
-		req->SendErrorResponse("missing request parameters");
+		return req->SendErrorResponse("missing request parameters");
-		return;
 	}
 
 	const char* sceneName = obs_data_get_string(req->data, "scene-name");
@@ -30,9 +28,9 @@
 
 	if (source) {
 		obs_frontend_set_current_scene(source);
-		req->SendOKResponse();
+		return req->SendOKResponse();
 	} else {
-		req->SendErrorResponse("requested scene does not exist");
+		return req->SendErrorResponse("requested scene does not exist");
 	}
 }
 
@@ -40,14 +38,14 @@
  * Get the current scene's name and source items.
  * 
  * @return {String} `name` Name of the currently active scene.
- * @return {Array<Source>} `sources` Ordered list of the current scene's source items.
+ * @return {Array<SceneItem>} `sources` Ordered list of the current scene's source items.
  *
  * @api requests
  * @name GetCurrentScene
  * @category scenes
  * @since 0.3
  */
-void WSRequestHandler::HandleGetCurrentScene(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleGetCurrentScene(WSRequestHandler* req) {
 	OBSSourceAutoRelease currentScene = obs_frontend_get_current_scene();
 	OBSDataArrayAutoRelease sceneItems = Utils::GetSceneItems(currentScene);
 
@@ -55,7 +53,7 @@ void WSRequestHandler::HandleGetCurrentScene(WSRequestHandler* req) {
 	obs_data_set_string(data, "name", obs_source_get_name(currentScene));
 	obs_data_set_array(data, "sources", sceneItems);
 
-	req->SendOKResponse(data);
+	return req->SendOKResponse(data);
 }
 
 /**
@@ -69,7 +67,7 @@ void WSRequestHandler::HandleGetCurrentScene(WSRequestHandler* req) {
  * @category scenes
  * @since 0.3
  */
-void WSRequestHandler::HandleGetSceneList(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleGetSceneList(WSRequestHandler* req) {
 	OBSSourceAutoRelease currentScene = obs_frontend_get_current_scene();
 	OBSDataArrayAutoRelease scenes = Utils::GetScenes();
 
@@ -78,7 +76,7 @@ void WSRequestHandler::HandleGetSceneList(WSRequestHandler* req) {
 		obs_source_get_name(currentScene));
 	obs_data_set_array(data, "scenes", scenes);
 
-	req->SendOKResponse(data);
+	return req->SendOKResponse(data);
 }
 
 /**
@@ -94,18 +92,16 @@ void WSRequestHandler::HandleGetSceneList(WSRequestHandler* req) {
 * @category scenes
 * @since 4.5.0
 */
-void WSRequestHandler::HandleReorderSceneItems(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleReorderSceneItems(WSRequestHandler* req) {
 	QString sceneName = obs_data_get_string(req->data, "scene");
 	OBSSourceAutoRelease scene = Utils::GetSceneFromNameOrCurrent(sceneName);
 	if (!scene) {
-		req->SendErrorResponse("requested scene doesn't exist");
+		return req->SendErrorResponse("requested scene doesn't exist");
-		return;
 	}
 
 	OBSDataArrayAutoRelease items = obs_data_get_array(req->data, "items");
 	if (!items) {
-		req->SendErrorResponse("sceneItem order not specified");
+		return req->SendErrorResponse("sceneItem order not specified");
-		return;
 	}
 
 	size_t count = obs_data_array_count(items);
@@ -120,14 +116,12 @@ void WSRequestHandler::HandleReorderSceneItems(WSRequestHandler* req) {
 		obs_sceneitem_release(sceneItem); // ref dec
 
 		if (!sceneItem) {
-			req->SendErrorResponse("Invalid sceneItem id or name specified");
+			return req->SendErrorResponse("Invalid sceneItem id or name specified");
-			return;
 		}
 		
 		for (size_t j = 0; j <= i; ++j) {
 			if (sceneItem == newOrder[j]) {
-				req->SendErrorResponse("Duplicate sceneItem in specified order");
+				return req->SendErrorResponse("Duplicate sceneItem in specified order");
-				return;
 			}
 		}
 
@@ -136,13 +130,12 @@ void WSRequestHandler::HandleReorderSceneItems(WSRequestHandler* req) {
 
 	bool success = obs_scene_reorder_items(obs_scene_from_source(scene), newOrder.data(), count);
 	if (!success) {
-		req->SendErrorResponse("Invalid sceneItem order");
+		return req->SendErrorResponse("Invalid sceneItem order");
-		return;
 	}
 
 	for (auto const& item: newOrder) {
 		obs_sceneitem_release(item);
 	}
 
-	req->SendOKResponse();
+	return req->SendOKResponse();
 }

src/WSRequestHandler_Streaming.cpp

@@ -1,4 +1,4 @@
-#include <QString>
+#include "obs-websocket.h"
 #include "Utils.h"
 #include "WSEvents.h"
 
@@ -20,7 +20,9 @@
  * @category streaming
  * @since 0.3
  */
- void WSRequestHandler::HandleGetStreamingStatus(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleGetStreamingStatus(WSRequestHandler* req) {
+	auto events = GetEventsSystem();
+
 	OBSDataAutoRelease data = obs_data_create();
 	obs_data_set_bool(data, "streaming", obs_frontend_streaming_active());
 	obs_data_set_bool(data, "recording", obs_frontend_recording_active());
@@ -28,18 +30,18 @@
 
 	const char* tc = nullptr;
 	if (obs_frontend_streaming_active()) {
-		tc = WSEvents::Instance->GetStreamingTimecode();
+		tc = events->GetStreamingTimecode();
 		obs_data_set_string(data, "stream-timecode", tc);
 		bfree((void*)tc);
 	}
 
 	if (obs_frontend_recording_active()) {
-		tc = WSEvents::Instance->GetRecordingTimecode();
+		tc = events->GetRecordingTimecode();
 		obs_data_set_string(data, "rec-timecode", tc);
 		bfree((void*)tc);
 	}
 
-	req->SendOKResponse(data);
+	return req->SendOKResponse(data);
 }
 
 /**
@@ -50,11 +52,11 @@
  * @category streaming
  * @since 0.3
  */
- void WSRequestHandler::HandleStartStopStreaming(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleStartStopStreaming(WSRequestHandler* req) {
 	if (obs_frontend_streaming_active())
-		HandleStopStreaming(req);
+		return HandleStopStreaming(req);
 	else
-		HandleStartStreaming(req);
+		return HandleStartStreaming(req);
 }
 
 /**
@@ -76,7 +78,7 @@
  * @category streaming
  * @since 4.1.0
  */
- void WSRequestHandler::HandleStartStreaming(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleStartStreaming(WSRequestHandler* req) {
 	if (obs_frontend_streaming_active() == false) {
 		OBSService configuredService = obs_frontend_get_streaming_service();
 		OBSService newService = nullptr;
@@ -157,9 +159,9 @@
 			obs_frontend_set_streaming_service(configuredService);
 		}
 
-		req->SendOKResponse();
+		return req->SendOKResponse();
 	} else {
-		req->SendErrorResponse("streaming already active");
+		return req->SendErrorResponse("streaming already active");
 	}
 }
 
@@ -172,12 +174,12 @@
  * @category streaming
  * @since 4.1.0
  */
-void WSRequestHandler::HandleStopStreaming(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleStopStreaming(WSRequestHandler* req) {
 	if (obs_frontend_streaming_active() == true) {
 		obs_frontend_streaming_stop();
-		req->SendOKResponse();
+		return req->SendOKResponse();
 	} else {
-		req->SendErrorResponse("streaming not active");
+		return req->SendErrorResponse("streaming not active");
 	}
 }
 
@@ -198,13 +200,12 @@ void WSRequestHandler::HandleStopStreaming(WSRequestHandler* req) {
  * @category streaming
  * @since 4.1.0
  */
- void WSRequestHandler::HandleSetStreamSettings(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleSetStreamSettings(WSRequestHandler* req) {
 	OBSService service = obs_frontend_get_streaming_service();
 
 	OBSDataAutoRelease requestSettings = obs_data_get_obj(req->data, "settings");
 	if (!requestSettings) {
-		req->SendErrorResponse("'settings' are required'");
+		return req->SendErrorResponse("'settings' are required'");
-		return;
 	}
 
 	QString serviceType = obs_service_get_type(service);
@@ -242,7 +243,7 @@ void WSRequestHandler::HandleStopStreaming(WSRequestHandler* req) {
 	obs_data_set_string(response, "type", requestedType.toUtf8());
 	obs_data_set_obj(response, "settings", serviceSettings);
 
-	req->SendOKResponse(response);
+	return req->SendOKResponse(response);
 }
 
 /**
@@ -261,7 +262,7 @@ void WSRequestHandler::HandleStopStreaming(WSRequestHandler* req) {
  * @category streaming
  * @since 4.1.0
  */
-void WSRequestHandler::HandleGetStreamSettings(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleGetStreamSettings(WSRequestHandler* req) {
 	OBSService service = obs_frontend_get_streaming_service();
 
 	const char* serviceType = obs_service_get_type(service);
@@ -271,7 +272,7 @@ void WSRequestHandler::HandleGetStreamSettings(WSRequestHandler* req) {
 	obs_data_set_string(response, "type", serviceType);
 	obs_data_set_obj(response, "settings", settings);
 
-	req->SendOKResponse(response);
+	return req->SendOKResponse(response);
 }
 
 /**
@@ -282,7 +283,36 @@ void WSRequestHandler::HandleGetStreamSettings(WSRequestHandler* req) {
  * @category streaming
  * @since 4.1.0
  */
-void WSRequestHandler::HandleSaveStreamSettings(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleSaveStreamSettings(WSRequestHandler* req) {
 	obs_frontend_save_streaming_service();
-	req->SendOKResponse();
+	return req->SendOKResponse();
 }
+
+
+/**
+ * Send the provided text as embedded CEA-608 caption data.
+ * As of OBS Studio 23.1, captions are not yet available on Linux.
+ *
+ * @param {String} `text` Captions text
+ *
+ * @api requests
+ * @name SendCaptions
+ * @category streaming
+ * @since 4.6.0
+ */
+#if BUILD_CAPTIONS
+HandlerResponse WSRequestHandler::HandleSendCaptions(WSRequestHandler* req) {
+	if (!req->hasField("text")) {
+		return req->SendErrorResponse("missing request parameters");
+	}
+
+	OBSOutputAutoRelease output = obs_frontend_get_streaming_output();
+	if (output) {
+		const char* caption = obs_data_get_string(req->data, "text");
+		obs_output_output_caption_text1(output, caption);
+	}
+
+	return req->SendOKResponse();
+}
+#endif
+

src/WSRequestHandler_StudioMode.cpp

@@ -1,4 +1,3 @@
-#include <QString>
 #include "Utils.h"
 
 #include "WSRequestHandler.h"
@@ -13,13 +12,13 @@
  * @category studio mode
  * @since 4.1.0
  */
- void WSRequestHandler::HandleGetStudioModeStatus(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleGetStudioModeStatus(WSRequestHandler* req) {
 	bool previewActive = obs_frontend_preview_program_mode_active();
 
 	OBSDataAutoRelease response = obs_data_create();
 	obs_data_set_bool(response, "studio-mode", previewActive);
 
-	req->SendOKResponse(response);
+	return req->SendOKResponse(response);
 }
 
 /**
@@ -27,17 +26,16 @@
  * Will return an `error` if Studio Mode is not enabled.
  *
  * @return {String} `name` The name of the active preview scene.
- * @return {Array<Source>} `sources`
+ * @return {Array<SceneItem>} `sources`
  *
  * @api requests
  * @name GetPreviewScene
  * @category studio mode
  * @since 4.1.0
  */
-void WSRequestHandler::HandleGetPreviewScene(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleGetPreviewScene(WSRequestHandler* req) {
 	if (!obs_frontend_preview_program_mode_active()) {
-		req->SendErrorResponse("studio mode not enabled");
+		return req->SendErrorResponse("studio mode not enabled");
-		return;
 	}
 
 	OBSSourceAutoRelease scene = obs_frontend_get_current_preview_scene();
@@ -47,7 +45,7 @@ void WSRequestHandler::HandleGetPreviewScene(WSRequestHandler* req) {
 	obs_data_set_string(data, "name", obs_source_get_name(scene));
 	obs_data_set_array(data, "sources", sceneItems);
 
-	req->SendOKResponse(data);
+	return req->SendOKResponse(data);
 }
 
 /**
@@ -61,26 +59,23 @@ void WSRequestHandler::HandleGetPreviewScene(WSRequestHandler* req) {
  * @category studio mode
  * @since 4.1.0
  */
-void WSRequestHandler::HandleSetPreviewScene(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleSetPreviewScene(WSRequestHandler* req) {
 	if (!obs_frontend_preview_program_mode_active()) {
-		req->SendErrorResponse("studio mode not enabled");
+		return req->SendErrorResponse("studio mode not enabled");
-		return;
 	}
 
 	if (!req->hasField("scene-name")) {
-		req->SendErrorResponse("missing request parameters");
+		return req->SendErrorResponse("missing request parameters");
-		return;
 	}
 
 	const char* scene_name = obs_data_get_string(req->data, "scene-name");
 	OBSSourceAutoRelease scene = Utils::GetSceneFromNameOrCurrent(scene_name);
-
+	if (!scene) {
-	if (scene) {
+		return req->SendErrorResponse("specified scene doesn't exist");
-		obs_frontend_set_current_preview_scene(scene);
-		req->SendOKResponse();
-	} else {
-		req->SendErrorResponse("specified scene doesn't exist");
 	}
+
+	obs_frontend_set_current_preview_scene(scene);
+	return req->SendOKResponse();
 }
 
 /**
@@ -96,10 +91,9 @@ void WSRequestHandler::HandleSetPreviewScene(WSRequestHandler* req) {
  * @category studio mode
  * @since 4.1.0
  */
-void WSRequestHandler::HandleTransitionToProgram(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleTransitionToProgram(WSRequestHandler* req) {
 	if (!obs_frontend_preview_program_mode_active()) {
-		req->SendErrorResponse("studio mode not enabled");
+		return req->SendErrorResponse("studio mode not enabled");
-		return;
 	}
 
 	if (req->hasField("with-transition")) {
@@ -110,14 +104,12 @@ void WSRequestHandler::HandleTransitionToProgram(WSRequestHandler* req) {
 			QString transitionName =
 				obs_data_get_string(transitionInfo, "name");
 			if (transitionName.isEmpty()) {
-				req->SendErrorResponse("invalid request parameters");
+				return req->SendErrorResponse("invalid request parameters");
-				return;
 			}
 
 			bool success = Utils::SetTransitionByName(transitionName);
 			if (!success) {
-				req->SendErrorResponse("specified transition doesn't exist");
+				return req->SendErrorResponse("specified transition doesn't exist");
-				return;
 			}
 		}
 
@@ -129,7 +121,7 @@ void WSRequestHandler::HandleTransitionToProgram(WSRequestHandler* req) {
 	}
 
 	Utils::TransitionToProgram();
-	req->SendOKResponse();
+	return req->SendOKResponse();
 }
 
 /**
@@ -140,9 +132,9 @@ void WSRequestHandler::HandleTransitionToProgram(WSRequestHandler* req) {
  * @category studio mode
  * @since 4.1.0
  */
-void WSRequestHandler::HandleEnableStudioMode(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleEnableStudioMode(WSRequestHandler* req) {
 	obs_frontend_set_preview_program_mode(true);
-	req->SendOKResponse();
+	return req->SendOKResponse();
 }
 
 /**
@@ -153,9 +145,9 @@ void WSRequestHandler::HandleEnableStudioMode(WSRequestHandler* req) {
  * @category studio mode
  * @since 4.1.0
  */
-void WSRequestHandler::HandleDisableStudioMode(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleDisableStudioMode(WSRequestHandler* req) {
 	obs_frontend_set_preview_program_mode(false);
-	req->SendOKResponse();
+	return req->SendOKResponse();
 }
 
 /**
@@ -166,8 +158,8 @@ void WSRequestHandler::HandleDisableStudioMode(WSRequestHandler* req) {
  * @category studio mode
  * @since 4.1.0
  */
-void WSRequestHandler::HandleToggleStudioMode(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleToggleStudioMode(WSRequestHandler* req) {
 	bool previewProgramMode = obs_frontend_preview_program_mode_active();
 	obs_frontend_set_preview_program_mode(!previewProgramMode);
-	req->SendOKResponse();
+	return req->SendOKResponse();
 }

src/WSRequestHandler_Transitions.cpp

@@ -1,4 +1,3 @@
-#include <QString>
 #include "Utils.h"
 
 #include "WSRequestHandler.h"
@@ -15,7 +14,7 @@
  * @category transitions
  * @since 4.1.0
  */
- void WSRequestHandler::HandleGetTransitionList(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleGetTransitionList(WSRequestHandler* req) {
 	OBSSourceAutoRelease currentTransition = obs_frontend_get_current_transition();
 	obs_frontend_source_list transitionList = {};
 	obs_frontend_get_transitions(&transitionList);
@@ -35,7 +34,7 @@
 		obs_source_get_name(currentTransition));
 	obs_data_set_array(response, "transitions", transitions);
 
-	req->SendOKResponse(response);
+	return req->SendOKResponse(response);
 }
 
 /**
@@ -49,7 +48,7 @@
  * @category transitions
  * @since 0.3
  */
-void WSRequestHandler::HandleGetCurrentTransition(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleGetCurrentTransition(WSRequestHandler* req) {
 	OBSSourceAutoRelease currentTransition = obs_frontend_get_current_transition();
 
 	OBSDataAutoRelease response = obs_data_create();
@@ -59,7 +58,7 @@ void WSRequestHandler::HandleGetCurrentTransition(WSRequestHandler* req) {
 	if (!obs_transition_fixed(currentTransition))
 		obs_data_set_int(response, "duration", Utils::GetTransitionDuration());
 
-	req->SendOKResponse(response);
+	return req->SendOKResponse(response);
 }
 
 /**
@@ -72,18 +71,18 @@ void WSRequestHandler::HandleGetCurrentTransition(WSRequestHandler* req) {
  * @category transitions
  * @since 0.3
  */
-void WSRequestHandler::HandleSetCurrentTransition(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleSetCurrentTransition(WSRequestHandler* req) {
 	if (!req->hasField("transition-name")) {
-		req->SendErrorResponse("missing request parameters");
+		return req->SendErrorResponse("missing request parameters");
-		return;
 	}
 
 	QString name = obs_data_get_string(req->data, "transition-name");
 	bool success = Utils::SetTransitionByName(name);
-	if (success)
+	if (!success) {
-		req->SendOKResponse();
+		return req->SendErrorResponse("requested transition does not exist");
-	else
+	}
-		req->SendErrorResponse("requested transition does not exist");
+	
+	return req->SendOKResponse();
 }
 
 /**
@@ -96,15 +95,14 @@ void WSRequestHandler::HandleSetCurrentTransition(WSRequestHandler* req) {
  * @category transitions
  * @since 4.0.0
  */
-void WSRequestHandler::HandleSetTransitionDuration(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleSetTransitionDuration(WSRequestHandler* req) {
 	if (!req->hasField("duration")) {
-		req->SendErrorResponse("missing request parameters");
+		return req->SendErrorResponse("missing request parameters");
-		return;
 	}
 
 	int ms = obs_data_get_int(req->data, "duration");
 	Utils::SetTransitionDuration(ms);
-	req->SendOKResponse();
+	return req->SendOKResponse();
 }
 
 /**
@@ -117,10 +115,8 @@ void WSRequestHandler::HandleSetTransitionDuration(WSRequestHandler* req) {
  * @category transitions
  * @since 4.1.0
  */
-void WSRequestHandler::HandleGetTransitionDuration(WSRequestHandler* req) {
+HandlerResponse WSRequestHandler::HandleGetTransitionDuration(WSRequestHandler* req) {
 	OBSDataAutoRelease response = obs_data_create();
-	obs_data_set_int(response, "transition-duration",
+	obs_data_set_int(response, "transition-duration", Utils::GetTransitionDuration());
-		Utils::GetTransitionDuration());
+	return req->SendOKResponse(response);
-
-	req->SendOKResponse(response);
 }

src/WSServer.cpp

@@ -16,12 +16,16 @@ You should have received a copy of the GNU General Public License along
 with this program. If not, see <https://www.gnu.org/licenses/>
 */
 
-#include <QtWebSockets/QWebSocket>
+#include <chrono>
+#include <thread>
+
 #include <QtCore/QThread>
 #include <QtCore/QByteArray>
-#include <QMainWindow>
+#include <QtWidgets/QMainWindow>
-#include <QMessageBox>
+#include <QtWidgets/QMessageBox>
+#include <QtConcurrent/QtConcurrent>
 #include <obs-frontend-api.h>
+#include <util/platform.h>
 
 #include "WSServer.h"
 #include "obs-websocket.h"
@@ -30,139 +34,181 @@ with this program. If not, see <https://www.gnu.org/licenses/>
 
 QT_USE_NAMESPACE
 
-WSServer* WSServer::Instance = nullptr;
+using websocketpp::lib::placeholders::_1;
+using websocketpp::lib::placeholders::_2;
+using websocketpp::lib::bind;
 
-WSServer::WSServer(QObject* parent)
+WSServer::WSServer()
-	: QObject(parent),
+	: QObject(nullptr),
-	  _wsServer(Q_NULLPTR),
+	  _connections(),
-	  _clients(),
 	  _clMutex(QMutex::Recursive)
 {
-	_wsServer = new QWebSocketServer(
+	_server.init_asio();
-		QStringLiteral("obs-websocket"),
+#ifndef _WIN32
-		QWebSocketServer::NonSecureMode);
+	_server.set_reuse_addr(true);
+#endif
+
+	_server.set_open_handler(bind(&WSServer::onOpen, this, ::_1));
+	_server.set_close_handler(bind(&WSServer::onClose, this, ::_1));
+	_server.set_message_handler(bind(&WSServer::onMessage, this, ::_1, ::_2));
 }
 
-WSServer::~WSServer() {
+WSServer::~WSServer()
-	Stop();
+{
+	stop();
 }
 
-void WSServer::Start(quint16 port) {
+void WSServer::start(quint16 port)
-	if (port == _wsServer->serverPort())
+{
+	if (_server.is_listening() && port == _serverPort) {
+		blog(LOG_INFO, "WSServer::start: server already on this port. no restart needed");
 		return;
-
-	if(_wsServer->isListening())
-		Stop();
-
-	bool serverStarted = _wsServer->listen(QHostAddress::Any, port);
-	if (serverStarted) {
-		blog(LOG_INFO, "server started successfully on TCP port %d", port);
-
-		connect(_wsServer, SIGNAL(newConnection()),
-			this, SLOT(onNewConnection()));
 	}
-	else {
-		QString errorString = _wsServer->errorString();
-		blog(LOG_ERROR,
-			"error: failed to start server on TCP port %d: %s",
-			port, errorString.toUtf8().constData());
 
-		QMainWindow* mainWindow = (QMainWindow*)obs_frontend_get_main_window();
+	if (_server.is_listening()) {
+		stop();
+	}
+
+	_server.reset();
+
+	_serverPort = port;
+
+	websocketpp::lib::error_code errorCode;
+	_server.listen(_serverPort, errorCode);
+
+	if (errorCode) {
+		std::string errorCodeMessage = errorCode.message();
+		blog(LOG_INFO, "server: listen failed: %s", errorCodeMessage.c_str());
 
 		obs_frontend_push_ui_translation(obs_module_get_string);
-		QString title = tr("OBSWebsocket.Server.StartFailed.Title");
+		QString errorTitle = tr("OBSWebsocket.Server.StartFailed.Title");
-		QString msg = tr("OBSWebsocket.Server.StartFailed.Message").arg(port);
+		QString errorMessage = tr("OBSWebsocket.Server.StartFailed.Message").arg(_serverPort);
 		obs_frontend_pop_ui_translation();
 
-		QMessageBox::warning(mainWindow, title, msg);
+		QMainWindow* mainWindow = reinterpret_cast<QMainWindow*>(obs_frontend_get_main_window());
-	}
+		QMessageBox::warning(mainWindow, errorTitle, errorMessage);
+
+		return;
 	}
 
-void WSServer::Stop() {
+	_server.start_accept();
-	QMutexLocker locker(&_clMutex);
-	for(QWebSocket* pClient : _clients) {
-		pClient->close();
-	}
-	locker.unlock();
 
-	_wsServer->close();
+	QtConcurrent::run([=]() {
+		blog(LOG_INFO, "io thread started");
+		_server.run();
+		blog(LOG_INFO, "io thread exited");
+	});
+
+	blog(LOG_INFO, "server started successfully on port %d", _serverPort);
+}
+
+void WSServer::stop()
+{
+	if (!_server.is_listening()) {
+		return;
+	}
+
+	_server.stop_listening();
+	for (connection_hdl hdl : _connections) {
+		_server.close(hdl, websocketpp::close::status::going_away, "Server stopping");
+	}
+	_connections.clear();
+	_connectionProperties.clear();
+
+	_threadPool.waitForDone();
+
+	while (!_server.stopped()) {
+		std::this_thread::sleep_for(std::chrono::milliseconds(1));
+	}
 
 	blog(LOG_INFO, "server stopped successfully");
 }
 
-void WSServer::broadcast(QString message) {
+void WSServer::broadcast(std::string message)
+{
 	QMutexLocker locker(&_clMutex);
-	for(QWebSocket* pClient : _clients) {
+	for (connection_hdl hdl : _connections) {
-		if (Config::Current()->AuthRequired
+		if (GetConfig()->AuthRequired) {
-			&& (pClient->property(PROP_AUTHENTICATED).toBool() == false)) {
+			bool authenticated = _connectionProperties[hdl].isAuthenticated();
-			// Skip this client if unauthenticated
+			if (!authenticated) {
 				continue;
 			}
-		pClient->sendTextMessage(message);
+		}
+		_server.send(hdl, message, websocketpp::frame::opcode::text);
 	}
 }
 
-void WSServer::onNewConnection() {
+void WSServer::onOpen(connection_hdl hdl)
-	QWebSocket* pSocket = _wsServer->nextPendingConnection();
+{
-	if (pSocket) {
-		connect(pSocket, SIGNAL(textMessageReceived(const QString&)),
-			this, SLOT(onTextMessageReceived(QString)));
-		connect(pSocket, SIGNAL(disconnected()),
-			this, SLOT(onSocketDisconnected()));
-
-		pSocket->setProperty(PROP_AUTHENTICATED, false);
-
 	QMutexLocker locker(&_clMutex);
-		_clients << pSocket;
+	_connections.insert(hdl);
 	locker.unlock();
 
-		QHostAddress clientAddr = pSocket->peerAddress();
+	QString clientIp = getRemoteEndpoint(hdl);
-		QString clientIp = Utils::FormatIPAddress(clientAddr);
+	notifyConnection(clientIp);
+	blog(LOG_INFO, "new client connection from %s", clientIp.toUtf8().constData());
+}
 
-		blog(LOG_INFO, "new client connection from %s:%d",
+void WSServer::onMessage(connection_hdl hdl, server::message_ptr message)
-			clientIp.toUtf8().constData(), pSocket->peerPort());
+{
+	auto opcode = message->get_opcode();
+	if (opcode != websocketpp::frame::opcode::text) {
+		return;
+	}
 
+	QtConcurrent::run(&_threadPool, [=]() {
+		std::string payload = message->get_payload();
+
+		QMutexLocker locker(&_clMutex);
+		ConnectionProperties& connProperties = _connectionProperties[hdl];
+		locker.unlock();
+
+		WSRequestHandler handler(connProperties);
+		std::string response = handler.processIncomingMessage(payload);
+
+		_server.send(hdl, response, websocketpp::frame::opcode::text);
+	});
+}
+
+void WSServer::onClose(connection_hdl hdl)
+{
+	QMutexLocker locker(&_clMutex);
+	_connections.erase(hdl);
+	_connectionProperties.erase(hdl);
+	locker.unlock();
+
+	auto conn = _server.get_con_from_hdl(hdl);
+	auto localCloseCode = conn->get_local_close_code();
+
+	if (localCloseCode != websocketpp::close::status::going_away) {
+		QString clientIp = getRemoteEndpoint(hdl);
+		notifyDisconnection(clientIp);
+		blog(LOG_INFO, "client %s disconnected", clientIp.toUtf8().constData());
+	}
+}
+
+QString WSServer::getRemoteEndpoint(connection_hdl hdl)
+{
+	auto conn = _server.get_con_from_hdl(hdl);
+	return QString::fromStdString(conn->get_remote_endpoint());
+}
+
+void WSServer::notifyConnection(QString clientIp)
+{
 	obs_frontend_push_ui_translation(obs_module_get_string);
 	QString title = tr("OBSWebsocket.NotifyConnect.Title");
-		QString msg = tr("OBSWebsocket.NotifyConnect.Message")
+	QString msg = tr("OBSWebsocket.NotifyConnect.Message").arg(clientIp);
-			.arg(Utils::FormatIPAddress(clientAddr));
 	obs_frontend_pop_ui_translation();
 
 	Utils::SysTrayNotify(msg, QSystemTrayIcon::Information, title);
 }
-}
-
-void WSServer::onTextMessageReceived(QString message) {
-	QWebSocket* pSocket = qobject_cast<QWebSocket*>(sender());
-	if (pSocket) {
-		WSRequestHandler handler(pSocket);
-		handler.processIncomingMessage(message);
-	}
-}
-
-void WSServer::onSocketDisconnected() {
-	QWebSocket* pSocket = qobject_cast<QWebSocket*>(sender());
-	if (pSocket) {
-		pSocket->setProperty(PROP_AUTHENTICATED, false);
-
-		QMutexLocker locker(&_clMutex);
-		_clients.removeAll(pSocket);
-		locker.unlock();
-
-		pSocket->deleteLater();
-
-		QHostAddress clientAddr = pSocket->peerAddress();
-		QString clientIp = Utils::FormatIPAddress(clientAddr);
-
-		blog(LOG_INFO, "client %s:%d disconnected",
-			clientIp.toUtf8().constData(), pSocket->peerPort());
 
+void WSServer::notifyDisconnection(QString clientIp)
+{
 	obs_frontend_push_ui_translation(obs_module_get_string);
 	QString title = tr("OBSWebsocket.NotifyDisconnect.Title");
-		QString msg = tr("OBSWebsocket.NotifyDisconnect.Message")
+	QString msg = tr("OBSWebsocket.NotifyDisconnect.Message").arg(clientIp);
-			.arg(Utils::FormatIPAddress(clientAddr));
 	obs_frontend_pop_ui_translation();
 
 	Utils::SysTrayNotify(msg, QSystemTrayIcon::Information, title);
 }
-}

src/WSServer.h

@@ -1,6 +1,6 @@
 /*
 obs-websocket
-Copyright (C) 2016-2017	Stéphane Lepin <stephane.lepin@gmail.com>
+Copyright (C) 2016-2019	Stéphane Lepin <stephane.lepin@gmail.com>
 
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -16,37 +16,57 @@ You should have received a copy of the GNU General Public License along
 with this program. If not, see <https://www.gnu.org/licenses/>
 */
 
-#ifndef WSSERVER_H
+#pragma once
-#define WSSERVER_H
 
-#include <QObject>
+#include <map>
-#include <QList>
+#include <set>
-#include <QMutex>
+#include <QtCore/QObject>
+#include <QtCore/QMutex>
+#include <QtCore/QSharedPointer>
+#include <QtCore/QVariantHash>
+#include <QtCore/QThreadPool>
+
+#include <websocketpp/config/asio_no_tls.hpp>
+#include <websocketpp/server.hpp>
+
+#include "ConnectionProperties.h"
 
 #include "WSRequestHandler.h"
 
 QT_FORWARD_DECLARE_CLASS(QWebSocketServer)
 QT_FORWARD_DECLARE_CLASS(QWebSocket)
 
-class WSServer : public QObject {
+using websocketpp::connection_hdl;
-	Q_OBJECT
-	public:
-		explicit WSServer(QObject* parent = Q_NULLPTR);
-		virtual ~WSServer();
-		void Start(quint16 port);
-		void Stop();
-		void broadcast(QString message);
-		static WSServer* Instance;
 
-	private slots:
+typedef websocketpp::server<websocketpp::config::asio> server;
-		void onNewConnection();
+
-		void onTextMessageReceived(QString message);
+class WSServer : public QObject
-		void onSocketDisconnected();
+{
+Q_OBJECT
+
+public:
+	explicit WSServer();
+	virtual ~WSServer();
+	void start(quint16 port);
+	void stop();
+	void broadcast(std::string message);
+	QThreadPool* threadPool() {
+		return &_threadPool;
+	}
 
 private:
-		QWebSocketServer* _wsServer;
+	void onOpen(connection_hdl hdl);
-		QList<QWebSocket*> _clients;
+	void onMessage(connection_hdl hdl, server::message_ptr message);
-		QMutex _clMutex;
+	void onClose(connection_hdl hdl);
-};
 
-#endif // WSSERVER_H
+	QString getRemoteEndpoint(connection_hdl hdl);
+	void notifyConnection(QString clientIp);
+	void notifyDisconnection(QString clientIp);
+
+	server _server;
+	quint16 _serverPort;
+	std::set<connection_hdl, std::owner_less<connection_hdl>> _connections;
+	std::map<connection_hdl, ConnectionProperties, std::owner_less<connection_hdl>> _connectionProperties;
+	QMutex _clMutex;
+	QThreadPool _threadPool;
+};

src/forms/settings-dialog.cpp

@@ -41,7 +41,7 @@ SettingsDialog::SettingsDialog(QWidget* parent) :
 }
 
 void SettingsDialog::showEvent(QShowEvent* event) {
-	Config* conf = Config::Current();
+	auto conf = GetConfig();
 
 	ui->serverEnabled->setChecked(conf->ServerEnabled);
 	ui->serverPort->setValue(conf->ServerPort);
@@ -68,7 +68,7 @@ void SettingsDialog::AuthCheckboxChanged() {
 }
 
 void SettingsDialog::FormAccepted() {
-	Config* conf = Config::Current();
+	auto conf = GetConfig();
 
 	conf->ServerEnabled = ui->serverEnabled->isChecked();
 	conf->ServerPort = ui->serverPort->value();
@@ -81,7 +81,7 @@ void SettingsDialog::FormAccepted() {
 			conf->SetPassword(ui->password->text());
 		}
 
-		if (!Config::Current()->Secret.isEmpty())
+		if (!GetConfig()->Secret.isEmpty())
 			conf->AuthRequired = true;
 		else
 			conf->AuthRequired = false;
@@ -93,10 +93,12 @@ void SettingsDialog::FormAccepted() {
 
 	conf->Save();
 
-	if (conf->ServerEnabled)
+	auto server = GetServer();
-		WSServer::Instance->Start(conf->ServerPort);
+	if (conf->ServerEnabled) {
-	else
+		server->start(conf->ServerPort);
-		WSServer::Instance->Stop();
+	} else {
+		server->stop();
+	}
 }
 
 SettingsDialog::~SettingsDialog() {

src/forms/settings-dialog.h

@@ -1,6 +1,6 @@
 /*
 obs-websocket
-Copyright (C) 2016-2017	Stéphane Lepin <stephane.lepin@gmail.com>
+Copyright (C) 2016-2019	Stéphane Lepin <stephane.lepin@gmail.com>
 
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -16,10 +16,9 @@ You should have received a copy of the GNU General Public License along
 with this program. If not, see <https://www.gnu.org/licenses/>
 */
 
-#ifndef SETTINGSDIALOG_H
+#pragma once
-#define SETTINGSDIALOG_H
 
-#include <QDialog>
+#include <QtWidgets/QDialog>
 
 #include "ui_settings-dialog.h"
 
@@ -40,5 +39,3 @@ private Q_SLOTS:
 private:
 	Ui::SettingsDialog* ui;
 };
-
-#endif // SETTINGSDIALOG_H

src/obs-websocket.cpp

@@ -18,9 +18,10 @@ with this program. If not, see <https://www.gnu.org/licenses/>
 
 #include <obs-module.h>
 #include <obs-frontend-api.h>
-#include <QAction>
+
-#include <QMainWindow>
+#include <QtCore/QTimer>
-#include <QTimer>
+#include <QtWidgets/QAction>
+#include <QtWidgets/QMainWindow>
 
 #include "obs-websocket.h"
 #include "WSServer.h"
@@ -37,7 +38,9 @@ void ___output_dummy_addref(obs_output_t*) {}
 OBS_DECLARE_MODULE()
 OBS_MODULE_USE_DEFAULT_LOCALE("obs-websocket", "en-US")
 
-SettingsDialog* settings_dialog;
+ConfigPtr _config;
+WSServerPtr _server;
+WSEventsPtr _eventsSystem;
 
 bool obs_module_load(void) {
 	blog(LOG_INFO, "you can haz websockets (version %s)", OBS_WEBSOCKET_VERSION);
@@ -45,28 +48,32 @@ bool obs_module_load(void) {
 		QT_VERSION_STR, qVersion());
 
 	// Core setup
-	Config* config = Config::Current();
+	_config = ConfigPtr(new Config());
-	config->Load();
+	_config->MigrateFromGlobalSettings(); // TODO remove this on the next minor jump
+	_config->Load();
 
-	WSServer::Instance = new WSServer();
+	_server = WSServerPtr(new WSServer());
-	WSEvents::Instance = new WSEvents(WSServer::Instance);
+	_eventsSystem = WSEventsPtr(new WSEvents(_server));
 
-	if (config->ServerEnabled)
+	if (_config->ServerEnabled) {
-		WSServer::Instance->Start(config->ServerPort);
+		_server->start(_config->ServerPort);
+	}
 
 	// UI setup
-	QAction* menu_action = (QAction*)obs_frontend_add_tools_menu_qaction(
-		obs_module_text("OBSWebsocket.Menu.SettingsItem"));
-
 	obs_frontend_push_ui_translation(obs_module_get_string);
-	QMainWindow* main_window = (QMainWindow*)obs_frontend_get_main_window();
+	QMainWindow* mainWindow = (QMainWindow*)obs_frontend_get_main_window();
-	settings_dialog = new SettingsDialog(main_window);
+	SettingsDialog* settingsDialog = new SettingsDialog(mainWindow);
 	obs_frontend_pop_ui_translation();
 
-	auto menu_cb = [] {
+	const char* menuActionText =
-		settings_dialog->ToggleShowHide();
+		obs_module_text("OBSWebsocket.Settings.DialogTitle");
-	};
+	QAction* menuAction =
-	menu_action->connect(menu_action, &QAction::triggered, menu_cb);
+		(QAction*)obs_frontend_add_tools_menu_qaction(menuActionText);
+	QObject::connect(menuAction, &QAction::triggered, [settingsDialog] {
+		// The settings dialog belongs to the main window. Should be ok
+		// to pass the pointer to this QAction belonging to the main window
+		settingsDialog->ToggleShowHide();
+	});
 
 	// Loading finished
 	blog(LOG_INFO, "module loaded!");
@@ -75,6 +82,23 @@ bool obs_module_load(void) {
 }
 
 void obs_module_unload() {
+	_server->stop();
+
+	_eventsSystem.reset();
+	_server.reset();
+	_config.reset();
+
 	blog(LOG_INFO, "goodbye!");
 }
 
+ConfigPtr GetConfig() {
+	return _config;
+}
+
+WSServerPtr GetServer() {
+	return _server;
+}
+
+WSEventsPtr GetEventsSystem() {
+	return _eventsSystem;
+}

src/obs-websocket.h

@@ -1,6 +1,6 @@
 /*
 obs-websocket
-Copyright (C) 2016-2017	Stéphane Lepin <stephane.lepin@gmail.com>
+Copyright (C) 2016-2019	Stéphane Lepin <stephane.lepin@gmail.com>
 
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -16,10 +16,10 @@ You should have received a copy of the GNU General Public License along
 with this program. If not, see <https://www.gnu.org/licenses/>
 */
 
-#ifndef OBSWEBSOCKET_H
+#pragma once
-#define OBSWEBSOCKET_H
 
 #include <obs.hpp>
+#include <memory>
 
 void ___source_dummy_addref(obs_source_t*);
 void ___sceneitem_dummy_addref(obs_sceneitem_t*);
@@ -38,9 +38,19 @@ using OBSDataArrayAutoRelease =
 using OBSOutputAutoRelease =
 	OBSRef<obs_output_t*, ___output_dummy_addref, obs_output_release>;
 
-#define PROP_AUTHENTICATED "wsclient_authenticated"
+class Config;
-#define OBS_WEBSOCKET_VERSION "4.5.1"
+typedef std::shared_ptr<Config> ConfigPtr;
+
+class WSServer;
+typedef std::shared_ptr<WSServer> WSServerPtr;
+
+class WSEvents;
+typedef std::shared_ptr<WSEvents> WSEventsPtr;
+
+ConfigPtr GetConfig();
+WSServerPtr GetServer();
+WSEventsPtr GetEventsSystem();
+
+#define OBS_WEBSOCKET_VERSION "4.6.1"
 
 #define blog(level, msg, ...) blog(level, "[obs-websocket] " msg, ##__VA_ARGS__)
-
-#endif // OBSWEBSOCKET_H