WhisperLive.Client 1.2.1

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

// Install WhisperLive.Client as a Cake Tool
#tool nuget:?package=WhisperLive.Client&version=1.2.1

WhisperLive.Client

A dotnet client library for WhisperLive server.

Installation

dotnet add package WhisperLive.Client

Usage

To use the Recorder library, include the necessary files in your project and import the Recorder class along with its dependencies.

using WhisperLive.Abstraction;
using WhisperLive.Abstraction.Configurations;
using WhisperLive.Client.Filters;
using WhisperLive.Client.Implementation;

var url = "ws://your-server-location";

// Adds your own filter as you see fit into the SegmentFilterFilterPipeline here.
var filterPipeline = new SegmentFilterFilterPipeline();
filterPipeline.AddFilter(new YourCustomFilter());
filterPipeline.AddFilter<YourAnotherCustomFilter>();

var configuration = new TranscriptorConfiguration(
    model: "large-v2",
    language: "en",
    isMultiLanguage: false,
    useVoiceActivityDetection: false,
    transcriptionDelay: TimeSpan.FromMilliseconds(100),
    transcriptionTimeout: TimeSpan.FromSeconds(30),
    segmentFilter: filterPipeline,
    options: TranscriptionOptions.Default with
    {
        RepetitionPenalty = 1.1f,
    });

// Create the transcriptor with a pre-defined configuration.
using var transcriptor = new SingleChannelTranscriptor(serviceUri);

// Subscribe to the events
transcriptor.TranscriptorReady += (sessionId, transcriptor) => { ... };
transcriptor.TranscribeMessageCompleted += (sessionId, speaker, segments) => { ... };
transcriptor.SessionEnded += (sessionId, reason, desc) => { ... };

// Starts the transcription session.
// The input can be an audio file path, an audio stream, or a HLS streaming URL.
var source = "/path/to/my/audio.mp3";
using var transcriptionSession = await transcriptor.StartAsync(source, CancellationToken.None);

// To stop the transcription you can call `StopAsync`
await transcriptor.StopAsync(transcriptionSession.Id, CancellationToken.None);

License

This project is licensed under the MIT License.

Product 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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on WhisperLive.Client:

Package Downloads
WhisperLive.Client.Recorder

A dotnet client for WhisperLive speech to text server with microphone record support.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.2.1 45 6/11/2024
1.2.0 62 6/10/2024
1.1.5 66 6/4/2024
1.1.4 80 5/28/2024
1.1.3 68 5/27/2024
1.1.2 70 5/27/2024
1.1.1 69 5/27/2024
1.1.0 75 5/23/2024
1.1.0-preview-006 89 4/30/2024
1.1.0-preview-005 73 4/29/2024
1.1.0-preview-004 75 4/18/2024
1.1.0-preview-003 69 4/18/2024
1.1.0-preview-002 86 4/9/2024
1.1.0-preview-001 80 4/9/2024
1.0.3 116 4/9/2024
1.0.1 93 3/27/2024
1.0.0 89 3/26/2024

Fixes an issue regarding initializing payload that is causing the server to reject the connection.