docs(jsdoc): clean up types for compatability with obs-websocket-js typedef generator

.travis.yml

@@ -32,16 +32,6 @@ matrix:
     after_success:
     - docker exec -it xenial /root/obs-websocket/CI/package-xenial.sh
 
-  - os: osx
-    env: _macos_build
-    osx_image: xcode9.4
-    before_install:
-    - "./CI/install-dependencies-macos.sh"
-    - "./CI/install-build-obs-macos.sh"
-    script: "./CI/build-macos.sh"
-    after_success:
-    - ./CI/package-macos.sh
-
 deploy:
 - provider: s3
   region: eu-central-1
@@ -57,15 +47,3 @@ deploy:
     - "$TRAVIS_OS_NAME = linux"
     - "-d /home/travis/package"
     all_branches: true
-- provider: s3
-  region: eu-central-1
-  bucket: obs-websocket-osx-builds
-  access_key_id: "$AWS_ID"
-  secret_access_key: "$AWS_SECRET"
-  local_dir: release
-  skip_cleanup: true
-  acl: public_read
-  on:
-    repo: Palakis/obs-websocket
-    condition: "$TRAVIS_OS_NAME = osx"
-    all_branches: true

BUILDING.md

@@ -49,5 +49,7 @@ cd obs-websocket
 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 & OS X : [![Automated Build status for Linux & OS X](https://travis-ci.org/Palakis/obs-websocket.svg?branch=master)](https://travis-ci.org/Palakis/obs-websocket)
+
+- 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)

CI/install-build-obs-macos.sh

@@ -20,6 +20,10 @@ if [ "${HAS_GIT}" = "" ]; then
     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.."
@@ -30,6 +34,8 @@ git checkout $OBSLatestTag
 mkdir build && cd build
 echo "[obs-websocket] Building obs-studio.."
 cmake .. \
+	-DCMAKE_OSX_DEPLOYMENT_TARGET=10.11 \
 	-DDISABLE_PLUGINS=true \
+	-DDepsPath=/tmp/obsdeps \
 	-DCMAKE_PREFIX_PATH=/usr/local/opt/qt/lib/cmake \
 && make -j4

CI/install-dependencies-macos.sh

@@ -1,5 +1,7 @@
 #!/bin/sh
 
+
+
 OSTYPE=$(uname)
 
 if [ "${OSTYPE}" != "Darwin" ]; then
@@ -19,7 +21,7 @@ echo "[obs-websocket] Updating Homebrew.."
 brew update >/dev/null
 echo "[obs-websocket] Checking installed Homebrew formulas.."
 BREW_PACKAGES=$(brew list)
-BREW_DEPENDENCIES="ffmpeg libav cmake"
+BREW_DEPENDENCIES="jack speexdsp ccache swig mbedtls"
 
 for DEPENDENCY in ${BREW_DEPENDENCIES}; do
     if echo "${BREW_PACKAGES}" | grep -q "^${DEPENDENCY}\$"; then
@@ -39,7 +41,7 @@ echo "[obs-websocket] Installing obs-websocket dependency 'QT 5.10.1'.."
 # Pouring from the bottle is much quicker though, so use bottle for now.
 # =!= NOTICE =!=
 
-brew install https://raw.githubusercontent.com/Homebrew/homebrew-core/9a70413d137839de0054571e5f85fd07ee400955/Formula/qt.rb
+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
@@ -56,4 +58,4 @@ 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
+fi

CI/macos/obs-websocket.pkgproj

@@ -635,7 +635,7 @@
 			<key>OVERWRITE_PERMISSIONS</key>
 			<false/>
 			<key>VERSION</key>
-			<string>4.5.0</string>
+			<string>4.5.1</string>
 		</dict>
 		<key>PROJECT_COMMENTS</key>
 		<dict>

CI/package-macos.sh

@@ -16,13 +16,10 @@ export WS_LIB="/usr/local/opt/qt/lib/QtWebSockets.framework/QtWebSockets"
 export NET_LIB="/usr/local/opt/qt/lib/QtNetwork.framework/QtNetwork"
 
 export GIT_HASH=$(git rev-parse --short HEAD)
+export GIT_BRANCH_OR_TAG=$(git name-rev --name-only HEAD | awk -F/ '{print $NF}')
 
-export VERSION="$GIT_HASH-$TRAVIS_BRANCH"
-export LATEST_VERSION="$TRAVIS_BRANCH"
-if [ -n "${TRAVIS_TAG}" ]; then
-	export VERSION="$TRAVIS_TAG"
-	export LATEST_VERSION="$TRAVIS_TAG"
-fi
+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"

CMakeLists.txt

@@ -162,9 +162,14 @@ if(UNIX AND NOT APPLE)
 		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")
+
 	install(FILES ${locale_files}
 		DESTINATION "${CMAKE_INSTALL_PREFIX}/share/obs/obs-plugins/obs-websocket/locale")
 endif()

azure-pipelines.yml

@@ -0,0 +1,20 @@
+pool:
+  vmImage: 'macOS-10.13'
+
+steps:
+- script: ./CI/install-dependencies-macos.sh
+  displayName: 'Install Dependencies'
+
+- script: ./CI/install-build-obs-macos.sh
+  displayName: 'Build OBS'
+
+- script: ./CI/build-macos.sh
+  displayName: 'Build obs-websocket'
+
+- script: ./CI/package-macos.sh
+  displayName: 'Package'
+
+- task: PublishBuildArtifacts@1
+  inputs:
+    pathtoPublish: './release'
+    artifactName: 'build'

docs/generated/comments.json

@@ -3107,7 +3107,7 @@
         "description": "Changes the order of scene items in the requested scene.",
         "param": [
           "{String (optional)} `scene` Name of the scene to reorder (defaults to current).",
-          "{Scene|Array} `items` Ordered list of objects with name and/or id specified. Id preferred due to uniqueness per scene",
+          "{Array<Scene>} `items` Ordered list of objects with name and/or id specified. Id preferred due to uniqueness per scene",
           "{int (optional)} `items[].id` Id of a specific scene item. Unique on a scene by scene basis.",
           "{String (optional)} `items[].name` Name of a scene item. Sufficiently unique if no scene items share sources within the scene."
         ],
@@ -3122,7 +3122,7 @@
             "description": "Name of the scene to reorder (defaults to current)."
           },
           {
-            "type": "Scene|Array",
+            "type": "Array<Scene>",
             "name": "items",
             "description": "Ordered list of objects with name and/or id specified. Id preferred due to uniqueness per scene"
           },

docs/generated/protocol.md

@@ -1477,7 +1477,7 @@ Changes the order of scene items in the requested scene.
 | Name | Type  | Description |
 | ---- | :---: | ------------|
 | `scene` | _String (optional)_ | Name of the scene to reorder (defaults to current). |
-| `items` | _Scene\|Array_ | Ordered list of objects with name and/or id specified. Id preferred due to uniqueness per scene |
+| `items` | _Array<Scene>_ | Ordered list of objects with name and/or id specified. Id preferred due to uniqueness per scene |
 | `items[].id` | _int (optional)_ | Id of a specific scene item. Unique on a scene by scene basis. |
 | `items[].name` | _String (optional)_ | Name of a scene item. Sufficiently unique if no scene items share sources within the scene. |
 

installer/installer.iss

@@ -2,7 +2,7 @@
 ; SEE THE DOCUMENTATION FOR DETAILS ON CREATING INNO SETUP SCRIPT FILES!
 
 #define MyAppName "obs-websocket"
-#define MyAppVersion "4.5.0"
+#define MyAppVersion "4.5.1"
 #define MyAppPublisher "Stephane Lepin"
 #define MyAppURL "http://github.com/Palakis/obs-websocket"
 

src/WSRequestHandler_Scenes.cpp

@@ -85,7 +85,7 @@ void WSRequestHandler::HandleGetSceneList(WSRequestHandler* req) {
 * Changes the order of scene items in the requested scene.
 *
 * @param {String (optional)} `scene` Name of the scene to reorder (defaults to current).
-* @param {Scene|Array} `items` Ordered list of objects with name and/or id specified. Id preferred due to uniqueness per scene
+* @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.
 *

src/WSRequestHandler_Sources.cpp

@@ -1241,6 +1241,7 @@ void WSRequestHandler::HandleRemoveFilterFromSource(WSRequestHandler* req)
 	OBSSourceAutoRelease filter = obs_source_get_filter_by_name(source, filterName);
 	if (!filter) {
 		req->SendErrorResponse("specified filter doesn't exist");
+		return;
 	}
 
 	obs_source_filter_remove(source, filter);
@@ -1285,6 +1286,7 @@ void WSRequestHandler::HandleReorderSourceFilter(WSRequestHandler* req)
 	OBSSourceAutoRelease filter = obs_source_get_filter_by_name(source, filterName);
 	if (!filter) {
 		req->SendErrorResponse("specified filter doesn't exist");
+		return;
 	}
 
 	struct filterSearch {
@@ -1357,6 +1359,7 @@ void WSRequestHandler::HandleMoveSourceFilter(WSRequestHandler* req)
 	OBSSourceAutoRelease filter = obs_source_get_filter_by_name(source, filterName);
 	if (!filter) {
 		req->SendErrorResponse("specified filter doesn't exist");
+		return;
 	}
 
 	obs_order_movement movement;
@@ -1414,6 +1417,7 @@ void WSRequestHandler::HandleSetSourceFilterSettings(WSRequestHandler* req)
 	OBSSourceAutoRelease filter = obs_source_get_filter_by_name(source, filterName);
 	if (!filter) {
 		req->SendErrorResponse("specified filter doesn't exist");
+		return;
 	}
 
 	OBSDataAutoRelease settings = obs_source_get_settings(filter);

src/obs-websocket.h

@@ -39,7 +39,7 @@ using OBSOutputAutoRelease =
 	OBSRef<obs_output_t*, ___output_dummy_addref, obs_output_release>;
 
 #define PROP_AUTHENTICATED "wsclient_authenticated"
-#define OBS_WEBSOCKET_VERSION "4.5.0"
+#define OBS_WEBSOCKET_VERSION "4.5.1"
 
 #define blog(level, msg, ...) blog(level, "[obs-websocket] " msg, ##__VA_ARGS__)