R
fn

useSpeechRecognition

v0.0.15testeddemo

Reactive wrapper around the Web Speech API `SpeechRecognition` for transcribing speech to text.

Examples

ts
const { isSupported, isListening, result, start, stop } = useSpeechRecognition({ lang: 'en-US' });
start();
ts
// Toggle from a button, read the live transcript
const { result, isFinal, toggle } = useSpeechRecognition({ continuous: true });
watch(result, transcript => console.log(transcript));

Demo

Loading demo…

Signature

ts
export function useSpeechRecognition(options: UseSpeechRecognitionOptions ={ ... }

Parameters

ParameterTypeDescription
options?UseSpeechRecognitionOptionsConfiguration options

Returns

UseSpeechRecognitionReturnSupport flag, reactive listening/result/error state, and start/stop/toggle controls