Merge pull request #58 from nullinside-development-group/chore/rework

chore: code clean up

Author: ProgrammingByPermutation

src/TwitchStreamingTools/ViewModels/Pages/ChatViewModel.cs

@@ -2,7 +2,6 @@
 using System.Collections.ObjectModel;
 using System.Linq;
 using System.Reactive;
-using System.Speech.Synthesis;
 using System.Threading.Tasks;
 
 using Nullinside.Api.Common.Twitch;
@@ -131,14 +130,16 @@ private void OnAddChatCommand() {
       return;
     }
 
+    // Add it to the list.
     _selectedTwitchChatNames.Add(username);
 
     // Add the callback, we don't need to wait for it to return it can run in the background.
     _ = _twitchClient.AddMessageCallback(username, OnChatMessage);
 
-
-    using var speech = new SpeechSynthesizer();
+    // Clear out the textbox so the user knows we took their input
     TwitchChatName = null;
+
+    // Update and write the configuration
     _configuration.TwitchChats = (
       from user in _selectedTwitchChatNames
       select new TwitchChatConfiguration {
@@ -148,13 +149,22 @@ from user in _selectedTwitchChatNames
         TtsVoice = Configuration.GetDefaultTtsVoice(),
         TtsVolume = 100
       }).ToList();
+
     _configuration.WriteConfiguration();
   }
 
+  /// <summary>
+  ///   Handles removing a chat we were monitoring.
+  /// </summary>
+  /// <param name="channel">The chat to remove.</param>
   private void OnRemoveChatCommand(string channel) {
+    // Remove it from the list
     _selectedTwitchChatNames.Remove(channel);
+
+    // Remove the callback
     _twitchClient.RemoveMessageCallback(channel, OnChatMessage);
-    using var speech = new SpeechSynthesizer();
+
+    // Update and write the configuration
     _configuration.TwitchChats = (
       from user in _selectedTwitchChatNames
       select new TwitchChatConfiguration {
@@ -168,6 +178,10 @@ from user in _selectedTwitchChatNames
     _configuration.WriteConfiguration();
   }
 
+  /// <summary>
+  ///   Handles a new chat message being received from <see cref="_twitchClient" />.
+  /// </summary>
+  /// <param name="msg">The message received.</param>
   private void OnChatMessage(OnMessageReceivedArgs msg) {
     if (_selectedTwitchChatNames.Count > 1) {
       TwitchChat = (TwitchChat + $"\n({msg.ChatMessage.Channel}) {msg.ChatMessage.Username}: {msg.ChatMessage.Message}").Trim();

src/TwitchStreamingTools/ViewModels/Pages/SettingsViewModel.cs

@@ -19,9 +19,24 @@ public class SettingsViewModel : PageViewModelBase {
   /// </summary>
   private readonly IConfiguration _configuration;
 
+  /// <summary>
+  ///   The list of possible output devices that exist on the machine.
+  /// </summary>
   private ObservableCollection<string> _outputDevices;
+
+  /// <summary>
+  ///   The selected output device to send TTS to.
+  /// </summary>
   private string? _selectedOutputDevice;
+
+  /// <summary>
+  ///   The TTS voice selected to send TTS to.
+  /// </summary>
   private string? _selectedTtsVoice;
+
+  /// <summary>
+  ///   The list of installed TTS voices on the machine.
+  /// </summary>
   private ObservableCollection<string> _ttsVoices;
 
   /// <summary>
@@ -35,6 +50,9 @@ public class SettingsViewModel : PageViewModelBase {
   /// </summary>
   public SettingsViewModel(IConfiguration configuration) {
     _configuration = configuration;
+
+    // Get the list of output devices and set the default to either what we have in the configuration or the system 
+    // default whichever is more appropriate.
     var outputDevices = new List<string>();
     for (int i = 0; i < NAudioUtilities.GetTotalOutputDevices(); i++) {
       outputDevices.Add(NAudioUtilities.GetOutputDevice(i).ProductName);
@@ -43,9 +61,15 @@ public SettingsViewModel(IConfiguration configuration) {
     _outputDevices = new ObservableCollection<string>(outputDevices);
     _selectedOutputDevice = Configuration.GetDefaultAudioDevice();
 
+    // Get the list of TTS voices and set the default to either what we have in the configuration or the system 
+    // default whichever is more appropriate.
     using var speech = new SpeechSynthesizer();
     _ttsVoices = new ObservableCollection<string>(speech.GetInstalledVoices().Select(v => v.VoiceInfo.Name));
     _selectedTtsVoice = Configuration.GetDefaultTtsVoice();
+
+    // Get the volume and set the default to either what we have in the configuration or to half-volume. Why half-volume?
+    // No one knows. I just figured I'd at least try not to blow anyone's eardrums out. I'm sure this decision will haunt
+    // me one day.
     _ttsVolume = Configuration.GetDefaultTtsVolume() ?? 50u;
   }