Merge pull request #436 from neilenns/issue435

Add a push to mute setting to the volume action

Author: neilenns

com.neil-enns.trackaudio.sdPlugin/pi/stationVolume.html

@@ -44,5 +44,21 @@
         accept="image/png, image/jpeg, image/svg+xml"
       ></sdpi-file>
     </sdpi-item>
+
+    <sdpi-item>
+      <details class="sdpi-item-value">
+        <summary>Advanced options</summary>
+        <sdpi-checkbox
+          setting="pushToMute"
+          label="Push to toggle mute"
+          default="true"
+        ></sdpi-checkbox>
+        <sdpi-checkbox
+          setting="tapToMute"
+          label="Tap to toggle mute"
+          default="true"
+        ></sdpi-checkbox>
+      </details>
+    </sdpi-item>
   </body>
 </html>

src/actions/stationVolume.ts

@@ -68,7 +68,7 @@ export class StationVolume extends SingletonAction<StationVolumeSettings> {
       return;
     }
 
-    handleStationVolumeDialPress(ev.action);
+    handleStationVolumeDialPress(ev.action, "press");
   }
 
   override onTouchTap(
@@ -80,7 +80,7 @@ export class StationVolume extends SingletonAction<StationVolumeSettings> {
       return;
     }
 
-    handleStationVolumeDialPress(ev.action);
+    handleStationVolumeDialPress(ev.action, "tap");
   }
 
   override onWillDisappear(
@@ -96,5 +96,7 @@ export interface StationVolumeSettings {
   changeAmount?: number;
   mutedImagePath?: string;
   notMutedImagePath?: string;
+  pushToMute?: boolean;
+  tapToMute?: boolean;
   [key: string]: JsonValue;
 }

src/controllers/stationVolume.ts

@@ -145,6 +145,22 @@ export class StationVolumeController extends BaseController {
     this.refreshDisplay();
   }
 
+  /**
+   * Gets the pushToMute setting.
+   * @returns {boolean} True if push to mute is enabled. Defaults to true.
+   */
+  get pushToMute(): boolean {
+    return this._settings?.pushToMute ?? true;
+  }
+
+  /**
+   * Gets the tapToMute setting.
+   * @returns {boolean} True if tap to mute is enabled. Defaults to true.
+   */
+  get tapToMute(): boolean {
+    return this._settings?.tapToMute ?? true;
+  }
+
   /**
    * Gets the settings.
    * @returns {StationVolumeSettings} The settings.

src/events/streamDeck/stationVolume/stationVolumeDialPress.ts

@@ -1,12 +1,18 @@
 import { DialAction } from "@elgato/streamdeck";
 import actionManager from "@managers/action";
 import trackAudioManager from "@managers/trackAudio";
+import mainLogger from "@utils/logger";
+
+const logger = mainLogger.child({ service: "stationVolume" });
 
 /**
  * Toggles the mute setting on the station.
  * @param action The action that triggered the press
  */
-export const handleStationVolumeDialPress = (action: DialAction) => {
+export const handleStationVolumeDialPress = (
+  action: DialAction,
+  trigger: "press" | "tap"
+) => {
   const savedAction = actionManager
     .getStationVolumeControllers()
     .find((entry) => entry.action.id === action.id);
@@ -15,6 +21,24 @@ export const handleStationVolumeDialPress = (action: DialAction) => {
     return;
   }
 
+  if (!savedAction.pushToMute && trigger === "press") {
+    logger.info(
+      `Station volume action ${
+        savedAction.callsign ?? "undefined"
+      } does not have push to mute enabled.`
+    );
+    return;
+  }
+
+  if (!savedAction.tapToMute && trigger === "tap") {
+    logger.info(
+      `Station volume action ${
+        savedAction.callsign ?? "undefined"
+      } does not have tap to mute enabled.`
+    );
+    return;
+  }
+
   trackAudioManager.sendMessage({
     type: "kSetStationState",
     value: {

src/events/vatsim/vatsimDataReceived.ts

@@ -14,7 +14,7 @@ export const handleVatsimDataReceived = (data: VatsimData) => {
     }
 
     // Look for the callsign in the returned ATIS info. If it's found set the letter.
-    // If not set the isUnavialable flag to show the error to the user.
+    // If not set the isUnavailable flag to show the error to the user.
     if (action.callsign in atisInfo) {
       action.isUnavailable = false;
       action.letter = atisInfo[action.callsign].atis_code;