Merge pull request #349 from dvonthenen/update-v2-interface

Convenience Changes, Removal of Plain `Send()` to Avoid Confusion

Deepgram/Abstractions/v2/AbstractWebSocketClient.cs

@@ -250,12 +250,6 @@ public virtual Task SendClose(bool nullByte = false, CancellationTokenSource? _c
         throw new DeepgramException("Unimplemented");
     }
 
-    /// <summary>
-    /// Sends a binary message over the WebSocket connection.
-    /// </summary>
-    /// <param name="data">The data to be sent over the WebSocket.</param>
-    public virtual void Send(byte[] data, int length = Constants.UseArrayLengthForSend) => SendBinary(data, length);
-
     /// <summary>
     /// This method sends a binary message over the WebSocket connection.
     /// </summary>

Deepgram/Clients/Interfaces/v2/IListenWebSocketClient.cs

@@ -12,9 +12,15 @@ namespace Deepgram.Clients.Interfaces.v2;
 public interface IListenWebSocketClient
 {
     #region Connect and Disconnect
+    /// <summary>
+    /// Connects to the Deepgram WebSocket API
+    /// </summary>
     public Task<bool> Connect(LiveSchema options, CancellationTokenSource? cancelToken = null, Dictionary<string, string>? addons = null,
         Dictionary<string, string>? headers = null);
 
+    /// <summary>
+    /// Disconnects from the Deepgram WebSocket API
+    /// </summary>
     public Task<bool> Stop(CancellationTokenSource? cancelToken = null, bool nullByte = false);
     #endregion
 

Deepgram/Clients/Interfaces/v2/ISpeakWebSocketClient.cs

@@ -12,9 +12,15 @@ namespace Deepgram.Clients.Interfaces.v2;
 public interface ISpeakWebSocketClient
 {
     #region Connect and Disconnect
+    /// <summary>
+    /// Connects to the Deepgram WebSocket API
+    /// </summary>
     public Task<bool> Connect(SpeakSchema options, CancellationTokenSource? cancelToken = null, Dictionary<string, string>? addons = null,
         Dictionary<string, string>? headers = null);
 
+    /// <summary>
+    /// Disconnects from the Deepgram WebSocket API
+    /// </summary>
     public Task<bool> Stop(CancellationTokenSource? cancelToken = null, bool nullByte = false);
     #endregion
 

Deepgram/Clients/Listen/v2/WebSocket/Client.cs

@@ -3,6 +3,7 @@
 // SPDX-License-Identifier: MIT
 
 using Deepgram.Abstractions.v2;
+using Abstract = Deepgram.Abstractions.v2;
 using Deepgram.Models.Authenticate.v1;
 using Deepgram.Models.Listen.v2.WebSocket;
 using Common = Deepgram.Models.Common.v2.WebSocket;
@@ -277,7 +278,8 @@ public async Task<bool> Subscribe(EventHandler<UnhandledResponse> eventHandler)
     public async Task SendKeepAlive()
     {
         Log.Debug("SendKeepAlive", "Sending KeepAlive Message Immediately...");
-        byte[] data = Encoding.ASCII.GetBytes("{\"type\": \"KeepAlive\"}");
+        ControlMessage message = new ControlMessage(Constants.KeepAlive);
+        byte[] data = Encoding.ASCII.GetBytes(message.ToString());
         await SendMessageImmediately(data);
     }
 
@@ -287,10 +289,17 @@ public async Task SendKeepAlive()
     public async Task SendFinalize()
     {
         Log.Debug("SendFinalize", "Sending Finalize Message Immediately...");
-        byte[] data = Encoding.ASCII.GetBytes("{\"type\": \"Finalize\"}");
+        ControlMessage message = new ControlMessage(Constants.Finalize);
+        byte[] data = Encoding.ASCII.GetBytes(message.ToString());
         await SendMessageImmediately(data);
     }
 
+    /// <summary>
+    /// Sends a binary message over the WebSocket connection.
+    /// </summary>
+    /// <param name="data">The data to be sent over the WebSocket.</param>
+    public void Send(byte[] data, int length = Abstract.Constants.UseArrayLengthForSend) => SendBinary(data, length);
+
     /// <summary>
     /// Sends a Close message to Deepgram
     /// </summary>
@@ -322,7 +331,8 @@ await _clientWebSocket.SendAsync(new ArraySegment<byte>(new byte[1] { 0 }), WebS
             return;
         }
 
-        byte[] data = Encoding.ASCII.GetBytes("{\"type\": \"CloseStream\"}");
+        ControlMessage message = new ControlMessage(Constants.CloseStream);
+        byte[] data = Encoding.ASCII.GetBytes(message.ToString());
         await SendMessageImmediately(data);
     }
     #endregion

Deepgram/Clients/Listen/v2/WebSocket/Constants.cs

@@ -11,5 +11,10 @@ public static class Constants
 {
     // Default flush period
     public const int DefaultFlushPeriodInMs = 500;
+
+    // user message types
+    public const string KeepAlive = "KeepAlive";
+    public const string Finalize = "Finalize";
+    public const string CloseStream = "CloseStream";
 }
 

Deepgram/Clients/Speak/v2/WebSocket/Client.cs

@@ -3,6 +3,7 @@
 // SPDX-License-Identifier: MIT
 
 using Deepgram.Abstractions.v2;
+using Abstract = Deepgram.Abstractions.v2;
 using Deepgram.Models.Authenticate.v1;
 using Deepgram.Models.Speak.v2.WebSocket;
 using Common = Deepgram.Models.Common.v2.WebSocket;
@@ -389,10 +390,7 @@ public override void SendMessage(byte[] data, int length = Constants.UseArrayLen
     /// We need to override the Send function to use the SendMessage function. This is different than STT
     /// because we only deal in text messages for TTS where STT is sending binary (or audio) messages.
     /// </summary>
-    public override void Send(byte[] data, int length = Constants.UseArrayLengthForSend)
-    {
-        SendMessage(data, length);
-    }
+    public void Send(byte[] data, int length = Abstract.Constants.UseArrayLengthForSend) => SendMessage(data, length);
     #endregion
 
     internal async Task ProcessAutoFlush()

Deepgram/Models/Listen/v2/WebSocket/ControlMessage.cs

@@ -0,0 +1,24 @@
+// Copyright 2024 Deepgram .NET SDK contributors. All Rights Reserved.
+// Use of this source code is governed by a MIT license that can be found in the LICENSE file.
+// SPDX-License-Identifier: MIT
+
+namespace Deepgram.Models.Listen.v2.WebSocket;
+
+public class ControlMessage(string text)
+{
+    /// <summary>
+    /// Gets or sets the type of control message.
+    /// </summary>
+    [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
+    [JsonPropertyName("type")]
+    public string? Type { get; set; } = text;
+
+    /// <summary>
+    /// Override ToString method to serialize the object
+    /// </summary>
+    public override string ToString()
+    {
+        return Regex.Unescape(JsonSerializer.Serialize(this, JsonSerializeOptions.DefaultOptions));
+    }
+}
+

Deepgram/Utilities/QueryParameterUtil.cs

@@ -46,7 +46,7 @@ public static string FormatURL<S>(string uriSegment, S? parameter, Dictionary<st
     /// <summary>
     /// Encodes the specified parameters into a URL
     /// </summary>
-    internal static string UrlEncode<T>(T parameters, IEnumerable<PropertyInfo>? propertyInfoList, Dictionary<string, string>? addons = null)
+    internal static string UrlEncode<T>(T? parameters, IEnumerable<PropertyInfo>? propertyInfoList, Dictionary<string, string>? addons = null)
     {
         var sb = new StringBuilder();
         if (propertyInfoList != null)