docs(ci): Update protocol.md - 5350832 [skip ci]

4.9.1 Prep

.editorconfig

@@ -3,6 +3,7 @@ insert_final_newline = true
 
 [*.{c,cpp,h,hpp}]
 indent_style = tab
+indent_size = 4
 
 [*.{yml,yaml}]
 indent_style = space

.github/CONTRIBUTING.md

@@ -1,22 +0,0 @@
-## Contributing to obs-websocket
-
-### Translating obs-websocket to your language
-Localization happens on Crowdin: https://crowdin.com/project/obs-websocket
-
-### Writing code for obs-websocket
-#### Coding Guidelines
-- Function and variable names: snake_case for C names, CamelCase for C++ names
-- Tabs are 8 columns wide
-- 80 columns max.
-
-#### Commit Guidelines
-- Commits follow the 50/72 standard:
-	- 50 characters max for the title
-	- One empty line after the title
-	- Description wrapped to 72 columns max per line.
-- Commit titles:
-	- Use present tense
-	- Prefix the title with a "scope" name
-		- e.g: "CI: fix wrong behaviour when packaging for OS X"
-		- Typical scopes: CI, General, Request, Event, Server
-		- Look at existing commits for more examples

.github/FUNDING.yml

@@ -0,0 +1,3 @@
+open_collective: obs-websocket
+github: Palakis
+custom: https://www.paypal.me/stephanelepin

.github/ISSUE_TEMPLATE.md

@@ -1,16 +1,20 @@
 ##### Issue type
-Bug report? Feature request? Other?
+<!--- Uncomment one of the two options below. -->
+
+<!--- - Bug report -->
+<!--- - Feature request -->
 
 ##### Description
-*Replace this with a description of the bug encountered or feature requested.*
+<!--- Describe the bug encountered or feature requested. -->
 
 ##### Steps to reproduce and other useful info
-*If it's a bug, please describe the steps to reproduce it and PLEASE include an OBS log file. Otherwise, remove this section.*
+<!--- If it's a bug, please describe the steps to reproduce it and PLEASE include an OBS log file. Otherwise, remove this section. -->
 
 ##### Technical information
 - **Operating System** :
 - **OBS Studio version** :
+- **obs-websocket version** :
 
 ##### Development Environment
-*If you're trying to compile obs-websocket, please describe your compiler type and version (e.g: GCC 4.7, VC2013, ...), and the CMake settings used.  
-Remove this section if it doesn't apply to your case.*
+<!--- If you're trying to compile obs-websocket, please describe your compiler type and version (e.g: GCC 4.7, VC2013, ...), and the CMake settings used. -->
+<!--- Remove this section if it does not apply. -->

.github/pull_request_template.md

@@ -0,0 +1,35 @@
+<!--- Please fill out the following template, which will help other contributors review your Pull Request. -->
+
+<!--- Make sure you’ve read the contribution guidelines here: https://github.com/Palakis/obs-websocket/blob/4.x-current/CONTRIBUTING.md -->
+
+### Description
+<!--- Describe your changes. -->
+
+### Motivation and Context
+<!--- Why is this change required? What problem does it solve? -->
+<!--- If it fixes/closes an open issue or implements feature request, -->
+<!--- please link to the issue here. -->
+
+### How Has This Been Tested?
+<!--- Please describe in detail how you tested your changes, along with the OS(s) you tested with. -->
+Tested OS(s): 
+
+### Types of changes
+<!--- What types of changes does your PR introduce? Uncomment all that apply -->
+
+<!--- - Bug fix (non-breaking change which fixes an issue) -->
+<!--- - New request/event (non-breaking) -->
+<!--- - Documentation change (a change to documentation pages) -->
+<!--- - Enhancement (modification to a current event/request which adds functionality) -->
+<!--- - Performance enhancement (non-breaking change which improves efficiency) -->
+<!--- - Code cleanup (non-breaking change which makes code smaller or more readable) -->
+
+### Checklist:
+<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
+<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
+-   [ ] I have read the [**contributing** document](https://github.com/Palakis/obs-websocket/blob/4.x-current/CONTRIBUTING.md).
+-   [ ] My code is not on the master branch.
+-   [ ] The code has been tested.
+-   [ ] All commit messages are properly formatted and commits squashed where appropriate.
+-   [ ] I have included updates to all appropriate documentation.
+

.gitignore

@@ -4,6 +4,7 @@
 /build32/
 /build64/
 /release/
+/package/
 /installer/Output/
 .idea
 .vscode

.travis.yml

@@ -1,49 +0,0 @@
-language: cpp
-
-env:
-  global:
-  # AWS key ID
-  - secure: pAiNUGVbjP12BfnWPk0FFTkbnk4Tocvv88XiT3rzRqkQaD7/iyEogLBfHM4nOEgFiIMHbC41aE83w5JgRNPwn6mTgoQBOglzqq1tGuXfqPyV2VStk8beji1evubGoVjjPaoPTFyIdQc5GGxdHyogI/ed9Hb3ccyykYvjyolj9XoCiW42QHx60AHGwl+So+dEa8xydj9SLRPlZ/AitmI/cPVN3YotA7s37BLFiab54enxk7T4rwpR1nU0HVfoCpn5F4wZYxRq+LlSVFzC8vVE9cpDSLS5kjrZIZaT18tYG1/untCj+wqMIZbghaJXLtPSRW2YPHcJTz8q1YSXnJ19+0uiAIMAqaVv0kD5BAM97byYDBW+b9H6SYFkb/Pw/qcK9amMzMBjDPFpYFkl9Q2kzhsNs3HsZf/flSZjtrkQJiP3SOi/KvKzVK9X4Wym6hYZWHgmMTTYFrvr6BYnf2GkpfKNjm1d2kc0NNrq4d5H4NOEQB8MP+QH+o+BPeM6d9dthrUc1Pw+BXzOAr85CN4qtpPGoAl/Dbfgd6eu/88E2LpUufW2VFAOPWjykSOqzSN3orh7AaWuE34VFEnQ+2y3uIE8AKoyXzJv6zYkyNnNewKZeGe2kKYNwLn5UxQA9JEj7a+tvVevk4xBSkkjFAvjSG2z8/F1FXNbEfoLX1Hz/bU=
-  # AWS key secret
-  - secure: bGwljoP3E1OVBXLXox0O6p8kwQXLcNQ8YDKVa4H8u9Y+Ic7uqE4iV3rYS3ynNWSBMVRWY3ZbyClnhrCNwRhBAlcd8qWSJdpjVzs6HdQyzhuKa1P3V4FJPb7upGP/5R/DECGwex8Mun9dmXpYDak75LxfKIJUidPis5VDCYqul7k/xVVCou6Ctjpj7vQhWXDj2G/py+mdB8DERhymnQCtyK1Ziu8c4QlFKByZmnD72GFm/h3JPI1Pq1V2mz3x6x6GaYjb9Rdbd0UNwqjGQX4q2M/c3GEJa6B2JBCoTncawNZBNnPUF9qtv+zh0TNaNHMRWX13AJ/qYB+nVDub0C9b/6Mc48mt0Tv4ze15MproVrylZdV6qHYEG8yGPBqpTVbRP6gv6Y2TXIHWoTzqA+F/Gv2IDChyHXsld/MQQS2MSo5iaYktIrZKtX8Z0qAmTzPwIVBromaSI3vrE7UH0fRSQ6fAM8+Tn+MRthOBdqu23kS1dnG+X2CPbUhBfsJp0OSwVQD5jQtA51/sREVeGFiJvzQIkvwQDjb5MYilsRnwmoBXemkLmqaviXVY4rz1o5AIvz2pgZS2YggK1xHZCuI5tSjcNEkb77VwZTfsqrdDo9EJh6VgfdnGlHQhR2/A5hUJ4ANpJ/LgZlgfVp71Xg2GWQW6M4Znc5uj6A6xLBkO6FA=
-
-cache:
-  directories:
-  - node_modules
-
-matrix:
-  include:
-  - os: linux
-    env: _generate_docs
-    script: "./CI/generate-docs.sh"
-
-  - os: linux
-    env: _linux_build
-    dist: trusty
-    sudo: required
-    services:
-    - docker
-    before_install:
-    - docker run -d --name xenial -v $(dirname $(pwd)):/root -v /home/travis/package:/package
-      -e TRAVIS_BRANCH="$TRAVIS_BRANCH" -e TRAVIS_TAG="$TRAVIS_TAG" -w /root nimmis/ubuntu:16.04
-    - docker exec -it xenial /root/obs-websocket/CI/install-dependencies-xenial.sh
-    script:
-    - docker exec -it xenial /root/obs-websocket/CI/build-xenial.sh
-    after_success:
-    - docker exec -it xenial /root/obs-websocket/CI/package-xenial.sh
-
-deploy:
-- provider: s3
-  region: eu-central-1
-  bucket: obs-websocket-linux-builds
-  access_key_id: "$AWS_ID"
-  secret_access_key: "$AWS_SECRET"
-  local_dir: /home/travis/package
-  skip_cleanup: true
-  acl: public_read
-  on:
-    repo: Palakis/obs-websocket
-    condition:
-    - "$TRAVIS_OS_NAME = linux"
-    - "-d /home/travis/package"
-    all_branches: true

BUILDING.md

@@ -2,7 +2,7 @@
 
 ## Prerequisites
 
-You'll need [Qt 5.10.x](https://download.qt.io/official_releases/qt/5.10/),
+You'll need [Qt 5.15.2](https://download.qt.io/official_releases/qt/5.15/5.15.2/),
 [CMake](https://cmake.org/download/) and a working [OBS Studio development environment](https://obsproject.com/wiki/install-instructions) installed on your
 computer.
 
@@ -24,17 +24,23 @@ sudo apt-get install libboost-all-dev
 git clone --recursive https://github.com/Palakis/obs-websocket.git
 cd obs-websocket
 mkdir build && cd build
-cmake -DLIBOBS_INCLUDE_DIR="<path to the libobs sub-folder in obs-studio's source code>" -DCMAKE_INSTALL_PREFIX=/usr ..
+cmake -DLIBOBS_INCLUDE_DIR="<path to the libobs sub-folder in obs-studio's source code>" -DCMAKE_INSTALL_PREFIX=/usr -DUSE_UBUNTU_FIX=true ..
 make -j4
 sudo make install
 ```
 
+On other linux OS's, use this cmake command instead:
+
+```shell
+cmake -DLIBOBS_INCLUDE_DIR="<path to the libobs sub-folder in obs-studio's source code>" -DCMAKE_INSTALL_PREFIX=/usr ..
+```
+
 ## OS X
 
 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
+Use of the macOS CI scripts is recommended. Please note that these
 scripts install new software and can change several settings on your system. An
 existing obs-studio development environment is not required, as
 `install-build-obs-macos.sh` will install it for you. If you already have a
@@ -47,16 +53,14 @@ look for issues or specificities.
 ```shell
 git clone --recursive https://github.com/Palakis/obs-websocket.git
 cd obs-websocket
-./CI/install-dependencies-macos.sh
-./CI/install-build-obs-macos.sh
-./CI/build-macos.sh
-./CI/package-macos.sh
+./CI/macos/install-dependencies-macos.sh
+./CI/macos/install-build-obs-macos.sh
+./CI/macos/build-plugin-macos.sh
+./CI/macos/package-plugin-macos.sh
 ```
 
 This will result in a ready-to-use `obs-websocket.pkg` installer in the `release` subfolder.
 
 ## Automated Builds
 
-- Windows: [![Automated Build status for Windows](https://ci.appveyor.com/api/projects/status/github/Palakis/obs-websocket)](https://ci.appveyor.com/project/Palakis/obs-websocket/history)
-- Linux: [![Automated Build status for Linux](https://travis-ci.org/Palakis/obs-websocket.svg?branch=master)](https://travis-ci.org/Palakis/obs-websocket)
-- macOS: [![Automated Build status for macOS](https://img.shields.io/azure-devops/build/Palakis/obs-websocket/Palakis.obs-websocket.svg)](https://dev.azure.com/Palakis/obs-websocket/_build)
+[![Build Status](https://dev.azure.com/Palakis/obs-websocket/_apis/build/status/Palakis.obs-websocket?branchName=4.x-current)](https://dev.azure.com/Palakis/obs-websocket/_build/latest?definitionId=2&branchName=4.x-current)

CI/build-xenial.sh

@@ -1,8 +0,0 @@
-#!/bin/sh
-set -ex
-
-cd /root/obs-websocket
-
-mkdir build && cd build
-cmake -DCMAKE_INSTALL_PREFIX=/usr ..
-make -j4

CI/generate-docs.sh

@@ -4,6 +4,9 @@ echo "-- Generating documentation."
 echo "-- Node version: $(node -v)"
 echo "-- NPM version: $(npm -v)"
 
+git fetch origin
+git checkout ${CHECKOUT_REF/refs\/heads\//}
+
 cd docs
 npm install
 npm run build
@@ -15,19 +18,14 @@ if git diff --quiet; then
 	exit 0
 fi
 
-if [ "$TRAVIS_PULL_REQUEST" != "false" -o "$TRAVIS_BRANCH" != "4.x-current" ]; then
-	echo "-- Skipping documentation deployment because this is either a pull request or a non-master branch."
-	exit 0
-fi
-
 REMOTE_URL="$(git config remote.origin.url)"
 TARGET_REPO=${REMOTE_URL/https:\/\/github.com\//github.com/}
 GITHUB_REPO=https://${GH_TOKEN:-git}@${TARGET_REPO}
 
-git config user.name "Travis CI"
+git config user.name "Azure CI"
 git config user.email "$COMMIT_AUTHOR_EMAIL"
 
 git add ./generated
 git pull
-git commit -m "docs(travis): Update protocol.md - $(git rev-parse --short HEAD) [skip ci]"
-git push -q $GITHUB_REPO HEAD:$TRAVIS_BRANCH
+git commit -m "docs(ci): Update protocol.md - $(git rev-parse --short HEAD) [skip ci]"
+git push -q $GITHUB_REPO

CI/install-build-obs-macos.sh

@@ -1,43 +0,0 @@
-#!/bin/sh
-
-OSTYPE=$(uname)
-
-if [ "${OSTYPE}" != "Darwin" ]; then
-    echo "[obs-websocket - Error] macOS obs-studio build script can be run on Darwin-type OS only."
-    exit 1
-fi
-
-HAS_CMAKE=$(type cmake 2>/dev/null)
-HAS_GIT=$(type git 2>/dev/null)
-
-if [ "${HAS_CMAKE}" = "" ]; then
-    echo "[obs-websocket - Error] CMake not installed - please run 'install-dependencies-macos.sh' first."
-    exit 1
-fi
-
-if [ "${HAS_GIT}" = "" ]; then
-    echo "[obs-websocket - Error] Git not installed - please install Xcode developer tools or via Homebrew."
-    exit 1
-fi
-
-echo "[obs-websocket] Downloading and unpacking OBS dependencies"
-wget --quiet --retry-connrefused --waitretry=1 https://obs-nightly.s3.amazonaws.com/osx-deps-2018-08-09.tar.gz
-tar -xf ./osx-deps-2018-08-09.tar.gz -C /tmp
-
-# Build obs-studio
-cd ..
-echo "[obs-websocket] Cloning obs-studio from GitHub.."
-git clone https://github.com/obsproject/obs-studio
-cd obs-studio
-OBSLatestTag=$(git describe --tags --abbrev=0)
-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

@@ -1,129 +0,0 @@
-@echo off
-SETLOCAL EnableDelayedExpansion
-
-REM Check if obs-studio build exists.
-REM If the obs-studio directory does exist, check if the last OBS tag built
-REM matches the latest OBS tag.
-REM If the tags match, do not build obs-studio.
-REM If the tags do not match, build obs-studio.
-REM If the obs-studio directory doesn't exist, build obs-studio.
-echo Checking for obs-studio build...
-
-set OBSLatestTagPrePull=0
-set OBSLatestTagPostPull=0
-echo Latest tag pre-pull: %OBSLatestTagPrePull%
-echo Latest tag post-pull: %OBSLatestTagPostPull%
-
-REM Set up the build flag as undefined.
-set "BuildOBS="
-
-REM Check the last tag successfully built by CI.
-if exist C:\projects\obs-studio-last-tag-built.txt (
-	set /p OBSLastTagBuilt=<C:\projects\obs-studio-last-tag-built.txt
-) else (
-	set OBSLastTagBuilt=0
-)
-
-REM If obs-studio directory exists, run git pull and get the latest tag number.
-if exist C:\projects\obs-studio\ (
-	echo obs-studio directory exists
-	echo   Updating tag info
-	cd C:\projects\obs-studio\
-	git describe --tags --abbrev=0 --exclude="*-rc*" > C:\projects\latest-obs-studio-tag-pre-pull.txt
-	set /p OBSLatestTagPrePull=<C:\projects\latest-obs-studio-tag-pre-pull.txt
-	git checkout master
-	git pull
-	git describe --tags --abbrev=0 --exclude="*-rc*" > C:\projects\latest-obs-studio-tag-post-pull.txt
-	set /p OBSLatestTagPostPull=<C:\projects\latest-obs-studio-tag-post-pull.txt
-	set /p OBSLatestTag=<C:\projects\latest-obs-studio-tag-post-pull.txt
-	echo %OBSLatestTagPostPull%> C:\projects\latest-obs-studio-tag.txt
-)
-
-REM Check the obs-studio tags for mismatches.
-REM If a new tag was pulled, set the build flag.
-if not %OBSLatestTagPrePull%==%OBSLatestTagPostPull% (
-	echo Latest tag pre-pull: %OBSLatestTagPrePull%
-	echo Latest tag post-pull: %OBSLatestTagPostPull%
-	echo Tags do not match.  Need to rebuild OBS.
-	set BuildOBS=true
-)
-
-REM If the latest git tag doesn't match the last built tag, set the build flag.
-if not %OBSLatestTagPostPull%==%OBSLastTagBuilt% (
-	echo Last built OBS tag: %OBSLastTagBuilt%
-	echo Latest tag post-pull: %OBSLatestTagPostPull%
-	echo Tags do not match.  Need to rebuild OBS.
-	set BuildOBS=true
-)
-
-REM If obs-studio directory does not exist, clone the git repo, get the latest
-REM tag number, and set the build flag.
-if not exist C:\projects\obs-studio (
-	echo obs-studio directory does not exist
-	git clone https://github.com/obsproject/obs-studio
-	cd C:\projects\obs-studio\
-	git describe --tags --abbrev=0 --exclude="*-rc*" > C:\projects\obs-studio-latest-tag.txt
-	set /p OBSLatestTag=<C:\projects\obs-studio-latest-tag.txt
-	set BuildOBS=true
-)
-
-REM If the needed obs-studio libs for this build_config do not exist,
-REM set the build flag.
-if not exist C:\projects\obs-studio\build32\libobs\%build_config%\obs.lib (
-	echo obs-studio\build32\libobs\%build_config%\obs.lib does not exist
-	set BuildOBS=true
-)
-if not exist C:\projects\obs-studio\build32\UI\obs-frontend-api\%build_config%\obs-frontend-api.lib (
-	echo obs-studio\build32\UI\obs-frontend-api\%build_config%\obs-frontend-api.lib does not exist
-	set BuildOBS=true
-)
-
-REM Some debug info
-echo:
-echo Latest tag pre-pull: %OBSLatestTagPrePull%
-echo Latest tag post-pull: %OBSLatestTagPostPull%
-echo Latest tag: %OBSLatestTag%
-echo Last built OBS tag: %OBSLastTagBuilt%
-
-if defined BuildOBS (
-	echo BuildOBS: true
-) else (
-	echo BuildOBS: false
-)
-echo:
-
-REM If the build flag is set, build obs-studio.
-if defined BuildOBS (
-	echo Building obs-studio...
-	echo   git checkout %OBSLatestTag%
-	git checkout %OBSLatestTag%
-	echo:
-	echo   Removing previous build dirs...
-	if exist build rmdir /s /q C:\projects\obs-studio\build
-	if exist build32 rmdir /s /q C:\projects\obs-studio\build32
-	if exist build64 rmdir /s /q C:\projects\obs-studio\build64
-	echo   Making new build dirs...
-	mkdir build
-	mkdir build32
-	mkdir build64
-	echo   Running cmake for obs-studio %OBSLatestTag% 32-bit...
-	cd ./build32
-	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" -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%^)...
-	call msbuild /m /p:Configuration=%build_config% C:\projects\obs-studio\build32\obs-studio.sln /logger:"C:\Program Files\AppVeyor\BuildAgent\Appveyor.MSBuildLogger.dll"
-	echo   Building obs-studio %OBSLatestTag% 64-bit ^(Build Config: %build_config%^)...
-	call msbuild /m /p:Configuration=%build_config% C:\projects\obs-studio\build64\obs-studio.sln /logger:"C:\Program Files\AppVeyor\BuildAgent\Appveyor.MSBuildLogger.dll"
-	cd ..
-	git describe --tags --abbrev=0 > C:\projects\obs-studio-last-tag-built.txt
-	set /p OBSLastTagBuilt=<C:\projects\obs-studio-last-tag-built.txt
-) else (
-	echo Last OBS tag built is:  %OBSLastTagBuilt%
-	echo No need to rebuild OBS.
-)

CI/install-dependencies-macos.sh

@@ -1,61 +0,0 @@
-#!/bin/sh
-
-
-
-OSTYPE=$(uname)
-
-if [ "${OSTYPE}" != "Darwin" ]; then
-    echo "[obs-websocket - Error] macOS install dependencies script can be run on Darwin-type OS only."
-    exit 1
-fi
-
-HAS_BREW=$(type brew 2>/dev/null)
-
-if [ "${HAS_BREW}" = "" ]; then
-    echo "[obs-websocket - Error] Please install Homebrew (https://www.brew.sh/) to build obs-websocket on macOS."
-    exit 1
-fi
-
-# OBS Studio deps
-echo "[obs-websocket] Updating Homebrew.."
-brew update >/dev/null
-echo "[obs-websocket] Checking installed Homebrew formulas.."
-BREW_PACKAGES=$(brew list)
-BREW_DEPENDENCIES="jack speexdsp ccache swig mbedtls"
-
-for DEPENDENCY in ${BREW_DEPENDENCIES}; do
-    if echo "${BREW_PACKAGES}" | grep -q "^${DEPENDENCY}\$"; then
-        echo "[obs-websocket] Upgrading OBS-Studio dependency '${DEPENDENCY}'.."
-        brew upgrade ${DEPENDENCY} 2>/dev/null
-    else
-        echo "[obs-websocket] Installing OBS-Studio dependency '${DEPENDENCY}'.."
-        brew install ${DEPENDENCY} 2>/dev/null
-    fi
-done
-
-# qtwebsockets deps
-echo "[obs-websocket] Installing obs-websocket dependency 'QT 5.10.1'.."
-# =!= NOTICE =!=
-# When building QT5 from sources on macOS 10.13+, use local qt5 formula:
-# brew install ./CI/macos/qt.rb
-# Pouring from the bottle is much quicker though, so use bottle for now.
-# =!= NOTICE =!=
-
-brew install https://gist.githubusercontent.com/DDRBoxman/b3956fab6073335a4bf151db0dcbd4ad/raw/ed1342a8a86793ea8c10d8b4d712a654da121ace/qt.rb
-
-# Pin this version of QT5 to avoid `brew upgrade`
-# upgrading it to incompatible version
-brew pin qt
-
-# Fetch and install Packages app
-# =!= NOTICE =!=
-# Installs a LaunchDaemon under /Library/LaunchDaemons/fr.whitebox.packages.build.dispatcher.plist
-# =!= NOTICE =!=
-
-HAS_PACKAGES=$(type packagesbuild 2>/dev/null)
-
-if [ "${HAS_PACKAGES}" = "" ]; then
-    echo "[obs-websocket] Installing Packaging app (might require password due to 'sudo').."
-    curl -o './Packages.pkg' --retry-connrefused -s --retry-delay 1 'https://s3-us-west-2.amazonaws.com/obs-nightly/Packages.pkg'
-    sudo installer -pkg ./Packages.pkg -target /
-fi

CI/install-dependencies-xenial.sh

@@ -1,19 +0,0 @@
-#!/bin/sh
-set -ex
-
-add-apt-repository -y ppa:obsproject/obs-studio
-apt-get -qq update
-
-apt-get install -y \
-	libc-dev-bin \
-	libc6-dev git \
-	build-essential \
-	checkinstall \
-	cmake \
-	obs-studio \
-	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
-
-ldconfig

CI/install-setup-qt.cmd

@@ -1,6 +0,0 @@
-@echo off
-
-REM Set default values to use AppVeyor's built-in Qt.
-set QTDIR32=C:\Qt\5.10.1\msvc2015
-set QTDIR64=C:\Qt\5.10.1\msvc2015_64
-set QTCompileVersion=5.10.1

CI/linux/build-plugin-ubuntu.sh

@@ -0,0 +1,9 @@
+#!/bin/sh
+set -ex
+
+echo "[obs-websocket] Running CMake.."
+mkdir build && cd build
+cmake -DCMAKE_INSTALL_PREFIX=/usr -DUSE_UBUNTU_FIX=true ..
+
+echo "[obs-websocket] Building plugin.."
+make -j4

CI/linux/install-dependencies-ubuntu.sh

@@ -0,0 +1,26 @@
+#!/bin/sh
+set -ex
+
+echo "[obs-websocket] Installing obs-studio PPA and updates.."
+sudo add-apt-repository -y ppa:obsproject/obs-studio
+sudo apt-get -qq update
+
+echo "[obs-websocket] Installing obs-studio and dependencies.."
+sudo apt-get install -y \
+	libc-dev-bin \
+	libc6-dev git \
+	build-essential \
+	checkinstall \
+	cmake \
+	obs-studio \
+	qtbase5-dev
+
+echo "[obs-websocket] Installed OBS Version: $(obs --version)"
+
+ls /usr/include/
+ls /usr/include/obs/
+
+# Dirty hack
+sudo wget -O /usr/include/obs/obs-frontend-api.h https://raw.githubusercontent.com/obsproject/obs-studio/27.0.0/UI/obs-frontend-api/obs-frontend-api.h
+
+sudo ldconfig

CI/linux/package-plugin-ubuntu.sh

@@ -0,0 +1,24 @@
+#!/bin/bash
+
+set -e
+
+export GIT_HASH=$(git rev-parse --short HEAD)
+export PKG_VERSION="1-$GIT_HASH-$BRANCH_SHORT_NAME-git"
+
+if [[ $BRANCH_FULL_NAME =~ ^refs/tags/ ]]; then
+	export PKG_VERSION="$BRANCH_SHORT_NAME"
+	echo "[obs-websocket] Branch is a tag. Setting version to $PKG_VERSION."
+fi
+
+cd ./build
+
+PAGER="cat" sudo checkinstall -y --type=debian --fstrans=no --nodoc \
+	--backup=no --deldoc=yes --install=no \
+	--pkgname=obs-websocket --pkgversion="$PKG_VERSION" \
+	--pkglicense="GPLv2.0" --maintainer="stephane.lepin@gmail.com" \
+	--pkggroup="video" \
+	--pkgsource="https://github.com/Palakis/obs-websocket" \
+	--requires="obs-studio \(\>= 26.1.0\), libqt5core5a, libqt5widgets5, qt5-image-formats-plugins" \
+	--pakdir="../package"
+
+sudo chmod ao+r ../package/*

CI/macos/Brewfile

@@ -0,0 +1,5 @@
+brew "jack"
+brew "speexdsp"
+brew "cmake"
+brew "freetype"
+brew "fdk-aac"

CI/macos/build-plugin-macos.sh

@@ -14,12 +14,10 @@ if [ "${HAS_CMAKE}" = "" ]; then
 	exit 1
 fi
 
-#export QT_PREFIX="$(find /usr/local/Cellar/qt5 -d 1 | tail -n 1)"
-
 echo "[obs-websocket] Building 'obs-websocket' for macOS."
 mkdir -p build && cd build
 cmake .. \
-	-DQTDIR=/usr/local/opt/qt \
+	-DQTDIR=/tmp/obsdeps \
 	-DLIBOBS_INCLUDE_DIR=../../obs-studio/libobs \
 	-DLIBOBS_LIB=../../obs-studio/libobs \
 	-DOBS_FRONTEND_LIB="$(pwd)/../../obs-studio/build/UI/obs-frontend-api/libobs-frontend-api.dylib" \

CI/macos/install-build-obs-macos.sh

@@ -0,0 +1,39 @@
+#!/bin/sh
+
+OSTYPE=$(uname)
+
+if [ "${OSTYPE}" != "Darwin" ]; then
+	echo "[obs-websocket - Error] macOS obs-studio build script can be run on Darwin-type OS only."
+	exit 1
+fi
+
+HAS_CMAKE=$(type cmake 2>/dev/null)
+HAS_GIT=$(type git 2>/dev/null)
+
+if [ "${HAS_CMAKE}" = "" ]; then
+	echo "[obs-websocket - Error] CMake not installed - please run 'install-dependencies-macos.sh' first."
+	exit 1
+fi
+
+if [ "${HAS_GIT}" = "" ]; then
+	echo "[obs-websocket - Error] Git not installed - please install Xcode developer tools or via Homebrew."
+	exit 1
+fi
+
+# Build obs-studio
+cd ..
+echo "[obs-websocket] Cloning obs-studio from GitHub.."
+git clone https://github.com/obsproject/obs-studio
+cd obs-studio
+OBSLatestTag=$(git describe --tags --abbrev=0)
+git checkout $OBSLatestTag
+mkdir build && cd build
+echo "[obs-websocket] Building obs-studio.."
+cmake .. \
+	-DQTDIR=/tmp/obsdeps \
+	-DDepsPath=/tmp/obsdeps \
+	-DCMAKE_OSX_DEPLOYMENT_TARGET=10.13 \
+	-DDISABLE_PLUGINS=true \
+	-DENABLE_SCRIPTING=0 \
+	-DCMAKE_PREFIX_PATH=/tmp/obsdeps/lib/cmake \
+&& make -j4

CI/macos/install-dependencies-macos.sh

@@ -0,0 +1,57 @@
+#!/bin/sh
+
+OSTYPE=$(uname)
+
+if [ "${OSTYPE}" != "Darwin" ]; then
+	echo "[obs-websocket - Error] macOS install dependencies script can be run on Darwin-type OS only."
+	exit 1
+fi
+
+HAS_BREW=$(type brew 2>/dev/null)
+
+if [ "${HAS_BREW}" = "" ]; then
+	echo "[obs-websocket - Error] Please install Homebrew (https://www.brew.sh/) to build obs-websocket on macOS."
+	exit 1
+fi
+
+# OBS Studio Brew Deps
+echo "[obs-websocket] Updating Homebrew.."
+brew update >/dev/null
+echo "[obs-websocket] Checking installed Homebrew formulas.."
+
+if [ -d /usr/local/opt/openssl@1.0.2t ]; then
+  brew uninstall openssl@1.0.2t
+  brew untap local/openssl
+fi
+
+if [ -d /usr/local/opt/python@2.7.17 ]; then
+  brew uninstall python@2.7.17
+  brew untap local/python2
+fi
+
+brew bundle --file ./CI/macos/Brewfile
+
+# Fetch and install Packages app
+# =!= NOTICE =!=
+# Installs a LaunchDaemon under /Library/LaunchDaemons/fr.whitebox.packages.build.dispatcher.plist
+# =!= NOTICE =!=
+
+HAS_PACKAGES=$(type packagesbuild 2>/dev/null)
+
+if [ "${HAS_PACKAGES}" = "" ]; then
+	echo "[obs-websocket] Installing Packaging app (might require password due to 'sudo').."
+	curl -L -O http://s.sudre.free.fr/Software/files/Packages.dmg
+	sudo hdiutil attach ./Packages.dmg
+	sudo installer -pkg /Volumes/Packages\ 1.2.9/Install\ Packages.pkg -target /
+fi
+
+# OBS Deps
+echo "[obs-websocket] Installing obs-websocket dependency 'OBS Deps ${OBS_DEPS_VERSION}'.."
+wget --quiet --retry-connrefused --waitretry=1 https://github.com/obsproject/obs-deps/releases/download/${OBS_DEPS_VERSION}/macos-deps-${OBS_DEPS_VERSION}.tar.gz
+tar -xf ./macos-deps-${OBS_DEPS_VERSION}.tar.gz -C /tmp
+
+# Qt deps
+echo "[obs-websocket] Installing obs-websocket dependency 'Qt ${QT_VERSION}'.."
+curl -L -O https://github.com/obsproject/obs-deps/releases/download/${OBS_DEPS_VERSION}/macos-qt-${QT_VERSION}-${OBS_DEPS_VERSION}.tar.gz
+tar -xf ./macos-qt-${QT_VERSION}-${OBS_DEPS_VERSION}.tar.gz -C "/tmp"
+xattr -r -d com.apple.quarantine /tmp/obsdeps

CI/macos/obs-websocket.pkgproj

@@ -514,11 +514,11 @@
 			<key>CONCLUSION_ACTION</key>
 			<integer>0</integer>
 			<key>IDENTIFIER</key>
-			<string>fr.palakis.obswebsocket</string>
+			<string>fr.palakis.obs-websocket</string>
 			<key>OVERWRITE_PERMISSIONS</key>
 			<false/>
 			<key>VERSION</key>
-			<string>4.7.0</string>
+			<string>4.9.1</string>
 		</dict>
 		<key>PROJECT_COMMENTS</key>
 		<dict>

CI/macos/package-plugin-macos.sh

@@ -0,0 +1,89 @@
+#!/bin/bash
+
+set -e
+
+OSTYPE=$(uname)
+
+if [ "${OSTYPE}" != "Darwin" ]; then
+	echo "[obs-websocket - Error] macOS package script can be run on Darwin-type OS only."
+	exit 1
+fi
+
+echo "[obs-websocket] Preparing package build"
+
+GIT_HASH=$(git rev-parse --short HEAD)
+GIT_BRANCH_OR_TAG=$(git name-rev --name-only HEAD | awk -F/ '{print $NF}')
+
+VERSION="$GIT_HASH-$GIT_BRANCH_OR_TAG"
+
+FILENAME_UNSIGNED="obs-websocket-$VERSION-Unsigned.pkg"
+FILENAME="obs-websocket-$VERSION.pkg"
+
+echo "[obs-websocket] Modifying obs-websocket.so linking"
+install_name_tool \
+	-change /tmp/obsdeps/lib/QtWidgets.framework/Versions/5/QtWidgets \
+		@executable_path/../Frameworks/QtWidgets.framework/Versions/5/QtWidgets \
+	-change /tmp/obsdeps/lib/QtGui.framework/Versions/5/QtGui \
+		@executable_path/../Frameworks/QtGui.framework/Versions/5/QtGui \
+	-change /tmp/obsdeps/lib/QtCore.framework/Versions/5/QtCore \
+		@executable_path/../Frameworks/QtCore.framework/Versions/5/QtCore \
+	./build/obs-websocket.so
+
+# Check if replacement worked
+echo "[obs-websocket] Dependencies for obs-websocket"
+otool -L ./build/obs-websocket.so
+
+if [[ "$RELEASE_MODE" == "True" ]]; then
+	echo "[obs-websocket] Signing plugin binary: obs-websocket.so"
+	codesign --sign "$CODE_SIGNING_IDENTITY" ./build/obs-websocket.so
+else
+	echo "[obs-websocket] Skipped plugin codesigning"
+fi
+
+echo "[obs-websocket] Actual package build"
+packagesbuild ./CI/macos/obs-websocket.pkgproj
+
+echo "[obs-websocket] Renaming obs-websocket.pkg to $FILENAME"
+mv ./release/obs-websocket.pkg ./release/$FILENAME_UNSIGNED
+
+if [[ "$RELEASE_MODE" == "True" ]]; then
+	echo "[obs-websocket] Signing installer: $FILENAME"
+	productsign \
+		--sign "$INSTALLER_SIGNING_IDENTITY" \
+		./release/$FILENAME_UNSIGNED \
+		./release/$FILENAME
+	rm ./release/$FILENAME_UNSIGNED
+
+	echo "[obs-websocket] Submitting installer $FILENAME for notarization"
+	zip -r ./release/$FILENAME.zip ./release/$FILENAME
+	UPLOAD_RESULT=$(xcrun altool \
+		--notarize-app \
+		--primary-bundle-id "fr.palakis.obs-websocket" \
+		--username "$AC_USERNAME" \
+		--password "$AC_PASSWORD" \
+		--asc-provider "$AC_PROVIDER_SHORTNAME" \
+		--file "./release/$FILENAME.zip")
+	rm ./release/$FILENAME.zip
+
+	REQUEST_UUID=$(echo $UPLOAD_RESULT | awk -F ' = ' '/RequestUUID/ {print $2}')
+	echo "Request UUID: $REQUEST_UUID"
+
+	echo "[obs-websocket] Wait for notarization result"
+	# Pieces of code borrowed from rednoah/notarized-app
+	while sleep 30 && date; do
+		CHECK_RESULT=$(xcrun altool \
+			--notarization-info "$REQUEST_UUID" \
+			--username "$AC_USERNAME" \
+			--password "$AC_PASSWORD" \
+			--asc-provider "$AC_PROVIDER_SHORTNAME")
+		echo $CHECK_RESULT
+
+		if ! grep -q "Status: in progress" <<< "$CHECK_RESULT"; then
+			echo "[obs-websocket] Staple ticket to installer: $FILENAME"
+			xcrun stapler staple ./release/$FILENAME
+			break
+		fi
+	done
+else
+	echo "[obs-websocket] Skipped installer codesigning and notarization"
+fi

CI/macos/qt.rb

@@ -1,163 +0,0 @@
-# Patches for Qt must be at the very least submitted to Qt's Gerrit codereview
-# rather than their bug-report Jira. The latter is rarely reviewed by Qt.
-class Qt < Formula
-	desc "Cross-platform application and UI framework"
-	homepage "https://www.qt.io/"
-	url "https://download.qt.io/archive/qt/5.10/5.10.1/single/qt-everywhere-src-5.10.1.tar.xz"
-	mirror "https://mirrorservice.org/sites/download.qt-project.org/official_releases/qt/5.10/5.10.1/single/qt-everywhere-src-5.10.1.tar.xz"
-	sha256 "05ffba7b811b854ed558abf2be2ddbd3bb6ddd0b60ea4b5da75d277ac15e740a"
-	head "https://code.qt.io/qt/qt5.git", :branch => "5.10.1", :shallow => false
-
-	bottle do
-		sha256 "8b4bad005596a5f8790150fe455db998ac2406f4e0f04140d6656205d844d266" => :high_sierra
-		sha256 "9c488554935fb573554a4e36d36d3c81e47245b7fefc4b61edef894e67ba1740" => :sierra
-		sha256 "c0407afba5951df6cc4c6f6c1c315972bd41c99cecb4e029919c4c15ab6f7bdc" => :el_capitan
-	end
-
-	keg_only "Qt 5 has CMake issues when linked"
-
-	option "with-docs", "Build documentation"
-	option "with-examples", "Build examples"
-
-	deprecated_option "with-mysql" => "with-mysql-client"
-
-	# OS X 10.7 Lion is still supported in Qt 5.5, but is no longer a reference
-	# configuration and thus untested in practice. Builds on OS X 10.7 have been
-	# reported to fail: <https://github.com/Homebrew/homebrew/issues/45284>.
-	depends_on :macos => :mountain_lion
-
-	depends_on "pkg-config" => :build
-	depends_on :xcode => :build
-	depends_on "mysql-client" => :optional
-	depends_on "postgresql" => :optional
-
-	# Restore `.pc` files for framework-based build of Qt 5 on OS X. This
-	# partially reverts <https://codereview.qt-project.org/#/c/140954/> merged
-	# between the 5.5.1 and 5.6.0 releases. (Remove this as soon as feasible!)
-	#
-	# Core formulae known to fail without this patch (as of 2016-10-15):
-	#   * gnuplot  (with `--with-qt` option)
-	#   * mkvtoolnix (with `--with-qt` option, silent build failure)
-	#   * poppler    (with `--with-qt` option)
-	patch do
-		url "https://raw.githubusercontent.com/Homebrew/formula-patches/e8fe6567/qt5/restore-pc-files.patch"
-		sha256 "48ff18be2f4050de7288bddbae7f47e949512ac4bcd126c2f504be2ac701158b"
-	end
-
-	# Fix compile error on macOS 10.13 around QFixed:
-	# https://github.com/Homebrew/homebrew-core/issues/27095
-	# https://bugreports.qt.io/browse/QTBUG-67545
-	patch do
-		url "https://raw.githubusercontent.com/z00m1n/formula-patches/0de0e229/qt/QTBUG-67545.patch"
-		sha256 "4a115097c7582c7dce4207f5500d13feb8c990eb8a05a43f41953985976ebe6c"
-	end
-
-	# Fix compile error on macOS 10.13 caused by qtlocation dependency
-	# mapbox-gl-native using Boost 1.62.0 does not build with C++ 17:
-	# https://github.com/Homebrew/homebrew-core/issues/27095
-	# https://bugreports.qt.io/browse/QTBUG-67810
-	patch do
-		url "https://raw.githubusercontent.com/z00m1n/formula-patches/a1a1f0dd/qt/QTBUG-67810.patch"
-		sha256 "8ee0bf71df1043f08ebae3aa35036be29c4d9ebff8a27e3b0411a6bd635e9382"
-	end
-
-	def install
-		args = %W[
-			-verbose
-			-prefix #{prefix}
-			-release
-			-opensource -confirm-license
-			-system-zlib
-			-qt-libpng
-			-qt-libjpeg
-			-qt-freetype
-			-qt-pcre
-			-nomake tests
-			-no-rpath
-			-pkg-config
-			-dbus-runtime
-			-no-assimp
-		]
-
-		args << "-nomake" << "examples" if build.without? "examples"
-
-		if build.with? "mysql-client"
-			args << "-plugin-sql-mysql"
-			(buildpath/"brew_shim/mysql_config").write <<~EOS
-				#!/bin/sh
-				if [ x"$1" = x"--libs" ]; then
-					mysql_config --libs | sed "s/-lssl -lcrypto//"
-				else
-					exec mysql_config "$@"
-				fi
-			EOS
-			chmod 0755, "brew_shim/mysql_config"
-			args << "-mysql_config" << buildpath/"brew_shim/mysql_config"
-		end
-
-		args << "-plugin-sql-psql" if build.with? "postgresql"
-
-		system "./configure", *args
-		system "make"
-		ENV.deparallelize
-		system "make", "install"
-
-		if build.with? "docs"
-			system "make", "docs"
-			system "make", "install_docs"
-		end
-
-		# Some config scripts will only find Qt in a "Frameworks" folder
-		frameworks.install_symlink Dir["#{lib}/*.framework"]
-
-		# The pkg-config files installed suggest that headers can be found in the
-		# `include` directory. Make this so by creating symlinks from `include` to
-		# the Frameworks' Headers folders.
-		Pathname.glob("#{lib}/*.framework/Headers") do |path|
-			include.install_symlink path => path.parent.basename(".framework")
-		end
-
-		# Move `*.app` bundles into `libexec` to expose them to `brew linkapps` and
-		# because we don't like having them in `bin`.
-		# (Note: This move breaks invocation of Assistant via the Help menu
-		# of both Designer and Linguist as that relies on Assistant being in `bin`.)
-		libexec.mkpath
-		Pathname.glob("#{bin}/*.app") { |app| mv app, libexec }
-	end
-
-	def caveats; <<~EOS
-		We agreed to the Qt opensource license for you.
-		If this is unacceptable you should uninstall.
-		EOS
-	end
-
-	test do
-		(testpath/"hello.pro").write <<~EOS
-			QT       += core
-			QT       -= gui
-			TARGET = hello
-			CONFIG   += console
-			CONFIG   -= app_bundle
-			TEMPLATE = app
-			SOURCES += main.cpp
-		EOS
-
-		(testpath/"main.cpp").write <<~EOS
-			#include <QCoreApplication>
-			#include <QDebug>
-
-			int main(int argc, char *argv[])
-			{
-				QCoreApplication a(argc, argv);
-				qDebug() << "Hello World!";
-				return 0;
-			}
-		EOS
-
-		system bin/"qmake", testpath/"hello.pro"
-		system "make"
-		assert_predicate testpath/"hello", :exist?
-		assert_predicate testpath/"main.o", :exist?
-		system "./hello"
-	end
-end

CI/package-macos.sh

@@ -1,43 +0,0 @@
-#!/bin/sh
-
-set -e
-
-OSTYPE=$(uname)
-
-if [ "${OSTYPE}" != "Darwin" ]; then
-    echo "[obs-websocket - Error] macOS package script can be run on Darwin-type OS only."
-    exit 1
-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 GIT_HASH=$(git rev-parse --short HEAD)
-export GIT_BRANCH_OR_TAG=$(git name-rev --name-only HEAD | awk -F/ '{print $NF}')
-
-export VERSION="$GIT_HASH-$GIT_BRANCH_OR_TAG"
-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] Modifying obs-websocket.so"
-install_name_tool \
-	-add_rpath @executable_path/../Frameworks/QtWidgets.framework/Versions/5/ \
-	-add_rpath @executable_path/../Frameworks/QtGui.framework/Versions/5/ \
-	-add_rpath @executable_path/../Frameworks/QtCore.framework/Versions/5/ \
-	-change /usr/local/opt/qt/lib/QtWidgets.framework/Versions/5/QtWidgets @rpath/QtWidgets \
-	-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 obs-websocket"
-otool -L ./build/obs-websocket.so
-
-echo "[obs-websocket] Actual package build"
-packagesbuild ./CI/macos/obs-websocket.pkgproj
-
-echo "[obs-websocket] Renaming obs-websocket.pkg to $FILENAME"
-mv ./release/obs-websocket.pkg ./release/$FILENAME
-cp ./release/$FILENAME ./release/$LATEST_FILENAME

CI/package-xenial.sh

@@ -1,24 +0,0 @@
-#!/bin/sh
-
-set -e
-
-cd /root/obs-websocket
-
-export GIT_HASH=$(git rev-parse --short HEAD)
-export PKG_VERSION="1-$GIT_HASH-$TRAVIS_BRANCH-git"
-
-if [ -n "${TRAVIS_TAG}" ]; then
-	export PKG_VERSION="$TRAVIS_TAG"
-fi
-
-cd /root/obs-websocket/build
-
-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" \
-	--pkggroup="video" \
-	--pkgsource="https://github.com/Palakis/obs-websocket" \
-	--pakdir="/package"
-
-chmod ao+r /package/*

CI/windows/download-obs-deps.cmd

@@ -0,0 +1,7 @@
+if exist %DEPS_BASE_PATH% (
+    echo "OBS dependencies found. Download skipped."
+) else (
+    echo "OBS dependencies not found. Downloading..."
+    curl -o %DEPS_BASE_PATH%.zip -kLO https://cdn-fastly.obsproject.com/downloads/dependencies2019.zip -f --retry 5 -C -
+    7z x %DEPS_BASE_PATH%.zip -o%DEPS_BASE_PATH%
+)

CI/windows/install-qt-win.cmd

@@ -0,0 +1,8 @@
+if exist %QT_BASE_DIR% (
+    echo "Qt directory found. Download skipped."
+) else (
+    echo "Qt directory not found. Downloading..."
+    curl -kLO https://tt2468.net/dl/Qt_5.15.2.7z -f --retry 5 -C -
+    7z x Qt_5.15.2.7z -o%QT_BASE_DIR%
+)
+dir %QT_BASE_DIR%

CI/windows/package-plugin-windows.cmd

@@ -0,0 +1,12 @@
+mkdir package
+cd package
+
+git rev-parse --short HEAD > package-version.txt
+set /p PackageVersion=<package-version.txt
+del package-version.txt
+
+REM Package ZIP archive
+7z a "obs-websocket-%PackageVersion%-Windows.zip" "..\release\*"
+
+REM Build installer
+iscc ..\installer\installer.iss /O. /F"obs-websocket-%PackageVersion%-Windows-Installer"

CI/windows/prepare-obs-windows.cmd

@@ -0,0 +1,37 @@
+
+@echo off
+SETLOCAL EnableDelayedExpansion
+
+REM If obs-studio directory does not exist, clone the git repo
+if not exist %OBS_PATH% (
+    echo obs-studio directory does not exist
+    git clone https://github.com/obsproject/obs-studio %OBS_PATH%
+    cd /D %OBS_PATH%\
+    git describe --tags --abbrev=0 > "%OBS_PATH%\obs-studio-latest-tag.txt"
+    set /p OBS_LATEST_TAG=<"%OBS_PATH%\obs-studio-latest-tag.txt"
+)
+
+REM Prepare OBS Studio builds
+
+echo Running CMake...
+cd /D %OBS_PATH%
+echo   git checkout %OBS_LATEST_TAG%
+git checkout %OBS_LATEST_TAG%
+echo:
+
+if not exist build32 mkdir build32
+if not exist build64 mkdir build64
+
+echo   Running cmake for obs-studio %OBS_LATEST_TAG% 32-bit...
+cd build32
+cmake -G "Visual Studio 16 2019" -A Win32 -DCMAKE_SYSTEM_VERSION=10.0 -DQTDIR="%QTDIR32%" -DDepsPath="%DEPS_PATH_32%" -DDISABLE_PLUGINS=true -DCOPIED_DEPENDENCIES=false -DCOPY_DEPENDENCIES=true ..
+echo:
+echo:
+
+echo   Running cmake for obs-studio %OBS_LATEST_TAG% 64-bit...
+cd ..\build64
+cmake -G "Visual Studio 16 2019" -A x64 -DCMAKE_SYSTEM_VERSION=10.0 -DQTDIR="%QTDIR64%" -DDepsPath="%DEPS_PATH_64%" -DDISABLE_PLUGINS=true -DCOPIED_DEPENDENCIES=false -DCOPY_DEPENDENCIES=true ..
+echo:
+echo:
+
+dir "%OBS_PATH%\libobs"

CI/windows/prepare-plugin-windows.cmd

@@ -0,0 +1,7 @@
+mkdir build32
+mkdir build64
+
+cd build32
+cmake -G "Visual Studio 16 2019" -A Win32 -DCMAKE_SYSTEM_VERSION=10.0 -DQTDIR="%QTDIR32%" -DLibObs_DIR="%OBS_PATH%\build32\libobs" -DLIBOBS_INCLUDE_DIR="%OBS_PATH%\libobs" -DLIBOBS_LIB="%OBS_PATH%\build32\libobs\%build_config%\obs.lib" -DOBS_FRONTEND_LIB="%OBS_PATH%\build32\UI\obs-frontend-api\%build_config%\obs-frontend-api.lib" ..
+cd ..\build64
+cmake -G "Visual Studio 16 2019" -A x64 -DCMAKE_SYSTEM_VERSION=10.0 -DQTDIR="%QTDIR64%" -DLibObs_DIR="%OBS_PATH%\build64\libobs" -DLIBOBS_INCLUDE_DIR="%OBS_PATH%\libobs" -DLIBOBS_LIB="%OBS_PATH%\build64\libobs\%build_config%\obs.lib" -DOBS_FRONTEND_LIB="%OBS_PATH%\build64\UI\obs-frontend-api\%build_config%\obs-frontend-api.lib" ..

CMakeLists.txt

@@ -1,21 +1,18 @@
-cmake_minimum_required(VERSION 3.2)
-project(obs-websocket)
+cmake_minimum_required(VERSION 3.5)
+project(obs-websocket VERSION 4.9.1)
 
 set(CMAKE_PREFIX_PATH "${QTDIR}")
 set(CMAKE_INCLUDE_CURRENT_DIR ON)
 set(CMAKE_AUTOMOC ON)
 set(CMAKE_AUTOUIC ON)
 
-set(CMAKE_CXX_STANDARD 11)
+set(CMAKE_CXX_STANDARD 17)
 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")
+if (${CMAKE_SYSTEM_PROCESSOR} MATCHES "arm") 
+    set(CMAKE_CXX_FLAGS "-mfpu=neon")
 endif()
 
 if (WIN32 OR APPLE)
@@ -23,8 +20,7 @@ if (WIN32 OR APPLE)
 endif()
 
 find_package(LibObs REQUIRED)
-find_package(Qt5Core REQUIRED)
-find_package(Qt5Widgets REQUIRED)
+find_package(Qt5 REQUIRED COMPONENTS Core Widgets)
 
 set(obs-websocket_SOURCES
 	src/obs-websocket.cpp
@@ -40,12 +36,18 @@ set(obs-websocket_SOURCES
 	src/WSRequestHandler_SceneItems.cpp
 	src/WSRequestHandler_Sources.cpp
 	src/WSRequestHandler_Streaming.cpp
+	src/WSRequestHandler_VirtualCam.cpp
 	src/WSRequestHandler_StudioMode.cpp
 	src/WSRequestHandler_Transitions.cpp
 	src/WSRequestHandler_Outputs.cpp
+	src/WSRequestHandler_MediaControl.cpp
 	src/WSEvents.cpp
 	src/Config.cpp
 	src/Utils.cpp
+	src/rpc/RpcRequest.cpp
+	src/rpc/RpcResponse.cpp
+	src/rpc/RpcEvent.cpp
+	src/protocol/OBSRemoteProtocol.cpp
 	src/forms/settings-dialog.cpp)
 
 set(obs-websocket_HEADERS
@@ -56,6 +58,10 @@ set(obs-websocket_HEADERS
 	src/WSEvents.h
 	src/Config.h
 	src/Utils.h
+	src/rpc/RpcRequest.h
+	src/rpc/RpcResponse.h
+	src/rpc/RpcEvent.h
+	src/protocol/OBSRemoteProtocol.h
 	src/forms/settings-dialog.h)
 
 # --- Platform-independent build settings ---
@@ -67,8 +73,8 @@ include_directories(
 	"${LIBOBS_INCLUDE_DIR}/../UI/obs-frontend-api"
 	${Qt5Core_INCLUDES}
 	${Qt5Widgets_INCLUDES}
-	"${CMAKE_SOURCE_DIR}/deps/asio/asio/include"
-	"${CMAKE_SOURCE_DIR}/deps/websocketpp")
+	"${CMAKE_CURRENT_SOURCE_DIR}/deps/asio/asio/include"
+	"${CMAKE_CURRENT_SOURCE_DIR}/deps/websocketpp")
 
 target_link_libraries(obs-websocket
 	libobs
@@ -79,9 +85,14 @@ target_link_libraries(obs-websocket
 
 # --- Windows-specific build settings and tasks ---
 if(WIN32)
-	if(NOT DEFINED OBS_FRONTEND_LIB)
-		set(OBS_FRONTEND_LIB "OBS_FRONTEND_LIB-NOTFOUND" CACHE FILEPATH "OBS frontend library")
-		message(FATAL_ERROR "Could not find OBS Frontend API's library !")
+	set(OBS_FRONTEND_LIB "NOTFOUND" CACHE FILEPATH "OBS frontend library")
+	if(OBS_FRONTEND_LIB STREQUAL "NOTFOUND")
+		message(FATAL_ERROR "OBS Frontend API library not found!")
+	endif()
+
+    if(MSVC)
+        # Enable Multicore Builds and disable FH4 (to not depend on VCRUNTIME140_1.DLL)
+	    add_definitions(/MP /d2FH4-)
     endif()
 
 	add_definitions(-D_WEBSOCKETPP_CPP11_STL_)
@@ -106,57 +117,70 @@ if(WIN32)
 	set(RELEASE_DIR "${PROJECT_SOURCE_DIR}/release")
 
 	add_custom_command(TARGET obs-websocket POST_BUILD
-		# If config is Release, package release files
-		COMMAND if $<CONFIG:Release>==1 (
+		# If config is Release or RelWithDebInfo, package release files
+		COMMAND if $<OR:$<CONFIG:Release>,$<CONFIG:RelWithDebInfo>>==1 (
 			"${CMAKE_COMMAND}" -E make_directory
-			"${RELEASE_DIR}/data/obs-plugins/obs-websocket"
-			"${RELEASE_DIR}/obs-plugins/${ARCH_NAME}")
+			"${RELEASE_DIR}/obs-plugins/${ARCH_NAME}"
+		)
 
-		COMMAND if $<CONFIG:Release>==1 ("${CMAKE_COMMAND}" -E copy_directory
+		COMMAND if $<OR:$<CONFIG:Release>,$<CONFIG:RelWithDebInfo>>==1 (
+			"${CMAKE_COMMAND}" -E copy_directory
 			"${PROJECT_SOURCE_DIR}/data"
-			"${RELEASE_DIR}/data/obs-plugins/obs-websocket")
+			"${RELEASE_DIR}/data/obs-plugins/obs-websocket"
+		)
 
-		COMMAND if $<CONFIG:Release>==1 ("${CMAKE_COMMAND}" -E copy
+		COMMAND if $<OR:$<CONFIG:Release>,$<CONFIG:RelWithDebInfo>>==1 (
+			"${CMAKE_COMMAND}" -E copy
 			"$<TARGET_FILE:obs-websocket>"
-			"${RELEASE_DIR}/obs-plugins/${ARCH_NAME}")
+			"${RELEASE_DIR}/obs-plugins/${ARCH_NAME}"
+		)
 
-		# If config is RelWithDebInfo, package release files
+		# In Release or RelWithDebInfo mode, copy Qt image format plugins
+		COMMAND if $<OR:$<CONFIG:Release>,$<CONFIG:RelWithDebInfo>>==1 (
+			"${CMAKE_COMMAND}" -E make_directory
+			"${RELEASE_DIR}/bin/${ARCH_NAME}/imageformats"
+		)
+		COMMAND if $<OR:$<CONFIG:Release>,$<CONFIG:RelWithDebInfo>>==1 (
+			"${CMAKE_COMMAND}" -E copy
+			"${QTDIR}/plugins/imageformats/qicns.dll"
+			"${QTDIR}/plugins/imageformats/qico.dll"
+			"${QTDIR}/plugins/imageformats/qjpeg.dll"
+			"${QTDIR}/plugins/imageformats/qtiff.dll"
+			"${QTDIR}/plugins/imageformats/qwbmp.dll"
+			"${QTDIR}/plugins/imageformats/qwebp.dll"
+			"${RELEASE_DIR}/bin/${ARCH_NAME}/imageformats"
+		)
+
+		# If config is RelWithDebInfo, package PDB file for target
 		COMMAND if $<CONFIG:RelWithDebInfo>==1 (
-			"${CMAKE_COMMAND}" -E make_directory
-			"${RELEASE_DIR}/data/obs-plugins/obs-websocket"
-			"${RELEASE_DIR}/obs-plugins/${ARCH_NAME}")
-
-		COMMAND if $<CONFIG:RelWithDebInfo>==1 ("${CMAKE_COMMAND}" -E copy_directory
-			"${PROJECT_SOURCE_DIR}/data"
-			"${RELEASE_DIR}/data/obs-plugins/obs-websocket")
-
-		COMMAND if $<CONFIG:RelWithDebInfo>==1 ("${CMAKE_COMMAND}" -E copy
-			"$<TARGET_FILE:obs-websocket>"
-			"${RELEASE_DIR}/obs-plugins/${ARCH_NAME}")
-
-		COMMAND if $<CONFIG:RelWithDebInfo>==1 ("${CMAKE_COMMAND}" -E copy
+			"${CMAKE_COMMAND}" -E copy
 			"$<TARGET_PDB_FILE:obs-websocket>"
-			"${RELEASE_DIR}/obs-plugins/${ARCH_NAME}")
+			"${RELEASE_DIR}/obs-plugins/${ARCH_NAME}"
+		)
 
-		# Copy to obs-studio dev environment for immediate testing
+		# In the Debug configuration, copy to obs-studio dev environment for immediate testing
 		COMMAND if $<CONFIG:Debug>==1 (
 			"${CMAKE_COMMAND}" -E copy
 				"$<TARGET_FILE:obs-websocket>"
-				"${LIBOBS_INCLUDE_DIR}/../${OBS_BUILDDIR_ARCH}/rundir/$<CONFIG>/obs-plugins/${ARCH_NAME}")
+				"${LIBOBS_INCLUDE_DIR}/../${OBS_BUILDDIR_ARCH}/rundir/$<CONFIG>/obs-plugins/${ARCH_NAME}"
+		)
 
 		COMMAND if $<CONFIG:Debug>==1 (
 			"${CMAKE_COMMAND}" -E copy
 			"$<TARGET_PDB_FILE:obs-websocket>"
-				"${LIBOBS_INCLUDE_DIR}/../${OBS_BUILDDIR_ARCH}/rundir/$<CONFIG>/obs-plugins/${ARCH_NAME}")
+			"${LIBOBS_INCLUDE_DIR}/../${OBS_BUILDDIR_ARCH}/rundir/$<CONFIG>/obs-plugins/${ARCH_NAME}"
+		)
 
 		COMMAND if $<CONFIG:Debug>==1 (
 			"${CMAKE_COMMAND}" -E make_directory
-				"${LIBOBS_INCLUDE_DIR}/../${OBS_BUILDDIR_ARCH}/rundir/$<CONFIG>/data/obs-plugins/obs-websocket")
+			"${LIBOBS_INCLUDE_DIR}/../${OBS_BUILDDIR_ARCH}/rundir/$<CONFIG>/data/obs-plugins/obs-websocket"
+		)
 
 		COMMAND if $<CONFIG:Debug>==1 (
 			"${CMAKE_COMMAND}" -E copy_directory
 			"${PROJECT_SOURCE_DIR}/data"
-				"${LIBOBS_INCLUDE_DIR}/../${OBS_BUILDDIR_ARCH}/rundir/$<CONFIG>/data/obs-plugins/obs-websocket")
+			"${LIBOBS_INCLUDE_DIR}/../${OBS_BUILDDIR_ARCH}/rundir/$<CONFIG>/data/obs-plugins/obs-websocket"
+		)
 	)
 	# --- End of sub-section ---
 
@@ -165,20 +189,30 @@ endif()
 
 # --- Linux-specific build settings and tasks ---
 if(UNIX AND NOT APPLE)
+	include(GNUInstallDirs)
+
 	set_target_properties(obs-websocket PROPERTIES PREFIX "")
 	target_link_libraries(obs-websocket obs-frontend-api)
 
 	file(GLOB locale_files data/locale/*.ini)
-	execute_process(COMMAND uname -m COMMAND tr -d '\n' OUTPUT_VARIABLE UNAME_MACHINE)
 
-	install(TARGETS obs-websocket
-		LIBRARY DESTINATION "${CMAKE_INSTALL_PREFIX}/lib/obs-plugins")
-	# Dirty fix for Ubuntu
-        install(TARGETS obs-websocket
-                LIBRARY DESTINATION "${CMAKE_INSTALL_PREFIX}/lib/${UNAME_MACHINE}-linux-gnu/obs-plugins")
+    set(CMAKE_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS
+		OWNER_READ OWNER_WRITE OWNER_EXECUTE
+		GROUP_READ GROUP_WRITE GROUP_EXECUTE
+		WORLD_READ WORLD_EXECUTE
+	)
+
+	if(${USE_UBUNTU_FIX})
+		install(TARGETS obs-websocket LIBRARY
+			DESTINATION "/usr/lib/obs-plugins"
+			PERMISSIONS OWNER_READ OWNER_WRITE GROUP_READ WORLD_READ)
+	endif()
+	install(TARGETS obs-websocket LIBRARY
+		DESTINATION "${CMAKE_INSTALL_FULL_LIBDIR}/obs-plugins"
+		PERMISSIONS OWNER_READ OWNER_WRITE GROUP_READ WORLD_READ)
 
 	install(FILES ${locale_files}
-		DESTINATION "${CMAKE_INSTALL_PREFIX}/share/obs/obs-plugins/obs-websocket/locale")
+		DESTINATION "${CMAKE_INSTALL_FULL_DATAROOTDIR}/obs/obs-plugins/obs-websocket/locale")
 endif()
 # --- End of section ---
 

CONTRIBUTING.md

@@ -0,0 +1,82 @@
+# Contributing to obs-websocket
+
+## Translating obs-websocket to your language
+
+Localization happens on [Crowdin](https://crowdin.com/project/obs-websocket)
+
+## Branches
+
+**Development happens on `4.x-current`**
+
+## Writing code for obs-websocket
+
+### Code Formatting Guidelines
+
+* Function and variable names: snake_case for C names, camelCase for C++ method names
+
+* Request and Event names should use MixedCaps names
+
+* Request and Event json properties should use camelCase. For more detailed info on property naming, see [Google's JSON Style Guide](https://google.github.io/styleguide/jsoncstyleguide.xml)
+
+* Code is indented with Tabs. Assume they are 8 columns wide
+
+* 80 columns max code width. (Docs can be larger)
+
+* New and updated requests/events must always come with accompanying documentation comments (see existing protocol elements for examples).
+These are required to automatically generate the [protocol specification document](docs/generated/protocol.md).
+
+### Code Best-Practices
+
+* 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();
+```
+
+* Some example common response/request property names are:
+    * `sceneName` - The name of a scene
+    * `sourceName` - The name of a source
+    * `fromScene` - From a scene - scene name
+
+### Commit Guidelines
+
+* Commits follow the 50/72 standard:
+    * 50 characters max for the commit title (excluding scope name)
+    * One empty line after the title
+    * Description wrapped to 72 columns max width per line.
+
+* Commit titles:
+    * Use present tense
+    * Prefix the title with a "scope" name
+        * e.g: "CI: fix wrong behaviour when packaging for OS X"
+        * Typical scopes: CI, General, Requests, Events, Server
+
+**Example commit:**
+
+```
+Requests: Add GetTransitionPosition
+
+Adds a new request called `GetTransitionPosition` which gets the current
+transition's state from 0.0f to 1.0f. Works with both auto and manual
+transitions.
+```
+
+### Pull Requests
+
+* Pull Requests must never be based off your fork's main branch (in this case, `4.x-current`).
+    * Start your work in a newly named branch based on the upstream main one (e.g.: `feature/cool-new-feature`, `bugfix/fix-palakis-mistakes`, ...)
+
+* Only open a pull request if you are ready to show off your work.
+
+* If your work is not done yet, but for any reason you need to PR it (like collecting discussions, testing with CI, getting testers),
+    create it as a Draft Pull Request (open the little arrow menu next to the "Create pull request" button, then select "Create draft pull request").

README.md

@@ -1,26 +1,42 @@
-obs-websocket
-==============
+# obs-websocket
+
+<p align="center">
+  <img src="/.github/images/obsws_logo.png" width=150 align="center">
+</p>
 
 WebSockets API for OBS Studio.
 
-Follow the main author on Twitter for news & updates : [@LePalakis](https://twitter.com/LePalakis)
-
-[![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](https://travis-ci.org/Palakis/obs-websocket.svg?branch=master)](https://travis-ci.org/Palakis/obs-websocket)
+[![Build Status](https://dev.azure.com/Palakis/obs-websocket/_apis/build/status/Palakis.obs-websocket?branchName=4.x-current)](https://dev.azure.com/Palakis/obs-websocket/_build/latest?definitionId=2&branchName=4.x-current)
+[![CodeFactor](https://www.codefactor.io/repository/github/palakis/obs-websocket/badge)](https://www.codefactor.io/repository/github/palakis/obs-websocket)
+[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/fold_left.svg?style=social&label=Follow%20%40LePalakis)](https://twitter.com/LePalakis)
+[![Discord](https://img.shields.io/discord/715691013825364120.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/WBaSQ3A)
+[![Financial Contributors on Open Collective](https://opencollective.com/obs-websocket/all/badge.svg?label=financial+contributors)](https://opencollective.com/obs-websocket)
 
 ## Downloads
 
-Binaries for Windows and Linux are available in the [Releases](https://github.com/Palakis/obs-websocket/releases) section.
+Binaries for Windows, MacOS, and Linux are available in the [Releases](https://github.com/Palakis/obs-websocket/releases) section.
+
+### Homebrew
+
+If you're using MacOS you can use Homebrew for installation as well:
+
+```sh
+brew install obs-websocket
+```
 
 ## Using obs-websocket
 
-A web client and frontend made by [t2t2](https://github.com/t2t2/obs-tablet-remote) (compatible with tablets and other touch interfaces) is available here : http://t2t2.github.io/obs-tablet-remote/
+Here is a list of available web clients: (compatible with tablets and other touch interfaces)
+
+- [Niek/obs-web](https://github.com/Niek/obs-web)
+- [t2t2/obs-tablet-remote](https://github.com/t2t2/obs-tablet-remote)
 
 It is **highly recommended** to protect obs-websocket with a password against unauthorized control. To do this, open the "Websocket server settings" dialog under OBS' "Tools" menu. In the settings dialogs, you can enable or disable authentication and set a password for it.
 
 ### Possible use cases
 
 - Remote control OBS from a phone or tablet on the same local network
-- Change your stream overlay/graphics based on the current scene (like the AGDQ overlay does)
+- Change your stream overlay/graphics based on the current scene
 - Automate scene switching with a third-party program (e.g. : auto-pilot, foot pedal, ...)
 
 ### For developers
@@ -33,9 +49,22 @@ Here's a list of available language APIs for obs-websocket :
 - C#/VB.NET: [obs-websocket-dotnet](https://github.com/Palakis/obs-websocket-dotnet)
 - 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
+- Python 3.6+ with asyncio: [simpleobsws](https://github.com/IRLToolkit/simpleobsws) by tt2468
 - Java 8+: [obs-websocket-java](https://github.com/Twasi/websocket-obs-java) by TwasiNET
+- Java 11+: [obs-java-client](https://github.com/harm27/obs-java-client) by harm27
+- Golang: [go-obs-websocket](https://github.com/christopher-dG/go-obs-websocket) by Chris de Graaf
+- Rust: [obws](https://github.com/dnaka91/obws) by dnaka91
+- Dart: [obs_websocket](https://pub.dev/packages/obs_websocket) by faithoflifedev
+- HTTP API: [obs-websocket-http](https://github.com/IRLToolkit/obs-websocket-http) by tt2468
+- CLI: [obs-cli](https://github.com/leafac/obs-cli) by leafac
 
-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` !
+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 a message in `#project-showoff` in the [discord server!](https://discord.gg/WBaSQ3A)
+
+### Securing obs-websocket (via TLS/SSL)
+
+If you are intending to use obs-websocket outside of a LAN environment, it is highly recommended to secure the connection using a tunneling service.
+
+See the SSL [tunnelling guide](SSL-TUNNELLING.md) for easy instructions on how to encrypt your websocket connection.
 
 ## Compiling obs-websocket
 
@@ -43,85 +72,23 @@ 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 required to automatically generate the [protocol specification document](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();
-```
-
+See [the contributing document](/CONTRIBUTING.md)
 
 ## Translations
 
-**Your help is welcome 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 (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): Initial German localization
-- [Genture](https://github.com/Genteure): Initial Simplified Chinese and Traditional Chinese localizations
-- [Larissa Gabilan](https://github.com/laris151): Initial Portuguese localization
-- [Andy Asquelt](https://github.com/asquelt): Initial Polish 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
-- [Guillaume "Elektordi" Genty](https://github.com/Elektordi): Code contributions
-- [Marwin M](https://github.com/dragonbane0): Code contributions
-- [Logan S.](https://github.com/lsdaniel): Code contributions
-- [RainbowEK](https://github.com/RainbowEK): Code contributions
-- [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
+Thank you so much to all of the contibutors [(here)](https://github.com/Palakis/obs-websocket/graphs/contributors) for your amazing help.
 
 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!
+These supporters have contributed financially to the project and made possible the addition of several features into obs-websocket. Many thanks to them!
 
 ---
 
@@ -134,3 +101,33 @@ They have contributed financially to the project and made possible the addition
 [MediaUnit](http://www.mediaunit.no) is a Norwegian media company developing products and services for the media industry, primarly focused on web and events.
 
 [![MediaUnit](.github/images/mediaunit_logo_black.png)](http://www.mediaunit.no/)
+
+## Contributors
+
+### Code Contributors
+
+This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
+<a href="https://github.com/Palakis/obs-websocket/graphs/contributors"><img src="https://opencollective.com/obs-websocket/contributors.svg?width=890&button=false" /></a>
+
+### Financial Contributors
+
+Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/obs-websocket/contribute)]
+
+#### Individuals
+
+<a href="https://opencollective.com/obs-websocket"><img src="https://opencollective.com/obs-websocket/individuals.svg?width=890"></a>
+
+#### Organizations
+
+Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/obs-websocket/contribute)]
+
+<a href="https://opencollective.com/obs-websocket/organization/0/website"><img src="https://opencollective.com/obs-websocket/organization/0/avatar.svg"></a>
+<a href="https://opencollective.com/obs-websocket/organization/1/website"><img src="https://opencollective.com/obs-websocket/organization/1/avatar.svg"></a>
+<a href="https://opencollective.com/obs-websocket/organization/2/website"><img src="https://opencollective.com/obs-websocket/organization/2/avatar.svg"></a>
+<a href="https://opencollective.com/obs-websocket/organization/3/website"><img src="https://opencollective.com/obs-websocket/organization/3/avatar.svg"></a>
+<a href="https://opencollective.com/obs-websocket/organization/4/website"><img src="https://opencollective.com/obs-websocket/organization/4/avatar.svg"></a>
+<a href="https://opencollective.com/obs-websocket/organization/5/website"><img src="https://opencollective.com/obs-websocket/organization/5/avatar.svg"></a>
+<a href="https://opencollective.com/obs-websocket/organization/6/website"><img src="https://opencollective.com/obs-websocket/organization/6/avatar.svg"></a>
+<a href="https://opencollective.com/obs-websocket/organization/7/website"><img src="https://opencollective.com/obs-websocket/organization/7/avatar.svg"></a>
+<a href="https://opencollective.com/obs-websocket/organization/8/website"><img src="https://opencollective.com/obs-websocket/organization/8/avatar.svg"></a>
+<a href="https://opencollective.com/obs-websocket/organization/9/website"><img src="https://opencollective.com/obs-websocket/organization/9/avatar.svg"></a>

SSL-TUNNELLING.md

@@ -0,0 +1,45 @@
+# Connecting over a TLS/secure connection (or remotely)
+
+If you want to expose the WebSocket server of obs-websocket over a secure TLS connection (or to connect remotely), the easiest approach is to use a localhost tunneling service like [ngrok](https://ngrok.com/) or [pagekite](https://pagekite.net/).
+
+**Before doing this, secure the WebSocket server first by enabling authentication with a strong password!**
+
+**Please bear in mind that doing this will expose your OBS instance to the open Internet and the security risks it implies. *You've been warned!***
+
+
+## ngrok
+
+[Install the ngrok CLI tool](https://ngrok.com/download) on a linux OS, then start ngrok bound to port 4444 like this:
+
+```bash
+ngrok http 4444
+```
+
+The ngrok command will output something like this:
+
+```text
+ngrok by @inconshreveable
+
+Tunnel Status                 online
+Version                       2.0/2.0
+Web Interface                 http://127.0.0.1:4040
+Forwarding                    http://TUNNEL_ID.ngrok.io -> localhost:4444
+Forwarding                    https://TUNNEL_ID.ngrok.io -> localhost:4444
+```
+
+Where `TUNNEL_ID` is, as the name implies, the unique name of your ngrok tunnel. You'll get a new one every time you start ngrok.
+
+Then, use `wss://TUNNEL_ID.ngrok.io` to connect to obs-websocket over TLS.
+
+See the [ngrok documentation](https://ngrok.com/docs) for more tunneling options and settings.
+
+
+## PageKite
+
+[Install the PageKite CLI tool](http://pagekite.net/downloads), then start PageKite bound to port 4444 like this (replace NAME with one of your choosing):
+
+```bash
+python pagekite.py 4444 NAME.pagekite.me
+```
+
+Then, use `wss://NAME.pagekite.me` to connect to obs-websocket over TLS.

appveyor.yml

@@ -1,40 +0,0 @@
-environment:
-  CURL_VERSION: 7.39.0
-
-install:
-  - git submodule update --init --recursive
-  - cd C:\projects\
-  - if not exist dependencies2015.zip curl -kLO https://obsproject.com/downloads/dependencies2015.zip -f --retry 5 -C -
-  - 7z x dependencies2015.zip -odependencies2015
-  - set DepsPath32=%CD%\dependencies2015\win32
-  - set DepsPath64=%CD%\dependencies2015\win64
-  - call C:\projects\obs-websocket\CI\install-setup-qt.cmd
-  - set build_config=RelWithDebInfo
-  - call C:\projects\obs-websocket\CI\install-build-obs.cmd
-  - cd C:\projects\obs-websocket\
-  - mkdir build32
-  - mkdir build64
-  - cd ./build32
-  - cmake -G "Visual Studio 14 2015" -DQTDIR="%QTDIR32%" -DLibObs_DIR="C:\projects\obs-studio\build32\libobs" -DLIBOBS_INCLUDE_DIR="C:\projects\obs-studio\libobs" -DLIBOBS_LIB="C:\projects\obs-studio\build32\libobs\%build_config%\obs.lib" -DOBS_FRONTEND_LIB="C:\projects\obs-studio\build32\UI\obs-frontend-api\%build_config%\obs-frontend-api.lib" ..
-  - cd ../build64
-  - cmake -G "Visual Studio 14 2015 Win64" -DQTDIR="%QTDIR64%" -DLibObs_DIR="C:\projects\obs-studio\build64\libobs" -DLIBOBS_INCLUDE_DIR="C:\projects\obs-studio\libobs" -DLIBOBS_LIB="C:\projects\obs-studio\build64\libobs\%build_config%\obs.lib" -DOBS_FRONTEND_LIB="C:\projects\obs-studio\build64\UI\obs-frontend-api\%build_config%\obs-frontend-api.lib" ..
-
-build_script:
-  - call msbuild /m /p:Configuration=%build_config% C:\projects\obs-websocket\build32\obs-websocket.sln /logger:"C:\Program Files\AppVeyor\BuildAgent\Appveyor.MSBuildLogger.dll"
-  - call msbuild /m /p:Configuration=%build_config% C:\projects\obs-websocket\build64\obs-websocket.sln /logger:"C:\Program Files\AppVeyor\BuildAgent\Appveyor.MSBuildLogger.dll"
-
-before_deploy:
-  - 7z a "C:\projects\obs-websocket\build.zip" C:\projects\obs-websocket\release\*
-  - set PATH=%PATH%;"C:\\Program Files (x86)\\Inno Setup 5"
-  - iscc "C:\projects\obs-websocket\installer\installer.iss"
-
-deploy_script:
-  - ps: Push-AppveyorArtifact "C:\projects\obs-websocket\build.zip" -FileName "obs-websocket-$(git log --pretty=format:'%h' -n 1)-Windows.zip"
-  - ps: Push-AppveyorArtifact "C:\projects\obs-websocket\installer\Output\obs-websocket-Windows-Installer.exe" -FileName "obs-websocket-$(git log --pretty=format:'%h' -n 1)-Windows-Installer.exe"
-
-test: off
-
-cache:
-  - C:\projects\dependencies2015.zip
-  - C:\projects\obs-studio-last-tag-built.txt
-  - C:\projects\obs-studio\

azure-pipelines.yml

@@ -1,23 +1,199 @@
-pool:
-  vmImage: 'macOS-10.13'
+variables:
+  isReleaseMode: ${{ startsWith(variables['Build.SourceBranch'], 'refs/tags/') }}
 
+trigger:
+  branches:
+    include:
+      - '4.x-current'
+  tags:
+    include:
+      - '*'
+
+jobs:
+- job: 'GenerateDocs'
+  condition: |
+    or(
+      eq(variables['Build.SourceBranch'], 'refs/heads/4.x-current'),
+      eq(variables['Build.SourceBranch'], 'refs/heads/master')
+    )
+  pool:
+    vmImage: 'ubuntu-18.04'
+  steps:
+    - checkout: self
+      submodules: false
+
+    - script: ./CI/generate-docs.sh
+      displayName: 'Generate docs'
+      env:
+        CHECKOUT_REF: $(Build.SourceBranch)
+        GH_TOKEN: $(GithubToken)
+
+- job: 'Build_Windows'
+  pool:
+    vmImage: 'windows-2019'
+  variables:
+    build_config: RelWithDebInfo
+    DEPS_CACHE_VERSION: '1' # Change whenever updating OBS dependencies URL, in order to force a cache reset
+    DEPS_BASE_PATH: 'D:\obsdependencies'
+    DEPS_PATH_32: '$(DEPS_BASE_PATH)\win32'
+    DEPS_PATH_64: '$(DEPS_BASE_PATH)\win64'
+    QT_CACHE_VERSION: '1' # Change whenever updating Qt dependency URL, in order to force a cache reset
+    QT_BASE_DIR: 'D:\QtDep'
+    QTDIR32: '$(QT_BASE_DIR)\5.15.2\msvc2019'
+    QTDIR64: '$(QT_BASE_DIR)\5.15.2\msvc2019_64'
+    OBS_CACHE_VERSION: '1'
+    OBS_PATH: 'D:\obs-studio'
   steps:
     - checkout: self
       submodules: true
 
-- script: ./CI/install-dependencies-macos.sh
-  displayName: 'Install Dependencies'
+    - task: Cache@2
+      displayName: Restore cached Qt archive file
+      inputs:
+        key: 'qtdep-"$(QT_CACHE_VERSION)" | "$(Agent.OS)"'
+        restoreKeys: |
+          qtdep-"$(QT_CACHE_VERSION)" | "$(Agent.OS)"
+        path: $(QT_BASE_DIR)
 
-- script: ./CI/install-build-obs-macos.sh
-  displayName: 'Build OBS'
+    - script: ./CI/windows/install-qt-win.cmd
+      displayName: 'Install Qt'
+      env:
+        QT_BASE_DIR: $(QT_BASE_DIR)
 
-- script: ./CI/build-macos.sh
+    - task: Cache@2
+      displayName: Restore cached OBS Studio dependencies
+      inputs:
+        key: 'obsdeps-"$(DEPS_CACHE_VERSION)" | "$(Agent.OS)"'
+        restoreKeys: |
+          obsdeps-"$(DEPS_CACHE_VERSION)" | "$(Agent.OS)"
+        path: $(DEPS_BASE_PATH)
+
+    - script: ./CI/windows/download-obs-deps.cmd
+      displayName: 'Download OBS Studio dependencies'
+
+    - task: Cache@2
+      displayName: Restore cached OBS Studio builds
+      inputs:
+        key: 'obs-"$(OBS_CACHE_VERSION)" | "$(Agent.OS)"'
+        restoreKeys: |
+          obs-"$(OBS_CACHE_VERSION)" | "$(Agent.OS)"
+        path: $(OBS_PATH)
+
+    - script: ./CI/windows/prepare-obs-windows.cmd
+      displayName: 'Checkout & CMake OBS Studio'
+      env:
+        build_config: $(build_config)
+        DEPS_PATH_32: $(DEPS_PATH_32)
+        DEPS_PATH_64: $(DEPS_PATH_64)
+        QTDIR32: $(QTDIR32)
+        QTDIR64: $(QTDIR64)
+        OBS_PATH: $(OBS_PATH)
+
+    - task: MSBuild@1
+      displayName: 'Build OBS Studio 32-bit'
+      inputs:
+        msbuildArguments: '/m /p:Configuration=$(build_config)'
+        solution: '$(OBS_PATH)\build32\obs-studio.sln'
+
+    - task: MSBuild@1
+      displayName: 'Build OBS Studio 64-bit'
+      inputs:
+        msbuildArguments: '/m /p:Configuration=$(build_config)'
+        solution: '$(OBS_PATH)\build64\obs-studio.sln'
+
+    - script: ./CI/windows/prepare-plugin-windows.cmd
+      displayName: 'CMake obs-websocket'
+      env:
+        build_config: $(build_config)
+        QTDIR32: $(QTDIR32)
+        QTDIR64: $(QTDIR64)
+        OBS_PATH: $(OBS_PATH)
+
+    - task: MSBuild@1
+      displayName: 'Build obs-websocket 32-bit'
+      inputs:
+        msbuildArguments: '/m /p:Configuration=$(build_config)'
+        solution: '.\build32\obs-websocket.sln'
+
+    - task: MSBuild@1
+      displayName: 'Build obs-websocket 64-bit'
+      inputs:
+        msbuildArguments: '/m /p:Configuration=$(build_config)'
+        solution: '.\build64\obs-websocket.sln'
+
+    - script: ./CI/windows/package-plugin-windows.cmd
+      displayName: 'Package obs-websocket'
+
+    - task: PublishBuildArtifacts@1
+      displayName: 'Upload package artifacts'
+      inputs:
+        pathtoPublish: './package'
+        artifactName: 'windows_build'
+
+- job: 'Build_Linux'
+  pool:
+    vmImage: 'ubuntu-20.04'
+  variables:
+      BRANCH_SHORT_NAME: $(Build.SourceBranchName)
+      BRANCH_FULL_NAME: $(Build.SourceBranch)
+  steps:
+    - checkout: self
+      submodules: true
+
+    - script: ./CI/linux/install-dependencies-ubuntu.sh
+      displayName: 'Install dependencies'
+
+    - script: ./CI/linux/build-plugin-ubuntu.sh
       displayName: 'Build obs-websocket'
 
-- script: ./CI/package-macos.sh
-  displayName: 'Package'
+    - script: ./CI/linux/package-plugin-ubuntu.sh
+      displayName: 'Package obs-websocket'
+
+    - task: PublishBuildArtifacts@1
+      inputs:
+        pathtoPublish: './package'
+        artifactName: 'deb_build'
+
+- job: 'Build_macOS'
+  pool:
+    vmImage: 'macOS-10.15'
+  variables:
+    OBS_DEPS_VERSION: '2020-12-22'
+    QT_VERSION: '5.15.2'
+  steps:
+    - checkout: self
+      submodules: true
+
+    - script: ./CI/macos/install-dependencies-macos.sh
+      displayName: 'Install dependencies'
+      env:
+        OBS_DEPS_VERSION: $(OBS_DEPS_VERSION)
+        QT_VERSION: $(QT_VERSION)
+
+    - script: ./CI/macos/install-build-obs-macos.sh
+      displayName: 'Build OBS'
+
+    - script: ./CI/macos/build-plugin-macos.sh
+      displayName: 'Build obs-websocket'
+
+    - task: InstallAppleCertificate@2
+      displayName: 'Install release signing certificates'
+      condition: eq(variables['isReleaseMode'], true)
+      inputs:
+        certSecureFile: 'Certificates.p12'
+        certPwd: $(secrets.macOS.certificatesImportPassword)
+
+    - script: ./CI/macos/package-plugin-macos.sh
+      displayName: 'Package obs-websocket'
+      env:
+        RELEASE_MODE: $(isReleaseMode)
+        CODE_SIGNING_IDENTITY: $(secrets.macOS.codeSigningIdentity)
+        INSTALLER_SIGNING_IDENTITY: $(secrets.macOS.installerSigningIdentity)
+        AC_USERNAME: $(secrets.macOS.notarization.username)
+        AC_PASSWORD: $(secrets.macOS.notarization.password)
+        AC_PROVIDER_SHORTNAME: $(secrets.macOS.notarization.providerShortName)
 
     - task: PublishBuildArtifacts@1
       inputs:
         pathtoPublish: './release'
-    artifactName: 'build'
+        artifactName: 'macos_build'

data/locale/ar-SA.ini

@@ -0,0 +1 @@
+

data/locale/de-DE.ini

@@ -3,6 +3,7 @@ OBSWebsocket.Settings.ServerEnable="WebSockets-Server aktivieren"
 OBSWebsocket.Settings.ServerPort="Server-Port"
 OBSWebsocket.Settings.AuthRequired="Authentifizierung aktivieren"
 OBSWebsocket.Settings.Password="Passwort"
+OBSWebsocket.Settings.LockToIPv4="Nur IPv4 verwenden (deaktiviert IPv6)"
 OBSWebsocket.Settings.DebugEnable="Debug-Protokollierung aktivieren"
 OBSWebsocket.Settings.AlertsEnable="Infobereichbenachrichtigungen aktivieren"
 OBSWebsocket.NotifyConnect.Title="Neue Websocket-Verbindung"
@@ -10,7 +11,8 @@ OBSWebsocket.NotifyConnect.Message="Client %1 verbunden"
 OBSWebsocket.NotifyDisconnect.Title="Websocket-Client getrennt"
 OBSWebsocket.NotifyDisconnect.Message="Client %1 getrennt"
 OBSWebsocket.Server.StartFailed.Title="Websocket-Serverfehler"
-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.Server.StartFailed.Message="Der WebSocket-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 - Fehler: %2"
 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

@@ -3,14 +3,19 @@ OBSWebsocket.Settings.ServerEnable="Enable WebSockets server"
 OBSWebsocket.Settings.ServerPort="Server Port"
 OBSWebsocket.Settings.AuthRequired="Enable authentication"
 OBSWebsocket.Settings.Password="Password"
+OBSWebsocket.Settings.LockToIPv4="Lock server to only using IPv4"
 OBSWebsocket.Settings.DebugEnable="Enable debug logging"
 OBSWebsocket.Settings.AlertsEnable="Enable System Tray Alerts"
+OBSWebsocket.Settings.AuthDisabledWarning="Running obs-websocket with authentication disabled is not recommended, as it allows attackers to easily collect sensetive data. Are you sure you want to proceed?"
 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="WebSockets Server failure"
-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.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 - Error message: %2"
 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."
+OBSWebsocket.InitialPasswordSetup.Title="obs-websocket - Server Password Configuration"
+OBSWebsocket.InitialPasswordSetup.Text="It looks like you are running obs-websocket for the first time. Do you want to configure a password now for the WebSockets server? Setting a password is highly recommended."
+OBSWebsocket.InitialPasswordSetup.DismissedText="You can configure a server password later in the WebSockets Server Settings. (Under the Tools menu of OBS Studio)"

data/locale/es-ES.ini

@@ -1,3 +1,4 @@
+OBSWebsocket.Settings.DialogTitle="Configuración del servidor WebSocket"
 OBSWebsocket.Settings.ServerEnable="Habilitar el servidor WebSockets"
 OBSWebsocket.Settings.ServerPort="Puerto del Servidor"
 OBSWebsocket.Settings.AuthRequired="Habilitar autenticación"
@@ -9,4 +10,7 @@ OBSWebsocket.NotifyConnect.Message="Cliente %1 conectado"
 OBSWebsocket.NotifyDisconnect.Title="Cliente WebSocket desconectado"
 OBSWebsocket.NotifyDisconnect.Message="Cliente %1 desconectado"
 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 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."
+OBSWebsocket.ProfileChanged.Started="El servidor WebSocket esta habilitado en este perfil. El servidor ha iniciado."
+OBSWebsocket.ProfileChanged.Stopped="Servidor WebSockets deshabilitado en este perfil. Servidor detenido."
+OBSWebsocket.ProfileChanged.Restarted="Puerto del servidor WebSockets cambiado en este perfil. Servidor reiniciado."
+

data/locale/fr-FR.ini

@@ -10,7 +10,7 @@ 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 WebSockets"
-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/hi-IN.ini

@@ -0,0 +1 @@
+

data/locale/it-IT.ini

@@ -1,7 +1,9 @@
+OBSWebsocket.Settings.DialogTitle="Impostazioni del server di WebSocket"
 OBSWebsocket.Settings.ServerEnable="Abilitare il server WebSockets"
 OBSWebsocket.Settings.ServerPort="Porta del server"
 OBSWebsocket.Settings.AuthRequired="Abilitare l'autenticazione"
 OBSWebsocket.Settings.Password="Password"
+OBSWebsocket.Settings.LockToIPv4="Blocca il server per usare solo IPv4"
 OBSWebsocket.Settings.DebugEnable="Attivare la registrazione di debug"
 OBSWebsocket.Settings.AlertsEnable="Attivare gli avvisi di vassoio di sistema"
 OBSWebsocket.NotifyConnect.Title="Nuova connessione WebSocket"
@@ -9,4 +11,8 @@ 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 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."
+OBSWebsocket.Server.StartFailed.Message="L'avvio del server WebSockets è fallito, forse perché:\n - La porta TCP %1 può attualmente essere in uso altrove su questo sistema, forse da un'altra applicazione. Provare a impostare una porta TCP diversa nelle impostazioni del server WebSocket o interrompere qualsiasi applicazione che potrebbe utilizzare questa porta.\n - Messaggio di errore: %2"
+OBSWebsocket.ProfileChanged.Started="Server WebSockets abilitato in questo profilo. Il server è avviato."
+OBSWebsocket.ProfileChanged.Stopped="Server WebSocket disabilitato in questo profilo. Server interrotto."
+OBSWebsocket.ProfileChanged.Restarted="La porta del server WebSocket è stata modificata in questo profilo. Il server è stato riavviato."
+

data/locale/ja-JP.ini

@@ -1,3 +1,4 @@
+OBSWebsocket.Settings.DialogTitle="Websocket サーバー設定"
 OBSWebsocket.Settings.ServerEnable="WebSockets サーバーを有効にする"
 OBSWebsocket.Settings.ServerPort="サーバーポート"
 OBSWebsocket.Settings.AuthRequired="認証を有効にする"
@@ -9,3 +10,7 @@ OBSWebsocket.NotifyConnect.Message="接続されているクライアント %1"
 OBSWebsocket.NotifyDisconnect.Title="WebSocket クライアントが切断されました"
 OBSWebsocket.NotifyDisconnect.Message="切断されたクライアント %1"
 OBSWebsocket.Server.StartFailed.Title="WebSockets サーバー障害"
+OBSWebsocket.ProfileChanged.Started="このプロファイルでWebSocketサーバが有効になりました。サーバを起動しました。"
+OBSWebsocket.ProfileChanged.Stopped="このプロファイルでWebSocketサーバが無効になりました。サーバを停止しました。"
+OBSWebsocket.ProfileChanged.Restarted="このプロファイルでWebSocketサーバの通信ポートが変更されました。サーバを再起動しました。"
+

data/locale/ko-KR.ini

@@ -0,0 +1,18 @@
+OBSWebsocket.Settings.DialogTitle="웹소켓 서버 설정"
+OBSWebsocket.Settings.ServerEnable="웹소켓 서버 활성화"
+OBSWebsocket.Settings.ServerPort="서버 포트"
+OBSWebsocket.Settings.AuthRequired="인증 활성화"
+OBSWebsocket.Settings.Password="비밀번호"
+OBSWebsocket.Settings.LockToIPv4="IPv4만 이용하여 서버를 연결"
+OBSWebsocket.Settings.DebugEnable="디버그 로깅 활성화"
+OBSWebsocket.Settings.AlertsEnable="시스템 트레이 알림 활성화"
+OBSWebsocket.NotifyConnect.Title="새로운 웹소켓 연결"
+OBSWebsocket.NotifyConnect.Message="클라이언트 %1 가 연결되었습니다"
+OBSWebsocket.NotifyDisconnect.Title="웹소켓 클라이언트가 연결 해제되었습니다"
+OBSWebsocket.NotifyDisconnect.Message="클라이언트 %1 가 연결이 해제되었습니다"
+OBSWebsocket.Server.StartFailed.Title="웹소켓 서버 시작이 실패하였습니다"
+OBSWebsocket.Server.StartFailed.Message="웹소켓 서버가 시작되지 못했습니다. \n 시스템 상의 다른 프로그램이 TCP 포트 %1을 사용 중인 것으로 보입니다. 다른 TCP 포트를 사용하거나, 해당 포트를 사용 중인 프로그램을 종료하고 다시 시도해주세요. \n 에러 메시지: %2"
+OBSWebsocket.ProfileChanged.Started="프로파일 설정에 따라 웹소켓 서버가 활성화되었습니다. 서버가 시작되었습니다."
+OBSWebsocket.ProfileChanged.Stopped="프로파일 설정에 따라 웹소켓 서버가 비활성화되었습니다. 서버가 중지되었습니다."
+OBSWebsocket.ProfileChanged.Restarted="프로파일 설정에 따라 웹소켓 포트가 변경되었습니다. 서버가 재시작되었습니다."
+

data/locale/nl-NL.ini

@@ -1,4 +1,9 @@
+OBSWebsocket.Settings.DialogTitle="WebSockets Server Instellingen"
+OBSWebsocket.Settings.ServerEnable="WebSockets server inschakelen"
 OBSWebsocket.Settings.ServerPort="Serverpoort"
+OBSWebsocket.Settings.AuthRequired="Verificatie inschakelen"
+OBSWebsocket.Settings.Password="Wachtwoord"
+OBSWebsocket.Settings.LockToIPv4="Server vergrendelen om alleen IPv4 te gebruiken"
 OBSWebsocket.Settings.DebugEnable="Activeer debug logs"
 OBSWebsocket.Settings.AlertsEnable="Systemvak waarschuwingen inschakelen"
 OBSWebsocket.NotifyConnect.Title="Nieuwe WebSocket verbinding"
@@ -7,3 +12,7 @@ OBSWebsocket.NotifyDisconnect.Title="WebSocket client connectie verbroken"
 OBSWebsocket.NotifyDisconnect.Message="Client %1 losgekoppeld"
 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 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."
+OBSWebsocket.ProfileChanged.Started="WebSockets server ingeschakeld in dit profiel. Server gestart."
+OBSWebsocket.ProfileChanged.Stopped="WebSockets server uitgeschakeld in dit profiel. Server is gestopt."
+OBSWebsocket.ProfileChanged.Restarted="WebSockets server poort is veranderd in dit profiel. Server is herstart."
+

data/locale/pl-PL.ini

@@ -1,5 +1,9 @@
+OBSWebsocket.Settings.DialogTitle="Ustawienia serwera WebSockets"
 OBSWebsocket.Settings.ServerEnable="Włącz serwer WebSockets"
+OBSWebsocket.Settings.ServerPort="Port serwera"
 OBSWebsocket.Settings.AuthRequired="Wymagaj uwierzytelniania"
+OBSWebsocket.Settings.Password="Hasło"
+OBSWebsocket.Settings.LockToIPv4="Zablokuj serwer tylko za pomocą IPv4"
 OBSWebsocket.Settings.DebugEnable="Włącz rejestrowanie debugowania"
 OBSWebsocket.Settings.AlertsEnable="Włącz powiadomienia w zasobniku systemowym"
 OBSWebsocket.NotifyConnect.Title="Nowe połączenie WebSocket"
@@ -7,4 +11,5 @@ OBSWebsocket.NotifyConnect.Message="Klient %1 połączony"
 OBSWebsocket.NotifyDisconnect.Title="Klient WebSocket odłączony"
 OBSWebsocket.NotifyDisconnect.Message="Klient %1 rozłączony"
 OBSWebsocket.Server.StartFailed.Title="Awaria serwera WebSockets"
-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."
+OBSWebsocket.ProfileChanged.Started="Serwer WebSockets włączony w tym profilu. Serwer uruchomiony."
+

data/locale/pt-PT.ini

@@ -1,7 +1,9 @@
+OBSWebsocket.Settings.DialogTitle="Configurações do servidor de WebSockets"
 OBSWebsocket.Settings.ServerEnable="Habilitar servidor de WebSockets"
 OBSWebsocket.Settings.ServerPort="Porta do Servidor"
 OBSWebsocket.Settings.AuthRequired="Activar autenticação"
 OBSWebsocket.Settings.Password="Palavra passe"
+OBSWebsocket.Settings.LockToIPv4="Forçar apenas o uso de IPv4 (desabilitar IPv6)"
 OBSWebsocket.Settings.DebugEnable="Habilitar registro de debug"
 OBSWebsocket.Settings.AlertsEnable="Ativar Alertas da bandeja do sistema"
 OBSWebsocket.NotifyConnect.Title="Nova conexão WebSocket"
@@ -9,4 +11,8 @@ 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 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."
+OBSWebsocket.Server.StartFailed.Message="O servidor de WebSockets falhou ao iniciar, possivelmente porque:\n - A porta TCP %1 pode já estar em uso em algum outro lugar neste sistema, possivelmente por outro aplicativo. Tente definir uma porta TCP diferente nas configurações do servidor de WebSockets, ou pare qualquer aplicativo que possa estar usando essa porta.\n - Mensagem de erro: %2"
+OBSWebsocket.ProfileChanged.Started="Servidor de WebSockets habilitado nesse perfil. Servidor iniciado."
+OBSWebsocket.ProfileChanged.Stopped="Servidor de WebSockets desabilitado nesse perfil. Servidor parado."
+OBSWebsocket.ProfileChanged.Restarted="Porta do servidor de WebSockets foi alterada neste perfil. Servidor reiniciado."
+

data/locale/ru-RU.ini

@@ -3,6 +3,7 @@ OBSWebsocket.Settings.ServerEnable="Включить сервер WebSockets"
 OBSWebsocket.Settings.ServerPort="Порт сервера"
 OBSWebsocket.Settings.AuthRequired="Включить авторизацию"
 OBSWebsocket.Settings.Password="Пароль"
+OBSWebsocket.Settings.LockToIPv4="Блокировка сервера только с использованием IPv4"
 OBSWebsocket.Settings.DebugEnable="Включить ведение журнала отладки"
 OBSWebsocket.Settings.AlertsEnable="Включить оповещения в системном трее"
 OBSWebsocket.NotifyConnect.Title="Новое соединение WebSocket"
@@ -10,4 +11,8 @@ 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 занят другим приложением в системе. Попробуйте задать другой TCP-порт в настройках сервера WebSockets или закройте приложение, которое может использовать данный порт.\n - Произошла неизвестная сетевая ошибка в системе. Попробуйте снова после изменения настроек, перезапуска OBS или системы."
+OBSWebsocket.Server.StartFailed.Message="Сервер WebSockets не запустился, возможно, потому, что:\n-TCP-порт %1 в настоящее время может использоваться в другом месте этой системы, возможно, другим приложением. Попробуйте установить другой TCP-порт в настройках сервера WebSocket или остановить любое приложение, которое может использовать этот порт.\n-сообщение об ошибке: %2"
+OBSWebsocket.ProfileChanged.Started="Сервер WebSockets включен в этом профиле. Сервер запущен."
+OBSWebsocket.ProfileChanged.Stopped="Сервер WebSockets отключен в этом профиле. Сервер остановлен."
+OBSWebsocket.ProfileChanged.Restarted="Порт сервера WebSockets изменен в этом профиле. Сервер перезапущен."
+

data/locale/zh-CN.ini

@@ -1,3 +1,4 @@
+OBSWebsocket.Settings.DialogTitle="WebSockets 服务器设置"
 OBSWebsocket.Settings.ServerEnable="启用 WebSockets 服务器"
 OBSWebsocket.Settings.ServerPort="服务器端口"
 OBSWebsocket.Settings.AuthRequired="启用身份验证"
@@ -9,4 +10,7 @@ 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 或重新启动系统。"
+OBSWebsocket.ProfileChanged.Started="此配置文件中启用了 WebSockets 服务器。服务器已启动。"
+OBSWebsocket.ProfileChanged.Stopped="此配置文件中禁用了 WebSockets 服务器。服务器已停止。"
+OBSWebsocket.ProfileChanged.Restarted="此配置文件中的 WebSockets 服务器端口已更改。服务器已重新启动。"
+

data/locale/zh-TW.ini

@@ -6,4 +6,4 @@ OBSWebsocket.NotifyConnect.Message="客戶端 %1 已連線"
 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/partials/introduction.md

@@ -1,10 +1,12 @@
-# obs-websocket 4.7.0 protocol reference
+# obs-websocket 4.9.1 protocol reference
 
 # General Introduction
 Messages are exchanged between the client and the server as JSON objects.
-This protocol is based on the original OBS Remote protocol created by Bill Hamilton, with new commands specific to OBS Studio.
+This protocol is based on the original OBS Remote protocol created by Bill Hamilton, with new commands specific to OBS Studio. As of v5.0.0, backwards compatability with the protocol will not be kept.
 
 # Authentication
+**Starting with obs-websocket 4.9, authentication is enabled by default and users are encouraged to configure a password on first run.**
+
 `obs-websocket` uses SHA256 to transmit credentials.
 
 A request for [`GetAuthRequired`](#getauthrequired) returns two elements:
@@ -32,3 +34,5 @@ auth_response_string = secret + challenge
 auth_response_hash = binary_sha256(auth_response_string)
 auth_response = base64_encode(auth_response_hash)
 ```
+
+You can also refer to any of the [client libraries](https://github.com/Palakis/obs-websocket#for-developers) listed on the README for examples of how to authenticate.

docs/partials/requestsHeader.md

@@ -6,6 +6,6 @@ Requests are sent by the client and require at least the following two fields:
 Once a request is sent, the server will return a JSON response with at least the following fields:
 - `message-id` _String_: The client defined identifier specified in the request.
 - `status` _String_: Response status, will be one of the following: `ok`, `error`
-- `error` _String_: An error message accompanying an `error` status.
+- `error` _String (Optional)_: An error message accompanying an `error` status.
 
 Additional information may be required/returned depending on the request type. See below for more information.

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.7.0"
+#define MyAppVersion "4.9.1"
 #define MyAppPublisher "Stephane Lepin"
 #define MyAppURL "http://github.com/Palakis/obs-websocket"
 
@@ -23,6 +23,7 @@ DefaultGroupName={#MyAppName}
 OutputBaseFilename=obs-websocket-Windows-Installer
 Compression=lzma
 SolidCompression=yes
+DirExistsWarning=no
 
 [Languages]
 Name: "english"; MessagesFile: "compiler:Default.isl"

src/Config.cpp

@@ -18,19 +18,26 @@ with this program. If not, see <https://www.gnu.org/licenses/>
 
 #include <obs-frontend-api.h>
 
+#include <QtCore/QObject>
 #include <QtCore/QCryptographicHash>
 #include <QtCore/QTime>
 #include <QtWidgets/QSystemTrayIcon>
+#include <QtWidgets/QMainWindow>
+#include <QtWidgets/QInputDialog>
+#include <QtWidgets/QMessageBox>
 
 #define SECTION_NAME "WebsocketAPI"
 #define PARAM_ENABLE "ServerEnabled"
 #define PARAM_PORT "ServerPort"
+#define PARAM_LOCKTOIPV4 "LockToIPv4"
 #define PARAM_DEBUG "DebugEnabled"
 #define PARAM_ALERT "AlertsEnabled"
 #define PARAM_AUTHREQUIRED "AuthRequired"
 #define PARAM_SECRET "AuthSecret"
 #define PARAM_SALT "AuthSalt"
 
+#define GLOBAL_AUTH_SETUP_PROMPTED "AuthSetupPrompted"
+
 #include "Utils.h"
 #include "WSServer.h"
 
@@ -41,9 +48,10 @@ with this program. If not, see <https://www.gnu.org/licenses/>
 Config::Config() :
 	ServerEnabled(true),
 	ServerPort(4444),
+	LockToIPv4(false),
 	DebugEnabled(false),
 	AlertsEnabled(true),
-	AuthRequired(false),
+	AuthRequired(true),
 	Secret(""),
 	Salt(""),
 	SettingsLoaded(false)
@@ -67,6 +75,7 @@ void Config::Load()
 
 	ServerEnabled = config_get_bool(obsConfig, SECTION_NAME, PARAM_ENABLE);
 	ServerPort = config_get_uint(obsConfig, SECTION_NAME, PARAM_PORT);
+	LockToIPv4 = config_get_bool(obsConfig, SECTION_NAME, PARAM_LOCKTOIPV4);
 
 	DebugEnabled = config_get_bool(obsConfig, SECTION_NAME, PARAM_DEBUG);
 	AlertsEnabled = config_get_bool(obsConfig, SECTION_NAME, PARAM_ALERT);
@@ -82,6 +91,7 @@ void Config::Save()
 
 	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_LOCKTOIPV4, LockToIPv4);
 
 	config_set_bool(obsConfig, SECTION_NAME, PARAM_DEBUG, DebugEnabled);
 	config_set_bool(obsConfig, SECTION_NAME, PARAM_ALERT, AlertsEnabled);
@@ -104,6 +114,8 @@ void Config::SetDefaults()
 			SECTION_NAME, PARAM_ENABLE, ServerEnabled);
 		config_set_default_uint(obsConfig,
 			SECTION_NAME, PARAM_PORT, ServerPort);
+		config_set_default_bool(obsConfig,
+			SECTION_NAME, PARAM_LOCKTOIPV4, LockToIPv4);
 
 		config_set_default_bool(obsConfig,
 			SECTION_NAME, PARAM_DEBUG, DebugEnabled);
@@ -124,6 +136,70 @@ config_t* Config::GetConfigStore()
 	return obs_frontend_get_profile_config();
 }
 
+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_LOCKTOIPV4)) {
+		bool value = config_get_bool(source, SECTION_NAME, PARAM_LOCKTOIPV4);
+		config_set_bool(destination, SECTION_NAME, PARAM_LOCKTOIPV4, value);
+
+		config_remove_value(source, SECTION_NAME, PARAM_LOCKTOIPV4);
+	}
+
+	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);
+}
+
 QString Config::GenerateSalt()
 {
 	// Generate 32 random chars
@@ -205,16 +281,17 @@ void Config::OnFrontendEvent(enum obs_frontend_event event, void* param)
 
 		bool previousEnabled = config->ServerEnabled;
 		uint64_t previousPort = config->ServerPort;
+		bool previousLock = config->LockToIPv4;
 
 		config->SetDefaults();
 		config->Load();
 
-		if (config->ServerEnabled != previousEnabled || config->ServerPort != previousPort) {
+		if (config->ServerEnabled != previousEnabled || config->ServerPort != previousPort || config->LockToIPv4 != previousLock) {
 			auto server = GetServer();
 			server->stop();
 
 			if (config->ServerEnabled) {
-				server->start(config->ServerPort);
+				server->start(config->ServerPort, config->LockToIPv4);
 
 				if (previousEnabled != config->ServerEnabled) {
 					Utils::SysTrayNotify(startMessage, QSystemTrayIcon::MessageIcon::Information);
@@ -226,61 +303,50 @@ void Config::OnFrontendEvent(enum obs_frontend_event event, void* param)
 			}
 		}
 	}
+	else if (event == OBS_FRONTEND_EVENT_FINISHED_LOADING) {
+		FirstRunPasswordSetup();
+	}
 }
 
-void Config::MigrateFromGlobalSettings()
+void Config::FirstRunPasswordSetup()
 {
-	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);
+	// check if we already showed the auth setup prompt to the user, independently of the current settings (tied to the current profile)
+	config_t* globalConfig = obs_frontend_get_global_config();
+	bool alreadyPrompted = config_get_bool(globalConfig, SECTION_NAME, GLOBAL_AUTH_SETUP_PROMPTED);
+	if (alreadyPrompted) {
+		return;
 	}
 
-	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);
+	// lift the flag up and save it
+	config_set_bool(globalConfig, SECTION_NAME, GLOBAL_AUTH_SETUP_PROMPTED, true);
+	config_save(globalConfig);
 
-		config_remove_value(source, SECTION_NAME, PARAM_PORT);
+	// check if the password is already set
+	auto config = GetConfig();
+	if (!config) {
+		return;
 	}
 
-	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->Secret.isEmpty()) && !(config->Salt.isEmpty())) {
+		return;
 	}
 
-	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);
+	obs_frontend_push_ui_translation(obs_module_get_string);
+	QString dialogTitle = QObject::tr("OBSWebsocket.InitialPasswordSetup.Title");
+	QString dialogText = QObject::tr("OBSWebsocket.InitialPasswordSetup.Text");
+	QString dismissedText = QObject::tr("OBSWebsocket.InitialPasswordSetup.DismissedText");
+	obs_frontend_pop_ui_translation();
 
-		config_remove_value(source, SECTION_NAME, PARAM_ALERT);
+	auto mainWindow = reinterpret_cast<QMainWindow*>(
+		obs_frontend_get_main_window()
+	);
+	
+	QMessageBox::StandardButton response = QMessageBox::question(mainWindow, dialogTitle, dialogText);
+	if (response == QMessageBox::Yes) {
+		ShowPasswordSetting();
 	}
-
-	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);
+	else {
+		// tell the user they still can set the password later in our settings dialog
+		QMessageBox::information(mainWindow, dialogTitle, dismissedText);
 	}
-
-	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

@@ -42,6 +42,7 @@ class Config {
 
 		bool ServerEnabled;
 		uint64_t ServerPort;
+		bool LockToIPv4;
 
 		bool DebugEnabled;
 		bool AlertsEnabled;
@@ -54,4 +55,5 @@ class Config {
 
 	private:
 		static void OnFrontendEvent(enum obs_frontend_event event, void* param);
+		static void FirstRunPasswordSetup();
 };

src/Utils.cpp

@@ -16,6 +16,7 @@ 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 <inttypes.h>
 #include <QtWidgets/QMainWindow>
 #include <QtCore/QDir>
 #include <QtCore/QUrl>
@@ -23,6 +24,7 @@ with this program. If not, see <https://www.gnu.org/licenses/>
 #include <obs-frontend-api.h>
 #include <obs.hpp>
 #include <util/platform.h>
+#include <obs-data.h>
 
 #include "obs-websocket.h"
 
@@ -50,6 +52,43 @@ obs_bounds_type getBoundsTypeFromName(QString name) {
 	return boundTypeNames.key(name);
 }
 
+const QHash<obs_scale_type, QString> scaleTypeNames = {
+	{ OBS_SCALE_DISABLE, "OBS_SCALE_DISABLE" },
+	{ OBS_SCALE_POINT, "OBS_SCALE_POINT" },
+	{ OBS_SCALE_BICUBIC, "OBS_SCALE_BICUBIC" },
+	{ OBS_SCALE_BILINEAR, "OBS_SCALE_BILINEAR" },
+	{ OBS_SCALE_LANCZOS, "OBS_SCALE_LANCZOS" },
+	{ OBS_SCALE_AREA, "OBS_SCALE_AREA" },
+};
+
+QString getScaleNameFromType(obs_scale_type type) {
+	QString fallback = scaleTypeNames.value(OBS_SCALE_DISABLE);
+	return scaleTypeNames.value(type, fallback);
+}
+
+obs_scale_type getFilterTypeFromName(QString name) {
+	return scaleTypeNames.key(name);
+}
+
+bool Utils::StringInStringList(char** strings, const char* string) {
+	if (!strings) {
+		return false;
+	}
+
+	size_t index = 0;
+	while (strings[index] != NULL) {
+		char* value = strings[index];
+
+		if (strcmp(value, string) == 0) {
+			return true;
+		}
+
+		index++;
+	}
+
+	return false;
+}
+
 obs_data_array_t* Utils::StringListToArray(char** strings, const char* key) {
 	obs_data_array_t* list = obs_data_array_create();
 
@@ -103,9 +142,11 @@ obs_data_array_t* Utils::GetSceneItems(obs_source_t* source) {
  * @typedef {Object} `SceneItem` An OBS Scene Item.
  * @property {Number} `cy`
  * @property {Number} `cx`
+ * @property {Number} `alignment` The point on the source that the item is manipulated from. The sum of 1=Left or 2=Right, and 4=Top or 8=Bottom, or omit to center on that axis.
  * @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} `muted` Whether or not this Scene Item is muted.
  * @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`
@@ -145,6 +186,8 @@ obs_data_t* Utils::GetSceneItemData(obs_sceneitem_t* item) {
 	obs_data_set_double(data, "y", pos.y);
 	obs_data_set_int(data, "source_cx", (int)item_width);
 	obs_data_set_int(data, "source_cy", (int)item_height);
+	obs_data_set_bool(data, "muted", obs_source_muted(itemSource));
+	obs_data_set_int(data, "alignment", (int)obs_sceneitem_get_alignment(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));
@@ -175,34 +218,6 @@ obs_data_t* Utils::GetSceneItemData(obs_sceneitem_t* item) {
 	return data;
 }
 
-obs_sceneitem_t* Utils::GetSceneItemFromItem(obs_scene_t* scene, obs_data_t* itemInfo) {
-	if (!scene) {
-		return nullptr;
-	}
-
-	OBSDataItemAutoRelease idInfoItem = obs_data_item_byname(itemInfo, "id");
-	int id = obs_data_item_get_int(idInfoItem);
-
-	OBSDataItemAutoRelease nameInfoItem = obs_data_item_byname(itemInfo, "name");
-	const char* name = obs_data_item_get_string(nameInfoItem);
-
-	if (idInfoItem) {
-		obs_sceneitem_t* sceneItem = GetSceneItemFromId(scene, id);
-		obs_source_t* sceneItemSource = obs_sceneitem_get_source(sceneItem);
-
-		QString sceneItemName = obs_source_get_name(sceneItemSource);
-		if (nameInfoItem && (QString(name) != sceneItemName)) {
-			return nullptr;
-		}
-
-		return sceneItem;
-	} else if (nameInfoItem) {
-		return GetSceneItemFromName(scene, name);
-	}
-
-	return nullptr;
-}
-
 obs_sceneitem_t* Utils::GetSceneItemFromName(obs_scene_t* scene, QString name) {
 	if (!scene) {
 		return nullptr;
@@ -292,6 +307,49 @@ obs_sceneitem_t* Utils::GetSceneItemFromId(obs_scene_t* scene, int64_t id) {
 	return search.result;
 }
 
+obs_sceneitem_t* Utils::GetSceneItemFromItem(obs_scene_t* scene, obs_data_t* itemInfo) {
+	if (!scene) {
+		return nullptr;
+	}
+
+	OBSDataItemAutoRelease idInfoItem = obs_data_item_byname(itemInfo, "id");
+	int id = obs_data_item_get_int(idInfoItem);
+
+	OBSDataItemAutoRelease nameInfoItem = obs_data_item_byname(itemInfo, "name");
+	const char* name = obs_data_item_get_string(nameInfoItem);
+
+	if (idInfoItem) {
+		obs_sceneitem_t* sceneItem = GetSceneItemFromId(scene, id);
+		obs_source_t* sceneItemSource = obs_sceneitem_get_source(sceneItem);
+
+		QString sceneItemName = obs_source_get_name(sceneItemSource);
+		if (nameInfoItem && (QString(name) != sceneItemName)) {
+			return nullptr;
+		}
+
+		return sceneItem;
+	} else if (nameInfoItem) {
+		return GetSceneItemFromName(scene, name);
+	}
+
+	return nullptr;
+}
+
+obs_sceneitem_t* Utils::GetSceneItemFromRequestField(obs_scene_t* scene, obs_data_item_t* dataItem)
+{
+	enum obs_data_type dataType = obs_data_item_gettype(dataItem);
+
+	if (dataType == OBS_DATA_OBJECT) {
+		OBSDataAutoRelease itemData = obs_data_item_get_obj(dataItem);
+		return GetSceneItemFromItem(scene, itemData);
+	} else if (dataType == OBS_DATA_STRING) {
+		QString name = obs_data_item_get_string(dataItem);
+		return GetSceneItemFromName(scene, name);
+	}
+
+	return nullptr;
+}
+
 bool Utils::IsValidAlignment(const uint32_t alignment) {
 	switch (alignment) {
 		case OBS_ALIGN_CENTER:
@@ -386,6 +444,13 @@ int Utils::GetTransitionDuration(obs_source_t* transition) {
 		return 0;
 	}
 
+	if (obs_transition_fixed(transition)) {
+		// If this transition has a fixed duration (such as a Stinger),
+		// we don't currently have a way of retrieving that number.
+		// For now, return -1 to indicate that we don't know the actual duration.
+		return -1;
+	}
+
 	OBSSourceAutoRelease destinationScene = obs_transition_get_active_source(transition);
 	OBSDataAutoRelease destinationSettings = obs_source_get_private_settings(destinationScene);
 
@@ -412,6 +477,37 @@ bool Utils::SetTransitionByName(QString transitionName) {
 	}
 }
 
+obs_data_t* Utils::GetTransitionData(obs_source_t* transition) {
+	int duration = Utils::GetTransitionDuration(transition);
+	if (duration < 0) {
+		blog(LOG_WARNING, "GetTransitionData: duration is negative !");
+	}
+
+	OBSSourceAutoRelease sourceScene = obs_transition_get_source(transition, OBS_TRANSITION_SOURCE_A);
+	OBSSourceAutoRelease destinationScene = obs_transition_get_active_source(transition);
+
+	obs_data_t* transitionData = obs_data_create();
+	obs_data_set_string(transitionData, "name", obs_source_get_name(transition));
+	obs_data_set_string(transitionData, "type", obs_source_get_id(transition));
+	obs_data_set_int(transitionData, "duration", duration);
+
+	// When a transition starts and while it is running, SOURCE_A is the source scene
+	// and SOURCE_B is the destination scene.
+	// Before the transition_end event is triggered on a transition, the destination scene
+	// goes into SOURCE_A and SOURCE_B becomes null. This means that, in transition_stop
+	// we don't know what was the source scene
+	// TODO fix this in libobs
+
+	bool isTransitionEndEvent = (sourceScene == destinationScene);
+	if (!isTransitionEndEvent) {
+		obs_data_set_string(transitionData, "from-scene", obs_source_get_name(sourceScene));
+	}
+	
+	obs_data_set_string(transitionData, "to-scene", obs_source_get_name(destinationScene));
+
+	return transitionData;
+}
+
 QString Utils::OBSVersionString() {
 	uint32_t version = obs_get_version();
 
@@ -427,16 +523,13 @@ QString Utils::OBSVersionString() {
 }
 
 QSystemTrayIcon* Utils::GetTrayIcon() {
-	QMainWindow* main = (QMainWindow*)obs_frontend_get_main_window();
-	if (!main) return nullptr;
-
-	QList<QSystemTrayIcon*> trays = main->findChildren<QSystemTrayIcon*>();
-	return trays.isEmpty() ? nullptr : trays.first();
+	void* systemTray = obs_frontend_get_system_tray();
+	return reinterpret_cast<QSystemTrayIcon*>(systemTray);
 }
 
-void Utils::SysTrayNotify(QString text,
-	QSystemTrayIcon::MessageIcon icon, QString title) {
-	if (!GetConfig()->AlertsEnabled ||
+void Utils::SysTrayNotify(QString text, QSystemTrayIcon::MessageIcon icon, QString title) {
+	auto config = GetConfig();
+	if ((config && !config->AlertsEnabled) ||
 		!QSystemTrayIcon::isSystemTrayAvailable() ||
 		!QSystemTrayIcon::supportsMessages())
 	{
@@ -579,7 +672,7 @@ void Utils::StartReplayBuffer() {
 		obs_output_t* rpOutput = obs_frontend_get_replay_buffer_output();
 		OBSData outputHotkeys = obs_hotkeys_save_output(rpOutput);
 
-		OBSData dummyBinding = obs_data_create();
+		OBSDataAutoRelease dummyBinding = obs_data_create();
 		obs_data_set_bool(dummyBinding, "control", true);
 		obs_data_set_bool(dummyBinding, "alt", true);
 		obs_data_set_bool(dummyBinding, "shift", true);
@@ -622,16 +715,40 @@ bool Utils::SetFilenameFormatting(const char* filenameFormatting) {
 	return true;
 }
 
+const char* Utils::GetCurrentRecordingFilename()
+{
+	OBSOutputAutoRelease recordingOutput = obs_frontend_get_recording_output();
+	if (!recordingOutput) {
+		return nullptr;
+	}
+
+	OBSDataAutoRelease settings = obs_output_get_settings(recordingOutput);
+
+	// mimicks the behavior of BasicOutputHandler::GetRecordingFilename :
+	// try to fetch the path from the "url" property, then try "path" if the first one
+	// didn't yield any result
+	OBSDataItemAutoRelease item = obs_data_item_byname(settings, "url");
+	if (!item) {
+		item = obs_data_item_byname(settings, "path");
+		if (!item) {
+			return nullptr;
+		}
+	}
+
+	return obs_data_item_get_string(item);
+}
+
 // 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 {double} `position.x` The x position of the scene item from the left.
+ * @property {double} `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 {String} `scale.filter` The scale filter of the source. Can be "OBS_SCALE_DISABLE", "OBS_SCALE_POINT", "OBS_SCALE_BICUBIC", "OBS_SCALE_BILINEAR", "OBS_SCALE_LANCZOS" or "OBS_SCALE_AREA".
  * @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.
@@ -675,12 +792,16 @@ obs_data_t* Utils::GetSceneItemPropertiesData(obs_sceneitem_t* sceneItem) {
 	uint32_t boundsAlignment = obs_sceneitem_get_bounds_alignment(sceneItem);
 	QString boundsTypeName = getBoundsNameFromType(boundsType);
 
+	obs_scale_type scaleFilter = obs_sceneitem_get_scale_filter(sceneItem);
+	QString scaleFilterName = getScaleNameFromType(scaleFilter);
+
 	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_string(scaleData, "filter", scaleFilterName.toUtf8());
 	obs_data_set_double(scaleData, "x", scale.x);
 	obs_data_set_double(scaleData, "y", scale.y);
 
@@ -786,39 +907,60 @@ void getPauseRecordingFunctions(RecordingPausedFunction* recPausedFuncPtr, Pause
 	if (pauseRecFuncPtr) {
 		*pauseRecFuncPtr = (PauseRecordingFunction)os_dlsym(frontendApi, "obs_frontend_recording_pause");
 	}
-
-	os_dlclose(frontendApi);
 }
 
-bool Utils::RecordingPauseSupported()
+QString Utils::nsToTimestamp(uint64_t ns)
 {
-	RecordingPausedFunction recordingPaused = nullptr;
-	PauseRecordingFunction pauseRecording = nullptr;
-	getPauseRecordingFunctions(&recordingPaused, &pauseRecording);
+	uint64_t ms = ns / 1000000ULL;
+	uint64_t secs = ms / 1000ULL;
+	uint64_t minutes = secs / 60ULL;
 
-	return (recordingPaused && pauseRecording);
+	uint64_t hoursPart = minutes / 60ULL;
+	uint64_t minutesPart = minutes % 60ULL;
+	uint64_t secsPart = secs % 60ULL;
+	uint64_t msPart = ms % 1000ULL;
+
+	return QString::asprintf("%02" PRIu64 ":%02" PRIu64 ":%02" PRIu64 ".%03" PRIu64, hoursPart, minutesPart, secsPart, msPart);
 }
 
-bool Utils::RecordingPaused()
+void Utils::AddSourceHelper(void *_data, obs_scene_t *scene)
 {
-	RecordingPausedFunction recordingPaused = nullptr;
-	getPauseRecordingFunctions(&recordingPaused, nullptr);
-
-	if (recordingPaused == nullptr) {
-		return false;
+	auto *data = reinterpret_cast<AddSourceData*>(_data);
+	data->sceneItem = obs_scene_add(scene, data->source);
+	obs_sceneitem_set_visible(data->sceneItem, data->setVisible);
 }
 
-	return recordingPaused();
-}
-
-void Utils::PauseRecording(bool pause)
+obs_data_t *Utils::OBSDataGetDefaults(obs_data_t *data)
 {
-	PauseRecordingFunction pauseRecording = nullptr;
-	getPauseRecordingFunctions(nullptr, &pauseRecording);
+	obs_data_t *returnData = obs_data_create();
+	obs_data_item_t *item = NULL;
 
-	if (pauseRecording == nullptr) {
-		return;
-	}
+	for (item = obs_data_first(data); item; obs_data_item_next(&item)) {
+		enum obs_data_type type = obs_data_item_gettype(item);
+		const char *name = obs_data_item_get_name(item);
 
-	pauseRecording(pause); 
+		if (type == OBS_DATA_STRING) {
+			const char *val = obs_data_item_get_string(item);
+			obs_data_set_string(returnData, name, val);
+		} else if (type == OBS_DATA_NUMBER) {
+			enum obs_data_number_type type = obs_data_item_numtype(item);
+			if (type == OBS_DATA_NUM_INT) {
+				long long val = obs_data_item_get_int(item);
+				obs_data_set_int(returnData, name, val);
+			} else {
+				double val = obs_data_item_get_double(item);
+				obs_data_set_double(returnData, name, val);
+			}
+		} else if (type == OBS_DATA_BOOLEAN) {
+			bool val = obs_data_item_get_bool(item);
+			obs_data_set_bool(returnData, name, val);
+		} else if (type == OBS_DATA_OBJECT) {
+			OBSDataAutoRelease obj = obs_data_item_get_obj(item);
+			obs_data_set_obj(returnData, name, obj);
+		} else if (type == OBS_DATA_ARRAY) {
+			OBSDataArrayAutoRelease array = obs_data_item_get_array(item);
+			obs_data_set_array(returnData, name, array);
+		}
+	}
+	return returnData;
 }

src/Utils.h

@@ -34,56 +34,66 @@ with this program. If not, see <https://www.gnu.org/licenses/>
 typedef void(*PauseRecordingFunction)(bool);
 typedef bool(*RecordingPausedFunction)();
 
-class Utils {
-  public:
-	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);
+namespace Utils {
+	bool StringInStringList(char** strings, const char* string);
+	obs_data_array_t* StringListToArray(char** strings, const char* key);
+	obs_data_array_t* GetSceneItems(obs_source_t* source);
+	obs_data_t* GetSceneItemData(obs_sceneitem_t* item);
 
-	// These two functions support nested lookup into groups
-	static obs_sceneitem_t* GetSceneItemFromName(obs_scene_t* scene, QString name);
-	static obs_sceneitem_t* GetSceneItemFromId(obs_scene_t* scene, int64_t id);
+	// These functions support nested lookup into groups
+	obs_sceneitem_t* GetSceneItemFromName(obs_scene_t* scene, QString name);
+	obs_sceneitem_t* GetSceneItemFromId(obs_scene_t* scene, int64_t id);
+	obs_sceneitem_t* GetSceneItemFromItem(obs_scene_t* scene, obs_data_t* item);
+	obs_sceneitem_t* GetSceneItemFromRequestField(obs_scene_t* scene, obs_data_item_t* dataItem);
 
-	static obs_sceneitem_t* GetSceneItemFromItem(obs_scene_t* scene, obs_data_t* item);
-	static obs_scene_t* GetSceneFromNameOrCurrent(QString sceneName);
-	static obs_data_t* GetSceneItemPropertiesData(obs_sceneitem_t* item);
+	obs_scene_t* GetSceneFromNameOrCurrent(QString sceneName);
+	obs_data_t* GetSceneItemPropertiesData(obs_sceneitem_t* item);
 
-	static obs_data_t* GetSourceFilterInfo(obs_source_t* filter, bool includeSettings);
-	static obs_data_array_t* GetSourceFiltersList(obs_source_t* source, bool includeSettings);
+	obs_data_t* GetSourceFilterInfo(obs_source_t* filter, bool includeSettings);
+	obs_data_array_t* GetSourceFiltersList(obs_source_t* source, bool includeSettings);
 
-	static bool IsValidAlignment(const uint32_t alignment);
+	bool IsValidAlignment(const uint32_t alignment);
 
-	static obs_data_array_t* GetScenes();
-	static obs_data_t* GetSceneData(obs_source_t* source);
+	obs_data_array_t* GetScenes();
+	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(obs_source_t* transition);
-	static obs_source_t* GetTransitionFromName(QString transitionName);
-	static bool SetTransitionByName(QString transitionName);
+	QSpinBox* GetTransitionDurationControl();
+	int GetTransitionDuration(obs_source_t* transition);
+	obs_source_t* GetTransitionFromName(QString transitionName);
+	bool SetTransitionByName(QString transitionName);
+	obs_data_t* GetTransitionData(obs_source_t* transition);
 
-	static QString OBSVersionString();
+	QString OBSVersionString();
 
-	static QSystemTrayIcon* GetTrayIcon();
-	static void SysTrayNotify(
+	QSystemTrayIcon* GetTrayIcon();
+	void SysTrayNotify(
 		QString text,
 		QSystemTrayIcon::MessageIcon n,
 		QString title = QString("obs-websocket"));
 
-	static const char* GetRecordingFolder();
-	static bool SetRecordingFolder(const char* path);
+	const char* GetRecordingFolder();
+	bool SetRecordingFolder(const char* path);
 
-	static QString ParseDataToQueryString(obs_data_t* data);
-	static obs_hotkey_t* FindHotkeyByName(QString name);
+	QString ParseDataToQueryString(obs_data_t* data);
+	obs_hotkey_t* FindHotkeyByName(QString name);
 
-	static bool ReplayBufferEnabled();
-	static void StartReplayBuffer();
-	static bool IsRPHotkeySet();
+	bool ReplayBufferEnabled();
+	void StartReplayBuffer();
+	bool IsRPHotkeySet();
 
-	static const char* GetFilenameFormatting();
-	static bool SetFilenameFormatting(const char* filenameFormatting);
+	const char* GetFilenameFormatting();
+	bool SetFilenameFormatting(const char* filenameFormatting);
 
-	static bool RecordingPauseSupported();
-	static bool RecordingPaused();
-	static void PauseRecording(bool pause);
+	const char* GetCurrentRecordingFilename();
+
+	QString nsToTimestamp(uint64_t ns);
+	struct AddSourceData {
+		obs_source_t *source;
+		obs_sceneitem_t *sceneItem;
+		bool setVisible;
+	};
+	void AddSourceHelper(void *_data, obs_scene_t *scene);
+
+	obs_data_t *OBSDataGetDefaults(obs_data_t *data);
 };

src/WSEvents.h

@@ -43,14 +43,16 @@ public:
 	void connectFilterSignals(obs_source_t* filter);
 	void disconnectFilterSignals(obs_source_t* filter);
 
-	void hookTransitionBeginEvent();
-	void unhookTransitionBeginEvent();
+	void hookTransitionPlaybackEvents();
+	void unhookTransitionPlaybackEvents();
 
 	uint64_t getStreamingTime();
 	uint64_t getRecordingTime();
+	uint64_t getVirtualCamTime();
 
 	QString getStreamingTimecode();
 	QString getRecordingTimecode();
+	QString getVirtualCamTimecode();
 	
 	obs_data_t* GetStats();
 
@@ -102,6 +104,9 @@ private:
 	void OnRecordingPaused();
 	void OnRecordingResumed();
 	
+	void OnVirtualCamStarted();
+	void OnVirtualCamStopped();
+
 	void OnReplayStarting();
 	void OnReplayStarted();
 	void OnReplayStopping();
@@ -116,6 +121,8 @@ private:
 		enum obs_frontend_event event, void* privateData);
 
 	static void OnTransitionBegin(void* param, calldata_t* data);
+	static void OnTransitionEnd(void* param, calldata_t* data);
+	static void OnTransitionVideoEnd(void* param, calldata_t* data);
 
 	static void OnSourceCreate(void* param, calldata_t* data);
 	static void OnSourceDestroy(void* param, calldata_t* data);
@@ -124,6 +131,8 @@ private:
 	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 OnSourceAudioActivated(void* param, calldata_t* data);
+	static void OnSourceAudioDeactivated(void* param, calldata_t* data);
 
 	static void OnSourceRename(void* param, calldata_t* data);
 
@@ -132,10 +141,20 @@ private:
 	static void OnSourceFilterVisibilityChanged(void* param, calldata_t* data);
 	static void OnSourceFilterOrderChanged(void* param, calldata_t* data);
 	
+	static void OnMediaPlaying(void* param, calldata_t* data);
+	static void OnMediaPaused(void* param, calldata_t* data);
+	static void OnMediaRestarted(void* param, calldata_t* data);
+	static void OnMediaStopped(void* param, calldata_t* data);
+	static void OnMediaNext(void* param, calldata_t* data);
+	static void OnMediaPrevious(void* param, calldata_t* data);
+	static void OnMediaStarted(void* param, calldata_t* data);
+	static void OnMediaEnded(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 OnSceneItemLockChanged(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);

src/WSRequestHandler.cpp

@@ -17,6 +17,8 @@
  * with this program. If not, see <https://www.gnu.org/licenses/>
  */
 
+#include <functional>
+
 #include <obs-data.h>
 
 #include "Config.h"
@@ -24,265 +26,196 @@
 
 #include "WSRequestHandler.h"
 
-QHash<QString, HandlerResponse(*)(WSRequestHandler*)> WSRequestHandler::messageMap{
-	{ "GetVersion", WSRequestHandler::HandleGetVersion },
-	{ "GetAuthRequired", WSRequestHandler::HandleGetAuthRequired },
-	{ "Authenticate", WSRequestHandler::HandleAuthenticate },
+using namespace std::placeholders;
 
-	{ "GetStats", WSRequestHandler::HandleGetStats },
-	{ "SetHeartbeat", WSRequestHandler::HandleSetHeartbeat },
-	{ "GetVideoInfo", WSRequestHandler::HandleGetVideoInfo },
+const QHash<QString, RpcMethodHandler> WSRequestHandler::messageMap{
+	// Category: General
+	{ "GetVersion", &WSRequestHandler::GetVersion },
+	{ "GetAuthRequired", &WSRequestHandler::GetAuthRequired },
+	{ "Authenticate", &WSRequestHandler::Authenticate },
+	{ "SetHeartbeat", &WSRequestHandler::SetHeartbeat },
+	{ "SetFilenameFormatting", &WSRequestHandler::SetFilenameFormatting },
+	{ "GetFilenameFormatting", &WSRequestHandler::GetFilenameFormatting },
+	{ "GetStats", &WSRequestHandler::GetStats },
+	{ "BroadcastCustomMessage", &WSRequestHandler::BroadcastCustomMessage },
+	{ "GetVideoInfo", &WSRequestHandler::GetVideoInfo },
+	{ "OpenProjector", &WSRequestHandler::OpenProjector },
+	{ "TriggerHotkeyByName", &WSRequestHandler::TriggerHotkeyByName },
+	{ "TriggerHotkeyBySequence", &WSRequestHandler::TriggerHotkeyBySequence },
+	{ "ExecuteBatch", &WSRequestHandler::ExecuteBatch },
+	{ "Sleep", &WSRequestHandler::Sleep },
 
-	{ "SetFilenameFormatting", WSRequestHandler::HandleSetFilenameFormatting },
-	{ "GetFilenameFormatting", WSRequestHandler::HandleGetFilenameFormatting },
+	// Category: Media Control
+	{ "PlayPauseMedia", &WSRequestHandler::PlayPauseMedia },
+	{ "RestartMedia", &WSRequestHandler::RestartMedia },
+	{ "StopMedia", &WSRequestHandler::StopMedia },
+	{ "NextMedia", &WSRequestHandler::NextMedia },
+	{ "PreviousMedia", &WSRequestHandler::PreviousMedia },
+	{ "GetMediaDuration", &WSRequestHandler::GetMediaDuration },
+	{ "GetMediaTime", &WSRequestHandler::GetMediaTime },
+	{ "SetMediaTime", &WSRequestHandler::SetMediaTime },
+	{ "ScrubMedia", &WSRequestHandler::ScrubMedia },
+	{ "GetMediaState", &WSRequestHandler::GetMediaState },
+	{ "GetMediaSourcesList", &WSRequestHandler::GetMediaSourcesList },
 
-	{ "BroadcastCustomMessage", WSRequestHandler::HandleBroadcastCustomMessage },
+	// Category: Outputs
+	{ "ListOutputs", &WSRequestHandler::ListOutputs },
+	{ "GetOutputInfo", &WSRequestHandler::GetOutputInfo },
+	{ "StartOutput", &WSRequestHandler::StartOutput },
+	{ "StopOutput", &WSRequestHandler::StopOutput },
 
-	{ "SetCurrentScene", WSRequestHandler::HandleSetCurrentScene },
-	{ "GetCurrentScene", WSRequestHandler::HandleGetCurrentScene },
-	{ "GetSceneList", WSRequestHandler::HandleGetSceneList },
+	// Category: Profiles
+	{ "SetCurrentProfile", &WSRequestHandler::SetCurrentProfile },
+	{ "GetCurrentProfile", &WSRequestHandler::GetCurrentProfile },
+	{ "ListProfiles", &WSRequestHandler::ListProfiles },
 
-	{ "SetSourceRender", WSRequestHandler::HandleSetSceneItemRender }, // Retrocompat
-	{ "SetSceneItemRender", WSRequestHandler::HandleSetSceneItemRender },
-	{ "SetSceneItemPosition", WSRequestHandler::HandleSetSceneItemPosition },
-	{ "SetSceneItemTransform", WSRequestHandler::HandleSetSceneItemTransform },
-	{ "SetSceneItemCrop", WSRequestHandler::HandleSetSceneItemCrop },
-	{ "GetSceneItemProperties", WSRequestHandler::HandleGetSceneItemProperties },
-	{ "SetSceneItemProperties", WSRequestHandler::HandleSetSceneItemProperties },
-	{ "ResetSceneItem", WSRequestHandler::HandleResetSceneItem },
-	{ "DeleteSceneItem", WSRequestHandler::HandleDeleteSceneItem },
-	{ "DuplicateSceneItem", WSRequestHandler::HandleDuplicateSceneItem },
-	{ "ReorderSceneItems", WSRequestHandler::HandleReorderSceneItems },
+	// Category: Recording
+	{ "GetRecordingStatus", &WSRequestHandler::GetRecordingStatus },
+	{ "StartStopRecording", &WSRequestHandler::StartStopRecording },
+	{ "StartRecording", &WSRequestHandler::StartRecording },
+	{ "StopRecording", &WSRequestHandler::StopRecording },
+	{ "PauseRecording", &WSRequestHandler::PauseRecording },
+	{ "ResumeRecording", &WSRequestHandler::ResumeRecording },
+	{ "SetRecordingFolder", &WSRequestHandler::SetRecordingFolder },
+	{ "GetRecordingFolder", &WSRequestHandler::GetRecordingFolder },
 
-	{ "GetStreamingStatus", WSRequestHandler::HandleGetStreamingStatus },
-	{ "StartStopStreaming", WSRequestHandler::HandleStartStopStreaming },
-	{ "StartStopRecording", WSRequestHandler::HandleStartStopRecording },
+	// Category: Replay Buffer
+	{ "GetReplayBufferStatus", &WSRequestHandler::GetReplayBufferStatus },
+	{ "StartStopReplayBuffer", &WSRequestHandler::StartStopReplayBuffer },
+	{ "StartReplayBuffer", &WSRequestHandler::StartReplayBuffer },
+	{ "StopReplayBuffer", &WSRequestHandler::StopReplayBuffer },
+	{ "SaveReplayBuffer", &WSRequestHandler::SaveReplayBuffer },
 
-	{ "StartStreaming", WSRequestHandler::HandleStartStreaming },
-	{ "StopStreaming", WSRequestHandler::HandleStopStreaming },
+	// Category: Scene Collections
+	{ "SetCurrentSceneCollection", &WSRequestHandler::SetCurrentSceneCollection },
+	{ "GetCurrentSceneCollection", &WSRequestHandler::GetCurrentSceneCollection },
+	{ "ListSceneCollections", &WSRequestHandler::ListSceneCollections },
 
-	{ "StartRecording", WSRequestHandler::HandleStartRecording },
-	{ "StopRecording", WSRequestHandler::HandleStopRecording },
-	{ "PauseRecording", WSRequestHandler::HandlePauseRecording },
-	{ "ResumeRecording", WSRequestHandler::HandleResumeRecording },
+	// Category: Scene Items
+	{ "GetSceneItemList", &WSRequestHandler::GetSceneItemList },
+	{ "GetSceneItemProperties", &WSRequestHandler::GetSceneItemProperties },
+	{ "SetSceneItemProperties", &WSRequestHandler::SetSceneItemProperties },
+	{ "ResetSceneItem", &WSRequestHandler::ResetSceneItem },
+	{ "SetSceneItemRender", &WSRequestHandler::SetSceneItemRender },
+	{ "SetSceneItemPosition", &WSRequestHandler::SetSceneItemPosition },
+	{ "SetSceneItemTransform", &WSRequestHandler::SetSceneItemTransform },
+	{ "SetSceneItemCrop", &WSRequestHandler::SetSceneItemCrop },
+	{ "SetSourceRender", &WSRequestHandler::SetSceneItemRender }, // Retrocompat TODO: Remove in 5.0.0
+	{ "DeleteSceneItem", &WSRequestHandler::DeleteSceneItem },
+	{ "AddSceneItem", &WSRequestHandler::AddSceneItem },
+	{ "DuplicateSceneItem", &WSRequestHandler::DuplicateSceneItem },
 
-	{ "StartStopReplayBuffer", WSRequestHandler::HandleStartStopReplayBuffer },
-	{ "StartReplayBuffer", WSRequestHandler::HandleStartReplayBuffer },
-	{ "StopReplayBuffer", WSRequestHandler::HandleStopReplayBuffer },
-	{ "SaveReplayBuffer", WSRequestHandler::HandleSaveReplayBuffer },
+	// Category: Scenes
+	{ "SetCurrentScene", &WSRequestHandler::SetCurrentScene },
+	{ "GetCurrentScene", &WSRequestHandler::GetCurrentScene },
+	{ "GetSceneList", &WSRequestHandler::GetSceneList },
+	{ "CreateScene", &WSRequestHandler::CreateScene },
+	{ "ReorderSceneItems", &WSRequestHandler::ReorderSceneItems },
+	{ "SetSceneTransitionOverride", &WSRequestHandler::SetSceneTransitionOverride },
+	{ "RemoveSceneTransitionOverride", &WSRequestHandler::RemoveSceneTransitionOverride },
+	{ "GetSceneTransitionOverride", &WSRequestHandler::GetSceneTransitionOverride },
 
-	{ "SetRecordingFolder", WSRequestHandler::HandleSetRecordingFolder },
-	{ "GetRecordingFolder", WSRequestHandler::HandleGetRecordingFolder },
+	// Category: Sources
+	{ "CreateSource", &WSRequestHandler::CreateSource },
+	{ "GetSourcesList", &WSRequestHandler::GetSourcesList },
+	{ "GetSourceTypesList", &WSRequestHandler::GetSourceTypesList },
+	{ "GetVolume", &WSRequestHandler::GetVolume },
+	{ "SetVolume", &WSRequestHandler::SetVolume },
+	{ "SetAudioTracks", &WSRequestHandler::SetAudioTracks },
+	{ "GetAudioTracks", &WSRequestHandler::GetAudioTracks },
+	{ "GetMute", &WSRequestHandler::GetMute },
+	{ "SetMute", &WSRequestHandler::SetMute },
+	{ "ToggleMute", &WSRequestHandler::ToggleMute },
+	{ "GetSourceActive", &WSRequestHandler::GetSourceActive },
+	{ "GetAudioActive", &WSRequestHandler::GetAudioActive },
+	{ "SetSourceName", &WSRequestHandler::SetSourceName },
+	{ "SetSyncOffset", &WSRequestHandler::SetSyncOffset },
+	{ "GetSyncOffset", &WSRequestHandler::GetSyncOffset },
+	{ "GetSourceSettings", &WSRequestHandler::GetSourceSettings },
+	{ "SetSourceSettings", &WSRequestHandler::SetSourceSettings },
+	{ "GetTextGDIPlusProperties", &WSRequestHandler::GetTextGDIPlusProperties },
+	{ "SetTextGDIPlusProperties", &WSRequestHandler::SetTextGDIPlusProperties },
+	{ "GetTextFreetype2Properties", &WSRequestHandler::GetTextFreetype2Properties },
+	{ "SetTextFreetype2Properties", &WSRequestHandler::SetTextFreetype2Properties },
+	{ "GetBrowserSourceProperties", &WSRequestHandler::GetBrowserSourceProperties },
+	{ "SetBrowserSourceProperties", &WSRequestHandler::SetBrowserSourceProperties },
+	{ "GetSpecialSources", &WSRequestHandler::GetSpecialSources },
+	{ "GetSourceFilters", &WSRequestHandler::GetSourceFilters },
+	{ "GetSourceFilterInfo", &WSRequestHandler::GetSourceFilterInfo },
+	{ "AddFilterToSource", &WSRequestHandler::AddFilterToSource },
+	{ "RemoveFilterFromSource", &WSRequestHandler::RemoveFilterFromSource },
+	{ "ReorderSourceFilter", &WSRequestHandler::ReorderSourceFilter },
+	{ "MoveSourceFilter", &WSRequestHandler::MoveSourceFilter },
+	{ "SetSourceFilterSettings", &WSRequestHandler::SetSourceFilterSettings },
+	{ "SetSourceFilterVisibility", &WSRequestHandler::SetSourceFilterVisibility },
+	{ "GetAudioMonitorType", &WSRequestHandler::GetAudioMonitorType },
+	{ "SetAudioMonitorType", &WSRequestHandler::SetAudioMonitorType },
+	{ "GetSourceDefaultSettings", &WSRequestHandler::GetSourceDefaultSettings },
+	{ "TakeSourceScreenshot", &WSRequestHandler::TakeSourceScreenshot },
+	{ "RefreshBrowserSource", &WSRequestHandler::RefreshBrowserSource },
 
-	{ "GetTransitionList", WSRequestHandler::HandleGetTransitionList },
-	{ "GetCurrentTransition", WSRequestHandler::HandleGetCurrentTransition },
-	{ "SetCurrentTransition", WSRequestHandler::HandleSetCurrentTransition },
-	{ "SetTransitionDuration", WSRequestHandler::HandleSetTransitionDuration },
-	{ "GetTransitionDuration", WSRequestHandler::HandleGetTransitionDuration },
+	// Category: Streaming
+	{ "GetStreamingStatus", &WSRequestHandler::GetStreamingStatus },
+	{ "StartStopStreaming", &WSRequestHandler::StartStopStreaming },
+	{ "StartStreaming", &WSRequestHandler::StartStreaming },
+	{ "StopStreaming", &WSRequestHandler::StopStreaming },
+	{ "SetStreamSettings", &WSRequestHandler::SetStreamSettings },
+	{ "GetStreamSettings", &WSRequestHandler::GetStreamSettings },
+	{ "SaveStreamSettings", &WSRequestHandler::SaveStreamSettings },
+	{ "SendCaptions", &WSRequestHandler::SendCaptions },
 	
-	{ "SetVolume", WSRequestHandler::HandleSetVolume },
-	{ "GetVolume", WSRequestHandler::HandleGetVolume },
-	{ "ToggleMute", WSRequestHandler::HandleToggleMute },
-	{ "SetMute", WSRequestHandler::HandleSetMute },
-	{ "GetMute", WSRequestHandler::HandleGetMute },
-	{ "SetSyncOffset", WSRequestHandler::HandleSetSyncOffset },
-	{ "GetSyncOffset", WSRequestHandler::HandleGetSyncOffset },
-	{ "GetSpecialSources", WSRequestHandler::HandleGetSpecialSources },
-	{ "GetSourcesList", WSRequestHandler::HandleGetSourcesList },
-	{ "GetSourceTypesList", WSRequestHandler::HandleGetSourceTypesList },
-	{ "GetSourceSettings", WSRequestHandler::HandleGetSourceSettings },
-	{ "SetSourceSettings", WSRequestHandler::HandleSetSourceSettings },
-	{ "TakeSourceScreenshot", WSRequestHandler::HandleTakeSourceScreenshot },
+	// Category: VirtualCam
+	{ "GetVirtualCamStatus", &WSRequestHandler::GetVirtualCamStatus },
+	{ "StartStopVirtualCam", &WSRequestHandler::StartStopVirtualCam },
+	{ "StartVirtualCam", &WSRequestHandler::StartVirtualCam },
+	{ "StopVirtualCam", &WSRequestHandler::StopVirtualCam },
 
-	{ "GetSourceFilters", WSRequestHandler::HandleGetSourceFilters },
-	{ "GetSourceFilterInfo", WSRequestHandler::HandleGetSourceFilterInfo },
-	{ "AddFilterToSource", WSRequestHandler::HandleAddFilterToSource },
-	{ "RemoveFilterFromSource", WSRequestHandler::HandleRemoveFilterFromSource },
-	{ "ReorderSourceFilter", WSRequestHandler::HandleReorderSourceFilter },
-	{ "MoveSourceFilter", WSRequestHandler::HandleMoveSourceFilter },
-	{ "SetSourceFilterSettings", WSRequestHandler::HandleSetSourceFilterSettings },
-	{ "SetSourceFilterVisibility", WSRequestHandler::HandleSetSourceFilterVisibility },
+	// Category: Studio Mode
+	{ "GetStudioModeStatus", &WSRequestHandler::GetStudioModeStatus },
+	{ "GetPreviewScene", &WSRequestHandler::GetPreviewScene },
+	{ "SetPreviewScene", &WSRequestHandler::SetPreviewScene },
+	{ "TransitionToProgram", &WSRequestHandler::TransitionToProgram },
+	{ "EnableStudioMode", &WSRequestHandler::EnableStudioMode },
+	{ "DisableStudioMode", &WSRequestHandler::DisableStudioMode },
+	{ "ToggleStudioMode", &WSRequestHandler::ToggleStudioMode },
 
-	{ "SetCurrentSceneCollection", WSRequestHandler::HandleSetCurrentSceneCollection },
-	{ "GetCurrentSceneCollection", WSRequestHandler::HandleGetCurrentSceneCollection },
-	{ "ListSceneCollections", WSRequestHandler::HandleListSceneCollections },
-
-	{ "SetCurrentProfile", WSRequestHandler::HandleSetCurrentProfile },
-	{ "GetCurrentProfile", WSRequestHandler::HandleGetCurrentProfile },
-	{ "ListProfiles", WSRequestHandler::HandleListProfiles },
-
-	{ "SetStreamSettings", WSRequestHandler::HandleSetStreamSettings },
-	{ "GetStreamSettings", WSRequestHandler::HandleGetStreamSettings },
-	{ "SaveStreamSettings", WSRequestHandler::HandleSaveStreamSettings },
-#if BUILD_CAPTIONS
-	{ "SendCaptions", WSRequestHandler::HandleSendCaptions },
-#endif
-
-	{ "GetStudioModeStatus", WSRequestHandler::HandleGetStudioModeStatus },
-	{ "GetPreviewScene", WSRequestHandler::HandleGetPreviewScene },
-	{ "SetPreviewScene", WSRequestHandler::HandleSetPreviewScene },
-	{ "TransitionToProgram", WSRequestHandler::HandleTransitionToProgram },
-	{ "EnableStudioMode", WSRequestHandler::HandleEnableStudioMode },
-	{ "DisableStudioMode", WSRequestHandler::HandleDisableStudioMode },
-	{ "ToggleStudioMode", WSRequestHandler::HandleToggleStudioMode },
-
-	{ "SetTextGDIPlusProperties", WSRequestHandler::HandleSetTextGDIPlusProperties },
-	{ "GetTextGDIPlusProperties", WSRequestHandler::HandleGetTextGDIPlusProperties },
-
-	{ "SetTextFreetype2Properties", WSRequestHandler::HandleSetTextFreetype2Properties },
-	{ "GetTextFreetype2Properties", WSRequestHandler::HandleGetTextFreetype2Properties },
-
-	{ "GetBrowserSourceProperties", WSRequestHandler::HandleGetBrowserSourceProperties },
-	{ "SetBrowserSourceProperties", WSRequestHandler::HandleSetBrowserSourceProperties },
-
-	{ "ListOutputs", WSRequestHandler::HandleListOutputs },
-	{ "GetOutputInfo", WSRequestHandler::HandleGetOutputInfo },
-	{ "StartOutput", WSRequestHandler::HandleStartOutput },
-	{ "StopOutput", WSRequestHandler::HandleStopOutput }
+	// Category: Transitions
+	{ "GetTransitionList", &WSRequestHandler::GetTransitionList },
+	{ "GetCurrentTransition", &WSRequestHandler::GetCurrentTransition },
+	{ "SetCurrentTransition", &WSRequestHandler::SetCurrentTransition },
+	{ "SetTransitionDuration", &WSRequestHandler::SetTransitionDuration },
+	{ "GetTransitionDuration", &WSRequestHandler::GetTransitionDuration },
+	{ "GetTransitionPosition", &WSRequestHandler::GetTransitionPosition },
+	{ "GetTransitionSettings", &WSRequestHandler::GetTransitionSettings },
+	{ "SetTransitionSettings", &WSRequestHandler::SetTransitionSettings },
+	{ "ReleaseTBar", &WSRequestHandler::ReleaseTBar	},
+	{ "SetTBarPosition", &WSRequestHandler::SetTBarPosition	}
 };
 
-QSet<QString> WSRequestHandler::authNotRequired {
+const QSet<QString> WSRequestHandler::authNotRequired {
 	"GetVersion",
 	"GetAuthRequired",
 	"Authenticate"
 };
 
 WSRequestHandler::WSRequestHandler(ConnectionProperties& connProperties) :
-	_messageId(0),
-	_requestType(""),
-	data(nullptr),
 	_connProperties(connProperties)
 {
 }
 
-std::string WSRequestHandler::processIncomingMessage(std::string& textMessage) {
-	if (GetConfig()->DebugEnabled) {
-		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) {
-		blog(LOG_ERROR, "invalid JSON payload received for '%s'", msg);
-		return SendErrorResponse("invalid JSON payload");
-	}
-
-	if (!hasField("request-type") || !hasField("message-id")) {
-		return SendErrorResponse("missing request parameters");
-	}
-
-	_requestType = obs_data_get_string(data, "request-type");
-	_messageId = obs_data_get_string(data, "message-id");
-
-	if (GetConfig()->AuthRequired
-		&& (!authNotRequired.contains(_requestType))
+RpcResponse WSRequestHandler::processRequest(const RpcRequest& request) {
+	auto config = GetConfig();
+	if ((config && config->AuthRequired)
+		&& (!authNotRequired.contains(request.methodName()))
 		&& (!_connProperties.isAuthenticated()))
 	{
-		return SendErrorResponse("Not Authenticated");
+		return RpcResponse::fail(request, "Not Authenticated");
 	}
 
-	HandlerResponse (*handlerFunc)(WSRequestHandler*) = (messageMap[_requestType]);
+	RpcMethodHandler handlerFunc = messageMap[request.methodName()];
 	if (!handlerFunc) {
-		return SendErrorResponse("invalid request type");
+		return RpcResponse::fail(request, "invalid request type");
 	}
 
-	return handlerFunc(this);
-}
-
-WSRequestHandler::~WSRequestHandler() {
-}
-
-HandlerResponse WSRequestHandler::SendOKResponse(obs_data_t* additionalFields) {
-	return SendResponse("ok", additionalFields);
-}
-
-HandlerResponse WSRequestHandler::SendErrorResponse(QString errorMessage) {
-	OBSDataAutoRelease fields = obs_data_create();
-	obs_data_set_string(fields, "error", errorMessage.toUtf8().constData());
-
-	return SendResponse("error", fields);
-}
-
-HandlerResponse WSRequestHandler::SendErrorResponse(obs_data_t* additionalFields) {
-	return SendResponse("error", additionalFields);
-}
-
-HandlerResponse WSRequestHandler::SendResponse(const char* status, obs_data_t* fields) {
-	obs_data_t* response = obs_data_create();
-	obs_data_set_string(response, "message-id", _messageId);
-	obs_data_set_string(response, "status", status);
-
-	if (fields) {
-		obs_data_apply(response, fields);
-	}
-
-	return response;
-}
-
-bool WSRequestHandler::hasField(QString name, obs_data_type expectedFieldType, obs_data_number_type expectedNumberType) {
-	if (!data || name.isEmpty() || name.isNull()) {
-		return false;
-	}
-
-	OBSDataItemAutoRelease dataItem = obs_data_item_byname(data, name.toUtf8());
-	if (!dataItem) {
-		return false;
-	}
-
-	if (expectedFieldType != OBS_DATA_NULL) {
-		obs_data_type fieldType = obs_data_item_gettype(dataItem);
-		if (fieldType != expectedFieldType) {
-			return false;
-		}
-
-		if (fieldType == OBS_DATA_NUMBER && expectedNumberType != OBS_DATA_NUM_INVALID) {
-			obs_data_number_type numberType = obs_data_item_numtype(dataItem);
-			if (numberType != expectedNumberType) {
-				return false;
-			}
-		}
-	}
-
-	return true;
-}
-
-bool WSRequestHandler::hasBool(QString fieldName) {
-	return this->hasField(fieldName, OBS_DATA_BOOLEAN);
-}
-
-bool WSRequestHandler::hasString(QString fieldName) {
-	return this->hasField(fieldName, OBS_DATA_STRING);
-}
-
-bool WSRequestHandler::hasNumber(QString fieldName, obs_data_number_type expectedNumberType) {
-	return this->hasField(fieldName, OBS_DATA_NUMBER, expectedNumberType);
-}
-
-bool WSRequestHandler::hasInteger(QString fieldName) {
-	return this->hasNumber(fieldName, OBS_DATA_NUM_INT);
-}
-
-bool WSRequestHandler::hasDouble(QString fieldName) {
-	return this->hasNumber(fieldName, OBS_DATA_NUM_DOUBLE);
-}
-
-bool WSRequestHandler::hasArray(QString fieldName) {
-	return this->hasField(fieldName, OBS_DATA_ARRAY);
-}
-
-bool WSRequestHandler::hasObject(QString fieldName) {
-	return this->hasField(fieldName, OBS_DATA_OBJECT);
+	return std::bind(handlerFunc, this, _1)(request);
 }

src/WSRequestHandler.h

@@ -19,171 +19,192 @@ with this program. If not, see <https://www.gnu.org/licenses/>
 
 #pragma once
 
+#include <QtCore/QString>
 #include <QtCore/QHash>
 #include <QtCore/QSet>
-#include <QtCore/QVariantHash>
-#include <QtCore/QString>
-#include <QtCore/QSharedPointer>
 
 #include <obs.hpp>
 #include <obs-frontend-api.h>
 
 #include "ConnectionProperties.h"
 
+#include "rpc/RpcRequest.h"
+#include "rpc/RpcResponse.h"
+
 #include "obs-websocket.h"
 
-typedef obs_data_t* HandlerResponse;
-
-class WSRequestHandler : public QObject {
-	Q_OBJECT
+class WSRequestHandler;
+typedef RpcResponse(WSRequestHandler::*RpcMethodHandler)(const RpcRequest&);
 
+class WSRequestHandler {
 	public:
 		explicit WSRequestHandler(ConnectionProperties& connProperties);
-		~WSRequestHandler();
-		std::string processIncomingMessage(std::string& textMessage);
-
-		bool hasField(QString fieldName, obs_data_type expectedFieldType = OBS_DATA_NULL,
-					  obs_data_number_type expectedNumberType = OBS_DATA_NUM_INVALID);
-		bool hasBool(QString fieldName);
-		bool hasString(QString fieldName);
-		bool hasNumber(QString fieldName, obs_data_number_type expectedNumberType = OBS_DATA_NUM_INVALID);
-		bool hasInteger(QString fieldName);
-		bool hasDouble(QString fieldName);
-		bool hasArray(QString fieldName);
-		bool hasObject(QString fieldName);
-
-		HandlerResponse SendOKResponse(obs_data_t* additionalFields = nullptr);
-		HandlerResponse SendErrorResponse(QString errorMessage);
-		HandlerResponse SendErrorResponse(obs_data_t* additionalFields = nullptr);
-		HandlerResponse SendResponse(const char* status, obs_data_t* additionalFields = nullptr);
-
-		obs_data_t* parameters() {
-			return this->data;
-		}
+		RpcResponse processRequest(const RpcRequest& textMessage);
 
 	private:
-		const char* _messageId;
-		const char* _requestType;
 		ConnectionProperties& _connProperties;
-		OBSDataAutoRelease data;
 
-		HandlerResponse processRequest(std::string& textMessage);
+		static const QHash<QString, RpcMethodHandler> messageMap;
+		static const QSet<QString> authNotRequired;
 
-		static QHash<QString, HandlerResponse(*)(WSRequestHandler*)> messageMap;
-		static QSet<QString> authNotRequired;
+		// Category: General
+		RpcResponse GetVersion(const RpcRequest&);
+		RpcResponse GetAuthRequired(const RpcRequest&);
+		RpcResponse Authenticate(const RpcRequest&);
+		RpcResponse SetHeartbeat(const RpcRequest&);
+		RpcResponse SetFilenameFormatting(const RpcRequest&);
+		RpcResponse GetFilenameFormatting(const RpcRequest&);
+		RpcResponse GetStats(const RpcRequest&);
+		RpcResponse BroadcastCustomMessage(const RpcRequest&);
+		RpcResponse GetVideoInfo(const RpcRequest&);
+		RpcResponse OpenProjector(const RpcRequest&);
+		RpcResponse TriggerHotkeyByName(const RpcRequest&);
+		RpcResponse TriggerHotkeyBySequence(const RpcRequest&);
+		RpcResponse ExecuteBatch(const RpcRequest&);
+		RpcResponse Sleep(const RpcRequest&);
 
-		static HandlerResponse HandleGetVersion(WSRequestHandler* req);
-		static HandlerResponse HandleGetAuthRequired(WSRequestHandler* req);
-		static HandlerResponse HandleAuthenticate(WSRequestHandler* req);
+		// Category: Media Control
+		RpcResponse PlayPauseMedia(const RpcRequest&);
+		RpcResponse RestartMedia(const RpcRequest&);
+		RpcResponse StopMedia(const RpcRequest&);
+		RpcResponse NextMedia(const RpcRequest&);
+		RpcResponse PreviousMedia(const RpcRequest&);
+		RpcResponse GetMediaDuration(const RpcRequest&);
+		RpcResponse GetMediaTime(const RpcRequest&);
+		RpcResponse SetMediaTime(const RpcRequest&);
+		RpcResponse ScrubMedia(const RpcRequest&);
+		RpcResponse GetMediaState(const RpcRequest&);
+		RpcResponse GetMediaSourcesList(const RpcRequest&);
 
-		static HandlerResponse HandleGetStats(WSRequestHandler* req);
-		static HandlerResponse HandleSetHeartbeat(WSRequestHandler* req);
-		static HandlerResponse HandleGetVideoInfo(WSRequestHandler* req);
+		// Category: Outputs
+		RpcResponse ListOutputs(const RpcRequest&);
+		RpcResponse GetOutputInfo(const RpcRequest&);
+		RpcResponse StartOutput(const RpcRequest&);
+		RpcResponse StopOutput(const RpcRequest&);
 
-		static HandlerResponse HandleSetFilenameFormatting(WSRequestHandler* req);
-		static HandlerResponse HandleGetFilenameFormatting(WSRequestHandler* req);
+		// Category: Profiles
+		RpcResponse SetCurrentProfile(const RpcRequest&);
+		RpcResponse GetCurrentProfile(const RpcRequest&);
+		RpcResponse ListProfiles(const RpcRequest&);
 
-		static HandlerResponse HandleBroadcastCustomMessage(WSRequestHandler* req);
+		// Category: Recording
+		RpcResponse GetRecordingStatus(const RpcRequest&);
+		RpcResponse StartStopRecording(const RpcRequest&);
+		RpcResponse StartRecording(const RpcRequest&);
+		RpcResponse StopRecording(const RpcRequest&);
+		RpcResponse PauseRecording(const RpcRequest&);
+		RpcResponse ResumeRecording(const RpcRequest&);
+		RpcResponse SetRecordingFolder(const RpcRequest&);
+		RpcResponse GetRecordingFolder(const RpcRequest&);
 
-		static HandlerResponse HandleSetCurrentScene(WSRequestHandler* req);
-		static HandlerResponse HandleGetCurrentScene(WSRequestHandler* req);
-		static HandlerResponse HandleGetSceneList(WSRequestHandler* req);
+		// Category: Replay Buffer
+		RpcResponse GetReplayBufferStatus(const RpcRequest&);
+		RpcResponse StartStopReplayBuffer(const RpcRequest&);
+		RpcResponse StartReplayBuffer(const RpcRequest&);
+		RpcResponse StopReplayBuffer(const RpcRequest&);
+		RpcResponse SaveReplayBuffer(const RpcRequest&);
 
-		static HandlerResponse HandleSetSceneItemRender(WSRequestHandler* req);
-		static HandlerResponse HandleSetSceneItemPosition(WSRequestHandler* req);
-		static HandlerResponse HandleSetSceneItemTransform(WSRequestHandler* req);
-		static HandlerResponse HandleSetSceneItemCrop(WSRequestHandler* req);
-		static HandlerResponse HandleGetSceneItemProperties(WSRequestHandler* req);
-		static HandlerResponse HandleSetSceneItemProperties(WSRequestHandler* req);
-		static HandlerResponse HandleResetSceneItem(WSRequestHandler* req);
-		static HandlerResponse HandleDuplicateSceneItem(WSRequestHandler* req);
-		static HandlerResponse HandleDeleteSceneItem(WSRequestHandler* req);
-		static HandlerResponse HandleReorderSceneItems(WSRequestHandler* req);
+		// Category: Scene Collections
+		RpcResponse SetCurrentSceneCollection(const RpcRequest&);
+		RpcResponse GetCurrentSceneCollection(const RpcRequest&);
+		RpcResponse ListSceneCollections(const RpcRequest&);
 
-		static HandlerResponse HandleGetStreamingStatus(WSRequestHandler* req);
-		static HandlerResponse HandleStartStopStreaming(WSRequestHandler* req);
-		static HandlerResponse HandleStartStopRecording(WSRequestHandler* req);
+		// Category: Scene Items
+		RpcResponse GetSceneItemList(const RpcRequest&);
+		RpcResponse GetSceneItemProperties(const RpcRequest&);
+		RpcResponse SetSceneItemProperties(const RpcRequest&);
+		RpcResponse ResetSceneItem(const RpcRequest&);
+		RpcResponse SetSceneItemRender(const RpcRequest&);
+		RpcResponse SetSceneItemPosition(const RpcRequest&);
+		RpcResponse SetSceneItemTransform(const RpcRequest&);
+		RpcResponse SetSceneItemCrop(const RpcRequest&);
+		RpcResponse DeleteSceneItem(const RpcRequest&);
+		RpcResponse AddSceneItem(const RpcRequest&);
+		RpcResponse DuplicateSceneItem(const RpcRequest&);
 
-		static HandlerResponse HandleStartStreaming(WSRequestHandler* req);
-		static HandlerResponse HandleStopStreaming(WSRequestHandler* req);
+		// Category: Scenes
+		RpcResponse SetCurrentScene(const RpcRequest&);
+		RpcResponse GetCurrentScene(const RpcRequest&);
+		RpcResponse GetSceneList(const RpcRequest&);
+		RpcResponse CreateScene(const RpcRequest&);
+		RpcResponse ReorderSceneItems(const RpcRequest&);
+		RpcResponse SetSceneTransitionOverride(const RpcRequest&);
+		RpcResponse RemoveSceneTransitionOverride(const RpcRequest&);
+		RpcResponse GetSceneTransitionOverride(const RpcRequest&);
 
-		static HandlerResponse HandleStartRecording(WSRequestHandler* req);
-		static HandlerResponse HandleStopRecording(WSRequestHandler* req);
-		static HandlerResponse HandlePauseRecording(WSRequestHandler* req);
-		static HandlerResponse HandleResumeRecording(WSRequestHandler* req);
+		// Category: Sources
+		RpcResponse CreateSource(const RpcRequest&);
+		RpcResponse GetSourcesList(const RpcRequest&);
+		RpcResponse GetSourceTypesList(const RpcRequest&);
+		RpcResponse GetVolume(const RpcRequest&);
+		RpcResponse SetVolume(const RpcRequest&);
+		RpcResponse SetAudioTracks(const RpcRequest&);
+		RpcResponse GetAudioTracks(const RpcRequest&);
+		RpcResponse GetMute(const RpcRequest&);
+		RpcResponse SetMute(const RpcRequest&);
+		RpcResponse ToggleMute(const RpcRequest&);
+		RpcResponse GetSourceActive(const RpcRequest&);
+		RpcResponse GetAudioActive(const RpcRequest&);
+		RpcResponse SetSourceName(const RpcRequest&);
+		RpcResponse SetSyncOffset(const RpcRequest&);
+		RpcResponse GetSyncOffset(const RpcRequest&);
+		RpcResponse GetSourceSettings(const RpcRequest&);
+		RpcResponse SetSourceSettings(const RpcRequest&);
+		RpcResponse GetTextGDIPlusProperties(const RpcRequest&);
+		RpcResponse SetTextGDIPlusProperties(const RpcRequest&);
+		RpcResponse GetTextFreetype2Properties(const RpcRequest&);
+		RpcResponse SetTextFreetype2Properties(const RpcRequest&);
+		RpcResponse GetBrowserSourceProperties(const RpcRequest&);
+		RpcResponse SetBrowserSourceProperties(const RpcRequest&);
+		RpcResponse GetSpecialSources(const RpcRequest&);
+		RpcResponse GetSourceFilters(const RpcRequest&);
+		RpcResponse GetSourceFilterInfo(const RpcRequest&);
+		RpcResponse AddFilterToSource(const RpcRequest&);
+		RpcResponse RemoveFilterFromSource(const RpcRequest&);
+		RpcResponse ReorderSourceFilter(const RpcRequest&);
+		RpcResponse MoveSourceFilter(const RpcRequest&);
+		RpcResponse SetSourceFilterSettings(const RpcRequest&);
+		RpcResponse SetSourceFilterVisibility(const RpcRequest&);
+		RpcResponse GetAudioMonitorType(const RpcRequest&);
+		RpcResponse SetAudioMonitorType(const RpcRequest&);
+		RpcResponse GetSourceDefaultSettings(const RpcRequest&);
+		RpcResponse TakeSourceScreenshot(const RpcRequest&);
+		RpcResponse RefreshBrowserSource(const RpcRequest&);
 
-		static HandlerResponse HandleStartStopReplayBuffer(WSRequestHandler* req);
-		static HandlerResponse HandleStartReplayBuffer(WSRequestHandler* req);
-		static HandlerResponse HandleStopReplayBuffer(WSRequestHandler* req);
-		static HandlerResponse HandleSaveReplayBuffer(WSRequestHandler* req);
+		// Category: Streaming
+		RpcResponse GetStreamingStatus(const RpcRequest&);
+		RpcResponse StartStopStreaming(const RpcRequest&);
+		RpcResponse StartStreaming(const RpcRequest&);
+		RpcResponse StopStreaming(const RpcRequest&);
+		RpcResponse SetStreamSettings(const RpcRequest&);
+		RpcResponse GetStreamSettings(const RpcRequest&);
+		RpcResponse SaveStreamSettings(const RpcRequest&);
+		RpcResponse SendCaptions(const RpcRequest&);
 		
-		static HandlerResponse HandleSetRecordingFolder(WSRequestHandler* req);
-		static HandlerResponse HandleGetRecordingFolder(WSRequestHandler* req);
+		// Category: Virtual Cam
+		RpcResponse GetVirtualCamStatus(const RpcRequest&);
+		RpcResponse StartStopVirtualCam(const RpcRequest&);
+		RpcResponse StartVirtualCam(const RpcRequest&);
+		RpcResponse StopVirtualCam(const RpcRequest&);
 
-		static HandlerResponse HandleGetTransitionList(WSRequestHandler* req);
-		static HandlerResponse HandleGetCurrentTransition(WSRequestHandler* req);
-		static HandlerResponse HandleSetCurrentTransition(WSRequestHandler* req);
+		// Category: Studio Mode
+		RpcResponse GetStudioModeStatus(const RpcRequest&);
+		RpcResponse GetPreviewScene(const RpcRequest&);
+		RpcResponse SetPreviewScene(const RpcRequest&);
+		RpcResponse TransitionToProgram(const RpcRequest&);
+		RpcResponse EnableStudioMode(const RpcRequest&);
+		RpcResponse DisableStudioMode(const RpcRequest&);
+		RpcResponse ToggleStudioMode(const RpcRequest&);
 
-		static HandlerResponse HandleSetVolume(WSRequestHandler* req);
-		static HandlerResponse HandleGetVolume(WSRequestHandler* req);
-		static HandlerResponse HandleToggleMute(WSRequestHandler* req);
-		static HandlerResponse HandleSetMute(WSRequestHandler* req);
-		static HandlerResponse HandleGetMute(WSRequestHandler* req);
-		static HandlerResponse HandleSetSyncOffset(WSRequestHandler* req);
-		static HandlerResponse HandleGetSyncOffset(WSRequestHandler* req);
-		static HandlerResponse HandleGetSpecialSources(WSRequestHandler* req);
-		static HandlerResponse HandleGetSourcesList(WSRequestHandler* req);
-		static HandlerResponse HandleGetSourceTypesList(WSRequestHandler* req);
-		static HandlerResponse HandleGetSourceSettings(WSRequestHandler* req);
-		static HandlerResponse HandleSetSourceSettings(WSRequestHandler* req);
-		static HandlerResponse HandleTakeSourceScreenshot(WSRequestHandler* req);
-
-		static HandlerResponse HandleGetSourceFilters(WSRequestHandler* req);
-		static HandlerResponse HandleGetSourceFilterInfo(WSRequestHandler* req);
-		static HandlerResponse HandleAddFilterToSource(WSRequestHandler* req);
-		static HandlerResponse HandleRemoveFilterFromSource(WSRequestHandler* req);
-		static HandlerResponse HandleReorderSourceFilter(WSRequestHandler* req);
-		static HandlerResponse HandleMoveSourceFilter(WSRequestHandler* req);
-		static HandlerResponse HandleSetSourceFilterSettings(WSRequestHandler* req);
-		static HandlerResponse HandleSetSourceFilterVisibility(WSRequestHandler* req);
-
-		static HandlerResponse HandleSetCurrentSceneCollection(WSRequestHandler* req);
-		static HandlerResponse HandleGetCurrentSceneCollection(WSRequestHandler* req);
-		static HandlerResponse HandleListSceneCollections(WSRequestHandler* req);
-
-		static HandlerResponse HandleSetCurrentProfile(WSRequestHandler* req);
-		static HandlerResponse HandleGetCurrentProfile(WSRequestHandler* req);
-		static HandlerResponse HandleListProfiles(WSRequestHandler* req);
-
-		static HandlerResponse HandleSetStreamSettings(WSRequestHandler* req);
-		static HandlerResponse HandleGetStreamSettings(WSRequestHandler* req);
-		static HandlerResponse HandleSaveStreamSettings(WSRequestHandler* req);
-#if BUILD_CAPTIONS
-		static HandlerResponse HandleSendCaptions(WSRequestHandler * req);
-#endif
-
-		static HandlerResponse HandleSetTransitionDuration(WSRequestHandler* req);
-		static HandlerResponse HandleGetTransitionDuration(WSRequestHandler* req);
-
-		static HandlerResponse HandleGetStudioModeStatus(WSRequestHandler* req);
-		static HandlerResponse HandleGetPreviewScene(WSRequestHandler* req);
-		static HandlerResponse HandleSetPreviewScene(WSRequestHandler* req);
-		static HandlerResponse HandleTransitionToProgram(WSRequestHandler* req);
-		static HandlerResponse HandleEnableStudioMode(WSRequestHandler* req);
-		static HandlerResponse HandleDisableStudioMode(WSRequestHandler* req);
-		static HandlerResponse HandleToggleStudioMode(WSRequestHandler* req);
-
-		static HandlerResponse HandleSetTextGDIPlusProperties(WSRequestHandler* req);
-		static HandlerResponse HandleGetTextGDIPlusProperties(WSRequestHandler* req);
-
-		static HandlerResponse HandleSetTextFreetype2Properties(WSRequestHandler* req);
-		static HandlerResponse HandleGetTextFreetype2Properties(WSRequestHandler* req);
-
-		static HandlerResponse HandleSetBrowserSourceProperties(WSRequestHandler* req);
-		static HandlerResponse HandleGetBrowserSourceProperties(WSRequestHandler* req);
-
-		static HandlerResponse HandleListOutputs(WSRequestHandler* req);
-		static HandlerResponse HandleGetOutputInfo(WSRequestHandler* req);
-		static HandlerResponse HandleStartOutput(WSRequestHandler* req);
-		static HandlerResponse HandleStopOutput(WSRequestHandler* req);
+		// Category: Transitions
+		RpcResponse GetTransitionList(const RpcRequest&);
+		RpcResponse GetCurrentTransition(const RpcRequest&);
+		RpcResponse SetCurrentTransition(const RpcRequest&);
+		RpcResponse SetTransitionDuration(const RpcRequest&);
+		RpcResponse GetTransitionDuration(const RpcRequest&);
+		RpcResponse GetTransitionPosition(const RpcRequest&);
+		RpcResponse GetTransitionSettings(const RpcRequest&);
+		RpcResponse SetTransitionSettings(const RpcRequest&);
+		RpcResponse ReleaseTBar(const RpcRequest&);
+		RpcResponse SetTBarPosition(const RpcRequest&);
 };

src/WSRequestHandler_General.cpp

@@ -1,9 +1,13 @@
+#include "WSRequestHandler.h"
+
+#include <QtCore/QByteArray>
+#include <QtGui/QImageWriter>
+
 #include "obs-websocket.h"
 #include "Config.h"
 #include "Utils.h"
 #include "WSEvents.h"
-
-#include "WSRequestHandler.h"
+#include "protocol/OBSRemoteProtocol.h"
 
 #define CASE(x) case x: return #x;
 const char *describe_output_format(int format) {
@@ -60,32 +64,41 @@ const char *describe_scale_type(int scale) {
  * @return {String} `obs-websocket-version` obs-websocket plugin version.
  * @return {String} `obs-studio-version` OBS Studio program version.
  * @return {String} `available-requests` List of available request types, formatted as a comma-separated list string (e.g. : "Method1,Method2,Method3").
+ * @return {String} `supported-image-export-formats` List of supported formats for features that use image export (like the TakeSourceScreenshot request type) formatted as a comma-separated list string
  *
  * @api requests
  * @name GetVersion
  * @category general
  * @since 0.3
  */
-HandlerResponse WSRequestHandler::HandleGetVersion(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::GetVersion(const RpcRequest& request) {
 	QString obsVersion = Utils::OBSVersionString();
 
-	QList<QString> names = req->messageMap.keys();
-	names.sort(Qt::CaseInsensitive);
+	QList<QString> names = messageMap.keys();
+	QList<QByteArray> imageWriterFormats = QImageWriter::supportedImageFormats();
 
 	// (Palakis) OBS' data arrays only support object arrays, so I improvised.
 	QString requests;
+	names.sort(Qt::CaseInsensitive);
 	requests += names.takeFirst();
-	for (QString reqName : names) {
+	for (const QString& reqName : names) {
 		requests += ("," + reqName);
 	}
 
+	QString supportedImageExportFormats;
+	supportedImageExportFormats += QString::fromUtf8(imageWriterFormats.takeFirst());
+	for (const QByteArray& format : imageWriterFormats) {
+		supportedImageExportFormats += ("," + QString::fromUtf8(format));
+	}
+
 	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());
+	obs_data_set_string(data, "supported-image-export-formats", supportedImageExportFormats.toUtf8());
 
-	return req->SendOKResponse(data);
+	return request.success(data);
 }
 
 /**
@@ -101,21 +114,21 @@ HandlerResponse WSRequestHandler::HandleGetVersion(WSRequestHandler* req) {
  * @category general
  * @since 0.3
  */
-HandlerResponse WSRequestHandler::HandleGetAuthRequired(WSRequestHandler* req) {
-	bool authRequired = GetConfig()->AuthRequired;
+RpcResponse WSRequestHandler::GetAuthRequired(const RpcRequest& request) {
+	auto config = GetConfig();
+	bool authRequired = (config && config->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->SessionChallenge.toUtf8());
 		obs_data_set_string(data, "salt",
 			config->Salt.toUtf8());
 	}
 
-	return req->SendOKResponse(data);
+	return request.success(data);
 }
 
 /**
@@ -128,26 +141,27 @@ HandlerResponse WSRequestHandler::HandleGetAuthRequired(WSRequestHandler* req) {
  * @category general
  * @since 0.3
  */
-HandlerResponse WSRequestHandler::HandleAuthenticate(WSRequestHandler* req) {
-	if (!req->hasField("auth")) {
-		return req->SendErrorResponse("missing request parameters");
+RpcResponse WSRequestHandler::Authenticate(const RpcRequest& request) {
+	if (!request.hasField("auth")) {
+		return request.failed("missing request parameters");
 	}
 
-	if (req->_connProperties.isAuthenticated()) {
-		return req->SendErrorResponse("already authenticated");
+	if (_connProperties.isAuthenticated()) {
+		return request.failed("already authenticated");
 	}
 
-	QString auth = obs_data_get_string(req->data, "auth");
+	QString auth = obs_data_get_string(request.parameters(), "auth");
 	if (auth.isEmpty()) {
-		return req->SendErrorResponse("auth not specified!");
+		return request.failed("auth not specified!");
 	}
 
-	if (GetConfig()->CheckAuth(auth) == false) {
-		return req->SendErrorResponse("Authentication Failed.");
+	auto config = GetConfig();
+	if (!config || (config->CheckAuth(auth) == false)) {
+		return request.failed("Authentication Failed.");
 	}
 
-	req->_connProperties.setAuthenticated(true);
-	return req->SendOKResponse();
+	_connProperties.setAuthenticated(true);
+	return request.success();
 }
 
 /**
@@ -159,18 +173,20 @@ HandlerResponse WSRequestHandler::HandleAuthenticate(WSRequestHandler* req) {
  * @name SetHeartbeat
  * @category general
  * @since 4.3.0
+ * @deprecated Since 4.9.0. Please poll the appropriate data using requests. Will be removed in v5.0.0.
  */
-HandlerResponse WSRequestHandler::HandleSetHeartbeat(WSRequestHandler* req) {
-	if (!req->hasField("enable")) {
-		return req->SendErrorResponse("Heartbeat <enable> parameter missing");
+RpcResponse WSRequestHandler::SetHeartbeat(const RpcRequest& request) {
+	if (!request.hasField("enable")) {
+		return request.failed("Heartbeat <enable> parameter missing");
 	}
 
 	auto events = GetEventsSystem();
-	events->HeartbeatIsActive = obs_data_get_bool(req->data, "enable");
+	events->HeartbeatIsActive = obs_data_get_bool(request.parameters(), "enable");
 
 	OBSDataAutoRelease response = obs_data_create();
 	obs_data_set_bool(response, "enable", events->HeartbeatIsActive);
-	return req->SendOKResponse(response);
+
+	return request.success(response);
 }
 
 /**
@@ -183,18 +199,19 @@ HandlerResponse WSRequestHandler::HandleSetHeartbeat(WSRequestHandler* req) {
  * @category general
  * @since 4.3.0
  */
-HandlerResponse WSRequestHandler::HandleSetFilenameFormatting(WSRequestHandler* req) {
-	if (!req->hasField("filename-formatting")) {
-		return req->SendErrorResponse("<filename-formatting> parameter missing");
+RpcResponse WSRequestHandler::SetFilenameFormatting(const RpcRequest& request) {
+	if (!request.hasField("filename-formatting")) {
+		return request.failed("<filename-formatting> parameter missing");
 	}
 
-	QString filenameFormatting = obs_data_get_string(req->data, "filename-formatting");
+	QString filenameFormatting = obs_data_get_string(request.parameters(), "filename-formatting");
 	if (filenameFormatting.isEmpty()) {
-		return req->SendErrorResponse("invalid request parameters");
+		return request.failed("invalid request parameters");
 	}
 
 	Utils::SetFilenameFormatting(filenameFormatting.toUtf8());
-	return req->SendOKResponse();
+
+	return request.success();
 }
 
 /**
@@ -207,28 +224,30 @@ HandlerResponse WSRequestHandler::HandleSetFilenameFormatting(WSRequestHandler*
  * @category general
  * @since 4.3.0
  */
-HandlerResponse WSRequestHandler::HandleGetFilenameFormatting(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::GetFilenameFormatting(const RpcRequest& request) {
 	OBSDataAutoRelease response = obs_data_create();
 	obs_data_set_string(response, "filename-formatting", Utils::GetFilenameFormatting());
-	return req->SendOKResponse(response);
+
+	return request.success(response);
 }
 
 /**
  * Get OBS stats (almost the same info as provided in OBS' stats window)
  *
- * @return {OBSStats} `stats` OBS stats
+ * @return {OBSStats} `stats` [OBS stats](#obsstats)
  *
  * @api requests
  * @name GetStats
  * @category general
  * @since 4.6.0
  */
-HandlerResponse WSRequestHandler::HandleGetStats(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::GetStats(const RpcRequest& request) {
 	OBSDataAutoRelease stats = GetEventsSystem()->GetStats();
 
 	OBSDataAutoRelease response = obs_data_create();
 	obs_data_set_obj(response, "stats", stats);
-	return req->SendOKResponse(response);
+
+	return request.success(response);
 }
 
 /**
@@ -242,26 +261,26 @@ HandlerResponse WSRequestHandler::HandleGetStats(WSRequestHandler* req) {
  * @category general
  * @since 4.7.0
  */
-HandlerResponse WSRequestHandler::HandleBroadcastCustomMessage(WSRequestHandler* req) {
-	if (!req->hasField("realm") || !req->hasField("data")) {
-		return req->SendErrorResponse("missing request parameters");
+RpcResponse WSRequestHandler::BroadcastCustomMessage(const RpcRequest& request) {
+	if (!request.hasField("realm") || !request.hasField("data")) {
+		return request.failed("missing request parameters");
 	}
 
-	QString realm = obs_data_get_string(req->data, "realm");
-	OBSDataAutoRelease data = obs_data_get_obj(req->data, "data");
+	QString realm = obs_data_get_string(request.parameters(), "realm");
+	OBSDataAutoRelease data = obs_data_get_obj(request.parameters(), "data");
 
 	if (realm.isEmpty()) {
-		return req->SendErrorResponse("realm not specified!");
+		return request.failed("realm not specified!");
 	}
 
 	if (!data) {
-		return req->SendErrorResponse("data not specified!");
+		return request.failed("data not specified!");
 	}
 
 	auto events = GetEventsSystem();
 	events->OnBroadcastCustomMessage(realm, data);
 
-	return req->SendOKResponse();
+	return request.success();
 }
 
 
@@ -283,9 +302,10 @@ HandlerResponse WSRequestHandler::HandleBroadcastCustomMessage(WSRequestHandler*
  * @category general
  * @since 4.6.0 
  */
-HandlerResponse WSRequestHandler::HandleGetVideoInfo(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::GetVideoInfo(const RpcRequest& request) {
 	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);
@@ -296,5 +316,182 @@ HandlerResponse WSRequestHandler::HandleGetVideoInfo(WSRequestHandler* req) {
 	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);
+
+	return request.success(response);
+}
+
+/**
+ * Open a projector window or create a projector on a monitor. Requires OBS v24.0.4 or newer.
+ *
+ * @param {String (Optional)} `type` Type of projector: `Preview` (default), `Source`, `Scene`, `StudioProgram`, or `Multiview` (case insensitive).
+ * @param {int (Optional)} `monitor` Monitor to open the projector on. If -1 or omitted, opens a window.
+ * @param {String (Optional)} `geometry` Size and position of the projector window (only if monitor is -1). Encoded in Base64 using [Qt's geometry encoding](https://doc.qt.io/qt-5/qwidget.html#saveGeometry). Corresponds to OBS's saved projectors.
+ * @param {String (Optional)} `name` Name of the source or scene to be displayed (ignored for other projector types).
+ *
+ * @api requests
+ * @name OpenProjector
+ * @category general
+ * @since 4.8.0
+ */
+RpcResponse WSRequestHandler::OpenProjector(const RpcRequest& request) {
+	const char* type = obs_data_get_string(request.parameters(), "type");
+
+	int monitor = -1;
+	if (request.hasField("monitor")) {
+		monitor = obs_data_get_int(request.parameters(), "monitor");
+	}
+
+	const char* geometry = obs_data_get_string(request.parameters(), "geometry");
+	const char* name = obs_data_get_string(request.parameters(), "name");
+
+	obs_frontend_open_projector(type, monitor, geometry, name);
+	return request.success();
+}
+
+/**
+* Executes hotkey routine, identified by hotkey unique name
+*
+* @param {String} `hotkeyName` Unique name of the hotkey, as defined when registering the hotkey (e.g. "ReplayBuffer.Save")
+*
+* @api requests
+* @name TriggerHotkeyByName
+* @category general
+* @since 4.9.0
+*/
+RpcResponse WSRequestHandler::TriggerHotkeyByName(const RpcRequest& request) {
+	const char* name = obs_data_get_string(request.parameters(), "hotkeyName");
+
+	obs_hotkey_t* hk = Utils::FindHotkeyByName(name);
+	if (!hk) {
+		return request.failed("hotkey not found");
+	}
+	obs_hotkey_trigger_routed_callback(obs_hotkey_get_id(hk), true);
+	return request.success();
+}
+
+/**
+* Executes hotkey routine, identified by bound combination of keys. A single key combination might trigger multiple hotkey routines depending on user settings 
+*
+* @param {String} `keyId` Main key identifier (e.g. `OBS_KEY_A` for key "A"). Available identifiers [here](https://github.com/obsproject/obs-studio/blob/master/libobs/obs-hotkeys.h)
+* @param {Object (Optional)} `keyModifiers` Optional key modifiers object. False entries can be ommitted
+* @param {boolean} `keyModifiers.shift` Trigger Shift Key
+* @param {boolean} `keyModifiers.alt` Trigger Alt Key
+* @param {boolean} `keyModifiers.control` Trigger Control (Ctrl) Key
+* @param {boolean} `keyModifiers.command` Trigger Command Key (Mac)
+*
+* @api requests
+* @name TriggerHotkeyBySequence
+* @category general
+* @since 4.9.0
+*/
+RpcResponse WSRequestHandler::TriggerHotkeyBySequence(const RpcRequest& request) {
+	if (!request.hasField("keyId")) {
+		return request.failed("missing request keyId parameter");
+	}
+
+	OBSDataAutoRelease data = obs_data_get_obj(request.parameters(), "keyModifiers");
+
+	obs_key_combination_t combo = {0};
+	uint32_t modifiers = 0;
+	if (obs_data_get_bool(data, "shift"))
+		modifiers |= INTERACT_SHIFT_KEY;
+	if (obs_data_get_bool(data, "control"))
+		modifiers |= INTERACT_CONTROL_KEY;
+	if (obs_data_get_bool(data, "alt"))
+		modifiers |= INTERACT_ALT_KEY;
+	if (obs_data_get_bool(data, "command"))
+		modifiers |= INTERACT_COMMAND_KEY;
+
+	combo.modifiers = modifiers;
+	combo.key = obs_key_from_name(obs_data_get_string(request.parameters(), "keyId"));
+
+	if (!modifiers
+		&& (combo.key == OBS_KEY_NONE || combo.key >= OBS_KEY_LAST_VALUE)) {
+		return request.failed("invalid key-modifier combination");
+	}
+
+	// Inject hotkey press-release sequence
+	obs_hotkey_inject_event(combo, false);
+	obs_hotkey_inject_event(combo, true);
+	obs_hotkey_inject_event(combo, false);
+
+	return request.success();
+}
+
+/**
+* Executes a list of requests sequentially (one-by-one on the same thread).
+*
+* @param {Array<Object>} `requests` Array of requests to perform. Executed in order.
+* @param {String} `requests.*.request-type` Request type. Eg. `GetVersion`.
+* @param {String (Optional)} `requests.*.message-id` ID of the individual request. Can be any string and not required to be unique. Defaults to empty string if not specified.
+* @param {boolean (Optional)} `abortOnFail` Stop processing batch requests if one returns a failure.
+*
+* @return {Array<Object>} `results` Batch requests results, ordered sequentially.
+* @return {String} `results.*.message-id` ID of the individual request which was originally provided by the client.
+* @return {String} `results.*.status` Status response as string. Either `ok` or `error`.
+* @return {String (Optional)} `results.*.error` Error message accompanying an `error` status.
+*
+* @api requests
+* @name ExecuteBatch
+* @category general
+* @since 4.9.0
+*/
+RpcResponse WSRequestHandler::ExecuteBatch(const RpcRequest& request) {
+	if (!request.hasField("requests")) {
+		return request.failed("missing request parameters");
+	}
+
+	bool abortOnFail = obs_data_get_bool(request.parameters(), "abortOnFail");
+
+	OBSDataArrayAutoRelease results = obs_data_array_create();
+
+	OBSDataArrayAutoRelease requests = obs_data_get_array(request.parameters(), "requests");
+	size_t requestsCount = obs_data_array_count(requests);
+	for (size_t i = 0; i < requestsCount; i++) {
+		OBSDataAutoRelease requestData = obs_data_array_item(requests, i);
+		QString messageId = obs_data_get_string(requestData, "message-id");
+		QString methodName = obs_data_get_string(requestData, "request-type");
+		obs_data_unset_user_value(requestData, "request-type");
+		obs_data_unset_user_value(requestData, "message-id");
+
+		// build RpcRequest from json data object
+		RpcRequest subRequest(messageId, methodName, requestData);
+
+		// execute the request
+		RpcResponse subResponse = processRequest(subRequest);
+
+		// transform response into json data
+		OBSDataAutoRelease subResponseData = OBSRemoteProtocol::rpcResponseToJsonData(subResponse);
+
+		obs_data_array_push_back(results, subResponseData);
+
+		// if told to abort on fail and a failure occurs, stop request processing and return the progress
+		if (abortOnFail && (subResponse.status() == RpcResponse::Status::Error))
+			break;
+	}
+
+	OBSDataAutoRelease response = obs_data_create();
+	obs_data_set_array(response, "results", results);
+	return request.success(response);
+}
+
+/**
+ * Waits for the specified duration. Designed to be used in `ExecuteBatch` operations.
+ *
+ * @param {int} `sleepMillis` Delay in milliseconds to wait before continuing.
+ *
+ * @api requests
+ * @name Sleep
+ * @category general
+ * @since 4.9.1
+ */
+RpcResponse WSRequestHandler::Sleep(const RpcRequest& request) {
+	if (!request.hasField("sleepMillis")) {
+		return request.failed("missing request parameters");
+	}
+
+	long long sleepMillis = obs_data_get_int(request.parameters(), "sleepMillis");
+	std::this_thread::sleep_for(std::chrono::milliseconds(sleepMillis));
+
+	return request.success();
 }

src/WSRequestHandler_MediaControl.cpp

@@ -0,0 +1,405 @@
+#include "Utils.h"
+
+#include "WSRequestHandler.h"
+
+bool isMediaSource(const QString& sourceKind)
+{
+	return (sourceKind == "vlc_source" || sourceKind == "ffmpeg_source");
+}
+
+QString getSourceMediaState(obs_source_t *source)
+{
+	QString mediaState;
+	enum obs_media_state mstate = obs_source_media_get_state(source);
+	switch (mstate) {
+	case OBS_MEDIA_STATE_NONE:
+		mediaState = "none";
+		break;
+	case OBS_MEDIA_STATE_PLAYING:
+		mediaState = "playing";
+		break;
+	case OBS_MEDIA_STATE_OPENING:
+		mediaState = "opening";
+		break;
+	case OBS_MEDIA_STATE_BUFFERING:
+		mediaState = "buffering";
+		break;
+	case OBS_MEDIA_STATE_PAUSED:
+		mediaState = "paused";
+		break;
+	case OBS_MEDIA_STATE_STOPPED:
+		mediaState = "stopped";
+		break;
+	case OBS_MEDIA_STATE_ENDED:
+		mediaState = "ended";
+		break;
+	case OBS_MEDIA_STATE_ERROR:
+		mediaState = "error";
+		break;
+	default:
+		mediaState = "unknown";
+	}
+	return mediaState;
+}
+
+/**
+* Pause or play a media source. Supports ffmpeg and vlc media sources (as of OBS v25.0.8)
+* Note :Leaving out `playPause` toggles the current pause state
+*
+* @param {String} `sourceName` Source name.
+* @param {boolean} `playPause` (optional) Whether to pause or play the source. `false` for play, `true` for pause.
+*
+* @api requests
+* @name PlayPauseMedia
+* @category media control
+* @since 4.9.0
+*/
+RpcResponse WSRequestHandler::PlayPauseMedia(const RpcRequest& request) {
+	if (!request.hasField("sourceName")) {
+		return request.failed("missing request parameters");
+	}
+
+	QString sourceName = obs_data_get_string(request.parameters(), "sourceName");
+	bool playPause = obs_data_get_bool(request.parameters(), "playPause");
+	if (sourceName.isEmpty()) {
+		return request.failed("invalid request parameters");
+	}
+
+	OBSSourceAutoRelease source = obs_get_source_by_name(sourceName.toUtf8());
+	if (!source) {
+		return request.failed("specified source doesn't exist");
+	}
+	if (!request.hasField("playPause")) {
+		if (obs_source_media_get_state(source) == obs_media_state::OBS_MEDIA_STATE_PLAYING) {
+			obs_source_media_play_pause(source, true);
+		} else {
+			obs_source_media_play_pause(source, false);
+		}
+	} else {
+		bool playPause = obs_data_get_bool(request.parameters(), "playPause");
+		obs_source_media_play_pause(source, playPause);
+	}
+	return request.success();
+}
+
+/**
+* Restart a media source. Supports ffmpeg and vlc media sources (as of OBS v25.0.8)
+*
+* @param {String} `sourceName` Source name.
+*
+* @api requests
+* @name RestartMedia
+* @category media control
+* @since 4.9.0
+*/
+RpcResponse WSRequestHandler::RestartMedia(const RpcRequest& request) {
+	if (!request.hasField("sourceName")) {
+		return request.failed("missing request parameters");
+	}
+
+	QString sourceName = obs_data_get_string(request.parameters(), "sourceName");
+	if (sourceName.isEmpty()) {
+		return request.failed("invalid request parameters");
+	}
+
+	OBSSourceAutoRelease source = obs_get_source_by_name(sourceName.toUtf8());
+	if (!source) {
+		return request.failed("specified source doesn't exist");
+	}
+
+	obs_source_media_restart(source);
+	return request.success();
+}
+
+/**
+* Stop a media source. Supports ffmpeg and vlc media sources (as of OBS v25.0.8)
+*
+* @param {String} `sourceName` Source name.
+*
+* @api requests
+* @name StopMedia
+* @category media control
+* @since 4.9.0
+*/
+RpcResponse WSRequestHandler::StopMedia(const RpcRequest& request) {
+	if (!request.hasField("sourceName")) {
+		return request.failed("missing request parameters");
+	}
+
+	QString sourceName = obs_data_get_string(request.parameters(), "sourceName");
+	if (sourceName.isEmpty()) {
+		return request.failed("invalid request parameters");
+	}
+
+	OBSSourceAutoRelease source = obs_get_source_by_name(sourceName.toUtf8());
+	if (!source) {
+		return request.failed("specified source doesn't exist");
+	}
+
+	obs_source_media_stop(source);
+	return request.success();
+}
+
+/**
+* Skip to the next media item in the playlist. Supports only vlc media source (as of OBS v25.0.8)
+*
+* @param {String} `sourceName` Source name.
+*
+* @api requests
+* @name NextMedia
+* @category media control
+* @since 4.9.0
+*/
+RpcResponse WSRequestHandler::NextMedia(const RpcRequest& request) {
+	if (!request.hasField("sourceName")) {
+		return request.failed("missing request parameters");
+	}
+
+	QString sourceName = obs_data_get_string(request.parameters(), "sourceName");
+	if (sourceName.isEmpty()) {
+		return request.failed("invalid request parameters");
+	}
+
+	OBSSourceAutoRelease source = obs_get_source_by_name(sourceName.toUtf8());
+	if (!source) {
+		return request.failed("specified source doesn't exist");
+	}
+
+	obs_source_media_next(source);
+	return request.success();
+}
+
+/**
+* Go to the previous media item in the playlist. Supports only vlc media source (as of OBS v25.0.8)
+*
+* @param {String} `sourceName` Source name.
+*
+* @api requests
+* @name PreviousMedia
+* @category media control
+* @since 4.9.0
+*/
+RpcResponse WSRequestHandler::PreviousMedia(const RpcRequest& request) {
+	if (!request.hasField("sourceName")) {
+		return request.failed("missing request parameters");
+	}
+
+	QString sourceName = obs_data_get_string(request.parameters(), "sourceName");
+	if (sourceName.isEmpty()) {
+		return request.failed("invalid request parameters");
+	}
+
+	OBSSourceAutoRelease source = obs_get_source_by_name(sourceName.toUtf8());
+	if (!source) {
+		return request.failed("specified source doesn't exist");
+	}
+
+	obs_source_media_previous(source);
+	return request.success();
+}
+
+/**
+* Get the length of media in milliseconds. Supports ffmpeg and vlc media sources (as of OBS v25.0.8)
+* Note: For some reason, for the first 5 or so seconds that the media is playing, the total duration can be off by upwards of 50ms.
+*
+* @param {String} `sourceName` Source name.
+*
+* @return {int} `mediaDuration` The total length of media in milliseconds..
+*
+* @api requests
+* @name GetMediaDuration
+* @category media control
+* @since 4.9.0
+*/
+RpcResponse WSRequestHandler::GetMediaDuration(const RpcRequest& request) {
+	if (!request.hasField("sourceName")) {
+		return request.failed("missing request parameters");
+	}
+
+	QString sourceName = obs_data_get_string(request.parameters(), "sourceName");
+	if (sourceName.isEmpty()) {
+		return request.failed("invalid request parameters");
+	}
+
+	OBSSourceAutoRelease source = obs_get_source_by_name(sourceName.toUtf8());
+	if (!source) {
+		return request.failed("specified source doesn't exist");
+	}
+
+	OBSDataAutoRelease response = obs_data_create();
+	obs_data_set_int(response, "mediaDuration", obs_source_media_get_duration(source));
+	return request.success(response);
+}
+
+/**
+* Get the current timestamp of media in milliseconds. Supports ffmpeg and vlc media sources (as of OBS v25.0.8)
+*
+* @param {String} `sourceName` Source name.
+*
+* @return {int} `timestamp` The time in milliseconds since the start of the media.
+*
+* @api requests
+* @name GetMediaTime
+* @category media control
+* @since 4.9.0
+*/
+RpcResponse WSRequestHandler::GetMediaTime(const RpcRequest& request) {
+	if (!request.hasField("sourceName")) {
+		return request.failed("missing request parameters");
+	}
+
+	QString sourceName = obs_data_get_string(request.parameters(), "sourceName");
+	if (sourceName.isEmpty()) {
+		return request.failed("invalid request parameters");
+	}
+
+	OBSSourceAutoRelease source = obs_get_source_by_name(sourceName.toUtf8());
+	if (!source) {
+		return request.failed("specified source doesn't exist");
+	}
+
+	OBSDataAutoRelease response = obs_data_create();
+	obs_data_set_int(response, "timestamp", obs_source_media_get_time(source));
+	return request.success(response);
+}
+
+/**
+* Set the timestamp of a media source. Supports ffmpeg and vlc media sources (as of OBS v25.0.8)
+*
+* @param {String} `sourceName` Source name.
+* @param {int} `timestamp` Milliseconds to set the timestamp to.
+*
+* @api requests
+* @name SetMediaTime
+* @category media control
+* @since 4.9.0
+*/
+RpcResponse WSRequestHandler::SetMediaTime(const RpcRequest& request) {
+	if (!request.hasField("sourceName") || !request.hasField("timestamp")) {
+		return request.failed("missing request parameters");
+	}
+
+	QString sourceName = obs_data_get_string(request.parameters(), "sourceName");
+	int64_t timestamp = (int64_t)obs_data_get_int(request.parameters(), "timestamp");
+	if (sourceName.isEmpty()) {
+		return request.failed("invalid request parameters");
+	}
+
+	OBSSourceAutoRelease source = obs_get_source_by_name(sourceName.toUtf8());
+	if (!source) {
+		return request.failed("specified source doesn't exist");
+	}
+
+	obs_source_media_set_time(source, timestamp);
+	return request.success();
+}
+
+/**
+* Scrub media using a supplied offset. Supports ffmpeg and vlc media sources (as of OBS v25.0.8)
+* Note: Due to processing/network delays, this request is not perfect. The processing rate of this request has also not been tested.
+*
+* @param {String} `sourceName` Source name.
+* @param {int} `timeOffset` Millisecond offset (positive or negative) to offset the current media position.
+*
+* @api requests
+* @name ScrubMedia
+* @category media control
+* @since 4.9.0
+*/
+RpcResponse WSRequestHandler::ScrubMedia(const RpcRequest& request) {
+	if (!request.hasField("sourceName") || !request.hasField("timeOffset")) {
+		return request.failed("missing request parameters");
+	}
+
+	QString sourceName = obs_data_get_string(request.parameters(), "sourceName");
+	int64_t timeOffset = (int64_t)obs_data_get_int(request.parameters(), "timeOffset");
+	if (sourceName.isEmpty()) {
+		return request.failed("invalid request parameters");
+	}
+
+	OBSSourceAutoRelease source = obs_get_source_by_name(sourceName.toUtf8());
+	if (!source) {
+		return request.failed("specified source doesn't exist");
+	}
+
+	int64_t newTime = obs_source_media_get_time(source) + timeOffset;
+	if (newTime < 0) {
+		newTime = 0;
+	}
+
+	obs_source_media_set_time(source, newTime);
+	return request.success();
+}
+
+/**
+* Get the current playing state of a media source. Supports ffmpeg and vlc media sources (as of OBS v25.0.8)
+*
+* @param {String} `sourceName` Source name.
+*
+* @return {String} `mediaState` The media state of the provided source. States: `none`, `playing`, `opening`, `buffering`, `paused`, `stopped`, `ended`, `error`, `unknown`
+*
+* @api requests
+* @name GetMediaState
+* @category media control
+* @since 4.9.0
+*/
+RpcResponse WSRequestHandler::GetMediaState(const RpcRequest& request) {
+	if (!request.hasField("sourceName")) {
+		return request.failed("missing request parameters");
+	}
+
+	QString sourceName = obs_data_get_string(request.parameters(), "sourceName");
+	if (sourceName.isEmpty()) {
+		return request.failed("invalid request parameters");
+	}
+
+	OBSSourceAutoRelease source = obs_get_source_by_name(sourceName.toUtf8());
+	if (!source) {
+		return request.failed("specified source doesn't exist");
+	}
+
+	OBSDataAutoRelease response = obs_data_create();
+	obs_data_set_string(response, "mediaState", getSourceMediaState(source).toUtf8());
+
+	return request.success(response);
+}
+
+/**
+* List the media state of all media sources (vlc and media source)
+*
+* @return {Array<Object>} `mediaSources` Array of sources
+* @return {String} `mediaSources.*.sourceName` Unique source name
+* @return {String} `mediaSources.*.sourceKind` Unique source internal type (a.k.a `ffmpeg_source` or `vlc_source`)
+* @return {String} `mediaSources.*.mediaState` The current state of media for that source. States: `none`, `playing`, `opening`, `buffering`, `paused`, `stopped`, `ended`, `error`, `unknown`
+*
+* @api requests
+* @name GetMediaSourcesList
+* @category sources
+* @since 4.9.0
+*/
+RpcResponse WSRequestHandler::GetMediaSourcesList(const RpcRequest& request)
+{
+	OBSDataArrayAutoRelease sourcesArray = obs_data_array_create();
+
+	auto sourceEnumProc = [](void* privateData, obs_source_t* source) -> bool {
+		obs_data_array_t* sourcesArray = (obs_data_array_t*)privateData;
+
+		QString sourceKind = obs_source_get_id(source);
+		if (isMediaSource(sourceKind)) {
+			OBSDataAutoRelease sourceData = obs_data_create();
+			obs_data_set_string(sourceData, "sourceName", obs_source_get_name(source));
+			obs_data_set_string(sourceData, "sourceKind", sourceKind.toUtf8());
+
+			QString mediaState = getSourceMediaState(source);
+			obs_data_set_string(sourceData, "mediaState", mediaState.toUtf8());
+
+			obs_data_array_push_back(sourcesArray, sourceData);
+		}
+		return true;
+	};
+	obs_enum_sources(sourceEnumProc, sourcesArray);
+
+	OBSDataAutoRelease response = obs_data_create();
+	obs_data_set_array(response, "mediaSources", sourcesArray);
+	return request.success(response);
+}

src/WSRequestHandler_Outputs.cpp

@@ -1,3 +1,5 @@
+#include <functional>
+
 #include "WSRequestHandler.h"
 
 /**
@@ -13,7 +15,7 @@
 * @property {boolean} `flags.encoded` Output is encoded
 * @property {boolean} `flags.multiTrack` Output uses several audio tracks
 * @property {boolean} `flags.service` Output uses a service
-* @property {Object} `settings` Output name
+* @property {Object} `settings` Output settings
 * @property {boolean} `active` Output status (active or not)
 * @property {boolean} `reconnecting` Output reconnection status (reconnecting or not)
 * @property {double} `congestion` Output congestion
@@ -57,19 +59,19 @@ obs_data_t* getOutputInfo(obs_output_t* output)
 	return data;
 }
 
-HandlerResponse findOutputOrFail(WSRequestHandler* req, std::function<HandlerResponse (obs_output_t*)> callback)
+RpcResponse findOutputOrFail(const RpcRequest& request, std::function<RpcResponse (obs_output_t*, const RpcRequest&)> callback)
 {
-	if (!req->hasField("outputName")) {
-		return req->SendErrorResponse("missing request parameters");
+	if (!request.hasField("outputName")) {
+		return request.failed("missing request parameters");
 	}
 
-	const char* outputName = obs_data_get_string(req->parameters(), "outputName");
+	const char* outputName = obs_data_get_string(request.parameters(), "outputName");
 	OBSOutputAutoRelease output = obs_get_output_by_name(outputName);
 	if (!output) {
-		return req->SendErrorResponse("specified output doesn't exist");
+		return request.failed("specified output doesn't exist");
 	}
 
-	return callback(output);	
+	return callback(output, request);
 }
 
 /**
@@ -82,7 +84,7 @@ HandlerResponse findOutputOrFail(WSRequestHandler* req, std::function<HandlerRes
 * @category outputs
 * @since 4.7.0
 */
-HandlerResponse WSRequestHandler::HandleListOutputs(WSRequestHandler* req)
+RpcResponse WSRequestHandler::ListOutputs(const RpcRequest& request)
 {
 	OBSDataArrayAutoRelease outputs = obs_data_array_create();
 
@@ -97,7 +99,8 @@ HandlerResponse WSRequestHandler::HandleListOutputs(WSRequestHandler* req)
 
 	OBSDataAutoRelease fields = obs_data_create();
 	obs_data_set_array(fields, "outputs", outputs);
-	return req->SendOKResponse(fields);
+
+	return request.success(fields);
 }
 
 /**
@@ -112,20 +115,22 @@ HandlerResponse WSRequestHandler::HandleListOutputs(WSRequestHandler* req)
 * @category outputs
 * @since 4.7.0
 */
-HandlerResponse WSRequestHandler::HandleGetOutputInfo(WSRequestHandler* req)
+RpcResponse WSRequestHandler::GetOutputInfo(const RpcRequest& request)
 {
-	return findOutputOrFail(req, [req](obs_output_t* output) {
+	return findOutputOrFail(request, [](obs_output_t* output, const RpcRequest& request) {
 		OBSDataAutoRelease outputInfo = getOutputInfo(output);
 
 		OBSDataAutoRelease fields = obs_data_create();
 		obs_data_set_obj(fields, "outputInfo", outputInfo);
-		return req->SendOKResponse(fields);
+		return request.success(fields);
 	});
 }
 
 /**
 * Start an output
 *
+* Note: Controlling outputs is an experimental feature of obs-websocket. Some plugins which add outputs to OBS may not function properly when they are controlled in this way.
+*
 * @param {String} `outputName` Output name
 *
 * @api requests
@@ -133,27 +138,29 @@ HandlerResponse WSRequestHandler::HandleGetOutputInfo(WSRequestHandler* req)
 * @category outputs
 * @since 4.7.0
 */
-HandlerResponse WSRequestHandler::HandleStartOutput(WSRequestHandler* req)
+RpcResponse WSRequestHandler::StartOutput(const RpcRequest& request)
 {
-	return findOutputOrFail(req, [req](obs_output_t* output) {
+	return findOutputOrFail(request, [](obs_output_t* output, const RpcRequest& request) {
 		if (obs_output_active(output)) {
-			return req->SendErrorResponse("output already active");
+			return request.failed("output already active");
 		}
 
 		bool success = obs_output_start(output);
 		if (!success) {
 			QString lastError = obs_output_get_last_error(output);
 			QString errorMessage = QString("output start failed: %1").arg(lastError);
-			return req->SendErrorResponse(errorMessage);
+			return request.failed(errorMessage);
 		}
 
-		return req->SendOKResponse();
+		return request.success();
 	});
 }
 
 /**
 * Stop an output
 *
+* Note: Controlling outputs is an experimental feature of obs-websocket. Some plugins which add outputs to OBS may not function properly when they are controlled in this way.
+*
 * @param {String} `outputName` Output name
 * @param {boolean (optional)} `force` Force stop (default: false)
 *
@@ -162,20 +169,20 @@ HandlerResponse WSRequestHandler::HandleStartOutput(WSRequestHandler* req)
 * @category outputs
 * @since 4.7.0
 */
-HandlerResponse WSRequestHandler::HandleStopOutput(WSRequestHandler* req)
+RpcResponse WSRequestHandler::StopOutput(const RpcRequest& request)
 {
-	return findOutputOrFail(req, [req](obs_output_t* output) {
+	return findOutputOrFail(request, [](obs_output_t* output, const RpcRequest& request) {
 		if (!obs_output_active(output)) {
-			return req->SendErrorResponse("output not active");
+			return request.failed("output not active");
 		}
 
-		bool forceStop = obs_data_get_bool(req->data, "force");
+		bool forceStop = obs_data_get_bool(request.parameters(), "force");
 		if (forceStop) {
 			obs_output_force_stop(output);
 		} else {
 			obs_output_stop(output);
 		}
 
-		return req->SendOKResponse();
+		return request.success();
 	});
 }

src/WSRequestHandler_Profiles.cpp

@@ -12,19 +12,28 @@
  * @category profiles
  * @since 4.0.0
  */
-HandlerResponse WSRequestHandler::HandleSetCurrentProfile(WSRequestHandler* req) {
-	if (!req->hasField("profile-name")) {
-		return req->SendErrorResponse("missing request parameters");
+RpcResponse WSRequestHandler::SetCurrentProfile(const RpcRequest& request) {
+	if (!request.hasField("profile-name")) {
+		return request.failed("missing request parameters");
 	}
 
-	QString profileName = obs_data_get_string(req->data, "profile-name");
-	if (profileName.isEmpty()) {
-		return req->SendErrorResponse("invalid request parameters");
+	const char* profileName = obs_data_get_string(request.parameters(), "profile-name");
+	if (!profileName) {
+		return request.failed("invalid request parameters");
 	}
 
-	// TODO : check if profile exists
-	obs_frontend_set_current_profile(profileName.toUtf8());
-	return req->SendOKResponse();
+	char** profiles = obs_frontend_get_profiles();
+	bool profileExists = Utils::StringInStringList(profiles, profileName);
+	bfree(profiles);
+	if (!profileExists) {
+		return request.failed("profile does not exist");
+	}
+
+	obs_queue_task(OBS_TASK_UI, [](void* param) {
+		obs_frontend_set_current_profile(reinterpret_cast<const char*>(param));
+	}, (void*)profileName, true);
+
+	return request.success();
 }
 
  /**
@@ -37,23 +46,26 @@ HandlerResponse WSRequestHandler::HandleSetCurrentProfile(WSRequestHandler* req)
  * @category profiles
  * @since 4.0.0
  */
-HandlerResponse WSRequestHandler::HandleGetCurrentProfile(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::GetCurrentProfile(const RpcRequest& request) {
 	OBSDataAutoRelease response = obs_data_create();
-	obs_data_set_string(response, "profile-name", obs_frontend_get_current_profile());
-	return req->SendOKResponse(response);
+	char* currentProfile = obs_frontend_get_current_profile();
+	obs_data_set_string(response, "profile-name", currentProfile);
+	bfree(currentProfile);
+	return request.success(response);
 }
 
 /**
  * Get a list of available profiles.
  *
  * @return {Array<Object>} `profiles` List of available profiles.
+ * @return {String} `profiles.*.profile-name` Filter name
  *
  * @api requests
  * @name ListProfiles
  * @category profiles
  * @since 4.0.0
  */
-HandlerResponse WSRequestHandler::HandleListProfiles(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::ListProfiles(const RpcRequest& request) {
 	char** profiles = obs_frontend_get_profiles();
 	OBSDataArrayAutoRelease list = Utils::StringListToArray(profiles, "profile-name");
 	bfree(profiles);
@@ -61,5 +73,5 @@ HandlerResponse WSRequestHandler::HandleListProfiles(WSRequestHandler* req) {
 	OBSDataAutoRelease response = obs_data_create();
 	obs_data_set_array(response, "profiles", list);
 
-	return req->SendOKResponse(response);
+	return request.success(response);
 }

src/WSRequestHandler_Recording.cpp

@@ -1,32 +1,60 @@
+#include "obs-websocket.h"
 #include "WSRequestHandler.h"
 
+#include <functional>
 #include <util/platform.h>
 #include "Utils.h"
+#include "WSEvents.h"
 
-HandlerResponse ifCanPause(WSRequestHandler* req, std::function<HandlerResponse()> callback)
+RpcResponse ifCanPause(const RpcRequest& request, std::function<RpcResponse()> callback)
 {
 	if (!obs_frontend_recording_active()) {
-		return req->SendErrorResponse("recording is not active");
-	}
-
-	if (!Utils::RecordingPauseSupported()) {
-		return req->SendErrorResponse("recording pauses are not available in this version of OBS Studio");
+		return request.failed("recording is not active");
 	}
 
 	return callback();
 }
 
  /**
- * Toggle recording on or off.
+ * Get current recording status.
+ *
+ * @return {boolean} `isRecording` Current recording status.
+ * @return {boolean} `isRecordingPaused` Whether the recording is paused or not.
+ * @return {String (optional)} `recordTimecode` Time elapsed since recording started (only present if currently recording).
+ * @return {String (optional)} `recordingFilename` Absolute path to the recording file (only present if currently recording).
+ *
+ * @api requests
+ * @name GetRecordingStatus
+ * @category recording
+ * @since 4.9.0
+ */
+RpcResponse WSRequestHandler::GetRecordingStatus(const RpcRequest& request) {
+		auto events = GetEventsSystem();
+
+		OBSDataAutoRelease data = obs_data_create();
+		obs_data_set_bool(data, "isRecording", obs_frontend_recording_active());
+		obs_data_set_bool(data, "isRecordingPaused", obs_frontend_recording_paused());
+
+		if (obs_frontend_recording_active()) {
+				QString recordingTimecode = events->getRecordingTimecode();
+				obs_data_set_string(data, "recordTimecode", recordingTimecode.toUtf8().constData());
+				obs_data_set_string(data, "recordingFilename", Utils::GetCurrentRecordingFilename());
+		}
+
+		return request.success(data);
+}
+
+/**
+ * Toggle recording on or off (depending on the current recording state).
  *
  * @api requests
  * @name StartStopRecording
  * @category recording
  * @since 0.3
  */
-HandlerResponse WSRequestHandler::HandleStartStopRecording(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::StartStopRecording(const RpcRequest& request) {
 	(obs_frontend_recording_active() ? obs_frontend_recording_stop() : obs_frontend_recording_start());
-	return req->SendOKResponse();
+	return request.success();
 }
 
 /**
@@ -38,13 +66,13 @@ HandlerResponse WSRequestHandler::HandleStartStopRecording(WSRequestHandler* req
  * @category recording
  * @since 4.1.0
  */
-HandlerResponse WSRequestHandler::HandleStartRecording(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::StartRecording(const RpcRequest& request) {
 	if (obs_frontend_recording_active()) {
-		return req->SendErrorResponse("recording already active");
+		return request.failed("recording already active");
 	}
 
 	obs_frontend_recording_start();
-	return req->SendOKResponse();
+	return request.success();
 }
 
 /**
@@ -56,13 +84,13 @@ HandlerResponse WSRequestHandler::HandleStartRecording(WSRequestHandler* req) {
  * @category recording
  * @since 4.1.0
  */
- HandlerResponse WSRequestHandler::HandleStopRecording(WSRequestHandler* req) {
+ RpcResponse WSRequestHandler::StopRecording(const RpcRequest& request) {
 	if (!obs_frontend_recording_active()) {
-		return req->SendErrorResponse("recording not active");
+		return request.failed("recording not active");
 	}
 
 	obs_frontend_recording_stop();
-	return req->SendOKResponse();
+	return request.success();
 }
 
 /**
@@ -74,14 +102,14 @@ HandlerResponse WSRequestHandler::HandleStartRecording(WSRequestHandler* req) {
 * @category recording
 * @since 4.7.0
 */
-HandlerResponse WSRequestHandler::HandlePauseRecording(WSRequestHandler* req) {
-	return ifCanPause(req, [req]() {
-		if (Utils::RecordingPaused()) {
-			return req->SendErrorResponse("recording already paused");
+RpcResponse WSRequestHandler::PauseRecording(const RpcRequest& request) {
+	return ifCanPause(request, [request]() {
+		if (obs_frontend_recording_paused()) {
+			return request.failed("recording already paused");
 		}
 
-		Utils::PauseRecording(true);
-		return req->SendOKResponse();
+		obs_frontend_recording_pause(true);
+		return request.success();
 	});
 }
 
@@ -94,14 +122,14 @@ HandlerResponse WSRequestHandler::HandlePauseRecording(WSRequestHandler* req) {
 * @category recording
 * @since 4.7.0
 */
-HandlerResponse WSRequestHandler::HandleResumeRecording(WSRequestHandler* req) {
-	return ifCanPause(req, [req]() {
-		if (!Utils::RecordingPaused()) {
-			return req->SendErrorResponse("recording is not paused");
+RpcResponse WSRequestHandler::ResumeRecording(const RpcRequest& request) {
+	return ifCanPause(request, [request]() {
+		if (!obs_frontend_recording_paused()) {
+			return request.failed("recording is not paused");
 		}
 
-		Utils::PauseRecording(false);
-		return req->SendOKResponse();
+		obs_frontend_recording_pause(false);
+		return request.success();
 	});
 }
 
@@ -109,7 +137,7 @@ HandlerResponse WSRequestHandler::HandleResumeRecording(WSRequestHandler* req) {
  * 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
+ * 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.
  * 
@@ -120,18 +148,18 @@ HandlerResponse WSRequestHandler::HandleResumeRecording(WSRequestHandler* req) {
  * @category recording
  * @since 4.1.0
  */
-HandlerResponse WSRequestHandler::HandleSetRecordingFolder(WSRequestHandler* req) {
-	if (!req->hasField("rec-folder")) {
-		return req->SendErrorResponse("missing request parameters");
+RpcResponse WSRequestHandler::SetRecordingFolder(const RpcRequest& request) {
+	if (!request.hasField("rec-folder")) {
+		return request.failed("missing request parameters");
 	}
 
-	const char* newRecFolder = obs_data_get_string(req->data, "rec-folder");
+	const char* newRecFolder = obs_data_get_string(request.parameters(), "rec-folder");
 	bool success = Utils::SetRecordingFolder(newRecFolder);
 	if (!success) {
-		return req->SendErrorResponse("invalid request parameters");
+		return request.failed("invalid request parameters");
 	}
 
-	return req->SendOKResponse();
+	return request.success();
 }
 
 /**
@@ -144,11 +172,11 @@ HandlerResponse WSRequestHandler::HandleSetRecordingFolder(WSRequestHandler* req
  * @category recording
  * @since 4.1.0
  */
-HandlerResponse WSRequestHandler::HandleGetRecordingFolder(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::GetRecordingFolder(const RpcRequest& request) {
 	const char* recFolder = Utils::GetRecordingFolder();
 
 	OBSDataAutoRelease response = obs_data_create();
 	obs_data_set_string(response, "rec-folder", recFolder);
 
-	return req->SendOKResponse(response);
+	return request.success(response);
 }

src/WSRequestHandler_ReplayBuffer.cpp

@@ -1,22 +1,42 @@
+#include "obs-websocket.h"
+#include "WSEvents.h"
 #include "Utils.h"
 
 #include "WSRequestHandler.h"
 
+
  /**
-* Toggle the Replay Buffer on/off.
+ * Get the status of the OBS replay buffer.
+ *
+ * @return {boolean} `isReplayBufferActive` Current recording status.
+ *
+ * @api requests
+ * @name GetReplayBufferStatus
+ * @category replay buffer
+ * @since 4.9.0
+ */
+RpcResponse WSRequestHandler::GetReplayBufferStatus(const RpcRequest& request) {
+		OBSDataAutoRelease data = obs_data_create();
+		obs_data_set_bool(data, "isReplayBufferActive", obs_frontend_replay_buffer_active());
+
+		return request.success(data);
+}
+
+/**
+* Toggle the Replay Buffer on/off (depending on the current state of the replay buffer).
 *
 * @api requests
 * @name StartStopReplayBuffer
 * @category replay buffer
 * @since 4.2.0
 */
-HandlerResponse WSRequestHandler::HandleStartStopReplayBuffer(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::StartStopReplayBuffer(const RpcRequest& request) {
 	if (obs_frontend_replay_buffer_active()) {
 		obs_frontend_replay_buffer_stop();
 	} else {
 		Utils::StartReplayBuffer();
 	}
-	return req->SendOKResponse();
+	return request.success();
 }
 
 /**
@@ -31,17 +51,17 @@ HandlerResponse WSRequestHandler::HandleStartStopReplayBuffer(WSRequestHandler*
 * @category replay buffer
 * @since 4.2.0
 */
-HandlerResponse WSRequestHandler::HandleStartReplayBuffer(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::StartReplayBuffer(const RpcRequest& request) {
 	if (!Utils::ReplayBufferEnabled()) {
-		return req->SendErrorResponse("replay buffer disabled in settings");
+		return request.failed("replay buffer disabled in settings");
 	}
 
 	if (obs_frontend_replay_buffer_active() == true) {
-		return req->SendErrorResponse("replay buffer already active");
+		return request.failed("replay buffer already active");
 	}
 
 	Utils::StartReplayBuffer();
-	return req->SendOKResponse();
+	return request.success();
 }
 
 /**
@@ -53,12 +73,12 @@ HandlerResponse WSRequestHandler::HandleStartReplayBuffer(WSRequestHandler* req)
 * @category replay buffer
 * @since 4.2.0
 */
-HandlerResponse WSRequestHandler::HandleStopReplayBuffer(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::StopReplayBuffer(const RpcRequest& request) {
 	if (obs_frontend_replay_buffer_active() == true) {
 		obs_frontend_replay_buffer_stop();
-		return req->SendOKResponse();
+		return request.success();
 	} else {
-		return req->SendErrorResponse("replay buffer not active");
+		return request.failed("replay buffer not active");
 	}
 }
 
@@ -72,9 +92,9 @@ HandlerResponse WSRequestHandler::HandleStopReplayBuffer(WSRequestHandler* req)
 * @category replay buffer
 * @since 4.2.0
 */
-HandlerResponse WSRequestHandler::HandleSaveReplayBuffer(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::SaveReplayBuffer(const RpcRequest& request) {
 	if (!obs_frontend_replay_buffer_active()) {
-		return req->SendErrorResponse("replay buffer not active");
+		return request.failed("replay buffer not active");
 	}
 
 	OBSOutputAutoRelease replayOutput = obs_frontend_get_replay_buffer_output();
@@ -84,5 +104,5 @@ HandlerResponse WSRequestHandler::HandleSaveReplayBuffer(WSRequestHandler* req)
 	proc_handler_call(ph, "save", &cd);
 	calldata_free(&cd);
 
-	return req->SendOKResponse();
+	return request.success();
 }

src/WSRequestHandler_SceneCollections.cpp

@@ -2,6 +2,11 @@
 
 #include "WSRequestHandler.h"
 
+/**
+* @typedef {Object} `ScenesCollection`
+* @property {String} `sc-name` Name of the scene collection
+*/
+
 /**
  * Change the active scene collection.
  *
@@ -12,19 +17,28 @@
  * @category scene collections
  * @since 4.0.0
  */
-HandlerResponse WSRequestHandler::HandleSetCurrentSceneCollection(WSRequestHandler* req) {
-	if (!req->hasField("sc-name")) {
-		return req->SendErrorResponse("missing request parameters");
+RpcResponse WSRequestHandler::SetCurrentSceneCollection(const RpcRequest& request) {
+	if (!request.hasField("sc-name")) {
+		return request.failed("missing request parameters");
 	}
 
-	QString sceneCollection = obs_data_get_string(req->data, "sc-name");
-	if (sceneCollection.isEmpty()) {
-		return req->SendErrorResponse("invalid request parameters");
+	const char* sceneCollection = obs_data_get_string(request.parameters(), "sc-name");
+	if (!sceneCollection) {
+		return request.failed("invalid request parameters");
 	}
 
-	// TODO : Check if specified profile exists and if changing is allowed
-	obs_frontend_set_current_scene_collection(sceneCollection.toUtf8());
-	return req->SendOKResponse();
+	char** collections = obs_frontend_get_scene_collections();
+	bool collectionExists = Utils::StringInStringList(collections, sceneCollection);
+	bfree(collections);
+	if (!collectionExists) {
+		return request.failed("scene collection does not exist");
+	}
+
+	obs_queue_task(OBS_TASK_UI, [](void* param) {
+		obs_frontend_set_current_scene_collection(reinterpret_cast<const char*>(param));
+	}, (void*)sceneCollection, true);
+
+	return request.success();
 }
 
 /**
@@ -37,25 +51,27 @@ HandlerResponse WSRequestHandler::HandleSetCurrentSceneCollection(WSRequestHandl
  * @category scene collections
  * @since 4.0.0
  */
-HandlerResponse WSRequestHandler::HandleGetCurrentSceneCollection(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::GetCurrentSceneCollection(const RpcRequest& request) {
 	OBSDataAutoRelease response = obs_data_create();
-	obs_data_set_string(response, "sc-name",
-		obs_frontend_get_current_scene_collection());
 
-	return req->SendOKResponse(response);
+	char* sceneCollection = obs_frontend_get_current_scene_collection();
+	obs_data_set_string(response, "sc-name", sceneCollection);
+	bfree(sceneCollection);
+
+	return request.success(response);
 }
 
 /**
  * List available scene collections
  *
- * @return {Array<String>} `scene-collections` Scene collections list
+ * @return {Array<ScenesCollection>} `scene-collections` Scene collections list
  *
  * @api requests
  * @name ListSceneCollections
  * @category scene collections
  * @since 4.0.0
  */
-HandlerResponse WSRequestHandler::HandleListSceneCollections(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::ListSceneCollections(const RpcRequest& request) {
 	char** sceneCollections = obs_frontend_get_scene_collections();
 	OBSDataArrayAutoRelease list =
 		Utils::StringListToArray(sceneCollections, "sc-name");
@@ -64,5 +80,5 @@ HandlerResponse WSRequestHandler::HandleListSceneCollections(WSRequestHandler* r
 	OBSDataAutoRelease response = obs_data_create();
 	obs_data_set_array(response, "scene-collections", list);
 
-	return req->SendOKResponse(response);
+	return request.success(response);
 }

src/WSRequestHandler_SceneItems.cpp

@@ -2,25 +2,102 @@
 
 #include "WSRequestHandler.h"
 
+/**
+* Get a list of all scene items in a scene.
+*
+* @param {String (optional)} `sceneName` Name of the scene to get the list of scene items from. Defaults to the current scene if not specified.
+*
+* @return {String} `sceneName` Name of the requested (or current) scene
+* @return {Array<Object>} `sceneItems` Array of scene items
+* @return {int} `sceneItems.*.itemId` Unique item id of the source item
+* @return {String} `sceneItems.*.sourceKind` ID if the scene item's source. For example `vlc_source` or `image_source`
+* @return {String} `sceneItems.*.sourceName` Name of the scene item's source
+* @return {String} `sceneItems.*.sourceType` Type of the scene item's source. Either `input`, `group`, or `scene`
+*
+* @api requests
+* @name GetSceneItemList
+* @category scene items
+* @since 4.9.0
+*/
+RpcResponse WSRequestHandler::GetSceneItemList(const RpcRequest& request) {
+	const char* sceneName = obs_data_get_string(request.parameters(), "sceneName");
+
+	OBSSourceAutoRelease sceneSource;
+	if (sceneName && strcmp(sceneName, "") != 0) {
+		sceneSource = obs_get_source_by_name(sceneName);
+	} else {
+		sceneSource = obs_frontend_get_current_scene();
+	}
+
+	OBSScene scene = obs_scene_from_source(sceneSource);
+	if (!scene) {
+		return request.failed("requested scene is invalid or doesnt exist");
+	}
+
+	OBSDataArrayAutoRelease sceneItemArray = obs_data_array_create();
+
+	auto sceneItemEnumProc = [](obs_scene_t *, obs_sceneitem_t* item, void* privateData) -> bool {
+		obs_data_array_t* sceneItemArray = (obs_data_array_t*)privateData;
+
+		OBSDataAutoRelease sceneItemData = obs_data_create();
+		obs_data_set_int(sceneItemData, "itemId", obs_sceneitem_get_id(item));
+		OBSSource source = obs_sceneitem_get_source(item);
+		obs_data_set_string(sceneItemData, "sourceKind", obs_source_get_id(source));
+		obs_data_set_string(sceneItemData, "sourceName", obs_source_get_name(source));
+
+		QString typeString = "";
+		enum obs_source_type sourceType = obs_source_get_type(source);
+		switch (sourceType) {
+		case OBS_SOURCE_TYPE_INPUT:
+			typeString = "input";
+			break;
+
+		case OBS_SOURCE_TYPE_SCENE:
+			typeString = "scene";
+			break;
+
+		default:
+			typeString = "unknown";
+			break;
+		}
+		obs_data_set_string(sceneItemData, "sourceType", typeString.toUtf8());
+
+		obs_data_array_push_back(sceneItemArray, sceneItemData);
+		return true;
+	};
+	obs_scene_enum_items(scene, sceneItemEnumProc, sceneItemArray);
+
+	OBSDataAutoRelease response = obs_data_create();
+	obs_data_set_string(response, "sceneName", obs_source_get_name(sceneSource));
+	obs_data_set_array(response, "sceneItems", sceneItemArray);
+
+	return request.success(response);
+}
+
 /**
 * Gets the scene specific properties of the specified source item.
 * Coordinates are relative to the item's parent (the scene or group it belongs to).
 *
-* @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 {String (optional)} `scene-name` Name of the scene the scene item belongs to. Defaults to the current scene.
+* @param {String | Object} `item` Scene Item name (if this field is a string) or specification (if it is an object).
+* @param {String (optional)} `item.name` Scene Item name (if the `item` field is an object)
+* @param {int (optional)} `item.id` Scene Item ID (if the `item` field is an object)
 *
-* @return {String} `name` The name of the source.
-* @return {int} `position.x` The x position of the source from the left.
-* @return {int} `position.y` The y position of the source from the top.
-* @return {int} `position.alignment` The point on the source that the item is manipulated from.
+* @return {String} `name` Scene Item name.
+* @return {int} `itemId` Scene Item ID.
+* @return {double} `position.x` The x position of the source from the left.
+* @return {double} `position.y` The y position of the source from the top.
+* @return {int} `position.alignment` The point on the source that the item is manipulated from. The sum of 1=Left or 2=Right, and 4=Top or 8=Bottom, or omit to center on that axis.
 * @return {double} `rotation` The clockwise rotation of the item in degrees around the point of alignment.
 * @return {double} `scale.x` The x-scale factor of the source.
 * @return {double} `scale.y` The y-scale factor of the source.
+* @return {String} `scale.filter` The scale filter of the source. Can be "OBS_SCALE_DISABLE", "OBS_SCALE_POINT", "OBS_SCALE_BICUBIC", "OBS_SCALE_BILINEAR", "OBS_SCALE_LANCZOS" or "OBS_SCALE_AREA".
 * @return {int} `crop.top` The number of pixels cropped off the top of the source before scaling.
 * @return {int} `crop.right` The number of pixels cropped off the right of the source before scaling.
 * @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 {bool} `muted` If the source is muted.
 * @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.
@@ -30,53 +107,57 @@
 * @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)
+* @return {String (optional)} `parentGroupName` Name of the item's parent (if this item belongs to a group)
+* @return {Array<SceneItemTransform> (optional)} `groupChildren` List of children (if this item is a group)
 *
 * @api requests
 * @name GetSceneItemProperties
 * @category scene items
 * @since 4.3.0
 */
-HandlerResponse WSRequestHandler::HandleGetSceneItemProperties(WSRequestHandler* req) {
-	if (!req->hasField("item")) {
-		return req->SendErrorResponse("missing request parameters");
+RpcResponse WSRequestHandler::GetSceneItemProperties(const RpcRequest& request) {
+	if (!request.hasField("item")) {
+		return request.failed("missing request parameters");
 	}
 
-	QString itemName = obs_data_get_string(req->data, "item");
-	if (itemName.isEmpty()) {
-		return req->SendErrorResponse("invalid request parameters");
-	}
+	OBSData params = request.parameters();
 
-	QString sceneName = obs_data_get_string(req->data, "scene-name");
+	QString sceneName = obs_data_get_string(params, "scene-name");
 	OBSScene scene = Utils::GetSceneFromNameOrCurrent(sceneName);
 	if (!scene) {
-		return req->SendErrorResponse("requested scene doesn't exist");
+		return request.failed("requested scene doesn't exist");
 	}
 
-	OBSSceneItemAutoRelease sceneItem = Utils::GetSceneItemFromName(scene, itemName);
+	OBSDataItemAutoRelease itemField = obs_data_item_byname(params, "item");
+	OBSSceneItemAutoRelease sceneItem = Utils::GetSceneItemFromRequestField(scene, itemField);
 	if (!sceneItem) {
-		return req->SendErrorResponse("specified scene item doesn't exist");
+		return request.failed("specified scene item doesn't exist");
 	}
 
 	OBSDataAutoRelease data = Utils::GetSceneItemPropertiesData(sceneItem);
-	obs_data_set_string(data, "name", itemName.toUtf8());
 
-	return req->SendOKResponse(data);
+	OBSSource sceneItemSource = obs_sceneitem_get_source(sceneItem);
+	obs_data_set_string(data, "name", obs_source_get_name(sceneItemSource));
+	obs_data_set_int(data, "itemId", obs_sceneitem_get_id(sceneItem));
+
+	return request.success(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 (optional)} `position.x` The new x position of the source.
-* @param {int (optional)} `position.y` The new y position of the source.
+* @param {String (optional)} `scene-name` Name of the scene the source item belongs to. Defaults to the current scene.
+* @param {String | Object} `item` Scene Item name (if this field is a string) or specification (if it is an object).
+* @param {String (optional)} `item.name` Scene Item name (if the `item` field is an object)
+* @param {int (optional)} `item.id` Scene Item ID (if the `item` field is an object)
+* @param {double (optional)} `position.x` The new x position of the source.
+* @param {double (optional)} `position.y` The new y position of the source.
 * @param {int (optional)} `position.alignment` The new alignment of the source.
 * @param {double (optional)} `rotation` The new clockwise rotation of the item in degrees.
 * @param {double (optional)} `scale.x` The new x scale of the item.
 * @param {double (optional)} `scale.y` The new y scale of the item.
+* @param {String (optional)} `scale.filter` The new scale filter of the source. Can be "OBS_SCALE_DISABLE", "OBS_SCALE_POINT", "OBS_SCALE_BICUBIC", "OBS_SCALE_BILINEAR", "OBS_SCALE_LANCZOS" or "OBS_SCALE_AREA".
 * @param {int (optional)} `crop.top` The new amount of pixels cropped off the top 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 (optional)} `crop.left` The new amount of pixels cropped off the left of the source before scaling.
@@ -93,82 +174,109 @@ HandlerResponse WSRequestHandler::HandleGetSceneItemProperties(WSRequestHandler*
 * @category scene items
 * @since 4.3.0
 */
-HandlerResponse WSRequestHandler::HandleSetSceneItemProperties(WSRequestHandler* req) {
-	if (!req->hasField("item")) {
-		return req->SendErrorResponse("missing request parameters");
+RpcResponse WSRequestHandler::SetSceneItemProperties(const RpcRequest& request) {
+	if (!request.hasField("item")) {
+		return request.failed("missing request parameters");
 	}
 
-	QString itemName = obs_data_get_string(req->data, "item");
-	if (itemName.isEmpty()) {
-		return req->SendErrorResponse("invalid request parameters");
-	}
+	OBSData params = request.parameters();
 
-	QString sceneName = obs_data_get_string(req->data, "scene-name");
+	QString sceneName = obs_data_get_string(params, "scene-name");
 	OBSScene scene = Utils::GetSceneFromNameOrCurrent(sceneName);
 	if (!scene) {
-		return req->SendErrorResponse("requested scene doesn't exist");
+		return request.failed("requested scene doesn't exist");
 	}
 
-	OBSSceneItemAutoRelease sceneItem =
-		Utils::GetSceneItemFromName(scene, itemName);
+	OBSDataItemAutoRelease itemField = obs_data_item_byname(params, "item");
+	OBSSceneItemAutoRelease sceneItem = Utils::GetSceneItemFromRequestField(scene, itemField);
 	if (!sceneItem) {
-		return req->SendErrorResponse("specified scene item doesn't exist");
+		return request.failed("specified scene item doesn't exist");
 	}
 
 	bool badRequest = false;
-	OBSDataAutoRelease errorMessage = obs_data_create();
+	OBSDataAutoRelease errorData = obs_data_create();
 
 	obs_sceneitem_defer_update_begin(sceneItem);
 
-	if (req->hasField("position")) {
+	if (request.hasField("position")) {
 		vec2 oldPosition;
 		OBSDataAutoRelease positionError = obs_data_create();
 		obs_sceneitem_get_pos(sceneItem, &oldPosition);
-		OBSDataAutoRelease reqPosition = obs_data_get_obj(req->data, "position");
+
+		OBSDataAutoRelease reqPosition = obs_data_get_obj(params, "position");
 		vec2 newPosition = oldPosition;
+
 		if (obs_data_has_user_value(reqPosition, "x")) {
-			newPosition.x = obs_data_get_int(reqPosition, "x");
+			newPosition.x = obs_data_get_double(reqPosition, "x");
 		}
 		if (obs_data_has_user_value(reqPosition, "y")) {
-			newPosition.y = obs_data_get_int(reqPosition, "y");
+			newPosition.y = obs_data_get_double(reqPosition, "y");
 		}
+
 		if (obs_data_has_user_value(reqPosition, "alignment")) {
 			const uint32_t alignment = obs_data_get_int(reqPosition, "alignment");
 			if (Utils::IsValidAlignment(alignment)) {
 				obs_sceneitem_set_alignment(sceneItem, alignment);
-			}
-			else {
+			} else {
 				badRequest = true;
 				obs_data_set_string(positionError, "alignment", "invalid");
-				obs_data_set_obj(errorMessage, "position", positionError);
+				obs_data_set_obj(errorData, "position", positionError);
 			}
 		}
+
 		obs_sceneitem_set_pos(sceneItem, &newPosition);
 	}
 
-	if (req->hasField("rotation")) {
-		obs_sceneitem_set_rot(sceneItem, (float)obs_data_get_double(req->data, "rotation"));
+	if (request.hasField("rotation")) {
+		obs_sceneitem_set_rot(sceneItem, (float)obs_data_get_double(params, "rotation"));
+	}
+
+	if (request.hasField("scale")) {
+		OBSDataAutoRelease reqScale = obs_data_get_obj(params, "scale");
+
+		if (obs_data_has_user_value(reqScale, "filter")) {
+			QString newScaleFilter = obs_data_get_string(reqScale, "filter");
+			if (newScaleFilter == "OBS_SCALE_DISABLE") {
+				obs_sceneitem_set_scale_filter(sceneItem, OBS_SCALE_DISABLE);
+			}
+			else if (newScaleFilter == "OBS_SCALE_POINT") {
+				obs_sceneitem_set_scale_filter(sceneItem, OBS_SCALE_POINT);
+			}
+			else if (newScaleFilter == "OBS_SCALE_BICUBIC") {
+				obs_sceneitem_set_scale_filter(sceneItem, OBS_SCALE_BICUBIC);
+			}
+			else if (newScaleFilter == "OBS_SCALE_BILINEAR") {
+				obs_sceneitem_set_scale_filter(sceneItem, OBS_SCALE_BICUBIC);
+			}
+			else if (newScaleFilter == "OBS_SCALE_LANCZOS") {
+				obs_sceneitem_set_scale_filter(sceneItem, OBS_SCALE_LANCZOS);
+			}
+			else if (newScaleFilter == "OBS_SCALE_AREA") {
+				obs_sceneitem_set_scale_filter(sceneItem, OBS_SCALE_AREA);
+			}
 		}
 
-	if (req->hasField("scale")) {
 		vec2 oldScale;
 		obs_sceneitem_get_scale(sceneItem, &oldScale);
-		OBSDataAutoRelease reqScale = obs_data_get_obj(req->data, "scale");
 		vec2 newScale = oldScale;
+
 		if (obs_data_has_user_value(reqScale, "x")) {
 			newScale.x = obs_data_get_double(reqScale, "x");
 		}
 		if (obs_data_has_user_value(reqScale, "y")) {
 			newScale.y = obs_data_get_double(reqScale, "y");
 		}
+
 		obs_sceneitem_set_scale(sceneItem, &newScale);
 	}
 
-	if (req->hasField("crop")) {
+	if (request.hasField("crop")) {
 		obs_sceneitem_crop oldCrop;
 		obs_sceneitem_get_crop(sceneItem, &oldCrop);
-		OBSDataAutoRelease reqCrop = obs_data_get_obj(req->data, "crop");
+
+		OBSDataAutoRelease reqCrop = obs_data_get_obj(params, "crop");
 		obs_sceneitem_crop newCrop = oldCrop;
+
 		if (obs_data_has_user_value(reqCrop, "top")) {
 			newCrop.top = obs_data_get_int(reqCrop, "top");
 		}
@@ -181,21 +289,23 @@ HandlerResponse WSRequestHandler::HandleSetSceneItemProperties(WSRequestHandler*
 		if (obs_data_has_user_value(reqCrop, "left")) {
 			newCrop.left = obs_data_get_int(reqCrop, "left");
 		}
+
 		obs_sceneitem_set_crop(sceneItem, &newCrop);
 	}
 
-	if (req->hasField("visible")) {
-		obs_sceneitem_set_visible(sceneItem, obs_data_get_bool(req->data, "visible"));
+	if (request.hasField("visible")) {
+		obs_sceneitem_set_visible(sceneItem, obs_data_get_bool(params, "visible"));
 	}
 
-	if (req->hasField("locked")) {
-		obs_sceneitem_set_locked(sceneItem, obs_data_get_bool(req->data, "locked"));
+	if (request.hasField("locked")) {
+		obs_sceneitem_set_locked(sceneItem, obs_data_get_bool(params, "locked"));
 	}
 
-	if (req->hasField("bounds")) {
+	if (request.hasField("bounds")) {
 		bool badBounds = false;
 		OBSDataAutoRelease boundsError = obs_data_create();
-		OBSDataAutoRelease reqBounds = obs_data_get_obj(req->data, "bounds");
+		OBSDataAutoRelease reqBounds = obs_data_get_obj(params, "bounds");
+
 		if (obs_data_has_user_value(reqBounds, "type")) {
 			QString newBoundsType = obs_data_get_string(reqBounds, "type");
 			if (newBoundsType == "OBS_BOUNDS_NONE") {
@@ -224,16 +334,20 @@ HandlerResponse WSRequestHandler::HandleSetSceneItemProperties(WSRequestHandler*
 				obs_data_set_string(boundsError, "type", "invalid");
 			}
 		}
+
 		vec2 oldBounds;
 		obs_sceneitem_get_bounds(sceneItem, &oldBounds);
 		vec2 newBounds = oldBounds;
+
 		if (obs_data_has_user_value(reqBounds, "x")) {
 			newBounds.x = obs_data_get_double(reqBounds, "x");
 		}
 		if (obs_data_has_user_value(reqBounds, "y")) {
 			newBounds.y = obs_data_get_double(reqBounds, "y");
 		}
+
 		obs_sceneitem_set_bounds(sceneItem, &newBounds);
+
 		if (obs_data_has_user_value(reqBounds, "alignment")) {
 			const uint32_t bounds_alignment = obs_data_get_int(reqBounds, "alignment");
 			if (Utils::IsValidAlignment(bounds_alignment)) {
@@ -244,52 +358,51 @@ HandlerResponse WSRequestHandler::HandleSetSceneItemProperties(WSRequestHandler*
 				obs_data_set_string(boundsError, "alignment", "invalid");
 			}
 		}
+
 		if (badBounds) {
-			obs_data_set_obj(errorMessage, "bounds", boundsError);
+			obs_data_set_obj(errorData, "bounds", boundsError);
 		}
 	}
 
 	obs_sceneitem_defer_update_end(sceneItem);
 
 	if (badRequest) {
-		return req->SendErrorResponse(errorMessage);
+		return request.failed("error", errorData);
 	}
 
-	return req->SendOKResponse();
+	return request.success();
 }
 
 /**
 * Reset a scene item.
 *
-* @param {String (optional)} `scene-name` Name of the scene the source belongs to. Defaults to the current scene.
-* @param {String} `item` Name of the source item.
+* @param {String (optional)} `scene-name` Name of the scene the scene item belongs to. Defaults to the current scene.
+* @param {String | Object} `item` Scene Item name (if this field is a string) or specification (if it is an object).
+* @param {String (optional)} `item.name` Scene Item name (if the `item` field is an object)
+* @param {int (optional)} `item.id` Scene Item ID (if the `item` field is an object)
 *
 * @api requests
 * @name ResetSceneItem
 * @category scene items
 * @since 4.2.0
 */
-HandlerResponse WSRequestHandler::HandleResetSceneItem(WSRequestHandler* req) {
-	// TODO: remove this request, or refactor it to ResetSource
-
-	if (!req->hasField("item")) {
-		return req->SendErrorResponse("missing request parameters");
+RpcResponse WSRequestHandler::ResetSceneItem(const RpcRequest& request) {
+	if (!request.hasField("item")) {
+		return request.failed("missing request parameters");
 	}
 
-	const char* itemName = obs_data_get_string(req->data, "item");
-	if (!itemName) {
-		return req->SendErrorResponse("invalid request parameters");
-	}
+	OBSData params = request.parameters();
 
-	const char* sceneName = obs_data_get_string(req->data, "scene-name");
+	const char* sceneName = obs_data_get_string(params, "scene-name");
 	OBSScene scene = Utils::GetSceneFromNameOrCurrent(sceneName);
 	if (!scene) {
-		return req->SendErrorResponse("requested scene doesn't exist");
+		return request.failed("requested scene doesn't exist");
 	}
 
-	OBSSceneItemAutoRelease sceneItem = Utils::GetSceneItemFromName(scene, itemName);
+	OBSDataItemAutoRelease itemField = obs_data_item_byname(params, "item");
+	OBSSceneItemAutoRelease sceneItem = Utils::GetSceneItemFromRequestField(scene, itemField);
 	if (!sceneItem) {
-		return req->SendErrorResponse("specified scene item doesn't exist");
+		return request.failed("specified scene item doesn't exist");
 	}
 
 	OBSSource sceneItemSource = obs_sceneitem_get_source(sceneItem);
@@ -297,57 +410,65 @@ HandlerResponse WSRequestHandler::HandleResetSceneItem(WSRequestHandler* req) {
 	OBSDataAutoRelease settings = obs_source_get_settings(sceneItemSource);
 	obs_source_update(sceneItemSource, settings);
 
-	return req->SendOKResponse();
+	return request.success();
 }
 
 /**
 * Show or hide a specified source item in a specified scene.
 *
-* @param {String} `source` Scene item name in the specified scene.
+* @param {String (optional)} `scene-name` Name of the scene the scene item belongs to. Defaults to the currently active scene.
+* @param {String (optional)} `source` Scene Item name.
+* @param {int (optional)} `item` Scene Item id
 * @param {boolean} `render` true = shown ; false = hidden
-* @param {String (optional)} `scene-name` Name of the scene where the source resides. Defaults to the currently active scene.
 *
 * @api requests
 * @name SetSceneItemRender
 * @category scene items
 * @since 0.3
-* @deprecated Since 4.3.0. Prefer the use of SetSceneItemProperties.
 */
-HandlerResponse WSRequestHandler::HandleSetSceneItemRender(WSRequestHandler* req) {
-	if (!req->hasField("source") ||
-		!req->hasField("render"))
+RpcResponse WSRequestHandler::SetSceneItemRender(const RpcRequest& request) {
+	bool doesntHaveSourceOrItemParameter = !(request.hasField("source") || request.hasField("item"));
+	if (!request.hasField("render") || doesntHaveSourceOrItemParameter)
 	{
-		return req->SendErrorResponse("missing request parameters");
+		return request.failed("missing request parameters");
 	}
 
-	const char* itemName = obs_data_get_string(req->data, "source");
-	bool isVisible = obs_data_get_bool(req->data, "render");
+	const char* itemName = obs_data_get_string(request.parameters(), "source");
+	int64_t itemId = obs_data_get_int(request.parameters(), "item");
+	bool isVisible = obs_data_get_bool(request.parameters(), "render");
 
-	if (!itemName) {
-		return req->SendErrorResponse("invalid request parameters");
+	if (!itemName && !itemId) {
+		return request.failed("invalid request parameters");
 	}
 
-	const char* sceneName = obs_data_get_string(req->data, "scene-name");
+	const char* sceneName = obs_data_get_string(request.parameters(), "scene-name");
 	OBSScene scene = Utils::GetSceneFromNameOrCurrent(sceneName);
 	if (!scene) {
-		return req->SendErrorResponse("requested scene doesn't exist");
+		return request.failed("requested scene doesn't exist");
 	}
 
-	OBSSceneItemAutoRelease sceneItem =
-		Utils::GetSceneItemFromName(scene, itemName);
+	OBSSceneItemAutoRelease sceneItem;
+
+	if (strlen(itemName)) {
+		sceneItem = Utils::GetSceneItemFromName(scene, itemName);
 		if (!sceneItem) {
-		return req->SendErrorResponse("specified scene item doesn't exist");
+			return request.failed("specified scene item name doesn't exist");
+		}
+	} else {
+		sceneItem = Utils::GetSceneItemFromId(scene, itemId);
+		if (!sceneItem) {
+			return request.failed("specified scene item ID doesn't exist");
+		}
 	}
-
 	obs_sceneitem_set_visible(sceneItem, isVisible);
-	return req->SendOKResponse();
+	return request.success();
 }
 
 /**
 * Sets the coordinates of a specified source item.
 *
-* @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 item.
+* @param {String (optional)} `scene-name` Name of the scene the scene item belongs to. Defaults to the current scene.
+* @param {String} `item` Scene Item name.
 * @param {double} `x` X coordinate.
 * @param {double} `y` Y coordinate.
 
@@ -358,41 +479,41 @@ HandlerResponse WSRequestHandler::HandleSetSceneItemRender(WSRequestHandler* req
 * @since 4.0.0
 * @deprecated Since 4.3.0. Prefer the use of SetSceneItemProperties.
 */
-HandlerResponse WSRequestHandler::HandleSetSceneItemPosition(WSRequestHandler* req) {
-	if (!req->hasField("item") ||
-		!req->hasField("x") || !req->hasField("y")) {
-		return req->SendErrorResponse("missing request parameters");
+RpcResponse WSRequestHandler::SetSceneItemPosition(const RpcRequest& request) {
+	if (!request.hasField("item") ||
+		!request.hasField("x") || !request.hasField("y")) {
+		return request.failed("missing request parameters");
 	}
 
-	QString itemName = obs_data_get_string(req->data, "item");
+	QString itemName = obs_data_get_string(request.parameters(), "item");
 	if (itemName.isEmpty()) {
-		return req->SendErrorResponse("invalid request parameters");
+		return request.failed("invalid request parameters");
 	}
 
-	QString sceneName = obs_data_get_string(req->data, "scene-name");
+	QString sceneName = obs_data_get_string(request.parameters(), "scene-name");
 	OBSScene scene = Utils::GetSceneFromNameOrCurrent(sceneName);
 	if (!scene) {
-		return req->SendErrorResponse("requested scene could not be found");
+		return request.failed("requested scene could not be found");
 	}
 
 	OBSSceneItem sceneItem = Utils::GetSceneItemFromName(scene, itemName);
 	if (!sceneItem) {
-		return req->SendErrorResponse("specified scene item doesn't exist");
+		return request.failed("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");
+	item_position.x = obs_data_get_double(request.parameters(), "x");
+	item_position.y = obs_data_get_double(request.parameters(), "y");
 	obs_sceneitem_set_pos(sceneItem, &item_position);
 
-	return req->SendOKResponse();
+	return request.success();
 }
 
 /**
 * Set the transform of the specified source item.
 *
-* @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 item.
+* @param {String (optional)} `scene-name` Name of the scene the scene item belongs to. Defaults to the current scene.
+* @param {String} `item` Scene Item name.
 * @param {double} `x-scale` Width scale factor.
 * @param {double} `y-scale` Height scale factor.
 * @param {double} `rotation` Source item rotation (in degrees).
@@ -403,34 +524,34 @@ HandlerResponse WSRequestHandler::HandleSetSceneItemPosition(WSRequestHandler* r
 * @since 4.0.0
 * @deprecated Since 4.3.0. Prefer the use of SetSceneItemProperties.
 */
-HandlerResponse WSRequestHandler::HandleSetSceneItemTransform(WSRequestHandler* req) {
-	if (!req->hasField("item") ||
-		!req->hasField("x-scale") ||
-		!req->hasField("y-scale") ||
-		!req->hasField("rotation"))
+RpcResponse WSRequestHandler::SetSceneItemTransform(const RpcRequest& request) {
+	if (!request.hasField("item") ||
+		!request.hasField("x-scale") ||
+		!request.hasField("y-scale") ||
+		!request.hasField("rotation"))
 	{
-		return req->SendErrorResponse("missing request parameters");
+		return request.failed("missing request parameters");
 	}
 
-	QString itemName = obs_data_get_string(req->data, "item");
+	QString itemName = obs_data_get_string(request.parameters(), "item");
 	if (itemName.isEmpty()) {
-		return req->SendErrorResponse("invalid request parameters");
+		return request.failed("invalid request parameters");
 	}
 
-	QString sceneName = obs_data_get_string(req->data, "scene-name");
+	QString sceneName = obs_data_get_string(request.parameters(), "scene-name");
 	OBSScene scene = Utils::GetSceneFromNameOrCurrent(sceneName);
 	if (!scene) {
-		return req->SendErrorResponse("requested scene doesn't exist");
+		return request.failed("requested scene doesn't exist");
 	}
 
 	vec2 scale;
-	scale.x = obs_data_get_double(req->data, "x-scale");
-	scale.y = obs_data_get_double(req->data, "y-scale");
-	float rotation = obs_data_get_double(req->data, "rotation");
+	scale.x = obs_data_get_double(request.parameters(), "x-scale");
+	scale.y = obs_data_get_double(request.parameters(), "y-scale");
+	float rotation = obs_data_get_double(request.parameters(), "rotation");
 
 	OBSSceneItemAutoRelease sceneItem = Utils::GetSceneItemFromName(scene, itemName);
 	if (!sceneItem) {
-		return req->SendErrorResponse("specified scene item doesn't exist");
+		return request.failed("specified scene item doesn't exist");
 	}
 
 	obs_sceneitem_defer_update_begin(sceneItem);
@@ -440,14 +561,14 @@ HandlerResponse WSRequestHandler::HandleSetSceneItemTransform(WSRequestHandler*
 
 	obs_sceneitem_defer_update_end(sceneItem);
 
-	return req->SendOKResponse();
+	return request.success();
 }
 
 /**
 * Sets the crop coordinates of the specified source item.
 *
-* @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 {String (optional)} `scene-name` Name of the scene the scene item belongs to. Defaults to the current scene.
+* @param {String} `item` Scene Item name.
 * @param {int} `top` Pixel position of the top of the source item.
 * @param {int} `bottom` Pixel position of the bottom of the source item.
 * @param {int} `left` Pixel position of the left of the source item.
@@ -459,83 +580,124 @@ HandlerResponse WSRequestHandler::HandleSetSceneItemTransform(WSRequestHandler*
 * @since 4.1.0
 * @deprecated Since 4.3.0. Prefer the use of SetSceneItemProperties.
 */
-HandlerResponse WSRequestHandler::HandleSetSceneItemCrop(WSRequestHandler* req) {
-	if (!req->hasField("item")) {
-		return req->SendErrorResponse("missing request parameters");
+RpcResponse WSRequestHandler::SetSceneItemCrop(const RpcRequest& request) {
+	if (!request.hasField("item")) {
+		return request.failed("missing request parameters");
 	}
 
-	QString itemName = obs_data_get_string(req->data, "item");
+	QString itemName = obs_data_get_string(request.parameters(), "item");
 	if (itemName.isEmpty()) {
-		return req->SendErrorResponse("invalid request parameters");
+		return request.failed("invalid request parameters");
 	}
 
-	QString sceneName = obs_data_get_string(req->data, "scene-name");
+	QString sceneName = obs_data_get_string(request.parameters(), "scene-name");
 	OBSScene scene = Utils::GetSceneFromNameOrCurrent(sceneName);
 	if (!scene) {
-		return req->SendErrorResponse("requested scene doesn't exist");
+		return request.failed("requested scene doesn't exist");
 	}
 
 	OBSSceneItemAutoRelease sceneItem = Utils::GetSceneItemFromName(scene, itemName);
 	if (!sceneItem) {
-		return req->SendErrorResponse("specified scene item doesn't exist");
+		return request.failed("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");
-	crop.left = obs_data_get_int(req->data, "left");
-	crop.right = obs_data_get_int(req->data, "right");
+	crop.top = obs_data_get_int(request.parameters(), "top");
+	crop.bottom = obs_data_get_int(request.parameters(), "bottom");
+	crop.left = obs_data_get_int(request.parameters(), "left");
+	crop.right = obs_data_get_int(request.parameters(), "right");
 
 	obs_sceneitem_set_crop(sceneItem, &crop);
 
-	return req->SendOKResponse();
+	return request.success();
 }
 
 /**
  * Deletes a scene item.
  *
- * @param {String (optional)} `scene` Name of the scene the source belongs to. Defaults to the current scene.
- * @param {Object} `item` item to delete (required)
- * @param {String} `item.name` name of the scene item (prefer `id`, including both is acceptable).
- * @param {int} `item.id` id of the scene item.
+ * @param {String (optional)} `scene` Name of the scene the scene item belongs to. Defaults to the current scene.
+ * @param {Object} `item` Scene item to delete (required)
+ * @param {String} `item.name` Scene Item name (prefer `id`, including both is acceptable).
+ * @param {int} `item.id` Scene Item ID.
  *
  * @api requests
  * @name DeleteSceneItem
  * @category scene items
  * @since 4.5.0
  */
-HandlerResponse WSRequestHandler::HandleDeleteSceneItem(WSRequestHandler* req) {
-	if (!req->hasField("item")) {
-		return req->SendErrorResponse("missing request parameters");
+RpcResponse WSRequestHandler::DeleteSceneItem(const RpcRequest& request) {
+	if (!request.hasField("item")) {
+		return request.failed("missing request parameters");
 	}
 
-	const char* sceneName = obs_data_get_string(req->data, "scene");
+	const char* sceneName = obs_data_get_string(request.parameters(), "scene");
 	OBSScene scene = Utils::GetSceneFromNameOrCurrent(sceneName);
 	if (!scene) {
-		return req->SendErrorResponse("requested scene doesn't exist");
+		return request.failed("requested scene doesn't exist");
 	}
 
-	OBSDataAutoRelease item = obs_data_get_obj(req->data, "item");
-	OBSSceneItemAutoRelease sceneItem = Utils::GetSceneItemFromItem(scene, item);
+	OBSDataItemAutoRelease itemField = obs_data_item_byname(request.parameters(), "item");
+	OBSSceneItemAutoRelease sceneItem = Utils::GetSceneItemFromRequestField(scene, itemField);
 	if (!sceneItem) {
-		return req->SendErrorResponse("item with id/name combination not found in specified scene");
+		return request.failed("item with id/name combination not found in specified scene");
 	}
 
 	obs_sceneitem_remove(sceneItem);
 
-	return req->SendOKResponse();
+	return request.success();
 }
 
-struct DuplicateSceneItemData {
-	obs_sceneitem_t *referenceItem;
-	obs_source_t *fromSource;
-	obs_sceneitem_t *newItem;
-};
+/**
+ * Creates a scene item in a scene. In other words, this is how you add a source into a scene.
+ *
+ * @param {String} `sceneName` Name of the scene to create the scene item in
+ * @param {String} `sourceName` Name of the source to be added
+ * @param {boolean (optional)} `setVisible` Whether to make the sceneitem visible on creation or not. Default `true`
+ *
+ * @return {int} `itemId` Numerical ID of the created scene item
+ *
+ * @api requests
+ * @name AddSceneItem
+ * @category scene items
+ * @since 4.9.0
+ */
+RpcResponse WSRequestHandler::AddSceneItem(const RpcRequest& request) {
+	if (!request.hasField("sceneName") || !request.hasField("sourceName")) {
+		return request.failed("missing request parameters");
+	}
 
-static void DuplicateSceneItem(void *_data, obs_scene_t *scene) {
-	DuplicateSceneItemData *data = (DuplicateSceneItemData *)_data;
-	data->newItem = obs_scene_add(scene, data->fromSource);
-	obs_sceneitem_set_visible(data->newItem, obs_sceneitem_visible(data->referenceItem));
+	const char* sceneName = obs_data_get_string(request.parameters(), "sceneName");
+	OBSSourceAutoRelease sceneSource = obs_get_source_by_name(sceneName);
+	OBSScene scene = obs_scene_from_source(sceneSource);
+	if (!scene) {
+		return request.failed("requested scene is invalid or doesnt exist");
+	}
+
+	const char* sourceName = obs_data_get_string(request.parameters(), "sourceName");
+	OBSSourceAutoRelease source = obs_get_source_by_name(sourceName);
+	if (!source) {
+		return request.failed("requested source does not exist");
+	}
+
+	if (source == sceneSource) {
+		return request.failed("you cannot add a scene as a sceneitem to itself");
+	}
+
+	Utils::AddSourceData data;
+	data.source = source;
+	data.setVisible = true;
+	if (request.hasField("setVisible")) {
+		data.setVisible = obs_data_get_bool(request.parameters(), "setVisible");
+	}
+
+	obs_enter_graphics();
+	obs_scene_atomic_update(scene, Utils::AddSourceHelper, &data);
+	obs_leave_graphics();
+
+	OBSDataAutoRelease responseData = obs_data_create();
+	obs_data_set_int(responseData, "itemId", obs_sceneitem_get_id(data.sceneItem));
+
+	return request.success(responseData);
 }
 
 /**
@@ -543,9 +705,9 @@ static void DuplicateSceneItem(void *_data, obs_scene_t *scene) {
  *
  * @param {String (optional)} `fromScene` Name of the scene to copy the item from. Defaults to the current scene.
  * @param {String (optional)} `toScene` Name of the scene to create the item in. Defaults to the current scene.
- * @param {Object} `item` item to duplicate (required)
- * @param {String} `item.name` name of the scene item (prefer `id`, including both is acceptable).
- * @param {int} `item.id` id of the scene item.
+ * @param {Object} `item` Scene Item to duplicate from the source scene (required)
+ * @param {String} `item.name` Scene Item name (prefer `id`, including both is acceptable).
+ * @param {int} `item.id` Scene Item ID.
  *
  * @return {String} `scene` Name of the scene where the new item was created
  * @return {Object} `item` New item info
@@ -557,27 +719,33 @@ static void DuplicateSceneItem(void *_data, obs_scene_t *scene) {
  * @category scene items
  * @since 4.5.0
  */
-HandlerResponse WSRequestHandler::HandleDuplicateSceneItem(WSRequestHandler* req) {
-	if (!req->hasField("item")) {
-		return req->SendErrorResponse("missing request parameters");
+RpcResponse WSRequestHandler::DuplicateSceneItem(const RpcRequest& request) {
+	struct DuplicateSceneItemData {
+		obs_sceneitem_t *referenceItem;
+		obs_source_t *fromSource;
+		obs_sceneitem_t *newItem;
+	};
+
+	if (!request.hasField("item")) {
+		return request.failed("missing request parameters");
 	}
 
-	const char* fromSceneName = obs_data_get_string(req->data, "fromScene");
+	const char* fromSceneName = obs_data_get_string(request.parameters(), "fromScene");
 	OBSScene fromScene = Utils::GetSceneFromNameOrCurrent(fromSceneName);
 	if (!fromScene) {
-		return req->SendErrorResponse("requested fromScene doesn't exist");
+		return request.failed("requested fromScene doesn't exist");
 	}
 
-	const char* toSceneName = obs_data_get_string(req->data, "toScene");
+	const char* toSceneName = obs_data_get_string(request.parameters(), "toScene");
 	OBSScene toScene = Utils::GetSceneFromNameOrCurrent(toSceneName);
 	if (!toScene) {
-		return req->SendErrorResponse("requested toScene doesn't exist");
+		return request.failed("requested toScene doesn't exist");
 	}
 
-	OBSDataAutoRelease item = obs_data_get_obj(req->data, "item");
-	OBSSceneItemAutoRelease referenceItem = Utils::GetSceneItemFromItem(fromScene, item);
+	OBSDataItemAutoRelease itemField = obs_data_item_byname(request.parameters(), "item");
+	OBSSceneItemAutoRelease referenceItem = Utils::GetSceneItemFromRequestField(fromScene, itemField);
 	if (!referenceItem) {
-		return req->SendErrorResponse("item with id/name combination not found in specified scene");
+		return request.failed("item with id/name combination not found in specified scene");
 	}
 
 	DuplicateSceneItemData data;
@@ -585,12 +753,16 @@ HandlerResponse WSRequestHandler::HandleDuplicateSceneItem(WSRequestHandler* req
 	data.referenceItem = referenceItem;
 
 	obs_enter_graphics();
-	obs_scene_atomic_update(toScene, DuplicateSceneItem, &data);
+	obs_scene_atomic_update(toScene, [](void *_data, obs_scene_t *scene) {
+		auto data = reinterpret_cast<DuplicateSceneItemData*>(_data);
+		data->newItem = obs_scene_add(scene, data->fromSource);
+		obs_sceneitem_set_visible(data->newItem, obs_sceneitem_visible(data->referenceItem));
+	}, &data);
 	obs_leave_graphics();
 
 	obs_sceneitem_t *newItem = data.newItem;
 	if (!newItem) {
-		return req->SendErrorResponse("Error duplicating scene item");
+		return request.failed("Error duplicating scene item");
 	}
 
 	OBSDataAutoRelease itemData = obs_data_create();
@@ -601,5 +773,5 @@ HandlerResponse WSRequestHandler::HandleDuplicateSceneItem(WSRequestHandler* req
 	obs_data_set_obj(responseData, "item", itemData);
 	obs_data_set_string(responseData, "scene", obs_source_get_name(obs_scene_get_source(toScene)));
 
-	return req->SendOKResponse(responseData);
+	return request.success(responseData);
 }

src/WSRequestHandler_Scenes.cpp

@@ -18,19 +18,19 @@
  * @category scenes
  * @since 0.3
  */
-HandlerResponse WSRequestHandler::HandleSetCurrentScene(WSRequestHandler* req) {
-	if (!req->hasField("scene-name")) {
-		return req->SendErrorResponse("missing request parameters");
+RpcResponse WSRequestHandler::SetCurrentScene(const RpcRequest& request) {
+	if (!request.hasField("scene-name")) {
+		return request.failed("missing request parameters");
 	}
 
-	const char* sceneName = obs_data_get_string(req->data, "scene-name");
+	const char* sceneName = obs_data_get_string(request.parameters(), "scene-name");
 	OBSSourceAutoRelease source = obs_get_source_by_name(sceneName);
 
 	if (source) {
 		obs_frontend_set_current_scene(source);
-		return req->SendOKResponse();
+		return request.success();
 	} else {
-		return req->SendErrorResponse("requested scene does not exist");
+		return request.failed("requested scene does not exist");
 	}
 }
 
@@ -45,7 +45,7 @@ HandlerResponse WSRequestHandler::HandleSetCurrentScene(WSRequestHandler* req) {
  * @category scenes
  * @since 0.3
  */
-HandlerResponse WSRequestHandler::HandleGetCurrentScene(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::GetCurrentScene(const RpcRequest& request) {
 	OBSSourceAutoRelease currentScene = obs_frontend_get_current_scene();
 	OBSDataArrayAutoRelease sceneItems = Utils::GetSceneItems(currentScene);
 
@@ -53,21 +53,21 @@ HandlerResponse WSRequestHandler::HandleGetCurrentScene(WSRequestHandler* req) {
 	obs_data_set_string(data, "name", obs_source_get_name(currentScene));
 	obs_data_set_array(data, "sources", sceneItems);
 
-	return req->SendOKResponse(data);
+	return request.success(data);
 }
 
 /**
  * Get a list of scenes in the currently active profile.
  *
  * @return {String} `current-scene` Name of the currently active scene.
- * @return {Array<Scene>} `scenes` Ordered list of the current profile's scenes (See `[GetCurrentScene](#getcurrentscene)` for more information).
+ * @return {Array<Scene>} `scenes` Ordered list of the current profile's scenes (See [GetCurrentScene](#getcurrentscene) for more information).
  *
  * @api requests
  * @name GetSceneList
  * @category scenes
  * @since 0.3
  */
-HandlerResponse WSRequestHandler::HandleGetSceneList(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::GetSceneList(const RpcRequest& request) {
 	OBSSourceAutoRelease currentScene = obs_frontend_get_current_scene();
 	OBSDataArrayAutoRelease scenes = Utils::GetScenes();
 
@@ -76,32 +76,58 @@ HandlerResponse WSRequestHandler::HandleGetSceneList(WSRequestHandler* req) {
 		obs_source_get_name(currentScene));
 	obs_data_set_array(data, "scenes", scenes);
 
-	return req->SendOKResponse(data);
+	return request.success(data);
+}
+
+/**
+ * Create a new scene scene.
+ *
+ * @param {String} `sceneName` Name of the scene to create.
+ *
+ * @api requests
+ * @name CreateScene
+ * @category scenes
+ * @since 4.9.0
+ */
+RpcResponse WSRequestHandler::CreateScene(const RpcRequest& request) {
+	if (!request.hasField("sceneName")) {
+		return request.failed("missing request parameters");
+	}
+
+	const char* sceneName = obs_data_get_string(request.parameters(), "sceneName");
+	OBSSourceAutoRelease source = obs_get_source_by_name(sceneName);
+
+	if (source) {
+		return request.failed("scene with this name already exists");
+	}
+	obs_scene_t *createdScene = obs_scene_create(sceneName);
+	obs_scene_release(createdScene);
+	return request.success();
 }
 
 /**
 * Changes the order of scene items in the requested scene.
 *
 * @param {String (optional)} `scene` Name of the scene to reorder (defaults to current).
-* @param {Array<Scene>} `items` Ordered list of objects with name and/or id specified. Id preferred due to uniqueness per scene
-* @param {int (optional)} `items[].id` Id of a specific scene item. Unique on a scene by scene basis.
-* @param {String (optional)} `items[].name` Name of a scene item. Sufficiently unique if no scene items share sources within the scene.
+* @param {Array<Object>} `items` Ordered list of objects with name and/or id specified. Id preferred due to uniqueness per scene
+* @param {int (optional)} `items.*.id` Id of a specific scene item. Unique on a scene by scene basis.
+* @param {String (optional)} `items.*.name` Name of a scene item. Sufficiently unique if no scene items share sources within the scene.
 *
 * @api requests
 * @name ReorderSceneItems
 * @category scenes
 * @since 4.5.0
 */
-HandlerResponse WSRequestHandler::HandleReorderSceneItems(WSRequestHandler* req) {
-	QString sceneName = obs_data_get_string(req->data, "scene");
+RpcResponse WSRequestHandler::ReorderSceneItems(const RpcRequest& request) {
+	QString sceneName = obs_data_get_string(request.parameters(), "scene");
 	OBSScene scene = Utils::GetSceneFromNameOrCurrent(sceneName);
 	if (!scene) {
-		return req->SendErrorResponse("requested scene doesn't exist");
+		return request.failed("requested scene doesn't exist");
 	}
 
-	OBSDataArrayAutoRelease items = obs_data_get_array(req->data, "items");
+	OBSDataArrayAutoRelease items = obs_data_get_array(request.parameters(), "items");
 	if (!items) {
-		return req->SendErrorResponse("sceneItem order not specified");
+		return request.failed("sceneItem order not specified");
 	}
 
 	struct reorder_context {
@@ -121,7 +147,7 @@ HandlerResponse WSRequestHandler::HandleReorderSceneItems(WSRequestHandler* req)
 		struct obs_sceneitem_order_info info;
 
 		size_t itemCount = obs_data_array_count(ctx->items);
-		for (int i = 0; i < itemCount; i++) {
+		for (uint i = 0; i < itemCount; i++) {
 			OBSDataAutoRelease item = obs_data_array_item(ctx->items, i);
 
 			OBSSceneItemAutoRelease sceneItem = Utils::GetSceneItemFromItem(scene, item);
@@ -143,8 +169,134 @@ HandlerResponse WSRequestHandler::HandleReorderSceneItems(WSRequestHandler* req)
 	}, &ctx);
 
 	if (!ctx.success) {
-		return req->SendErrorResponse(ctx.errorMessage);
+		return request.failed(ctx.errorMessage);
 	}
 
-	return req->SendOKResponse();
+	return request.success();
+}
+
+/**
+ * Set a scene to use a specific transition override.
+ *
+ * @param {String} `sceneName` Name of the scene to switch to.
+ * @param {String} `transitionName` Name of the transition to use.
+ * @param {int (Optional)} `transitionDuration` Duration in milliseconds of the transition if transition is not fixed. Defaults to the current duration specified in the UI if there is no current override and this value is not given.
+ *
+ * @api requests
+ * @name SetSceneTransitionOverride
+ * @category scenes
+ * @since 4.8.0
+ */
+RpcResponse WSRequestHandler::SetSceneTransitionOverride(const RpcRequest& request) {
+	if (!request.hasField("sceneName") || !request.hasField("transitionName")) {
+		return request.failed("missing request parameters");
+	}
+
+	QString sceneName = obs_data_get_string(request.parameters(), "sceneName");
+	OBSSourceAutoRelease source = obs_get_source_by_name(sceneName.toUtf8());
+	if (!source) {
+		return request.failed("requested scene does not exist");
+	}
+
+	enum obs_source_type sourceType = obs_source_get_type(source);
+	if (sourceType != OBS_SOURCE_TYPE_SCENE) {
+		return request.failed("requested scene is invalid");
+	}
+
+	QString transitionName = obs_data_get_string(request.parameters(), "transitionName");
+	OBSSourceAutoRelease transition = Utils::GetTransitionFromName(transitionName);
+	if (!transition) {
+		return request.failed("requested transition does not exist");
+	}
+
+	OBSDataAutoRelease sourceData = obs_source_get_private_settings(source);
+	obs_data_set_string(sourceData, "transition", transitionName.toUtf8().constData());
+
+	if (request.hasField("transitionDuration")) {
+		int transitionOverrideDuration = obs_data_get_int(request.parameters(), "transitionDuration");
+		obs_data_set_int(sourceData, "transition_duration", transitionOverrideDuration);
+	} else if(!obs_data_has_user_value(sourceData, "transition_duration")) {
+		obs_data_set_int(sourceData, "transition_duration",
+			obs_frontend_get_transition_duration()
+		);
+	}
+
+	return request.success();
+}
+
+/**
+ * Remove any transition override on a scene.
+ *
+ * @param {String} `sceneName` Name of the scene to switch to.
+ *
+ * @api requests
+ * @name RemoveSceneTransitionOverride
+ * @category scenes
+ * @since 4.8.0
+ */
+RpcResponse WSRequestHandler::RemoveSceneTransitionOverride(const RpcRequest& request) {
+	if (!request.hasField("sceneName")) {
+		return request.failed("missing request parameters");
+	}
+
+	QString sceneName = obs_data_get_string(request.parameters(), "sceneName");
+	OBSSourceAutoRelease source = obs_get_source_by_name(sceneName.toUtf8());
+	if (!source) {
+		return request.failed("requested scene does not exist");
+	}
+
+	enum obs_source_type sourceType = obs_source_get_type(source);
+	if (sourceType != OBS_SOURCE_TYPE_SCENE) {
+		return request.failed("requested scene is invalid");
+	}
+
+	OBSDataAutoRelease sourceData = obs_source_get_private_settings(source);
+	obs_data_erase(sourceData, "transition");
+	obs_data_erase(sourceData, "transition_duration");
+
+	return request.success();
+}
+
+/**
+ * Get the current scene transition override.
+ *
+ * @param {String} `sceneName` Name of the scene to switch to.
+ *
+ * @return {String} `transitionName` Name of the current overriding transition. Empty string if no override is set.
+ * @return {int} `transitionDuration` Transition duration. `-1` if no override is set.
+ *
+ * @api requests
+ * @name GetSceneTransitionOverride
+ * @category scenes
+ * @since 4.8.0
+ */
+RpcResponse WSRequestHandler::GetSceneTransitionOverride(const RpcRequest& request) {
+	if (!request.hasField("sceneName")) {
+		return request.failed("missing request parameters");
+	}
+
+	QString sceneName = obs_data_get_string(request.parameters(), "sceneName");
+	OBSSourceAutoRelease source = obs_get_source_by_name(sceneName.toUtf8());
+	if (!source) {
+		return request.failed("requested scene does not exist");
+	}
+
+	enum obs_source_type sourceType = obs_source_get_type(source);
+	if (sourceType != OBS_SOURCE_TYPE_SCENE) {
+		return request.failed("requested scene is invalid");
+	}
+
+	OBSDataAutoRelease sourceData = obs_source_get_private_settings(source);
+	const char* transitionOverrideName = obs_data_get_string(sourceData, "transition");
+
+	bool hasDurationOverride = obs_data_has_user_value(sourceData, "transition_duration");
+	int transitionOverrideDuration = obs_data_get_int(sourceData, "transition_duration");
+
+	OBSDataAutoRelease fields = obs_data_create();
+	obs_data_set_string(fields, "transitionName", transitionOverrideName);
+	obs_data_set_int(fields, "transitionDuration",
+		(hasDurationOverride ? transitionOverrideDuration : -1)
+	);
+
+	return request.success(fields);
 }

src/WSRequestHandler_Streaming.cpp

@@ -11,22 +11,26 @@
  *
  * @return {boolean} `streaming` Current streaming status.
  * @return {boolean} `recording` Current recording status.
+ * @return {boolean} `recording-paused` If recording is paused.
+ * @return {boolean} `virtualcam` Current virtual cam status.
+ * @return {boolean} `preview-only` Always false. Retrocompatibility with OBSRemote.
  * @return {String (optional)} `stream-timecode` Time elapsed since streaming started (only present if currently streaming).
  * @return {String (optional)} `rec-timecode` Time elapsed since recording started (only present if currently recording).
- * @return {boolean} `preview-only` Always false. Retrocompatibility with OBSRemote.
+ * @return {String (optional)} `virtualcam-timecode` Time elapsed since virtual cam started (only present if virtual cam currently active).
  *
  * @api requests
  * @name GetStreamingStatus
  * @category streaming
  * @since 0.3
  */
-HandlerResponse WSRequestHandler::HandleGetStreamingStatus(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::GetStreamingStatus(const RpcRequest& request) {
 	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());
-	obs_data_set_bool(data, "recording-paused", Utils::RecordingPaused());
+	obs_data_set_bool(data, "recording-paused", obs_frontend_recording_paused());
+	obs_data_set_bool(data, "virtualcam", obs_frontend_virtualcam_active());
 	obs_data_set_bool(data, "preview-only", false);
 
 	if (obs_frontend_streaming_active()) {
@@ -39,52 +43,57 @@ HandlerResponse WSRequestHandler::HandleGetStreamingStatus(WSRequestHandler* req
 		obs_data_set_string(data, "rec-timecode", recordingTimecode.toUtf8().constData());
 	}
 
-	return req->SendOKResponse(data);
+	if (obs_frontend_virtualcam_active()) {
+		QString virtualCamTimecode = events->getVirtualCamTimecode();
+		obs_data_set_string(data, "virtualcam-timecode", virtualCamTimecode.toUtf8().constData());
+	}
+
+	return request.success(data);
 }
 
 /**
- * Toggle streaming on or off.
+ * Toggle streaming on or off (depending on the current stream state).
  *
  * @api requests
  * @name StartStopStreaming
  * @category streaming
  * @since 0.3
  */
-HandlerResponse WSRequestHandler::HandleStartStopStreaming(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::StartStopStreaming(const RpcRequest& request) {
 	if (obs_frontend_streaming_active())
-		return HandleStopStreaming(req);
+		return StopStreaming(request);
 	else
-		return HandleStartStreaming(req);
+		return StartStreaming(request);
 }
 
 /**
  * Start streaming.
  * Will return an `error` if streaming is already active.
  *
- * @param {Object (optional)} `stream` Special stream configuration. Please note: these won't be saved to OBS' configuration.
+ * @param {Object (optional)} `stream` Special stream configuration. Note: these won't be saved to OBS' configuration.
  * @param {String (optional)} `stream.type` If specified ensures the type of stream matches the given type (usually 'rtmp_custom' or 'rtmp_common'). If the currently configured stream type does not match the given stream type, all settings must be specified in the `settings` object or an error will occur when starting the stream.
  * @param {Object (optional)} `stream.metadata` Adds the given object parameters as encoded query string parameters to the 'key' of the RTMP stream. Used to pass data to the RTMP service about the streaming. May be any String, Numeric, or Boolean field.
  * @param {Object (optional)} `stream.settings` Settings for the stream.
  * @param {String (optional)} `stream.settings.server` The publish URL.
  * @param {String (optional)} `stream.settings.key` The publish key of the stream.
- * @param {boolean (optional)} `stream.settings.use-auth` Indicates whether authentication should be used when connecting to the streaming server.
- * @param {String (optional)} `stream.settings.username` If authentication is enabled, the username for the streaming server. Ignored if `use-auth` is not set to `true`.
- * @param {String (optional)} `stream.settings.password` If authentication is enabled, the password for the streaming server. Ignored if `use-auth` is not set to `true`.
+ * @param {boolean (optional)} `stream.settings.use_auth` Indicates whether authentication should be used when connecting to the streaming server.
+ * @param {String (optional)} `stream.settings.username` If authentication is enabled, the username for the streaming server. Ignored if `use_auth` is not set to `true`.
+ * @param {String (optional)} `stream.settings.password` If authentication is enabled, the password for the streaming server. Ignored if `use_auth` is not set to `true`.
  *
  * @api requests
  * @name StartStreaming
  * @category streaming
  * @since 4.1.0
  */
-HandlerResponse WSRequestHandler::HandleStartStreaming(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::StartStreaming(const RpcRequest& request) {
 	if (obs_frontend_streaming_active() == false) {
 		OBSService configuredService = obs_frontend_get_streaming_service();
 		OBSService newService = nullptr;
 
 		// TODO: fix service memory leak
 
-		if (req->hasField("stream")) {
-			OBSDataAutoRelease streamData = obs_data_get_obj(req->data, "stream");
+		if (request.hasField("stream")) {
+			OBSDataAutoRelease streamData = obs_data_get_obj(request.parameters(), "stream");
 			OBSDataAutoRelease newSettings = obs_data_get_obj(streamData, "settings");
 			OBSDataAutoRelease newMetadata = obs_data_get_obj(streamData, "metadata");
 
@@ -103,10 +112,10 @@ HandlerResponse WSRequestHandler::HandleStartStreaming(WSRequestHandler* req) {
 					&& obs_data_has_user_value(newSettings, "key"))
 			{
 				const char* key = obs_data_get_string(newSettings, "key");
-				int keylen = strlen(key);
+				size_t keylen = strlen(key);
 
 				bool hasQuestionMark = false;
-				for (int i = 0; i < keylen; i++) {
+				for (size_t i = 0; i < keylen; i++) {
 					if (key[i] == '?') {
 						hasQuestionMark = true;
 						break;
@@ -157,9 +166,9 @@ HandlerResponse WSRequestHandler::HandleStartStreaming(WSRequestHandler* req) {
 			obs_frontend_set_streaming_service(configuredService);
 		}
 
-		return req->SendOKResponse();
+		return request.success();
 	} else {
-		return req->SendErrorResponse("streaming already active");
+		return request.failed("streaming already active");
 	}
 }
 
@@ -172,12 +181,12 @@ HandlerResponse WSRequestHandler::HandleStartStreaming(WSRequestHandler* req) {
  * @category streaming
  * @since 4.1.0
  */
-HandlerResponse WSRequestHandler::HandleStopStreaming(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::StopStreaming(const RpcRequest& request) {
 	if (obs_frontend_streaming_active() == true) {
 		obs_frontend_streaming_stop();
-		return req->SendOKResponse();
+		return request.success();
 	} else {
-		return req->SendErrorResponse("streaming not active");
+		return request.failed("streaming not active");
 	}
 }
 
@@ -188,7 +197,7 @@ HandlerResponse WSRequestHandler::HandleStopStreaming(WSRequestHandler* req) {
  * @param {Object} `settings` The actual settings of the stream.
  * @param {String (optional)} `settings.server` The publish URL.
  * @param {String (optional)} `settings.key` The publish key.
- * @param {boolean (optional)} `settings.use-auth` Indicates whether authentication should be used when connecting to the streaming server.
+ * @param {boolean (optional)} `settings.use_auth` Indicates whether authentication should be used when connecting to the streaming server.
  * @param {String (optional)} `settings.username` The username for the streaming service.
  * @param {String (optional)} `settings.password` The password for the streaming service.
  * @param {boolean} `save` Persist the settings to disk.
@@ -198,21 +207,22 @@ HandlerResponse WSRequestHandler::HandleStopStreaming(WSRequestHandler* req) {
  * @category streaming
  * @since 4.1.0
  */
-HandlerResponse WSRequestHandler::HandleSetStreamSettings(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::SetStreamSettings(const RpcRequest& request) {
 	OBSService service = obs_frontend_get_streaming_service();
 
-	OBSDataAutoRelease requestSettings = obs_data_get_obj(req->data, "settings");
+	OBSDataAutoRelease requestSettings = obs_data_get_obj(request.parameters(), "settings");
 	if (!requestSettings) {
-		return req->SendErrorResponse("'settings' are required'");
+		return request.failed("'settings' are required'");
 	}
 
 	QString serviceType = obs_service_get_type(service);
-	QString requestedType = obs_data_get_string(req->data, "type");
+	QString requestedType = obs_data_get_string(request.parameters(), "type");
 
 	if (requestedType != nullptr && requestedType != serviceType) {
 		OBSDataAutoRelease hotkeys = obs_hotkeys_save_service(service);
 		service = obs_service_create(
 			requestedType.toUtf8(), STREAM_SERVICE_ID, requestSettings, hotkeys);
+		obs_frontend_set_streaming_service(service);
 	} else {
 		// If type isn't changing, we should overlay the settings we got
 		// to the existing settings. By doing so, you can send a request that
@@ -231,17 +241,19 @@ HandlerResponse WSRequestHandler::HandleSetStreamSettings(WSRequestHandler* req)
 	}
 
 	//if save is specified we should immediately save the streaming service
-	if (obs_data_get_bool(req->data, "save")) {
+	if (obs_data_get_bool(request.parameters(), "save")) {
 		obs_frontend_save_streaming_service();
 	}
 
-	OBSDataAutoRelease serviceSettings = obs_service_get_settings(service);
+	OBSService responseService = obs_frontend_get_streaming_service();
+	OBSDataAutoRelease serviceSettings = obs_service_get_settings(responseService);
+	const char* responseType = obs_service_get_type(responseService);
 
 	OBSDataAutoRelease response = obs_data_create();
-	obs_data_set_string(response, "type", requestedType.toUtf8());
+	obs_data_set_string(response, "type", responseType);
 	obs_data_set_obj(response, "settings", serviceSettings);
 
-	return req->SendOKResponse(response);
+	return request.success(response);
 }
 
 /**
@@ -251,16 +263,16 @@ HandlerResponse WSRequestHandler::HandleSetStreamSettings(WSRequestHandler* req)
  * @return {Object} `settings` Stream settings object.
  * @return {String} `settings.server` The publish URL.
  * @return {String} `settings.key` The publish key of the stream.
- * @return {boolean} `settings.use-auth` Indicates whether authentication should be used when connecting to the streaming server.
- * @return {String} `settings.username` The username to use when accessing the streaming server. Only present if `use-auth` is `true`.
- * @return {String} `settings.password` The password to use when accessing the streaming server. Only present if `use-auth` is `true`.
+ * @return {boolean} `settings.use_auth` Indicates whether authentication should be used when connecting to the streaming server.
+ * @return {String} `settings.username` The username to use when accessing the streaming server. Only present if `use_auth` is `true`.
+ * @return {String} `settings.password` The password to use when accessing the streaming server. Only present if `use_auth` is `true`.
  *
  * @api requests
  * @name GetStreamSettings
  * @category streaming
  * @since 4.1.0
  */
-HandlerResponse WSRequestHandler::HandleGetStreamSettings(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::GetStreamSettings(const RpcRequest& request) {
 	OBSService service = obs_frontend_get_streaming_service();
 
 	const char* serviceType = obs_service_get_type(service);
@@ -270,7 +282,7 @@ HandlerResponse WSRequestHandler::HandleGetStreamSettings(WSRequestHandler* req)
 	obs_data_set_string(response, "type", serviceType);
 	obs_data_set_obj(response, "settings", settings);
 
-	return req->SendOKResponse(response);
+	return request.success(response);
 }
 
 /**
@@ -281,15 +293,14 @@ HandlerResponse WSRequestHandler::HandleGetStreamSettings(WSRequestHandler* req)
  * @category streaming
  * @since 4.1.0
  */
-HandlerResponse WSRequestHandler::HandleSaveStreamSettings(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::SaveStreamSettings(const RpcRequest& request) {
 	obs_frontend_save_streaming_service();
-	return req->SendOKResponse();
+	return request.success();
 }
 
 
 /**
  * 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
  *
@@ -298,19 +309,18 @@ HandlerResponse WSRequestHandler::HandleSaveStreamSettings(WSRequestHandler* req
  * @category streaming
  * @since 4.6.0
  */
-#if BUILD_CAPTIONS
-HandlerResponse WSRequestHandler::HandleSendCaptions(WSRequestHandler* req) {
-	if (!req->hasField("text")) {
-		return req->SendErrorResponse("missing request parameters");
+RpcResponse WSRequestHandler::SendCaptions(const RpcRequest& request) {
+	if (!request.hasField("text")) {
+		return request.failed("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);
+		const char* caption = obs_data_get_string(request.parameters(), "text");
+		// Send caption text with immediately (0 second delay)
+		obs_output_output_caption_text2(output, caption, 0.0);
 	}
 
-	return req->SendOKResponse();
+	return request.success();
 }
-#endif
 

src/WSRequestHandler_StudioMode.cpp

@@ -12,13 +12,13 @@
  * @category studio mode
  * @since 4.1.0
  */
-HandlerResponse WSRequestHandler::HandleGetStudioModeStatus(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::GetStudioModeStatus(const RpcRequest& request) {
 	bool previewActive = obs_frontend_preview_program_mode_active();
 
 	OBSDataAutoRelease response = obs_data_create();
 	obs_data_set_bool(response, "studio-mode", previewActive);
 
-	return req->SendOKResponse(response);
+	return request.success(response);
 }
 
 /**
@@ -33,9 +33,9 @@ HandlerResponse WSRequestHandler::HandleGetStudioModeStatus(WSRequestHandler* re
  * @category studio mode
  * @since 4.1.0
  */
-HandlerResponse WSRequestHandler::HandleGetPreviewScene(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::GetPreviewScene(const RpcRequest& request) {
 	if (!obs_frontend_preview_program_mode_active()) {
-		return req->SendErrorResponse("studio mode not enabled");
+		return request.failed("studio mode not enabled");
 	}
 
 	OBSSourceAutoRelease scene = obs_frontend_get_current_preview_scene();
@@ -45,7 +45,7 @@ HandlerResponse WSRequestHandler::HandleGetPreviewScene(WSRequestHandler* req) {
 	obs_data_set_string(data, "name", obs_source_get_name(scene));
 	obs_data_set_array(data, "sources", sceneItems);
 
-	return req->SendOKResponse(data);
+	return request.success(data);
 }
 
 /**
@@ -59,23 +59,23 @@ HandlerResponse WSRequestHandler::HandleGetPreviewScene(WSRequestHandler* req) {
  * @category studio mode
  * @since 4.1.0
  */
-HandlerResponse WSRequestHandler::HandleSetPreviewScene(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::SetPreviewScene(const RpcRequest& request) {
 	if (!obs_frontend_preview_program_mode_active()) {
-		return req->SendErrorResponse("studio mode not enabled");
+		return request.failed("studio mode not enabled");
 	}
 
-	if (!req->hasField("scene-name")) {
-		return req->SendErrorResponse("missing request parameters");
+	if (!request.hasField("scene-name")) {
+		return request.failed("missing request parameters");
 	}
 
-	const char* scene_name = obs_data_get_string(req->data, "scene-name");
+	const char* scene_name = obs_data_get_string(request.parameters(), "scene-name");
 	OBSScene scene = Utils::GetSceneFromNameOrCurrent(scene_name);
 	if (!scene) {
-		return req->SendErrorResponse("specified scene doesn't exist");
+		return request.failed("specified scene doesn't exist");
 	}
 
 	obs_frontend_set_current_preview_scene(obs_scene_get_source(scene));
-	return req->SendOKResponse();
+	return request.success();
 }
 
 /**
@@ -91,25 +91,25 @@ HandlerResponse WSRequestHandler::HandleSetPreviewScene(WSRequestHandler* req) {
  * @category studio mode
  * @since 4.1.0
  */
-HandlerResponse WSRequestHandler::HandleTransitionToProgram(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::TransitionToProgram(const RpcRequest& request) {
 	if (!obs_frontend_preview_program_mode_active()) {
-		return req->SendErrorResponse("studio mode not enabled");
+		return request.failed("studio mode not enabled");
 	}
 
-	if (req->hasField("with-transition")) {
+	if (request.hasField("with-transition")) {
 		OBSDataAutoRelease transitionInfo =
-			obs_data_get_obj(req->data, "with-transition");
+			obs_data_get_obj(request.parameters(), "with-transition");
 
 		if (obs_data_has_user_value(transitionInfo, "name")) {
 			QString transitionName =
 				obs_data_get_string(transitionInfo, "name");
 			if (transitionName.isEmpty()) {
-				return req->SendErrorResponse("invalid request parameters");
+				return request.failed("invalid request parameters");
 			}
 
 			bool success = Utils::SetTransitionByName(transitionName);
 			if (!success) {
-				return req->SendErrorResponse("specified transition doesn't exist");
+				return request.failed("specified transition doesn't exist");
 			}
 		}
 
@@ -121,7 +121,7 @@ HandlerResponse WSRequestHandler::HandleTransitionToProgram(WSRequestHandler* re
 	}
 
 	obs_frontend_preview_program_trigger_transition();
-	return req->SendOKResponse();
+	return request.success();
 }
 
 /**
@@ -132,9 +132,16 @@ HandlerResponse WSRequestHandler::HandleTransitionToProgram(WSRequestHandler* re
  * @category studio mode
  * @since 4.1.0
  */
-HandlerResponse WSRequestHandler::HandleEnableStudioMode(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::EnableStudioMode(const RpcRequest& request) {
+	if (obs_frontend_preview_program_mode_active()) {
+		return request.failed("studio mode already active");
+	}
+	obs_queue_task(OBS_TASK_UI, [](void* param) {
 		obs_frontend_set_preview_program_mode(true);
-	return req->SendOKResponse();
+
+		UNUSED_PARAMETER(param);
+	}, nullptr, true);
+	return request.success();
 }
 
 /**
@@ -145,21 +152,34 @@ HandlerResponse WSRequestHandler::HandleEnableStudioMode(WSRequestHandler* req)
  * @category studio mode
  * @since 4.1.0
  */
-HandlerResponse WSRequestHandler::HandleDisableStudioMode(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::DisableStudioMode(const RpcRequest& request) {
+	if (!obs_frontend_preview_program_mode_active()) {
+		return request.failed("studio mode not active");
+	}
+	obs_queue_task(OBS_TASK_UI, [](void* param) {
 		obs_frontend_set_preview_program_mode(false);
-	return req->SendOKResponse();
+
+		UNUSED_PARAMETER(param);
+	}, nullptr, true);
+
+	return request.success();
 }
 
 /**
- * Toggles Studio Mode.
+ * Toggles Studio Mode (depending on the current state of studio mode).
  *
  * @api requests
  * @name ToggleStudioMode
  * @category studio mode
  * @since 4.1.0
  */
-HandlerResponse WSRequestHandler::HandleToggleStudioMode(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::ToggleStudioMode(const RpcRequest& request) {
+	obs_queue_task(OBS_TASK_UI, [](void* param) {
 		bool previewProgramMode = obs_frontend_preview_program_mode_active();
 		obs_frontend_set_preview_program_mode(!previewProgramMode);
-	return req->SendOKResponse();
+
+		UNUSED_PARAMETER(param);
+	}, nullptr, true);
+
+	return request.success();
 }

src/WSRequestHandler_Transitions.cpp

@@ -14,7 +14,7 @@
  * @category transitions
  * @since 4.1.0
  */
-HandlerResponse WSRequestHandler::HandleGetTransitionList(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::GetTransitionList(const RpcRequest& request) {
 	OBSSourceAutoRelease currentTransition = obs_frontend_get_current_transition();
 	obs_frontend_source_list transitionList = {};
 	obs_frontend_get_transitions(&transitionList);
@@ -34,7 +34,7 @@ HandlerResponse WSRequestHandler::HandleGetTransitionList(WSRequestHandler* req)
 		obs_source_get_name(currentTransition));
 	obs_data_set_array(response, "transitions", transitions);
 
-	return req->SendOKResponse(response);
+	return request.success(response);
 }
 
 /**
@@ -48,7 +48,7 @@ HandlerResponse WSRequestHandler::HandleGetTransitionList(WSRequestHandler* req)
  * @category transitions
  * @since 0.3
  */
-HandlerResponse WSRequestHandler::HandleGetCurrentTransition(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::GetCurrentTransition(const RpcRequest& request) {
 	OBSSourceAutoRelease currentTransition = obs_frontend_get_current_transition();
 
 	OBSDataAutoRelease response = obs_data_create();
@@ -58,7 +58,7 @@ HandlerResponse WSRequestHandler::HandleGetCurrentTransition(WSRequestHandler* r
 	if (!obs_transition_fixed(currentTransition))
 		obs_data_set_int(response, "duration", obs_frontend_get_transition_duration());
 
-	return req->SendOKResponse(response);
+	return request.success(response);
 }
 
 /**
@@ -71,18 +71,18 @@ HandlerResponse WSRequestHandler::HandleGetCurrentTransition(WSRequestHandler* r
  * @category transitions
  * @since 0.3
  */
-HandlerResponse WSRequestHandler::HandleSetCurrentTransition(WSRequestHandler* req) {
-	if (!req->hasField("transition-name")) {
-		return req->SendErrorResponse("missing request parameters");
+RpcResponse WSRequestHandler::SetCurrentTransition(const RpcRequest& request) {
+	if (!request.hasField("transition-name")) {
+		return request.failed("missing request parameters");
 	}
 
-	QString name = obs_data_get_string(req->data, "transition-name");
+	QString name = obs_data_get_string(request.parameters(), "transition-name");
 	bool success = Utils::SetTransitionByName(name);
 	if (!success) {
-		return req->SendErrorResponse("requested transition does not exist");
+		return request.failed("requested transition does not exist");
 	}
 
-	return req->SendOKResponse();
+	return request.success();
 }
 
 /**
@@ -95,14 +95,14 @@ HandlerResponse WSRequestHandler::HandleSetCurrentTransition(WSRequestHandler* r
  * @category transitions
  * @since 4.0.0
  */
-HandlerResponse WSRequestHandler::HandleSetTransitionDuration(WSRequestHandler* req) {
-	if (!req->hasField("duration")) {
-		return req->SendErrorResponse("missing request parameters");
+RpcResponse WSRequestHandler::SetTransitionDuration(const RpcRequest& request) {
+	if (!request.hasField("duration")) {
+		return request.failed("missing request parameters");
 	}
 
-	int ms = obs_data_get_int(req->data, "duration");
+	int ms = obs_data_get_int(request.parameters(), "duration");
 	obs_frontend_set_transition_duration(ms);
-	return req->SendOKResponse();
+	return request.success();
 }
 
 /**
@@ -115,8 +115,162 @@ HandlerResponse WSRequestHandler::HandleSetTransitionDuration(WSRequestHandler*
  * @category transitions
  * @since 4.1.0
  */
-HandlerResponse WSRequestHandler::HandleGetTransitionDuration(WSRequestHandler* req) {
+RpcResponse WSRequestHandler::GetTransitionDuration(const RpcRequest& request) {
 	OBSDataAutoRelease response = obs_data_create();
 	obs_data_set_int(response, "transition-duration", obs_frontend_get_transition_duration());
-	return req->SendOKResponse(response);
+	return request.success(response);
+}
+
+/**
+ * Get the position of the current transition.
+ *
+ * @return {double} `position` current transition position. This value will be between 0.0 and 1.0. Note: Transition returns 1.0 when not active.
+ *
+ * @api requests
+ * @name GetTransitionPosition
+ * @category transitions
+ * @since 4.9.0
+ */
+RpcResponse WSRequestHandler::GetTransitionPosition(const RpcRequest& request) {
+	OBSSourceAutoRelease currentTransition = obs_frontend_get_current_transition();
+
+	OBSDataAutoRelease response = obs_data_create();
+	obs_data_set_double(response, "position", obs_transition_get_time(currentTransition));
+
+	return request.success(response);
+}
+
+/**
+ * Get the current settings of a transition
+ *
+ * @param {String} `transitionName` Transition name
+ *
+ * @return {Object} `transitionSettings` Current transition settings
+ *
+ * @api requests
+ * @name GetTransitionSettings
+ * @category transitions
+ * @since 4.9.0
+ */
+RpcResponse WSRequestHandler::GetTransitionSettings(const RpcRequest& request) {
+	if (!request.hasField("transitionName")) {
+		return request.failed("missing request parameters");
+	}
+
+	const char* transitionName = obs_data_get_string(request.parameters(), "transitionName");
+	OBSSourceAutoRelease transition = Utils::GetTransitionFromName(transitionName);
+	if (!transition) {
+		return request.failed("specified transition doesn't exist");
+	}
+
+	OBSDataAutoRelease transitionSettings = obs_source_get_settings(transition);
+
+	OBSDataAutoRelease response = obs_data_create();
+	obs_data_set_obj(response, "transitionSettings", transitionSettings);
+	return request.success(response);
+}
+
+/**
+ * Change the current settings of a transition
+ *
+ * @param {String} `transitionName` Transition name
+ * @param {Object} `transitionSettings` Transition settings (they can be partial)
+ *
+ * @return {Object} `transitionSettings` Updated transition settings
+ *
+ * @api requests
+ * @name SetTransitionSettings
+ * @category transitions
+ * @since 4.9.0
+ */
+RpcResponse WSRequestHandler::SetTransitionSettings(const RpcRequest& request) {
+	if (!request.hasField("transitionName") || !request.hasField("transitionSettings")) {
+		return request.failed("missing request parameters");
+	}
+
+	const char* transitionName = obs_data_get_string(request.parameters(), "transitionName");
+	OBSSourceAutoRelease transition = Utils::GetTransitionFromName(transitionName);
+	if (!transition) {
+		return request.failed("specified transition doesn't exist");
+	}
+
+	OBSDataAutoRelease newSettings = obs_data_get_obj(request.parameters(), "transitionSettings");
+	obs_source_update(transition, newSettings);
+	obs_source_update_properties(transition);
+
+	OBSDataAutoRelease updatedSettings = obs_source_get_settings(transition);
+
+	OBSDataAutoRelease response = obs_data_create();
+	obs_data_set_obj(response, "transitionSettings", updatedSettings);
+	return request.success(response);
+}
+
+/**
+ * Release the T-Bar (like a user releasing their mouse button after moving it).
+ * *YOU MUST CALL THIS if you called `SetTBarPosition` with the `release` parameter set to `false`.*
+ *
+ * @api requests
+ * @name ReleaseTBar
+ * @category transitions
+ * @since 4.9.0
+ */
+RpcResponse WSRequestHandler::ReleaseTBar(const RpcRequest& request) {
+	if (!obs_frontend_preview_program_mode_active()) {
+		return request.failed("studio mode not enabled");
+	}
+
+    OBSSourceAutoRelease transition = obs_frontend_get_current_transition();
+	if (obs_transition_fixed(transition)) {
+		return request.failed("current transition doesn't support t-bar control");
+	}
+
+	obs_frontend_release_tbar();
+
+	return request.success();
+}
+
+/**
+ * Set the manual position of the T-Bar (in Studio Mode) to the specified value. Will return an error if OBS is not in studio mode
+ * or if the current transition doesn't support T-Bar control.
+ *
+ * If your code needs to perform multiple successive T-Bar moves (e.g. : in an animation, or in response to a user moving a T-Bar control in your User Interface), set `release` to false and call `ReleaseTBar` later once the animation/interaction is over.
+ *
+ * @param {double} `position` T-Bar position. This value must be between 0.0 and 1.0.
+ * @param {boolean (optional)} `release` Whether or not the T-Bar gets released automatically after setting its new position (like a user releasing their mouse button after moving the T-Bar). Call `ReleaseTBar` manually if you set `release` to false. Defaults to true.
+ *
+ * @api requests
+ * @name SetTBarPosition
+ * @category transitions
+ * @since 4.9.0
+ */
+RpcResponse WSRequestHandler::SetTBarPosition(const RpcRequest& request) {
+	if (!obs_frontend_preview_program_mode_active()) {
+		return request.failed("studio mode not enabled");
+	}
+
+    OBSSourceAutoRelease transition = obs_frontend_get_current_transition();
+	if (obs_transition_fixed(transition)) {
+		return request.failed("current transition doesn't support t-bar control");
+	}
+
+	if (!request.hasField("position")) {
+		return request.failed("missing request parameters");
+	}
+
+	double position = obs_data_get_double(request.parameters(), "position");
+	if (position < 0.0 || position > 1.0) {
+		return request.failed("position is out of range");
+	}
+
+	bool release = true;
+	if (request.hasField("release")) {
+		release = obs_data_get_bool(request.parameters(), "release");
+	}
+
+	obs_frontend_set_tbar_position((int)((float)position * 1024.0));
+	if (release) {
+		obs_frontend_release_tbar();
+	}
+
+	return request.success();
 }

src/WSRequestHandler_VirtualCam.cpp

@@ -0,0 +1,79 @@
+#include "obs-websocket.h"
+#include "Utils.h"
+#include "WSEvents.h"
+
+#include "WSRequestHandler.h"
+
+ /**
+ * Get current virtual cam status.
+ *
+ * @return {boolean} `isVirtualCam` Current virtual camera status.
+ * @return {String (optional)} `virtualCamTimecode` Time elapsed since virtual cam started (only present if virtual cam currently active).
+ *
+ * @api requests
+ * @name GetVirtualCamStatus
+ * @category virtual cam
+ * @since 4.9.1
+ */
+RpcResponse WSRequestHandler::GetVirtualCamStatus(const RpcRequest& request) {
+		auto events = GetEventsSystem();
+
+		OBSDataAutoRelease data = obs_data_create();
+		obs_data_set_bool(data, "isVirtualCam", obs_frontend_virtualcam_active());
+
+		if (obs_frontend_virtualcam_active()) {
+				QString virtualCamTimecode = events->getVirtualCamTimecode();
+				obs_data_set_string(data, "virtualCamTimecode", virtualCamTimecode.toUtf8().constData());
+		}
+
+		return request.success(data);
+}
+
+/**
+ * Toggle virtual cam on or off (depending on the current virtual cam state).
+ *
+ * @api requests
+ * @name StartStopVirtualCam
+ * @category virtual cam
+ * @since 4.9.1
+ */
+RpcResponse WSRequestHandler::StartStopVirtualCam(const RpcRequest& request) {
+	(obs_frontend_virtualcam_active() ? obs_frontend_stop_virtualcam() : obs_frontend_start_virtualcam());
+	return request.success();
+}
+
+/**
+ * Start virtual cam.
+ * Will return an `error` if virtual cam is already active.
+ *
+ * @api requests
+ * @name StartVirtualCam
+ * @category virtual cam
+ * @since 4.9.1
+ */
+RpcResponse WSRequestHandler::StartVirtualCam(const RpcRequest& request) {
+	if (obs_frontend_virtualcam_active()) {
+		return request.failed("virtual cam already active");
+	}
+
+	obs_frontend_start_virtualcam();
+	return request.success();
+}
+
+/**
+ * Stop virtual cam.
+ * Will return an `error` if virtual cam is not active.
+ *
+ * @api requests
+ * @name StopVirtualCam
+ * @category virtual cam
+ * @since 4.9.1
+ */
+ RpcResponse WSRequestHandler::StopVirtualCam(const RpcRequest& request) {
+	if (!obs_frontend_virtualcam_active()) {
+		return request.failed("virtual cam not active");
+	}
+
+	obs_frontend_stop_virtualcam();
+	return request.success();
+}

src/WSServer.cpp

@@ -31,6 +31,7 @@ with this program. If not, see <https://www.gnu.org/licenses/>
 #include "obs-websocket.h"
 #include "Config.h"
 #include "Utils.h"
+#include "protocol/OBSRemoteProtocol.h"
 
 QT_USE_NAMESPACE
 
@@ -43,6 +44,7 @@ WSServer::WSServer()
 	  _connections(),
 	  _clMutex(QMutex::Recursive)
 {
+		_server.get_alog().clear_channels(websocketpp::log::alevel::frame_header | websocketpp::log::alevel::frame_payload | websocketpp::log::alevel::control);
 	_server.init_asio();
 #ifndef _WIN32
 	_server.set_reuse_addr(true);
@@ -58,10 +60,25 @@ WSServer::~WSServer()
 	stop();
 }
 
-void WSServer::start(quint16 port)
+void WSServer::serverRunner()
 {
-	if (_server.is_listening() && port == _serverPort) {
-		blog(LOG_INFO, "WSServer::start: server already on this port. no restart needed");
+	blog(LOG_INFO, "IO thread started.");
+	try {
+		_server.run();
+	} catch (websocketpp::exception const & e) {
+		blog(LOG_ERROR, "websocketpp instance returned an error: %s", e.what());
+	} catch (const std::exception & e) {
+		blog(LOG_ERROR, "websocketpp instance returned an error: %s", e.what());
+	} catch (...) {
+		blog(LOG_ERROR, "websocketpp instance returned an error");
+	}
+	blog(LOG_INFO, "IO thread exited.");
+}
+
+void WSServer::start(quint16 port, bool lockToIPv4)
+{
+	if (_server.is_listening() && (port == _serverPort && _lockToIPv4 == lockToIPv4)) {
+		blog(LOG_INFO, "WSServer::start: server already on this port and protocol mode. no restart needed");
 		return;
 	}
 
@@ -72,9 +89,16 @@ void WSServer::start(quint16 port)
 	_server.reset();
 
 	_serverPort = port;
+	_lockToIPv4 = lockToIPv4;
 
 	websocketpp::lib::error_code errorCode;
+	if (lockToIPv4) {
+		blog(LOG_INFO, "WSServer::start: Locked to IPv4 bindings");
+		_server.listen(websocketpp::lib::asio::ip::tcp::v4(), _serverPort, errorCode);
+	} else {
+		blog(LOG_INFO, "WSServer::start: Not locked to IPv4 bindings");
 		_server.listen(_serverPort, errorCode);
+	}
 
 	if (errorCode) {
 		std::string errorCodeMessage = errorCode.message();
@@ -82,7 +106,7 @@ void WSServer::start(quint16 port)
 
 		obs_frontend_push_ui_translation(obs_module_get_string);
 		QString errorTitle = tr("OBSWebsocket.Server.StartFailed.Title");
-		QString errorMessage = tr("OBSWebsocket.Server.StartFailed.Message").arg(_serverPort);
+		QString errorMessage = tr("OBSWebsocket.Server.StartFailed.Message").arg(_serverPort).arg(errorCodeMessage.c_str());
 		obs_frontend_pop_ui_translation();
 
 		QMainWindow* mainWindow = reinterpret_cast<QMainWindow*>(obs_frontend_get_main_window());
@@ -93,11 +117,7 @@ void WSServer::start(quint16 port)
 
 	_server.start_accept();
 
-	QtConcurrent::run([=]() {
-		blog(LOG_INFO, "io thread started");
-		_server.run();
-		blog(LOG_INFO, "io thread exited");
-	});
+	_serverThread = std::thread(&WSServer::serverRunner, this);
 
 	blog(LOG_INFO, "server started successfully on port %d", _serverPort);
 }
@@ -110,25 +130,43 @@ void WSServer::stop()
 
 	_server.stop_listening();
 	for (connection_hdl hdl : _connections) {
-		_server.close(hdl, websocketpp::close::status::going_away, "Server stopping");
+		websocketpp::lib::error_code errorCode;
+		_server.pause_reading(hdl, errorCode);
+		if (errorCode) {
+			blog(LOG_ERROR, "Error: %s", errorCode.message().c_str());
+			continue;
+		}
+
+		_server.close(hdl, websocketpp::close::status::going_away, "Server stopping", errorCode);
+		if (errorCode) {
+			blog(LOG_ERROR, "Error: %s", errorCode.message().c_str());
+			continue;
+		}
 	}
-	_connections.clear();
-	_connectionProperties.clear();
 
 	_threadPool.waitForDone();
 
-	while (!_server.stopped()) {
-		std::this_thread::sleep_for(std::chrono::milliseconds(1));
+	while (_connections.size() > 0) {
+		std::this_thread::sleep_for(std::chrono::milliseconds(10));
 	}
 
+	_serverThread.join();
+
 	blog(LOG_INFO, "server stopped successfully");
 }
 
-void WSServer::broadcast(std::string message)
+void WSServer::broadcast(const RpcEvent& event)
 {
+	std::string message = OBSRemoteProtocol::encodeEvent(event);
+
+	auto config = GetConfig();
+	if (config && config->DebugEnabled) {
+		blog(LOG_INFO, "Update << '%s'", message.c_str());
+	}
+
 	QMutexLocker locker(&_clMutex);
 	for (connection_hdl hdl : _connections) {
-		if (GetConfig()->AuthRequired) {
+		if (config && config->AuthRequired) {
 			bool authenticated = _connectionProperties[hdl].isAuthenticated();
 			if (!authenticated) {
 				continue;
@@ -146,6 +184,11 @@ void WSServer::broadcast(std::string message)
 	}
 }
 
+bool WSServer::isListening()
+{
+	return _server.is_listening();
+}
+
 void WSServer::onOpen(connection_hdl hdl)
 {
 	QMutexLocker locker(&_clMutex);
@@ -171,8 +214,17 @@ void WSServer::onMessage(connection_hdl hdl, server::message_ptr message)
 		ConnectionProperties& connProperties = _connectionProperties[hdl];
 		locker.unlock();
 
-		WSRequestHandler handler(connProperties);
-		std::string response = handler.processIncomingMessage(payload);
+		auto config = GetConfig();
+		if (config && config->DebugEnabled) {
+			blog(LOG_INFO, "Request >> '%s'", payload.c_str());
+		}
+
+		WSRequestHandler requestHandler(connProperties);
+		std::string response = OBSRemoteProtocol::processMessage(requestHandler, payload);
+
+		if (config && config->DebugEnabled) {
+			blog(LOG_INFO, "Response << '%s'", response.c_str());
+		}
 
 		websocketpp::lib::error_code errorCode;
 		_server.send(hdl, response, websocketpp::frame::opcode::text, errorCode);
@@ -194,11 +246,12 @@ void WSServer::onClose(connection_hdl hdl)
 
 	auto conn = _server.get_con_from_hdl(hdl);
 	auto localCloseCode = conn->get_local_close_code();
-
-	if (localCloseCode != websocketpp::close::status::going_away) {
+	auto localCloseReason = conn->get_local_close_reason();
 	QString clientIp = getRemoteEndpoint(hdl);
+
+	blog(LOG_INFO, "Websocket connection with client '%s' closed (disconnected). Code is %d, reason is: '%s'", clientIp.toUtf8().constData(), localCloseCode, localCloseReason.c_str());
+	if (localCloseCode != websocketpp::close::status::going_away && _server.is_listening()) {
 		notifyDisconnection(clientIp);
-		blog(LOG_INFO, "client %s disconnected", clientIp.toUtf8().constData());
 	}
 }
 

src/WSServer.h

@@ -30,8 +30,8 @@ with this program. If not, see <https://www.gnu.org/licenses/>
 #include <websocketpp/server.hpp>
 
 #include "ConnectionProperties.h"
-
 #include "WSRequestHandler.h"
+#include "rpc/RpcEvent.h"
 
 using websocketpp::connection_hdl;
 
@@ -44,14 +44,17 @@ Q_OBJECT
 public:
 	explicit WSServer();
 	virtual ~WSServer();
-	void start(quint16 port);
+	void start(quint16 port, bool lockToIPv4);
 	void stop();
-	void broadcast(std::string message);
+	void broadcast(const RpcEvent& event);
+	bool isListening();
 	QThreadPool* threadPool() {
 		return &_threadPool;
 	}
 
 private:
+	void serverRunner();
+
 	void onOpen(connection_hdl hdl);
 	void onMessage(connection_hdl hdl, server::message_ptr message);
 	void onClose(connection_hdl hdl);
@@ -60,8 +63,10 @@ private:
 	void notifyConnection(QString clientIp);
 	void notifyDisconnection(QString clientIp);
 
+	std::thread _serverThread;
 	server _server;
 	quint16 _serverPort;
+	bool _lockToIPv4;
 	std::set<connection_hdl, std::owner_less<connection_hdl>> _connections;
 	std::map<connection_hdl, ConnectionProperties, std::owner_less<connection_hdl>> _connectionProperties;
 	QMutex _clMutex;

src/forms/settings-dialog.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 "settings-dialog.h"
+
 #include <obs-frontend-api.h>
+#include <obs-module.h>
+#include <QtWidgets/QMessageBox>
 
 #include "../obs-websocket.h"
 #include "../Config.h"
 #include "../WSServer.h"
-#include "settings-dialog.h"
+
 
 #define CHANGE_ME "changeme"
 
@@ -35,22 +39,25 @@ SettingsDialog::SettingsDialog(QWidget* parent) :
 		this, &SettingsDialog::AuthCheckboxChanged);
 	connect(ui->buttonBox, &QDialogButtonBox::accepted,
 		this, &SettingsDialog::FormAccepted);
-
-
-	AuthCheckboxChanged();
 }
 
 void SettingsDialog::showEvent(QShowEvent* event) {
 	auto conf = GetConfig();
-
+	if (conf) {
 		ui->serverEnabled->setChecked(conf->ServerEnabled);
 		ui->serverPort->setValue(conf->ServerPort);
+		ui->lockToIPv4->setChecked(conf->LockToIPv4);
 
 		ui->debugEnabled->setChecked(conf->DebugEnabled);
 		ui->alertsEnabled->setChecked(conf->AlertsEnabled);
 
+		ui->authRequired->blockSignals(true);
 		ui->authRequired->setChecked(conf->AuthRequired);
+		ui->authRequired->blockSignals(false);
+	}
+
 	ui->password->setText(CHANGE_ME);
+	ui->password->setEnabled(ui->authRequired->isChecked());
 }
 
 void SettingsDialog::ToggleShowHide() {
@@ -60,18 +67,41 @@ void SettingsDialog::ToggleShowHide() {
 		setVisible(false);
 }
 
-void SettingsDialog::AuthCheckboxChanged() {
-	if (ui->authRequired->isChecked())
+void SettingsDialog::PreparePasswordEntry() {
+	ui->authRequired->blockSignals(true);
+	ui->authRequired->setChecked(true);
+	ui->authRequired->blockSignals(false);
 	ui->password->setEnabled(true);
-	else
+	ui->password->setFocus();
+}
+
+void SettingsDialog::AuthCheckboxChanged() {
+	if (ui->authRequired->isChecked()) {
+		ui->password->setEnabled(true);
+	}
+	else {
+		obs_frontend_push_ui_translation(obs_module_get_string);
+		QString authDisabledWarning = QObject::tr("OBSWebsocket.Settings.AuthDisabledWarning");
+		obs_frontend_pop_ui_translation();
+
+		QMessageBox::StandardButton response = QMessageBox::question(this, "obs-websocket", authDisabledWarning);
+		if (response == QMessageBox::Yes) {
 			ui->password->setEnabled(false);
+		} else {
+			ui->authRequired->setChecked(true);
+		}
+	}
 }
 
 void SettingsDialog::FormAccepted() {
 	auto conf = GetConfig();
+	if (!conf) {
+		return;
+	}
 
 	conf->ServerEnabled = ui->serverEnabled->isChecked();
 	conf->ServerPort = ui->serverPort->value();
+	conf->LockToIPv4 = ui->lockToIPv4->isChecked();
 
 	conf->DebugEnabled = ui->debugEnabled->isChecked();
 	conf->AlertsEnabled = ui->alertsEnabled->isChecked();
@@ -81,7 +111,7 @@ void SettingsDialog::FormAccepted() {
 			conf->SetPassword(ui->password->text());
 		}
 
-		if (!GetConfig()->Secret.isEmpty())
+		if (!conf->Secret.isEmpty())
 			conf->AuthRequired = true;
 		else
 			conf->AuthRequired = false;
@@ -95,7 +125,7 @@ void SettingsDialog::FormAccepted() {
 
 	auto server = GetServer();
 	if (conf->ServerEnabled) {
-		server->start(conf->ServerPort);
+		server->start(conf->ServerPort, conf->LockToIPv4);
 	} else {
 		server->stop();
 	}

src/forms/settings-dialog.h

@@ -31,6 +31,7 @@ public:
 	~SettingsDialog();
 	void showEvent(QShowEvent* event);
 	void ToggleShowHide();
+	void PreparePasswordEntry();
 
 private Q_SLOTS:
 	void AuthCheckboxChanged();

src/forms/settings-dialog.ui

@@ -7,7 +7,7 @@
     <x>0</x>
     <y>0</y>
     <width>407</width>
-		<height>195</height>
+    <height>216</height>
    </rect>
   </property>
   <property name="sizePolicy">
@@ -79,7 +79,7 @@
        </property>
       </widget>
      </item>
-		 <item row="5" column="1">
+     <item row="6" column="1">
       <widget class="QCheckBox" name="alertsEnabled">
        <property name="text">
         <string>OBSWebsocket.Settings.AlertsEnable</string>
@@ -89,7 +89,7 @@
        </property>
       </widget>
      </item>
-		 <item row="6" column="1">
+     <item row="7" column="1">
       <widget class="QCheckBox" name="debugEnabled">
        <property name="text">
         <string>OBSWebsocket.Settings.DebugEnable</string>
@@ -99,6 +99,13 @@
        </property>
       </widget>
      </item>
+     <item row="5" column="1">
+      <widget class="QCheckBox" name="lockToIPv4">
+       <property name="text">
+        <string>OBSWebsocket.Settings.LockToIPv4</string>
+       </property>
+      </widget>
+     </item>
     </layout>
    </item>
    <item>

src/obs-websocket.cpp

@@ -47,6 +47,7 @@ OBS_MODULE_USE_DEFAULT_LOCALE("obs-websocket", "en-US")
 ConfigPtr _config;
 WSServerPtr _server;
 WSEventsPtr _eventsSystem;
+SettingsDialog* settingsDialog = nullptr;
 
 bool obs_module_load(void) {
 	blog(LOG_INFO, "you can haz websockets (version %s)", OBS_WEBSOCKET_VERSION);
@@ -64,14 +65,14 @@ bool obs_module_load(void) {
 	// UI setup
 	obs_frontend_push_ui_translation(obs_module_get_string);
 	QMainWindow* mainWindow = (QMainWindow*)obs_frontend_get_main_window();
-	SettingsDialog* settingsDialog = new SettingsDialog(mainWindow);
+	settingsDialog = new SettingsDialog(mainWindow);
 	obs_frontend_pop_ui_translation();
 
 	const char* menuActionText =
 		obs_module_text("OBSWebsocket.Settings.DialogTitle");
 	QAction* menuAction =
 		(QAction*)obs_frontend_add_tools_menu_qaction(menuActionText);
-	QObject::connect(menuAction, &QAction::triggered, [settingsDialog] {
+	QObject::connect(menuAction, &QAction::triggered, [] {
 		// 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();
@@ -81,7 +82,7 @@ bool obs_module_load(void) {
 	auto eventCallback = [](enum obs_frontend_event event, void *param) {
 		if (event == OBS_FRONTEND_EVENT_FINISHED_LOADING) {
 			if (_config->ServerEnabled) {
-				_server->start(_config->ServerPort);
+				_server->start(_config->ServerPort, _config->LockToIPv4);
 			}
 			obs_frontend_remove_event_callback((obs_frontend_event_cb)param, nullptr);
 		}
@@ -115,3 +116,10 @@ WSServerPtr GetServer() {
 WSEventsPtr GetEventsSystem() {
 	return _eventsSystem;
 }
+
+void ShowPasswordSetting() {
+	if (settingsDialog) {
+		settingsDialog->PreparePasswordEntry();
+		settingsDialog->setVisible(true);
+	}
+}

src/obs-websocket.h

@@ -55,7 +55,8 @@ typedef std::shared_ptr<WSEvents> WSEventsPtr;
 ConfigPtr GetConfig();
 WSServerPtr GetServer();
 WSEventsPtr GetEventsSystem();
+void ShowPasswordSetting();
 
-#define OBS_WEBSOCKET_VERSION "4.7.0"
+#define OBS_WEBSOCKET_VERSION "4.9.1"
 
 #define blog(level, msg, ...) blog(level, "[obs-websocket] " msg, ##__VA_ARGS__)

src/protocol/OBSRemoteProtocol.cpp

@@ -0,0 +1,139 @@
+/*
+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 <inttypes.h>
+
+#include "OBSRemoteProtocol.h"
+#include "../WSRequestHandler.h"
+#include "../rpc/RpcEvent.h"
+#include "../Utils.h"
+
+std::string OBSRemoteProtocol::processMessage(WSRequestHandler& requestHandler, std::string message)
+{
+	std::string msgContainer(message);
+	const char* msg = msgContainer.c_str();
+
+	OBSDataAutoRelease data = obs_data_create_from_json(msg);
+	if (!data) {
+		blog(LOG_ERROR, "invalid JSON payload received for '%s'", msg);
+		return jsonDataToString(
+			errorResponse(nullptr, "invalid JSON payload")
+		);
+	}
+
+	if (!obs_data_has_user_value(data, "request-type") || !obs_data_has_user_value(data, "message-id")) {
+		return jsonDataToString(
+			errorResponse(nullptr, "missing request parameters")
+		);
+	}
+
+	QString methodName = obs_data_get_string(data, "request-type");
+	QString messageId = obs_data_get_string(data, "message-id");
+
+	OBSDataAutoRelease params = obs_data_create();
+	obs_data_apply(params, data);
+	obs_data_unset_user_value(params, "request-type");
+	obs_data_unset_user_value(params, "message-id");
+
+	RpcRequest request(messageId, methodName, params);
+	RpcResponse response = requestHandler.processRequest(request);
+
+	OBSDataAutoRelease responseData = rpcResponseToJsonData(response);
+	return jsonDataToString(responseData);
+}
+
+std::string OBSRemoteProtocol::encodeEvent(const RpcEvent& event)
+{
+	OBSDataAutoRelease eventData = obs_data_create();
+
+	QString updateType = event.updateType();
+	obs_data_set_string(eventData, "update-type", updateType.toUtf8().constData());
+
+	std::optional<uint64_t> streamTime = event.streamTime();
+	if (streamTime.has_value()) {
+		QString streamingTimecode = Utils::nsToTimestamp(streamTime.value());
+		obs_data_set_string(eventData, "stream-timecode", streamingTimecode.toUtf8().constData());
+	}
+
+	std::optional<uint64_t> recordingTime = event.recordingTime();
+	if (recordingTime.has_value()) {
+		QString recordingTimecode = Utils::nsToTimestamp(recordingTime.value());
+		obs_data_set_string(eventData, "rec-timecode", recordingTimecode.toUtf8().constData());
+	}
+
+	OBSData additionalFields = event.additionalFields();
+	if (additionalFields) {
+		obs_data_apply(eventData, additionalFields);
+	}
+
+	return std::string(obs_data_get_json(eventData));
+}
+
+obs_data_t* OBSRemoteProtocol::rpcResponseToJsonData(const RpcResponse& response)
+{
+	QByteArray messageIdBytes = response.messageId().toUtf8();
+	const char* messageId = messageIdBytes.constData();
+
+	OBSData additionalFields = response.additionalFields();
+	switch (response.status()) {
+		case RpcResponse::Status::Ok:
+			return successResponse(messageId, additionalFields);
+		case RpcResponse::Status::Error:
+			return errorResponse(messageId, response.errorMessage().toUtf8().constData(), additionalFields);
+		default:
+			assert(false);
+	}
+
+	return nullptr;
+}
+
+obs_data_t* OBSRemoteProtocol::successResponse(const char* messageId, obs_data_t* fields)
+{
+	return buildResponse(messageId, "ok", fields);
+}
+
+obs_data_t* OBSRemoteProtocol::errorResponse(const char* messageId, const char* errorMessage, obs_data_t* additionalFields)
+{
+	OBSDataAutoRelease fields = obs_data_create();
+	if (additionalFields) {
+		obs_data_apply(fields, additionalFields);
+	}
+	obs_data_set_string(fields, "error", errorMessage);
+	return buildResponse(messageId, "error", fields);
+}
+
+obs_data_t* OBSRemoteProtocol::buildResponse(const char* messageId, const char* status, obs_data_t* fields)
+{
+	obs_data_t* response = obs_data_create();
+	if (messageId) {
+		obs_data_set_string(response, "message-id", messageId);
+	}
+	obs_data_set_string(response, "status", status);
+
+	if (fields) {
+		obs_data_apply(response, fields);
+	}
+
+	return response;
+}
+
+std::string OBSRemoteProtocol::jsonDataToString(OBSDataAutoRelease data)
+{
+	std::string responseString = obs_data_get_json(data);
+	return responseString;
+}

src/protocol/OBSRemoteProtocol.h

@@ -0,0 +1,41 @@
+/*
+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 <string>
+#include <obs-data.h>
+
+#include "../rpc/RpcResponse.h"
+
+class WSRequestHandler;
+class RpcEvent;
+
+class OBSRemoteProtocol
+{
+public:
+	static std::string processMessage(WSRequestHandler& requestHandler, std::string message);
+	static std::string encodeEvent(const RpcEvent& event);
+	static obs_data_t* rpcResponseToJsonData(const RpcResponse& response);
+
+private:
+	static obs_data_t* successResponse(const char* messageId, obs_data_t* fields = nullptr);
+	static obs_data_t* errorResponse(const char* messageId, const char* errorMessage, obs_data_t* additionalFields = nullptr);
+	static obs_data_t* buildResponse(const char* messageId, const char*, obs_data_t* fields = nullptr);
+	static std::string jsonDataToString(OBSDataAutoRelease data);
+};

src/rpc/RpcEvent.cpp

@@ -0,0 +1,35 @@
+/*
+obs-websocket
+Copyright (C) 2016-2020	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 "RpcEvent.h"
+
+RpcEvent::RpcEvent(
+	const QString& updateType,
+	std::optional<uint64_t> streamTime, std::optional<uint64_t> recordingTime,
+	obs_data_t* additionalFields
+) :
+	_updateType(updateType),
+	_streamTime(streamTime),
+	_recordingTime(recordingTime),
+	_additionalFields(nullptr)
+{
+	if (additionalFields) {
+		_additionalFields = obs_data_create();
+		obs_data_apply(_additionalFields, additionalFields);
+	}
+}

src/rpc/RpcEvent.h

@@ -0,0 +1,61 @@
+/*
+obs-websocket
+Copyright (C) 2016-2020	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 <optional>
+#include <obs-data.h>
+#include <QtCore/QString>
+
+#include "../obs-websocket.h"
+
+class RpcEvent
+{
+public:
+	explicit RpcEvent(
+		const QString& updateType,
+		std::optional<uint64_t> streamTime, std::optional<uint64_t> recordingTime,
+		obs_data_t* additionalFields = nullptr
+	);
+
+	const QString& updateType() const
+	{
+		return _updateType;
+	}
+
+	const std::optional<uint64_t> streamTime() const
+	{
+		return _streamTime;
+	}
+
+	const std::optional<uint64_t> recordingTime() const
+	{
+		return _recordingTime;
+	}
+
+	const OBSData additionalFields() const
+	{
+		return OBSData(_additionalFields);
+	}
+
+private:
+	QString _updateType;
+	std::optional<uint64_t> _streamTime;
+	std::optional<uint64_t> _recordingTime;
+	OBSDataAutoRelease _additionalFields;
+};

src/rpc/RpcRequest.cpp

@@ -0,0 +1,104 @@
+/*
+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 "RpcRequest.h"
+#include "RpcResponse.h"
+
+RpcRequest::RpcRequest(const QString& messageId, const QString& methodName, obs_data_t* params) :
+	_messageId(messageId),
+	_methodName(methodName),
+	_parameters(nullptr)
+{
+	if (params) {
+		_parameters = obs_data_create();
+		obs_data_apply(_parameters, params);
+	}
+}
+
+const RpcResponse RpcRequest::success(obs_data_t* additionalFields) const
+{
+	return RpcResponse::ok(*this, additionalFields);
+}
+
+const RpcResponse RpcRequest::failed(const QString& errorMessage, obs_data_t* additionalFields) const
+{
+	return RpcResponse::fail(*this, errorMessage, additionalFields);
+}
+
+const bool RpcRequest::hasField(QString name, obs_data_type expectedFieldType, obs_data_number_type expectedNumberType) const
+{
+	if (!_parameters || name.isEmpty() || name.isNull()) {
+		return false;
+	}
+
+	OBSDataItemAutoRelease dataItem = obs_data_item_byname(_parameters, name.toUtf8());
+	if (!dataItem) {
+		return false;
+	}
+
+	if (expectedFieldType != OBS_DATA_NULL) {
+		obs_data_type fieldType = obs_data_item_gettype(dataItem);
+		if (fieldType != expectedFieldType) {
+			return false;
+		}
+
+		if (fieldType == OBS_DATA_NUMBER && expectedNumberType != OBS_DATA_NUM_INVALID) {
+			obs_data_number_type numberType = obs_data_item_numtype(dataItem);
+			if (numberType != expectedNumberType) {
+				return false;
+			}
+		}
+	}
+
+	return true;
+}
+
+const bool RpcRequest::hasBool(QString fieldName) const
+{
+	return this->hasField(fieldName, OBS_DATA_BOOLEAN);
+}
+
+const bool RpcRequest::hasString(QString fieldName) const
+{
+	return this->hasField(fieldName, OBS_DATA_STRING);
+}
+
+const bool RpcRequest::hasNumber(QString fieldName, obs_data_number_type expectedNumberType) const
+{
+	return this->hasField(fieldName, OBS_DATA_NUMBER, expectedNumberType);
+}
+
+const bool RpcRequest::hasInteger(QString fieldName) const
+{
+	return this->hasNumber(fieldName, OBS_DATA_NUM_INT);
+}
+
+const bool RpcRequest::hasDouble(QString fieldName) const
+{
+	return this->hasNumber(fieldName, OBS_DATA_NUM_DOUBLE);
+}
+
+const bool RpcRequest::hasArray(QString fieldName) const
+{
+	return this->hasField(fieldName, OBS_DATA_ARRAY);
+}
+
+const bool RpcRequest::hasObject(QString fieldName) const
+{
+	return this->hasField(fieldName, OBS_DATA_OBJECT);
+}

src/rpc/RpcRequest.h

@@ -0,0 +1,65 @@
+/*
+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 <obs-data.h>
+#include <QtCore/QString>
+#include "../obs-websocket.h"
+
+// forward declarations
+class RpcResponse;
+
+class RpcRequest
+{
+public:
+	explicit RpcRequest(const QString& messageId, const QString& methodName, obs_data_t* params);
+	
+	const QString& messageId() const
+	{
+		return _messageId;
+	}
+		
+	const QString& methodName() const
+	{
+		return _methodName;
+	}
+
+	const OBSData parameters() const
+	{
+		return OBSData(_parameters);
+	}
+
+	const RpcResponse success(obs_data_t* additionalFields = nullptr) const;
+	const RpcResponse failed(const QString& errorMessage, obs_data_t* additionalFields = nullptr) const;
+
+	const bool hasField(QString fieldName, obs_data_type expectedFieldType = OBS_DATA_NULL,
+					obs_data_number_type expectedNumberType = OBS_DATA_NUM_INVALID) const;
+	const bool hasBool(QString fieldName) const;
+	const bool hasString(QString fieldName) const;
+	const bool hasNumber(QString fieldName, obs_data_number_type expectedNumberType = OBS_DATA_NUM_INVALID) const;
+	const bool hasInteger(QString fieldName) const;
+	const bool hasDouble(QString fieldName) const;
+	const bool hasArray(QString fieldName) const;
+	const bool hasObject(QString fieldName) const;
+
+private:
+	const QString _messageId;
+	const QString _methodName;
+	OBSDataAutoRelease _parameters;
+};

src/rpc/RpcResponse.cpp

@@ -0,0 +1,48 @@
+/*
+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 "RpcResponse.h"
+#include "RpcRequest.h"
+
+RpcResponse::RpcResponse(
+	Status status, const QString& messageId,
+	const QString& methodName, obs_data_t* additionalFields
+) :
+	_status(status),
+	_messageId(messageId),
+	_methodName(methodName),
+	_additionalFields(nullptr)
+{
+	if (additionalFields) {
+		_additionalFields = obs_data_create();
+		obs_data_apply(_additionalFields, additionalFields);
+	}
+}
+
+const RpcResponse RpcResponse::ok(const RpcRequest& request, obs_data_t* additionalFields)
+{
+	RpcResponse response(Status::Ok, request.messageId(), request.methodName(), additionalFields);
+	return response;
+} 
+
+const RpcResponse RpcResponse::fail(const RpcRequest& request, const QString& errorMessage, obs_data_t* additionalFields)
+{
+	RpcResponse response(Status::Error, request.messageId(), request.methodName(), additionalFields);
+	response._errorMessage = errorMessage;
+	return response;
+}

src/rpc/RpcResponse.h

@@ -0,0 +1,70 @@
+/*
+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 <obs-data.h>
+#include <QtCore/QString>
+#include "../obs-websocket.h"
+
+class RpcRequest;
+
+class RpcResponse
+{
+public:
+	enum Status { Unknown, Ok, Error };
+
+	static RpcResponse ofRequest(const RpcRequest& request);
+	static const RpcResponse ok(const RpcRequest& request, obs_data_t* additionalFields = nullptr);
+	static const RpcResponse fail(
+		const RpcRequest& request, const QString& errorMessage,
+		obs_data_t* additionalFields = nullptr
+	);
+
+	const Status status() const {
+		return _status;
+	}
+
+	const QString& messageId() const {
+		return _messageId;
+	}
+	
+	const QString& methodName() const {
+		return _methodName;
+	}
+
+	const QString& errorMessage() const {
+		return _errorMessage;
+	}
+	
+	const OBSData additionalFields() const {
+		return OBSData(_additionalFields);
+	}
+
+private:
+	explicit RpcResponse(
+		Status status,
+		const QString& messageId, const QString& methodName,
+		obs_data_t* additionalFields = nullptr
+	);
+	const Status _status;
+	const QString _messageId;
+	const QString _methodName;
+	QString _errorMessage;
+	OBSDataAutoRelease _additionalFields;
+};