VueUseuseSpeechRecognition
Reactive SpeechRecognition.
Demo
Your browser does not support SpeechRecognition API, more details
Usage
ts
import { useSpeechRecognition } from '@vueuse/core'
const {
isSupported,
isListening,
isFinal,
result,
start,
stop,
} = useSpeechRecognition()
import { useSpeechRecognition } from '@vueuse/core'
const {
isSupported,
isListening,
isFinal,
result,
start,
stop,
} = useSpeechRecognition()
Options
The following shows the default values of the options, they will be directly passed to SpeechRecognition API.
ts
useSpeechRecognition({
lang: 'en-US',
interimResults: true,
continuous: true,
})
useSpeechRecognition({
lang: 'en-US',
interimResults: true,
continuous: true,
})
Type Declarations
Show Type Declarations
typescript
export interface UseSpeechRecognitionOptions extends ConfigurableWindow {
/**
* Controls whether continuous results are returned for each recognition, or only a single result.
*
* @default true
*/
continuous?: boolean
/**
* Controls whether interim results should be returned (true) or not (false.) Interim results are results that are not yet final
*
* @default true
*/
interimResults?: boolean
/**
* Language for SpeechRecognition
*
* @default 'en-US'
*/
lang?: MaybeComputedRef<string>
}
/**
* Reactive SpeechRecognition.
*
* @see https://vueuse.org/useSpeechRecognition
* @see https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognition SpeechRecognition
* @param options
*/
export declare function useSpeechRecognition(
options?: UseSpeechRecognitionOptions
): {
isSupported: Ref<boolean>
isListening: Ref<boolean>
isFinal: Ref<boolean>
recognition: SpeechRecognition | undefined
result: Ref<string>
error: Ref<SpeechRecognitionErrorEvent | undefined>
toggle: (value?: boolean) => void
start: () => void
stop: () => void
}
export type UseSpeechRecognitionReturn = ReturnType<typeof useSpeechRecognition>
export interface UseSpeechRecognitionOptions extends ConfigurableWindow {
/**
* Controls whether continuous results are returned for each recognition, or only a single result.
*
* @default true
*/
continuous?: boolean
/**
* Controls whether interim results should be returned (true) or not (false.) Interim results are results that are not yet final
*
* @default true
*/
interimResults?: boolean
/**
* Language for SpeechRecognition
*
* @default 'en-US'
*/
lang?: MaybeComputedRef<string>
}
/**
* Reactive SpeechRecognition.
*
* @see https://vueuse.org/useSpeechRecognition
* @see https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognition SpeechRecognition
* @param options
*/
export declare function useSpeechRecognition(
options?: UseSpeechRecognitionOptions
): {
isSupported: Ref<boolean>
isListening: Ref<boolean>
isFinal: Ref<boolean>
recognition: SpeechRecognition | undefined
result: Ref<string>
error: Ref<SpeechRecognitionErrorEvent | undefined>
toggle: (value?: boolean) => void
start: () => void
stop: () => void
}
export type UseSpeechRecognitionReturn = ReturnType<typeof useSpeechRecognition>
Source
Contributors
Anthony Fu
Jelf
Mark Noonan
vaakian X
wheat
Joe Maylor
Shinigami
Alex Kozack
EGGSY
Antério Vieira