Navbot.RealtimeApi.Dotnet.SDK.WinForm 1.0.25

Project Name

The Dotnet.SDK of OpenAI Real-Time API.

Youtube playlist

https://www.youtube.com/playlist?list=PLtan4ax5Sz-1ckWzZWx872rFFuAukihNE

Project Introduction

We implemented serveral components that can directly interact with OpenAI Real-Time API, so that the .net developers can simply focus on the real-time conversation logic.

Table of Contents

• Feature Overview
• Installation and Configuration
• Usage
• Feature Demonstration
• License

Feature Overview

The Realtime control provides the following key features:

• Real-time Speech Recognition: Converts user speech into text in real time, supporting continuous speech input and feedback.
• Text-to-Speech: Converts AI or other text information into speech and plays it.
• Multi-language Support: Supports speech recognition in multiple languages.
• OpenAI Integration: Integrates the OpenAI API, supporting intelligent conversation and natural language processing.
• Custom Features: Allows developers to customize API calls and speech-related functionalities.
• FunctionCall: Allows developers to define and integrate customized FunctionCall.
• Voice-interaction GUI: we design and implement several interaction UI components

Installation and Configuration

System Requirements

List the basic environment requirements needed to run the project:

• Operating System: Windows 10 or higher
• .NET Version: .NET 8.0 or higher
• Other Dependencies: OpenAI API key, NAudio, etc.

NuGet Package Installation

To use the Realtime control, you need to install the following NuGet packages:

Navbot.RealtimeApi.Dotnet.SDK.Core
Navbot.RealtimeApi.Dotnet.SDK.WinForm
Navbot.RealtimeApi.Dotnet.SDK.WPF

You can install these packages by running the following commands in the NuGet Package Manager Console:

Install-Package Navbot.RealtimeApi.Dotnet.SDK.Core
Install-Package Navbot.RealtimeApi.Dotnet.SDK.WinForm
Install-Package Navbot.RealtimeApi.Dotnet.SDK.WPF

Alternatively, you can add them via the Package Manager UI by searching for each package.

WPF Getting Start

<Window x:Class="YourNamespace.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:wpf="clr-namespace:Navbot.RealtimeApi.Dotnet.SDK.WPF"
        Title="MainWindow" Height="450" Width="800">
    <Grid>
        <wpf:RealtimeApiWpfControl x:Name="realtimeApiWpfControl" />
    </Grid>
</Window>

private void Window_Loaded(object sender, RoutedEventArgs e)
{
    string openAiApiKey = Environment.GetEnvironmentVariable("OPENAI_API_KEY") ?? "Your OpenAiApiKey";
    realtimeApiWpfControl.OpenAiApiKey = openAiApiKey;
}
private void btnStart_Click(object sender, RoutedEventArgs e)
{
    realtimeApiWpfControl.StartSpeechRecognition();
}

private void btnStop_Click(object sender, RoutedEventArgs e)
{
    realtimeApiWpfControl.StopSpeechRecognition();
}

WinForm Getting Start

In a Windows Forms application, you can initialize the control and start using it as follows:

using Realtime.API.Dotnet.SDK.Core.Model;

    public partial class MainForm : Form
    {
        public MainForm()
        {
            InitializeComponent();
        }

        private void MainForm_Load(object sender, EventArgs e)
        {
            string openAiApiKey = Environment.GetEnvironmentVariable("OPENAI_API_KEY") ?? "Your OpenAiApiKey";
            realtimeApiWinFormControl1.OpenAiApiKey = openAiApiKey;
        }

        private void btnStart_Click(object sender, EventArgs e)
        {
            realtimeApiWinFormControl1.StartSpeechRecognition();
        }

        private void btnStop_Click(object sender, EventArgs e)
        {
            realtimeApiWinFormControl1.StopSpeechRecognition();
        }
    }

Feature Demonstration

1. Speech Recognition: Click the "Start" button to begin listening to the user's speech and convert it into text in real time.
2. Speech Text: By hooking up RealtimeApiDesktopControl.PlaybackTextAvailable event, the output text information of the AI speech will be displayed.

License

This project is licensed under the MIT License.

Contact Us

If you have any questions or suggestions, feel free to contact us:

• Email: fuwei007@gmail.com
• GitHub Issues: GitHub Repository