FIX - PTZMoveStop bug (#276)

* v3.6.2 PTZMoveStop fix

README.md

@@ -34,6 +34,9 @@ This module now supports Companions HTTP API, providing endpoints that can be us
 
 
 # Recent Patches
+**V3.6.2**
+- Fixed a bug with PTZ Stop action
+
 **V3.6.1**
 - Fixed a bug with Start Streaming and Stop Streaming actions not targeting specific vMix streams
 

docs/PATCH_NOTES.md

@@ -1,5 +1,8 @@
 # Patch Notes
 
+**V3.6.2**
+- Fixed a bug with PTZ Stop action
+
 **V3.6.1**
 - Fixed a bug with Start Streaming and Stop Streaming actions not targeting specific vMix streams
 

src/actions.ts

@@ -1212,7 +1212,7 @@ interface PTZMoveCallback {
     input: string
     functionID:
       | 'PTZHome'
-      | 'PTZStop'
+      | 'PTZMoveStop'
       | 'PTZMoveUp'
       | 'PTZMoveUpLeft'
       | 'PTZMoveUpRight'
@@ -4599,7 +4599,7 @@ export function getActions(instance: VMixInstance): VMixActions {
           default: 'PTZHome',
           choices: [
             { id: 'PTZHome', label: 'Home' },
-            { id: 'PTZStop', label: 'Stop' },
+            { id: 'PTZMoveStop', label: 'Stop' },
             { id: 'PTZMoveUp', label: 'Up' },
             { id: 'PTZMoveUpLeft', label: 'Up Left' },
             { id: 'PTZMoveUpRight', label: 'Up RIght' },
@@ -4627,7 +4627,7 @@ export function getActions(instance: VMixInstance): VMixActions {
           isVisible: (options) => {
             return (
               options.functionID !== 'PTZHome' &&
-              options.functionID !== 'PTZStop' &&
+              options.functionID !== 'PTZMoveStop' &&
               options.functionID !== 'PTZMoveToVirtualInputPosition'
             )
           },

src/upgrade.ts

@@ -603,6 +603,25 @@ const upgradeV3_6_0: CompanionStaticUpgradeScript<Config> = (_context, props): C
   return changes
 }
 
+const upgradeV3_6_2: CompanionStaticUpgradeScript<Config> = (_context, props): CompanionStaticUpgradeResult<Config> => {
+  let actions: any = props.actions
+
+  const changes: CompanionStaticUpgradeResult<Config> = {
+    updatedConfig: null,
+    updatedActions: [],
+    updatedFeedbacks: []
+  }
+
+  actions.forEach((action: any) => {
+    if (action.actionId === 'ptzMove' && action.options.functionID === 'PTZStop') {
+      action.options.functionID = 'PTZMoveStop'
+      changes.updatedActions.push(action)
+    }
+  })
+
+  return changes
+}
+
 export const getUpgrades = (): CompanionStaticUpgradeScript<Config>[] => {
-  return [upgradeV1_2_0, upgradeV2_0_0, upgradeV2_0_6, upgradeV3_5_0, adjustmentFix, upgradeV3_6_0]
+  return [upgradeV1_2_0, upgradeV2_0_0, upgradeV2_0_6, upgradeV3_5_0, adjustmentFix, upgradeV3_6_0, upgradeV3_6_2]
 }