Live Streaming Audio Transcription

The .NET SDK implements a LiveClient at the root of the Deepgram namespace. This encapsulates a websocket connection to the Deepgram API and returns a class that emits events received from the Deepgram API for consumption by your application.

Installing the SDK

1
# Install the Deepgram .NET SDK
2
# https://github.com/deepgram/deepgram-dotnet-sdk
3
4
dotnet add package Deepgram
5
6
# Optionally, install the Deepgram Microphone package
7
dotnet add package Deepgram.Microphone

Initiating a Connection

The Connect() method initiates a connection with the Deepgram API via websocket. You may pass in options for the transcription as well.

1
// Set "DEEPGRAM_API_KEY" environment variable to your Deepgram API Key
2
var liveClient = ClientFactory.CreateListenWebSocketClient();
3
4
// Start the connection
5
var liveSchema = new LiveSchema()
6
{
7
  Model = "nova-3",
8
};
9
await liveClient.Connect(liveSchema);

Events

The following events are fired by the LiveTranscriptionClient:

OpenResponse Event

Subscribe to the OpenResponse event by calling the Subscribe() function.

1
liveClient.Subscribe(new EventHandler<OpenResponse>((sender, e) =>
2
{
3
	Console.WriteLine($"\n\n----> OpenResponse received");
4
}));

ResultResponse Event

Subscribe to the ResultResponse event by calling the Subscribe() function.

1
liveClient.Subscribe(new EventHandler<ResultResponse>((sender, e) =>
2
{
3
	Console.WriteLine($"----> Speaker: {e.Channel.Alternatives[0].Transcript}");
4
}));

MetadataResponse Event

Subscribe to the MetadataResponse event by calling the Subscribe() function.

1
liveClient.Subscribe(new EventHandler<MetadataResponse>((sender, e) =>
2
{
3
	Console.WriteLine($"----> MetadataResponse received");
4
}));

SpeechStartedResponse Event

Subscribe to the SpeechStartedResponse event by calling the Subscribe() function.

1
liveClient.Subscribe(new EventHandler<SpeechStartedResponse>((sender, e) =>
2
{
3
	Console.WriteLine($"----> SpeechStartedResponse received");
4
}));

UtteranceEndResponse Event

Subscribe to the UtteranceEndResponse event by calling the Subscribe() function.

1
liveClient.Subscribe(new EventHandler<UtteranceEndResponse>((sender, e) =>
2
{
3
	Console.WriteLine($"----> UtteranceEndResponse received");
4
}));

CloseResponse Event

Subscribe to the CloseResponse event by calling the Subscribe() function.

1
liveClient.Subscribe(new EventHandler<CloseResponse>((sender, e) =>
2
{
3
	Console.WriteLine($"----> CloseResponse received");
4
}));

ErrorResponse Event

Subscribe to the ErrorResponse event by calling the Subscribe() function.

1
liveClient.Subscribe(new EventHandler<ErrorResponse>((sender, e) =>
2
{
3
	Console.WriteLine($"----> ErrorResponse received");
4
}));

UnhandledResponse Event

Subscribe to the UnhandledResponse event by calling the Subscribe() function.

1
liveClient.Subscribe(new EventHandler<UnhandledResponse>((sender, e) =>
2
{
3
	Console.WriteLine($"----> UnhandledResponse received");
4
}));

Functions

These functions provide capabilities that make up the LiveClient API.

Sending Data

The Send method sends raw audio data to the Deepgram API.

1
liveClient.Send(AUDIO_STREAM_DATA);

Get Websocket State

The State method returns the ready state of the websocket connection to Deepgram.

1
var websocketState = liveClient.State();

Stop Transcribing

The Stop method sends a signal to the Deepgram API that you have finished streaming audio, and it should conclude its transcription efforts. Upon sending the final transcript back, it will close the websocket connection.

1
await liveClient.Stop()