Skip to main content

asr_core/
lib.rs

1#![doc = include_str!("../README.md")]
2//! Bounded, runtime-independent speech recognition sessions.
3//!
4//! `Engine::prepare` creates reusable backend resources. `Engine::start` creates an isolated session;
5//! audio enters through `AudioInput` and final results are obtained with `Session::finish`.
6//! See the repository examples and docs/architecture.md for complete lifecycles.
7pub mod audio;
8mod backends;
9mod config;
10mod coordinator;
11#[cfg(any(
12    feature = "backend-dashscope",
13    feature = "backend-openai-http",
14    feature = "backend-openai-realtime"
15))]
16mod deadline;
17mod engine;
18mod error;
19mod result;
20mod session;
21pub mod utils;
22
23#[cfg(feature = "serve-openai-http")]
24pub mod serve;
25pub use audio::{AudioBuffer, AudioChunk, AudioSpec};
26pub use config::{
27    BiasPhrase, DashScopeConfig, EngineConfig, ExecutionProvider, HttpMode, HttpResponse,
28    OfflineConfig, OfflineFamily, OpenAiHttpConfig, OpenAiRealtimeConfig, PunctConfig, Secret,
29    SessionOptions, SpeechHints, StreamingConfig, Timeouts, TransducerBiasConfig, VadConfig,
30    DEFAULT_NUM_THREADS, MAX_NUM_THREADS,
31};
32pub use coordinator::{AudioInput, PushError, Session, Subscription};
33pub use engine::{Engine, EngineOptions, TranscriptSnapshotSink};
34pub use error::{AsrError, ErrorKind};
35pub use result::{
36    BackendCapabilities, PartialView, Segment, SessionFailure, SessionOutcome, SessionPhase,
37    SessionResult, SessionView, Transcript, Update,
38};
39
40#[cfg(feature = "capture-cpal")]
41mod capture;
42#[cfg(feature = "capture-cpal")]
43pub use capture::CaptureSession;