Enum Event

pub enum Event {
    ProvisionalLiveUpdate {
        text: String,
        is_low_quality: bool,
    },
    SegmentTranscript {
        text: String,
        is_low_quality: bool,
    },
    SystemMessage(String),
    Error(WhisperStreamError),
}

Events emitted by the transcription stream.

These are sent through the channel returned by [WhisperStreamBuilder::build].

Variants

ProvisionalLiveUpdate

A provisional, live text update. This is an intermediate result, suitable for displaying real-time feedback. It is subject to change and will be superseded by subsequent ProvisionalLiveUpdate messages (providing more refined guesses for the same ongoing audio) or ultimately by a SegmentTranscript for that audio segment. These should not be stored or considered definitive.

is_low_quality is true if the text is considered low quality by the detector.

Fields

text: String

is_low_quality: bool

SegmentTranscript

The final and complete transcription for a specific audio segment window. This is the version of the transcript that should be considered the actual output for that portion of audio.

is_low_quality is true if the text is considered low quality by the detector.

Fields

text: String

is_low_quality: bool

SystemMessage(String)

System messages (e.g., recording status, warnings).

Error(WhisperStreamError)

Errors encountered during processing.

Trait Implementations

impl Debug for Event

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.