Expand description
Most users will be looking for nothing more than WhisperState::full to run a full transcription pipeline.
You can get a WhisperState by first creating a WhisperContext using WhisperContext::new_with_params,
and then calling WhisperContext::create_state.
Structs§
- DtwParameters
- [EXPERIMENTAL] Enable Token-level timestamps with DTW, default Disabled
- Full
Params - Segment
Callback Data - System
Info - Programmatically exposes the information provided by
print_system_info - Whisper
Context - Whisper
Context Parameters - Whisper
Grammar Element - Whisper
Segment - A segment returned by Whisper after running the transcription pipeline.
- Whisper
State - Rustified pointer to a Whisper state.
- Whisper
State Segment Iterator - An iterator over a
WhisperState’s result. - Whisper
Token - Whisper
VadContext - A handle to use
whisper.cpp’s built in VAD standalone. - Whisper
VadContext Params - Whisper VAD context parameters
- Whisper
VadParams - Configuration for Voice Activity Detection in
whisper.cpp. - Whisper
VadSegment - Whisper
VadSegments - You can obtain this struct from a
WhisperVadContext.
Enums§
- DtwMode
- DtwModel
Preset - GGML
LogLevel - Sampling
Strategy - The sampling strategy to use to pick tokens from a list of likely possibilities.
- Whisper
Error - If you have not configured a logging trampoline with [crate::whisper_sys_log::install_whisper_log_trampoline] or
[crate::whisper_sys_tracing::install_whisper_tracing_trampoline],
then
whisper.cpp’s errors will be output to stderr, so you can check there for more information upon receiving aWhisperError. - Whisper
Grammar Element Type
Statics§
- WHISPER_
CPP_ VERSION - The version of whisper.cpp that whisper-rs was linked with.
Functions§
- convert_
integer_ to_ float_ audio - Convert an array of 16 bit mono audio samples to a vector of 32 bit floats.
- convert_
stereo_ to_ mono_ audio - Convert 32-bit floating point stereo PCM audio to 32-bit floating point mono PCM audio.
- get_
lang_ id - Return the id of the specified language, returns -1 if not found
- get_
lang_ max_ id - Return the ID of the maximum language (ie the number of languages - 1)
- get_
lang_ str - Get the short string of the specified language id (e.g. 2 -> “de”).
- get_
lang_ str_ full - Get the full string of the specified language name (e.g. 2 -> “german”).
- install_
logging_ hooks - Redirect all whisper.cpp and GGML logs to logging hooks installed by whisper-rs.
- print_
system_ info - Print system information.
- set_
log_ ⚠callback - Callback to control logging output: default behaviour is to print to stderr.