WhisperLive.Client 1.1.2

WhisperLive.Client

A dotnet client library for WhisperLive server.

Installation

npm install @codehard-th/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.