Merge pull request #249 from GuerrillaCoder/release-v3

Adds support for SpeechStarted

Deepgram/Clients/LiveTranscriptionClient.cs

@@ -11,6 +11,7 @@
 using Deepgram.Utilities;
 using Microsoft.Extensions.Logging;
 using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
 
 namespace Deepgram.Clients
 {
@@ -55,6 +56,11 @@ public LiveTranscriptionClient(Credentials credentials)
         /// </summary>
         public event EventHandler<TranscriptReceivedEventArgs> TranscriptReceived;
 
+        /// <summary>
+        /// Fires if vad_events enabled and speech start is detected
+        /// </summary>
+        public event EventHandler<SpeechStartedEventArgs> SpeechStarted;
+
         /// <summary>
         /// Retrieves the connection state of the WebSocket
         /// </summary>
@@ -264,12 +270,32 @@ private async Task Receive()
                         if (result.MessageType == WebSocketMessageType.Text)
                         {
                             var text = Encoding.UTF8.GetString(ms.ToArray());
+
                             if (text != null)
                             {
-                                var transcript = JsonConvert.DeserializeObject<LiveTranscriptionResult>(text);
-                                if (transcript != null)
+                                //get value of type property
+                                JObject jsonObject = JObject.Parse(text);
+                                string typeValue = jsonObject["type"]?.ToString();
+
+                                switch (typeValue)
                                 {
-                                    TranscriptReceived?.Invoke(null, new TranscriptReceivedEventArgs(transcript));
+                                    case "Results":
+                                        var transcript = JsonConvert.DeserializeObject<LiveTranscriptionResult>(text);
+                                        if (transcript != null)
+                                        {
+                                            TranscriptReceived?.Invoke(null, new TranscriptReceivedEventArgs(transcript));
+                                        }
+                                        break;
+                                    case "SpeechStarted":
+                                        var started = JsonConvert.DeserializeObject<LiveTranscriptionSpeechStarted>(text);
+                                        if (started != null)
+                                        {
+                                            SpeechStarted?.Invoke(null, new SpeechStartedEventArgs(started));
+                                        }
+                                        break;
+                                    default:
+                                        // add more...
+                                        break;
                                 }
                             }
                         }

Deepgram/Interfaces/ILiveTranscriptionClient.cs

@@ -27,6 +27,11 @@ public interface ILiveTranscriptionClient : IDisposable
         /// Fires when a transcript is received from the Deepgram API
         /// </summary>
         event EventHandler<TranscriptReceivedEventArgs> TranscriptReceived;
+
+        /// <summary>
+        /// Fires if vad_events set to true and speech detected
+        /// </summary>
+        event EventHandler<SpeechStartedEventArgs> SpeechStarted;
 
         /// <summary>
         /// Retrieves the connection state of the WebSocket

Deepgram/Models/LiveTranscriptionOptions.cs

@@ -247,5 +247,8 @@ public class LiveTranscriptionOptions
         /// </summary>
         [JsonProperty("tag")]
         public string[] Tag { get; set; }
+
+        [JsonProperty("vad_events")]
+        public bool VadEvents { get; set; }
     }
 }

Deepgram/Models/LiveTranscriptionResult.cs

@@ -50,5 +50,8 @@ public class LiveTranscriptionResult
         /// </summary>
         [JsonProperty("tags")]
         public string[] Tags { get; set; }
+
+        [JsonProperty("type")]
+        public string Type { get; set; }
     }
 }

Deepgram/Models/LiveTranscriptionSpeechStarted.cs

@@ -0,0 +1,26 @@
+using Newtonsoft.Json;
+using System;
+
+namespace Deepgram.Models
+{
+    public class LiveTranscriptionSpeechStarted
+    {
+        /// <summary>
+        /// Timestamp since start of first recognition that speech started.
+        /// </summary>
+        [JsonProperty("timestamp")]
+        public decimal Timestamp { get; set; }
+
+        /// <summary>
+        /// The channel field is interpreted as [A,B], where A is the channel index, and B is the total number of channels. The above example is channel 0 of single-channel audio.
+        /// </summary>
+        [JsonProperty("channel")]
+        public int[] Channel { get; set; }
+
+        /// <summary>
+        /// The type field is always SpeechStarted for this event
+        /// </summary>
+        [JsonProperty("type")]
+        public string Type { get; set; }
+    }
+}

Deepgram/Models/SpeechStartedEventArgs.cs

@@ -0,0 +1,18 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace Deepgram.Models
+{
+    public class SpeechStartedEventArgs : EventArgs
+    {
+        public SpeechStartedEventArgs(LiveTranscriptionSpeechStarted speechStarted)
+        {
+            SpeechStarted = speechStarted;
+        }
+
+        public LiveTranscriptionSpeechStarted SpeechStarted { get; set; }
+    }
+}