fix: more responsive feedback, director presets (#20)

* chore: update deps

* fix: more responsive feedback when using local inputs

* fix: director presets not populating

* chore: cleanup, version up

Author: bryce-seifert

.github/FUNDING.yml

@@ -1,13 +1 @@
-# These are supported funding model platforms
-
-github: bryce-seifert # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
-patreon: # Replace with a single Patreon username
-open_collective: # Replace with a single Open Collective username
-ko_fi: # Replace with a single Ko-fi username
-tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
-community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
-liberapay: # Replace with a single Liberapay username
-issuehunt: # Replace with a single IssueHunt username
-otechie: # Replace with a single Otechie username
-lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
-custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
+github: bryce-seifert

actions.js

@@ -5,12 +5,6 @@ export function getActions() {
 		{ id: 'false', label: 'Mute' },
 	]
 
-	let mutableChoices_Highlight = [
-		{ id: 'toggle', label: 'Toggle' },
-		{ id: 'true', label: 'Highlight' },
-		{ id: 'false', label: 'Un-highlight' },
-	]
-
 	let actions = {
 		speaker: {
 			name: 'Local: Speaker Control',
@@ -42,7 +36,7 @@ export function getActions() {
 				},
 			],
 			callback: (action) => {
-				this.sendRequest('mic', null, action.options.value)
+				this.sendRequest('mic', null, action.options.value, true)
 			},
 		},
 
@@ -59,7 +53,7 @@ export function getActions() {
 				},
 			],
 			callback: (action) => {
-				this.sendRequest('camera', null, action.options.value)
+				this.sendRequest('camera', null, action.options.value, true)
 			},
 		},
 

companion/manifest.json

@@ -3,7 +3,7 @@
 	"name": "vdo-ninja",
 	"shortname": "VDO.Ninja",
 	"description": "vdo-ninja",
-	"version": "2.2.0",
+	"version": "2.2.1",
 	"license": "MIT",
 	"repository": "git+https://github.com/bitfocus/companion-module-vdo-ninja.git",
 	"bugs": "https://github.com/bitfocus/companion-module-vdo-ninja/issues",

feedbacks.js

@@ -38,21 +38,17 @@ export function getFeedbacks() {
 			bgcolor: ColorGreen,
 		},
 		callback: (feedback) => {
-			if (this.states[feedback.options.stream]?.position) {
-				if (feedback.options.state) {
-					if (this.states[feedback.options.stream]?.others['mute-guest'] === 1) {
-						return true
+			let stream = this.states[feedback.options.stream]
+			if (stream) {
+				if (stream.position && !stream.director) {
+					if (stream?.others?.['mute-guest'] == 1) {
+						return feedback.options.state ?? false
 					} else {
-						return this.states[feedback.options.stream]?.muted
+						return stream?.muted === feedback.options.state
 					}
 				} else {
-					if (this.states[feedback.options.stream]?.others['mute-guest'] === 1) {
-						return false
-					}
-					return this.states[feedback.options.stream]?.muted === feedback.options.state
+					return stream?.muted === feedback.options.state
 				}
-			} else {
-				return this.states[feedback.options.stream]?.muted === feedback.options.state
 			}
 		},
 	}
@@ -84,21 +80,17 @@ export function getFeedbacks() {
 			bgcolor: ColorGreen,
 		},
 		callback: (feedback) => {
-			if (this.states[feedback.options.stream]?.position) {
-				if (feedback.options.state) {
-					if (this.states[feedback.options.stream]?.others['hide-guest'] === 1) {
-						return true
+			let stream = this.states[feedback.options.stream]
+			if (stream) {
+				if (stream.position && !stream.director) {
+					if (stream?.others?.['hide-guest'] == 1) {
+						return feedback.options.state ?? false
 					} else {
-						return this.states[feedback.options.stream]?.videoMuted
+						return stream?.videoMuted === feedback.options.state
 					}
 				} else {
-					if (this.states[feedback.options.stream]?.others['hide-guest'] === 1) {
-						return false
-					}
-					return this.states[feedback.options.stream]?.videoMuted === feedback.options.state
+					return stream?.videoMuted === feedback.options.state
 				}
-			} else {
-				return this.states[feedback.options.stream]?.videoMuted === feedback.options.state
 			}
 		},
 	}

index.js

@@ -1,4 +1,4 @@
-import { InstanceBase, runEntrypoint } from '@companion-module/base'
+import { InstanceBase, InstanceStatus, runEntrypoint } from '@companion-module/base'
 import { getActions } from './actions.js'
 import { getPresets } from './presets.js'
 import { getVariables, updateVariables } from './variables.js'
@@ -15,7 +15,7 @@ class VDONinjaInstance extends InstanceBase {
 	}
 
 	async init(config) {
-		this.updateStatus('connecting')
+		this.updateStatus(InstanceStatus.Connecting)
 
 		this.config = config
 
@@ -118,7 +118,7 @@ class VDONinjaInstance extends InstanceBase {
 					this.log('info', `Connection opened to VDO.Ninja`)
 					this.connected = true
 				}
-				this.updateStatus('ok')
+				this.updateStatus(InstanceStatus.Ok)
 
 				this.ws.send(`{"join": "${this.config.apiID}" }`)
 				this.ws.send(`{"action": "getDetails"}`)
@@ -139,7 +139,7 @@ class VDONinjaInstance extends InstanceBase {
 			this.ws.on('error', (data) => {
 				if (this.connected !== false) {
 					this.connected = false
-					this.updateStatus('connection_failure')
+					this.updateStatus(InstanceStatus.ConnectionFailure)
 					if (data?.code == 'ENOTFOUND') {
 						this.log('error', `Unable to reach ${serverUrl}`)
 					} else {
@@ -152,7 +152,7 @@ class VDONinjaInstance extends InstanceBase {
 			})
 		} else {
 			this.log('warn', `API ID required to connect to VDO.Ninja, please add one in the module settings`)
-			this.updateStatus('bad_config', 'Missing API ID')
+			this.updateStatus(InstanceStatus.BadConfig, 'Missing API ID')
 		}
 	}
 
@@ -166,6 +166,17 @@ class VDONinjaInstance extends InstanceBase {
 					let data = result[x]
 					this.processGetDetails(data)
 				}
+			} else if (callback.local) {
+				for (let x in this.states) {
+					if (this.states[x].localStream) {
+						let result = callback.result
+						if (callback.value !== 'toggle') {
+							this.processUpdate({ streamID: this.states[x].streamID, action: callback.action, value: result })
+						}
+					}
+				}
+			} else {
+				//console.log(callback)
 			}
 		} else if (message?.update) {
 			let data = message.update
@@ -186,6 +197,10 @@ class VDONinjaInstance extends InstanceBase {
 			label = data.label
 		}
 
+		if (data.localStream) {
+			label = `${label} (Local)`
+		}
+
 		let streamObject = { id: data.streamID, label: label }
 
 		if (this.streams.find((o) => o.id === data.streamID)) {
@@ -244,17 +259,20 @@ class VDONinjaInstance extends InstanceBase {
 					this.ws.send(`{"action": "getDetails"}`)
 					break
 				case 'directorMuted':
-					this.states[data.streamID].others['mute-guest'] = data.value ? 1 : 0
+					this.states[data.streamID].others['mute-guest'] = data.value ? '1' : '0'
 					break
-				case 'directorVideoMuted':
-					this.states[data.streamID].others['hide-guest'] = data.value ? 1 : 0
+				case 'directorVideoHide':
+					this.states[data.streamID].others['hide-guest'] = data.value ? '1' : '0'
 					break
 				case 'remoteMuted':
+				case 'mic':
 					this.states[data.streamID].muted = data.value
 					break
 				case 'remoteVideoMuted':
+				case 'camera':
 					this.states[data.streamID].videoMuted = data.value
 					break
+
 				default:
 					this.states[data.streamID][data.action] = data.value
 					break
@@ -267,11 +285,12 @@ class VDONinjaInstance extends InstanceBase {
 		}
 	}
 
-	sendRequest(action, target, value) {
+	sendRequest(action, target, value, local) {
 		let object = {
-			action: action ? action : 'null',
-			target: target ? target : 'null',
-			value: value ? value : 'null',
+			action: action ?? 'null',
+			target: target ?? 'null',
+			value: value ?? 'null',
+			local: local ?? false,
 		}
 		this.ws.send(JSON.stringify(object))
 	}

package.json

@@ -1,22 +1,22 @@
 {
 	"name": "vdo-ninja",
-	"version": "2.2.0",
+	"version": "2.2.1",
 	"main": "index.js",
 	"type": "module",
 	"scripts": {
 		"format": "prettier -w ."
 	},
 	"license": "MIT",
 	"dependencies": {
-		"@companion-module/base": "~1.6.0",
-		"ws": "^8.15.1"
+		"@companion-module/base": "~1.7.0",
+		"ws": "^8.16.0"
 	},
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/bitfocus/companion-module-vdo-ninja.git"
 	},
 	"devDependencies": {
-		"@companion-module/tools": "^1.4.1"
+		"@companion-module/tools": "^1.5.0"
 	},
 	"prettier": "@companion-module/tools/.prettierrc.json"
 }

presets.js

@@ -12,7 +12,7 @@ export function getPresets() {
 	for (let s in this.states) {
 		let stream = this.states[s]
 
-		if (stream.position) {
+		if (stream.position && !stream.director) {
 			presets[`guest_${stream.position}_mic`] = {
 				type: 'button',
 				category: 'Guest Actions',

variables.js

@@ -37,8 +37,8 @@ export function updateVariables() {
 				})
 			} else if (data.position) {
 				this.setVariableValues({
-					[`guest_${data.position}_mic`]: data.muted || data.others['mute-guest'] == 1 ? 'Muted' : 'Unmuted',
-					[`guest_${data.position}_camera`]: data.videoMuted || data.others['hide-guest'] == 1 ? 'Muted' : 'Unmuted',
+					[`guest_${data.position}_mic`]: data.muted || data.others?.['mute-guest'] == 1 ? 'Muted' : 'Unmuted',
+					[`guest_${data.position}_camera`]: data.videoMuted || data.others?.['hide-guest'] == 1 ? 'Muted' : 'Unmuted',
 					[`guest_${data.position}_label`]: label,
 				})
 			} else {