Merge pull request #255 from dvonthenen/refactor-live-client-part2

Refactor LiveClient

Deepgram/Abstractions/AbstractRestClient.cs

@@ -3,7 +3,6 @@
 // SPDX-License-Identifier: MIT
 
 using Deepgram.Encapsulations;
-using Deepgram.Models.Analyze.v1;
 using Deepgram.Models.Authenticate.v1;
 
 namespace Deepgram.Abstractions;

Deepgram/Models/Live/v1/NoopSchema.cs → Deepgram/Abstractions/NoopSchema.cs

@@ -2,7 +2,7 @@
 // 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.Live.v1;
+namespace Deepgram.Abstractions;
 
 public class NoopSchema
 {

Deepgram/Clients/Live/v1/Constants.cs

@@ -0,0 +1,15 @@
+// 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.Clients.Live.v1;
+
+/// <summary> 
+/// Headers of interest in the return values from the Deepgram Speak API.
+/// </summary> 
+public static class Constants
+{
+    // WS buffer size
+    public const int BufferSize = 1024 * 16;
+}
+

Deepgram/Clients/Live/v1/ResponseEventArgs.cs → Deepgram/Clients/Live/v1/ResponseEvent.cs

@@ -2,12 +2,10 @@
 // Use of this source code is governed by a MIT license that can be found in the LICENSE file.
 // SPDX-License-Identifier: MIT
 
-using Deepgram.Models.Live.v1;
-
 namespace Deepgram.Clients.Live.v1;
 
-public class ResponseEventArgs(EventResponse response) : EventArgs
+public class ResponseEvent<T>(T? response) : EventArgs
 {
-    public EventResponse Response { get; set; } = response;
+    public T? Response { get; set; } = response;
 }
 

Deepgram/Models/Live/v1/CloseResponse.cs

@@ -0,0 +1,15 @@
+// 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.Live.v1;
+
+public record CloseResponse
+{
+    /// <summary>
+    /// TODO
+    /// </summary>
+    [JsonPropertyName("type")]
+    [JsonConverter(typeof(JsonStringEnumConverter))]
+    public LiveType? Type { get; set; } = LiveType.Close;
+}

Deepgram/Models/Live/v1/ErrorResponse.cs

@@ -0,0 +1,33 @@
+// 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.Live.v1;
+
+public record ErrorResponse
+{
+    /// <summary>
+    /// Error Description
+    /// </summary>
+    [JsonPropertyName("description")]
+    public string? Description { get; set; } = "";
+
+    /// <summary>
+    /// Error Message
+    /// </summary>
+    [JsonPropertyName("message")]
+    public string? Message { get; set; } = "";
+
+    /// <summary>
+    /// Error Variant
+    /// </summary>
+    [JsonPropertyName("variant")]
+    public string? Variant { get; set; } = "";
+
+    /// <summary>
+    /// TODO
+    /// </summary>
+    [JsonPropertyName("type")]
+    [JsonConverter(typeof(JsonStringEnumConverter))]
+    public LiveType? Type { get; set; } = LiveType.Error;
+}

Deepgram/Models/Live/v1/LiveType.cs

@@ -6,8 +6,12 @@ namespace Deepgram.Models.Live.v1;
 
 public enum LiveType
 {
+    Open,
     Metadata,
     Results,
     UtteranceEnd,
     SpeechStarted,
+    Close,
+    Unhandled,
+    Error,
 }

Deepgram/Models/Live/v1/OpenResponse.cs

@@ -0,0 +1,15 @@
+// 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.Live.v1;
+
+public record OpenResponse
+{
+    /// <summary>
+    /// TODO
+    /// </summary>
+    [JsonPropertyName("type")]
+    [JsonConverter(typeof(JsonStringEnumConverter))]
+    public LiveType? Type { get; set; } = LiveType.Open;
+}

Deepgram/Models/Live/v1/TranscriptionResponse.cs → Deepgram/Models/Live/v1/ResultResponse.cs

@@ -3,7 +3,7 @@
 // SPDX-License-Identifier: MIT
 
 namespace Deepgram.Models.Live.v1;
-public record TranscriptionResponse
+public record ResultResponse
 {
     /// <summary>
     /// TODO

Deepgram/Models/Live/v1/UnhandledResponse.cs

@@ -0,0 +1,21 @@
+// 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.Live.v1;
+
+public record UnhandledResponse 
+{
+    /// <summary>
+    /// Raw JSON
+    /// </summary>
+    [JsonPropertyName("raw")]
+    public string? Raw { get; set; } = "";
+
+    /// <summary>
+    /// TODO
+    /// </summary>
+    [JsonPropertyName("type")]
+    [JsonConverter(typeof(JsonStringEnumConverter))]
+    public LiveType? Type { get; set; } = LiveType.Unhandled;
+}

examples/streaming/file/Program.cs

@@ -17,36 +17,47 @@ static async Task Main(string[] args)
             var liveClient = new LiveClient();
 
             // Subscribe to the EventResponseReceived event
-            liveClient.EventResponseReceived += (sender, e) =>
+            liveClient._resultsReceived += (sender, e) =>
             {
-                if (e.Response.Transcription != null)
+                if (e.Channel.Alternatives[0].Transcript == "")
                 {
-                    if (e.Response.Transcription.Channel.Alternatives[0].Transcript == "")
-                    {
-                        Console.WriteLine("Empty transcription received.");
-                        return;
-                    }
-
-                    // Console.WriteLine("Transcription received: " + JsonSerializer.Serialize(e.Response.Transcription));
-                    Console.WriteLine($"Speaker: {e.Response.Transcription.Channel.Alternatives[0].Transcript}");
-                }
-                else if (e.Response.SpeechStarted != null)
-                {
-                    Console.WriteLine("SpeechStarted received: " + JsonSerializer.Serialize(e.Response.SpeechStarted));
-                }
-                else if (e.Response.UtteranceEnd != null)
-                {
-                    Console.WriteLine("UtteranceEnd received: " + JsonSerializer.Serialize(e.Response.UtteranceEnd));
-                }
-                else if (e.Response.MetaData != null)
-                {
-                    Console.WriteLine("Metadata received: " + JsonSerializer.Serialize(e.Response.MetaData));
-                }
-                else if (e.Response.Error != null)
-                {
-                    Console.WriteLine("Error: " + JsonSerializer.Serialize(e.Response.Error.Message));
+                    Console.WriteLine("Empty transcription received.");
+                    return;
                 }
+
+                // Console.WriteLine("Transcription received: " + JsonSerializer.Serialize(e.Response.Transcription));
+                Console.WriteLine($"Speaker: {e.Channel.Alternatives[0].Transcript}");
             };
+            //liveClient.EventResponseReceived += (sender, e) =>
+            //{
+            //    if (e.Response.Transcription != null)
+            //    {
+            //        if (e.Response.Transcription.Channel.Alternatives[0].Transcript == "")
+            //        {
+            //            Console.WriteLine("Empty transcription received.");
+            //            return;
+            //        }
+
+            //        // Console.WriteLine("Transcription received: " + JsonSerializer.Serialize(e.Response.Transcription));
+            //        Console.WriteLine($"Speaker: {e.Response.Transcription.Channel.Alternatives[0].Transcript}");
+            //    }
+            //    else if (e.Response.SpeechStarted != null)
+            //    {
+            //        Console.WriteLine("SpeechStarted received: " + JsonSerializer.Serialize(e.Response.SpeechStarted));
+            //    }
+            //    else if (e.Response.UtteranceEnd != null)
+            //    {
+            //        Console.WriteLine("UtteranceEnd received: " + JsonSerializer.Serialize(e.Response.UtteranceEnd));
+            //    }
+            //    else if (e.Response.MetaData != null)
+            //    {
+            //        Console.WriteLine("Metadata received: " + JsonSerializer.Serialize(e.Response.MetaData));
+            //    }
+            //    else if (e.Response.Error != null)
+            //    {
+            //        Console.WriteLine("Error: " + JsonSerializer.Serialize(e.Response.Error.Message));
+            //    }
+            //};
 
             // Start the connection
             var liveSchema = new LiveSchema()

examples/streaming/microphone/Program.cs

@@ -14,35 +14,16 @@ static async Task Main(string[] args)
             var liveClient = new LiveClient();
 
             // Subscribe to the EventResponseReceived event
-            liveClient.EventResponseReceived += (sender, e) =>
+            liveClient._resultsReceived += (sender, e) =>
             {
-                if (e.Response.Transcription != null)
+                if (e.Channel.Alternatives[0].Transcript == "")
                 {
-                    if (e.Response.Transcription.Channel.Alternatives[0].Transcript == "")
-                    {
-                        Console.WriteLine("Empty transcription received.");
-                        return;
-                    }
-
-                    // Console.WriteLine("Transcription received: " + JsonSerializer.Serialize(e.Response.Transcription));
-                    Console.WriteLine($"Speaker: {e.Response.Transcription.Channel.Alternatives[0].Transcript}");
-                }
-                else if (e.Response.SpeechStarted != null)
-                {
-                    Console.WriteLine("SpeechStarted received: " + JsonSerializer.Serialize(e.Response.SpeechStarted));
-                }
-                else if (e.Response.UtteranceEnd != null)
-                {
-                    Console.WriteLine("UtteranceEnd received: " + JsonSerializer.Serialize(e.Response.UtteranceEnd));
-                }
-                else if (e.Response.MetaData != null)
-                {
-                    Console.WriteLine("Metadata received: " + JsonSerializer.Serialize(e.Response.MetaData));
-                }
-                else if (e.Response.Error != null)
-                {
-                    Console.WriteLine("Error: " + JsonSerializer.Serialize(e.Response.Error.Message));
+                    Console.WriteLine("Empty transcription received.");
+                    return;
                 }
+
+                // Console.WriteLine("Transcription received: " + JsonSerializer.Serialize(e.Response.Transcription));
+                Console.WriteLine($"Speaker: {e.Channel.Alternatives[0].Transcript}");
             };
 
             // Start the connection
@@ -61,7 +42,9 @@ static async Task Main(string[] args)
             var microphone = new Microphone(liveClient.Send);
             microphone.Start();
 
-            Thread.Sleep(3600000);
+            // Wait for the user to press a key
+            Console.WriteLine("Press any key to stop the microphone streaming...");
+            Console.ReadKey();
 
             // Stop the connection
             await liveClient.Stop();