[Keystrokes] Adding the ability to specify more bot commands

Author: ProgrammingByPermutation

streaming-tools/streaming-tools/Assets/add.png

@@ -26,7 +26,7 @@ public class Configuration : INotifyPropertyChanged {
         /// <summary>
         ///     The command to execute on keystroke.
         /// </summary>
-        private KeystokeCommand? keystokeCommand;
+        private ObservableCollection<KeystokeCommand>? keystrokeCommand;
 
         /// <summary>
         ///     The monitor selected in the layout view.
@@ -80,10 +80,10 @@ public static Configuration Instance {
         /// <summary>
         ///     Gets or sets the command to execute on keystroke.
         /// </summary>
-        public KeystokeCommand? KeystokeCommand {
-            get => this.keystokeCommand;
+        public ObservableCollection<KeystokeCommand>? KeystrokeCommand {
+            get => this.keystrokeCommand;
             set {
-                this.keystokeCommand = value;
+                this.keystrokeCommand = value;
                 this.OnPropertyChanged();
             }
         }
@@ -191,8 +191,8 @@ public static Configuration ReadConfiguration() {
                 config.TtsPhoneticUsernames = new ObservableCollection<KeyValuePair<string, string>>();
             }
 
-            if (null == config.KeystokeCommand) {
-                config.KeystokeCommand = new KeystokeCommand();
+            if (null == config.KeystrokeCommand) {
+                config.KeystrokeCommand = new ObservableCollection<KeystokeCommand>();
             }
 
             if (null == config.ChannelPointSoundRedemptions) {
@@ -345,6 +345,26 @@ public class KeystokeCommand {
         ///     Gets or sets the twitch chat to type in.
         /// </summary>
         public string? TwitchChat { get; set; }
+        
+        /// <summary>
+        ///     Gets or sets a value indicating whether this is a keystroke to skip all current messages.
+        /// </summary>
+        public bool ClearMessageQueue { get; set; }
+        
+        /// <summary>
+        ///     Gets or sets a value indicating whether the user that typed the current message should be timed out.
+        /// </summary>
+        public bool TimeoutUserCurrentMessage { get; set; }
+        
+        /// <summary>
+        ///     Gets or sets a value indicating whether the user that typed the current message should be banned.
+        /// </summary>
+        public bool BanUserCurrentMessage { get; set; }
+        
+        /// <summary>
+        ///     Gets or sets a value indicating whether this is a keystroke to send a message in chat.
+        /// </summary>
+        public bool SendChatMessage { get; set; }
     }
 
     /// <summary>

streaming-tools/streaming-tools/Assets/delete.png

@@ -17,7 +17,7 @@ public class TwitchChatTts : IDisposable {
         /// <summary>
         ///     The configuration for the twitch chat.
         /// </summary>
-        private readonly TwitchChatConfiguration? chatConfig;
+        public TwitchChatConfiguration? ChatConfig { get; }
 
         /// <summary>
         ///     The collection of sounds to play.
@@ -59,6 +59,8 @@ public class TwitchChatTts : IDisposable {
         /// </summary>
         private ManualResetEvent? ttsSoundOutputSignal;
 
+        private int messageToSkip;
+
         /// <summary>
         ///     Initializes a new instance of the <see cref="TwitchChatTts" /> class.
         /// </summary>
@@ -69,8 +71,7 @@ public TwitchChatTts(TwitchChatConfiguration? config) {
             this.soundThread.Name = "TwitchChatTts Thread";
             this.soundThread.IsBackground = true;
             this.soundThread.Start();
-            this.chatConfig = config;
-            GlobalKeyboardListener.Instance.Callback += this.KeyboardPressCallback;
+            this.ChatConfig = config;
         }
 
         /// <summary>
@@ -92,21 +93,23 @@ public void Dispose() {
                 this.ttsSoundOutput = null;
             }
 
-            if (null == this.chatConfig) {
+            if (null == this.ChatConfig) {
                 return;
             }
 
-            var user = Configuration.Instance.GetTwitchAccount(this.chatConfig.AccountUsername);
+            var user = Configuration.Instance.GetTwitchAccount(this.ChatConfig.AccountUsername);
             if (null == user) {
                 return;
             }
 
             var twitchManager = TwitchChatManager.Instance;
-            twitchManager.RemoveTwitchChannel(user, this.chatConfig.TwitchChannel, this.Client_OnMessageReceived);
+            twitchManager.RemoveTwitchChannel(user, this.ChatConfig.TwitchChannel, this.Client_OnMessageReceived);
             if (this.soundThread.Join(5000)) {
                 this.soundThread.Interrupt();
             }
         }
+        
+        public string? CurrentUsername { get; set; }
 
         /// <summary>
         ///     The main thread used to play sound asynchronously.
@@ -119,8 +122,14 @@ private void PlaySoundsThread() {
                             return;
                         }
 
+                        if (messageToSkip > 0) {
+                            --messageToSkip;
+                            Console.WriteLine($"Skipping: {e.ChatMessage.Username} says {e.ChatMessage.Message}");
+                            continue;
+                        }
+
                         Console.WriteLine($"Running: {e.ChatMessage.Username} says {e.ChatMessage.Message}");
-                        if (null == this.chatConfig) {
+                        if (null == this.ChatConfig) {
                             continue;
                         }
 
@@ -154,8 +163,8 @@ private void PlaySoundsThread() {
                         using (var stream = new MemoryStream()) {
                             // Setup the microsoft TTS object according to the settings.
                             synth.SetOutputToWaveStream(stream);
-                            synth.SelectVoice(this.chatConfig.TtsVoice);
-                            synth.Volume = (int)this.chatConfig.TtsVolume;
+                            synth.SelectVoice(this.ChatConfig.TtsVoice);
+                            synth.Volume = (int)this.ChatConfig.TtsVolume;
                             synth.Speak(chatMessage);
 
                             // Now that we filled the stream, seek to the beginning so we can play it.
@@ -173,8 +182,8 @@ private void PlaySoundsThread() {
                                     this.ttsSoundOutput = new WaveOutEvent();
                                     this.ttsSoundOutputSignal = new ManualResetEvent(false);
 
-                                    this.ttsSoundOutput.DeviceNumber = NAudioUtilities.GetOutputDeviceIndex(this.chatConfig.OutputDevice);
-                                    this.ttsSoundOutput.Volume = this.chatConfig.TtsVolume / 100.0f;
+                                    this.ttsSoundOutput.DeviceNumber = NAudioUtilities.GetOutputDeviceIndex(this.ChatConfig.OutputDevice);
+                                    this.ttsSoundOutput.Volume = this.ChatConfig.TtsVolume / 100.0f;
 
                                     this.ttsSoundOutput.Init(reader);
 
@@ -191,8 +200,10 @@ private void PlaySoundsThread() {
                                 }
 
                                 // Wait for the play to finish, we will get signaled.
+                                CurrentUsername = e.ChatMessage.Username;
                                 var signal = this.ttsSoundOutputSignal;
                                 signal?.WaitOne();
+                                CurrentUsername = null;
                             } finally {
                                 // Finally dispose of everything safely in the lock.
                                 lock (this.ttsSoundOutputLock)
@@ -215,18 +226,18 @@ private void PlaySoundsThread() {
         ///     Connects to the chat to listen for messages to read in text to speech.
         /// </summary>
         public void Connect() {
-            if (null == this.chatConfig) {
+            if (null == this.ChatConfig) {
                 return;
             }
 
             var config = Configuration.Instance;
-            var user = config.GetTwitchAccount(this.chatConfig.AccountUsername);
+            var user = config.GetTwitchAccount(this.ChatConfig.AccountUsername);
             if (null == user) {
                 return;
             }
 
             var twitchManager = TwitchChatManager.Instance;
-            twitchManager.AddTwitchChannel(user, this.chatConfig.TwitchChannel, this.Client_OnMessageReceived);
+            twitchManager.AddTwitchChannel(user, this.ChatConfig.TwitchChannel, this.Client_OnMessageReceived);
         }
 
         /// <summary>
@@ -261,18 +272,13 @@ private void Client_OnMessageReceived(TwitchClient twitchClient, OnMessageReceiv
             }
         }
 
-        /// <summary>
-        ///     Handles key press anywhere in the OS.
-        /// </summary>
-        /// <param name="keyboard">The key that was pressed in string format.</param>
-        /// <remarks>
-        ///     See:
-        ///     <see href="https://docs.microsoft.com/en-us/windows/win32/inputdev/virtual-key-codes?redirectedfrom=MSDN" />
-        /// </remarks>
-        private void KeyboardPressCallback(string keyboard) {
-            if ("123".Equals(keyboard, StringComparison.InvariantCultureIgnoreCase)) {
-                this.ttsSoundOutput?.Stop();
-            }
+        public void SkipCurrentTts() {
+            this.ttsSoundOutput?.Stop();
+        }
+        
+        public void SkipAllTts() {
+            messageToSkip = this.soundsToPlay.Count;
+            this.ttsSoundOutput?.Stop();
         }
     }
 }

streaming-tools/streaming-tools/Assets/play.png

@@ -10,6 +10,7 @@
     using ReactiveUI;
     using Twitch;
     using TwitchLib.Api.Core.Enums;
+    using TwitchLib.Api.Helix.Models.ChannelPoints.CreateCustomReward;
     using TwitchLib.Api.Helix.Models.ChannelPoints.UpdateCustomRewardRedemptionStatus;
     using TwitchLib.PubSub.Events;
     using Utilities;
@@ -111,7 +112,7 @@ public async void RefreshChannelPointRewards() {
                 var toAdd = actualRewardNames.Except(knownRewardNames);
                 var toDelete = knownRewardNames.Except(actualRewardNames);
 
-                // foreach (var reward in rewards.Data.Where(d => d.Title.StartsWith("Sound:"))) {
+                // foreach (var reward in rewards.Data.Where(d => d.Title.StartsWith("Sound: Jura"))) {
                 //     await api.Helix.ChannelPoints.CreateCustomRewards(user.Id, new CreateCustomRewardsRequest {
                 //         BackgroundColor = reward.BackgroundColor,
                 //         Cost = reward.Cost,
@@ -124,7 +125,7 @@ public async void RefreshChannelPointRewards() {
                 //         IsUserInputRequired = reward.IsUserInputRequired,
                 //         MaxPerStream = reward.MaxPerStreamSetting.MaxPerStream,
                 //         MaxPerUserPerStream = reward.MaxPerUserPerStreamSetting.MaxPerStream,
-                //         Title = "Sound: Scream",
+                //         Title = reward.Title,
                 //         Prompt = reward.Prompt
                 //     });
                 // }