Soundboard.Client
1.2.2
dotnet add package Soundboard.Client --version 1.2.2
NuGet\Install-Package Soundboard.Client -Version 1.2.2
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="Soundboard.Client" Version="1.2.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Soundboard.Client" Version="1.2.2" />
<PackageReference Include="Soundboard.Client" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Soundboard.Client --version 1.2.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Soundboard.Client, 1.2.2"
#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.
#:package Soundboard.Client@1.2.2
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Soundboard.Client&version=1.2.2
#tool nuget:?package=Soundboard.Client&version=1.2.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Soundboard.Client
Streaming TTS client SDK for .NET. Connects to any voice engine implementing the Soundboard API contract.
Quick start
using Soundboard.Client;
using Soundboard.Client.Models;
await using var client = new SoundboardClient();
// Check engine health
var health = await client.GetHealthAsync();
Console.WriteLine($"Engine v{health.EngineVersion}");
// Discover available presets and voices
var presets = await client.GetPresetsAsync();
var voices = await client.GetVoicesAsync();
// Stream speech — audio arrives chunk by chunk
var progress = new Progress<AudioChunk>(chunk =>
{
// Feed chunk.PcmData to your audio output
// PCM16 mono at chunk.SampleRate (24kHz)
});
await client.SpeakAsync(
new SpeakRequest("Hello from the SDK.", presets[0], voices[0]),
progress);
Features
- Streaming audio via WebSocket (
IProgress<AudioChunk>) CancellationTokenon every async method- Zero UI dependencies — works in console, WPF, ASP.NET, anywhere
- Engine-agnostic — any compliant engine works
- Single dependency:
Microsoft.Extensions.Logging.Abstractions
Configuration
var client = new SoundboardClient(new SoundboardClientOptions
{
BaseUrl = "http://localhost:8765",
HttpTimeout = TimeSpan.FromSeconds(10),
WebSocketReceiveTimeout = TimeSpan.FromSeconds(30)
});
Or set SOUNDBOARD_BASE_URL environment variable.
Links
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. 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. net9.0 is compatible. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net10.0
- Microsoft.Extensions.Logging.Abstractions (>= 10.0.0-preview.1.25080.5)
-
net8.0
- Microsoft.Extensions.Logging.Abstractions (>= 8.0.2)
-
net9.0
- Microsoft.Extensions.Logging.Abstractions (>= 9.0.0)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on Soundboard.Client:
| Package | Downloads |
|---|---|
|
Soundboard.Maui.Audio
NAudio-based PCM16 streaming audio playback adapter for Windows. Provides IAudioPlayer implementation with buffering, thread-safe start/stop/flush, and playback state tracking. |
GitHub repositories
This package is not used by any popular GitHub repositories.