-
Notifications
You must be signed in to change notification settings - Fork 32
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
dvonthenen
committed
Sep 4, 2024
1 parent
da73e62
commit 8159fea
Showing
32 changed files
with
1,925 additions
and
38 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
149 changes: 149 additions & 0 deletions
149
Deepgram/Clients/Interfaces/v1/ISpeakWebSocketClient.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,149 @@ | ||
| // 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 | ||
|
|
||
| using Deepgram.Models.Speak.v1.WebSocket; | ||
|
|
||
| namespace Deepgram.Clients.Interfaces.v1; | ||
|
|
||
| /// <summary> | ||
| /// Implements version 1 of the Live Client. | ||
| /// </summary> | ||
| public interface ISpeakWebSocketClient | ||
| { | ||
| #region Connect and Disconnect | ||
| public Task Connect(SpeakSchema options, CancellationTokenSource? cancelToken = null, Dictionary<string, string>? addons = null, | ||
| Dictionary<string, string>? headers = null); | ||
|
|
||
| public Task Stop(CancellationTokenSource? cancelToken = null); | ||
| #endregion | ||
|
|
||
| #region Subscribe Event | ||
| /// <summary> | ||
| /// Subscribe to an Open event from the Deepgram API | ||
| /// </summary> | ||
| /// <param name="eventHandler"></param> | ||
| /// <returns>True if successful</returns> | ||
| public bool Subscribe(EventHandler<OpenResponse> eventHandler); | ||
|
|
||
| /// <summary> | ||
| /// Subscribe to a Metadata event from the Deepgram API | ||
| /// </summary> | ||
| /// <param name="eventHandler"></param> | ||
| /// <returns>True if successful</returns> | ||
| public bool Subscribe(EventHandler<MetadataResponse> eventHandler); | ||
|
|
||
| /// <summary> | ||
| /// Subscribe to a Flushed event from the Deepgram API | ||
| /// </summary> | ||
| /// <returns>True if successful</returns> | ||
| public bool Subscribe(EventHandler<FlushedResponse> eventHandler); | ||
|
|
||
| /// <summary> | ||
| /// Subscribe to a Cleared event from the Deepgram API | ||
| /// </summary> | ||
| /// <returns>True if successful</returns> | ||
| public bool Subscribe(EventHandler<ClearedResponse> eventHandler); | ||
|
|
||
| /// <summary> | ||
| /// Subscribe to a Audio buffer/event from the Deepgram API | ||
| /// </summary> | ||
| /// <returns>True if successful</returns> | ||
| public bool Subscribe(EventHandler<AudioResponse> eventHandler); | ||
|
|
||
| /// <summary> | ||
| /// Subscribe to a Close event from the Deepgram API | ||
| /// </summary> | ||
| /// <returns>True if successful</returns> | ||
| public bool Subscribe(EventHandler<CloseResponse> eventHandler); | ||
|
|
||
| /// <summary> | ||
| /// Subscribe to an Unhandled event from the Deepgram API | ||
| /// </summary> | ||
| /// <returns>True if successful</returns> | ||
| public bool Subscribe(EventHandler<UnhandledResponse> eventHandler); | ||
|
|
||
| /// <summary> | ||
| /// Subscribe to an Warning event from the Deepgram API | ||
| /// </summary> | ||
| /// <returns>True if successful</returns> | ||
| public bool Subscribe(EventHandler<WarningResponse> eventHandler); | ||
|
|
||
|
|
||
| /// <summary> | ||
| /// Subscribe to an Error event from the Deepgram API | ||
| /// </summary> | ||
| /// <returns>True if successful</returns> | ||
| public bool Subscribe(EventHandler<ErrorResponse> eventHandler); | ||
| #endregion | ||
|
|
||
| #region Send Functions | ||
| /// <summary> | ||
| /// This method sends a binary message over the WebSocket connection. | ||
| /// </summary> | ||
| /// <param name="data"></param> | ||
| public void SpeakWithText(string data); | ||
|
|
||
| ///// <summary> | ||
| ///// This method Flushes the text buffer on Deepgram to be converted to audio | ||
| ///// </summary> | ||
| public void Flush(); | ||
|
|
||
| ///// <summary> | ||
| ///// This method Resets the text buffer on Deepgram to be converted to audio | ||
| ///// </summary> | ||
| public void Clear(); | ||
|
|
||
| ///// <summary> | ||
| ///// This method tells Deepgram to initiate the close server-side. | ||
| ///// </summary> | ||
| public void Close(); | ||
|
|
||
| ///// <summary> | ||
| ///// This method sends a binary message over the WebSocket connection. | ||
| ///// </summary> | ||
| ///// <param name="data"></param> | ||
| //public void SpeakWithStream(byte[] 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); | ||
|
|
||
| ///// <summary> | ||
| ///// This method sends a binary message over the WebSocket connection. | ||
| ///// </summary> | ||
| ///// <param name="data"></param> | ||
| //public void SendBinary(byte[] data); | ||
|
|
||
| /// <summary> | ||
| /// This method sends a text message over the WebSocket connection. | ||
| /// </summary> | ||
| public void SendMessage(byte[] data); | ||
|
|
||
| ///// <summary> | ||
| ///// This method sends a binary message over the WebSocket connection immediately without queueing. | ||
| ///// </summary> | ||
| //public void SendBinaryImmediately(byte[] data); | ||
|
|
||
| /// <summary> | ||
| /// This method sends a text message over the WebSocket connection immediately without queueing. | ||
| /// </summary> | ||
| public void SendMessageImmediately(byte[] data); | ||
| #endregion | ||
|
|
||
| #region Helpers | ||
| /// <summary> | ||
| /// Retrieves the connection state of the WebSocket | ||
| /// </summary> | ||
| /// <returns>Returns the connection state of the WebSocket</returns> | ||
| public WebSocketState State(); | ||
|
|
||
| /// <summary> | ||
| /// Indicates whether the WebSocket is connected | ||
| /// </summary> | ||
| /// <returns>Returns true if the WebSocket is connected</returns> | ||
| public bool IsConnected(); | ||
| #endregion | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.