MumbleSharp 2.0.1

dotnet add package MumbleSharp --version 2.0.1                
NuGet\Install-Package MumbleSharp -Version 2.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="MumbleSharp" Version="2.0.1" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add MumbleSharp --version 2.0.1                
#r "nuget: MumbleSharp, 2.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 MumbleSharp as a Cake Addin
#addin nuget:?package=MumbleSharp&version=2.0.1

// Install MumbleSharp as a Cake Tool
#tool nuget:?package=MumbleSharp&version=2.0.1                

MumbleSharp

MumbleSharp is Mumble client library and sample client implementations in C#.

MumbleSharp Logo

The library targets .NET Standard 2.1 and 2.0

The sample client implementations targets .NET 6.0

Mumble is a free, open source, low latency, high quality voice chat application.

The solution comes in two parts:

  1. The MumbleSharp Library
    • MumbleSharp is the actual MumbleSharp library which is a class library for building mumble clients.
  2. Demo implementations available on GitHub
    • MumbleClient is a console mumble client, a console application to use for testing and learning.
    • MumbleGuiClient is a winform mumble client, a minimalistic client but fully functional: channels display and switching, message chat, voice support, playback/recording device selection and a very basic voice detection.

NuGet Package

You may find the MumbleSharp library as a NuGet package:

Package Name Version
MumbleSharp MumbleSharpShield

Quick Start

As you can see from the MumbleClient's Program.cs creating a new client is very simple:

  1. Implement IMumbleProtocol and implement methods to respond to messages of different types however you wish.
  2. Use a MumbleConnection to connect to a server.

Work In Progress

The library nearly supports all non-voice things that Mumble can do. For voice it only supports Opus encoded packets (Opus is Mumble's primary codec).

Contributing

We're working on MumbleSharp in our spare time but are very happy to receive contributions. If you're thinking of contributing create an issue and assign-it to yourself and we'll try to give you any advice we can to achieve whatever you want, and that's a good way to make sure no one else is duplicating your work as well as being a good place to have discussions.

When contributing it's often useful to reference the Mumble source code.

Things To Do

If you want to contribute here's some ideas:

Jitter Buffer

There is no jitter buffering at the moment. Port the jitter buffering from mumble or implement your own. AudioBuffer.cs is probably the correct place to start doing this.

Other Codecs

Supporting other codecs should be relatively simple. For CELT you'll need to find the correct version of the DLL (check out the Mumble-Protocol.pdf for the version) and then write a wrapper with P/Invoke. For Speex you should be able to use NSpeex.

Looking For VoIP In Unity?

Martin Evans developed a VoIP asset for Unity: Dissonance Voice Chat

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  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. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos 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
2.0.1 914 5/10/2023
2.0.0 933 6/1/2022
1.2.0 869 2/25/2020
1.1.1 543 2/25/2020
1.0.0 1,139 5/5/2018

fix inclusion of opus.dll in projects referencing this package.