OpenVoiceSharp 1.0.1

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package OpenVoiceSharp --version 1.0.1                

                    
                

            
NuGet\Install-Package OpenVoiceSharp -Version 1.0.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="OpenVoiceSharp" Version="1.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add OpenVoiceSharp --version 1.0.1                

                    
                

            
#r "nuget: OpenVoiceSharp, 1.0.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install OpenVoiceSharp as a Cake Addin
#addin nuget:?package=OpenVoiceSharp&version=1.0.1

// Install OpenVoiceSharp as a Cake Tool
#tool nuget:?package=OpenVoiceSharp&version=1.0.1

<img src="https://raw.githubusercontent.com/realcoloride/OpenVoiceSharp/master/openvoicesharp.png" alt="OpenVoiceSharp" width="28" height="28"> OpenVoiceSharp

Agnostic VoIP Voice Chat and Audio Streaming C# library.

Introduction

OpenVoiceSharp is an extremely simple, basic compact library that allows for real time VoIP (Voice over IP) voice chat and audio streaming. It allows for any app or game to embed voice chatting functionality.

OpenVoiceSharp utilizes Opus as codec under the hood and RNNoise for basic (toggleable) noise suppression and WebRTC VAD (voice activity detection) for voice detection.

OpenVoiceSharp also has a dedicated class (VoiceUtilities) for converting PCM to float formats depending on use cases for engines.

Why did I make this?

I believe that voice chat, proximity or not is an essential functionality for game immersion or multiplayer, or discussion. Though, when searching for a friendly open source/free alternative other than Steam's Voice API or Epic Online Services's Voice API, I could not find any, and to make matters worse, it was extremely difficult to get information around how voice chat/audio streaming essentially worked under the hood, which can make difficult for people to make their own voice chat implementation.

Most alternatives are paid (Vivox, Photon Voice, Dissonance etc...) & are mostly compatible for Unity, which can cause an issue for developers using their own game engine, app stack, or game engines like the Godot Engine.

So upon learning how to make VoIP myself, I decided to share the knowledge into this library to make sure no one has to ever struggle with VoIP again, because I also believe that implementation for such things should be easy to use and implement.

Features

  • 🕓 Agnostic: no specific engine/environment required!
  • ⚡ Easy and friendly to use: all you need is a way to record and playback the audio!
  • 🎙️ Basic microphone recorder class: no way to record the audio correctly or easily? BasicMicrophoneRecorder does that!
  • 💥 Low memory footprint: using Opus, the packets are tiny! And OpenVoiceSharp aims to be as memory efficient and performant as possible.
  • 🎵 Audio streaming favoring: option to encode less for better quality packets for audio streaming and more!
  • 😯 Low latency: OpenVoiceSharp aims to be as low latency as possible. One opus frame is only 20ms!
  • 🔊 Customizable bitrate: make audio crystal crisp or not, it depends on you! (Supports from 8kbps up to 512kbps)
  • 🍃 Basic noise suppression using RNNoise (can be toggled)
  • 🧪 Basic voice conversion utilies: convert 16 bit PCM to float 32 PCM and so on.

[!NOTE]
OpenVoiceSharp is meant to be extremely basic and straightforward. Audio playback, modification (effects or more) and features such as groups, teams, muting should be left to implement by yourself. OpenVoiceSharp just provides a basic way to encode and decode voice packets along with a basic microphone recorder.

Requirements

soon enough:tm:

Installation

soon enough:tm:

Usage

soon enough:tm:

Troubleshooting

soon enough:tm:

License & Disclaimer

soon enough:tm:

(real)coloride - 2024, Licensed MIT.

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.3 129 6/16/2024
1.0.2 163 4/16/2024
1.0.1 114 4/11/2024
1.0.0 108 4/11/2024

More comments and details for documentation.