Adapt obs websocket service and sample to version 5

Author: hlxid

samples/obs-scenelist/extension/index.ts

@@ -8,12 +8,12 @@ module.exports = function (nodecg: NodeCG) {
     const obs = requireService<OBSServiceClient>(nodecg, "obs");
 
     obs?.onAvailable((client) => {
-        nodecg.log.info("OBS client has been updated, counting scenes and switching to another one.");
-        client.send("GetSceneList").then((data) => {
+        nodecg.log.info("OBS client has been updated, counting scenes and detecting when switching to another one.");
+        client.call("GetSceneList").then((data) => {
             nodecg.log.info(`There are ${data.scenes.length} scenes!`);
         });
-        client.on("SwitchScenes", (data) => {
-            nodecg.log.info(`Scene changed to ${data["scene-name"]}.`);
+        client.on("CurrentProgramSceneChanged", (data) => {
+            nodecg.log.info(`Scene changed to ${data.sceneName}.`);
         });
     });
 

services/nodecg-io-obs/extension/index.ts

@@ -5,6 +5,7 @@ import OBSWebSocket from "obs-websocket-js";
 interface OBSServiceConfig {
     host: string;
     port: number;
+    isSecure?: boolean;
     password?: string;
 }
 
@@ -18,7 +19,7 @@ class OBSService extends ServiceBundle<OBSServiceConfig, OBSServiceClient> {
     async validateConfig(config: OBSServiceConfig): Promise<Result<void>> {
         const client = new OBSWebSocket();
         try {
-            await client.connect({ address: `${config.host}:${config.port}`, password: config.password });
+            await this.connectClient(client, config);
 
             client.disconnect();
         } catch (e) {
@@ -30,7 +31,7 @@ class OBSService extends ServiceBundle<OBSServiceConfig, OBSServiceClient> {
     async createClient(config: OBSServiceConfig, logger: Logger): Promise<Result<OBSServiceClient>> {
         const client = new OBSWebSocket();
         try {
-            await client.connect({ address: `${config.host}:${config.port}`, password: config.password });
+            await this.connectClient(client, config);
             logger.info("Connected to OBS successfully.");
         } catch (e) {
             return error(e.error);
@@ -39,6 +40,11 @@ class OBSService extends ServiceBundle<OBSServiceConfig, OBSServiceClient> {
         return success(client);
     }
 
+    private async connectClient(client: OBSWebSocket, config: OBSServiceConfig): Promise<void> {
+        const protocol = config.isSecure ? "wss" : "ws";
+        await client.connect(`${protocol}://${config.host}:${config.port}`, config.password);
+    }
+
     stopClient(client: OBSServiceClient) {
         client.disconnect();
     }

services/nodecg-io-obs/obs-schema.json

@@ -7,6 +7,11 @@
             "type": "string",
             "description": "An IP address to the obs websocket server"
         },
+        "isSecure": {
+            "type": "boolean",
+            "description": "Whether the websocket connection is using encryption (wss) or not (ws)",
+            "default": false
+        },
         "port": {
             "type": "number",
             "description": "The port of the obs websocket server"