4a3ce4cc1d
Add comprehensive reference documentation for: - Vitest: environments, projects/workspaces, type testing, vi utilities - Pinia: HMR, Nuxt integration, SSR setup - Vue: built-in components (Transition, Teleport, Suspense, KeepAlive) and advanced directives
2.2 KiB
2.2 KiB
category
| category |
|---|
| Sensors |
useSpeechRecognition
Reactive SpeechRecognition.
Usage
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.
import { useSpeechRecognition } from '@vueuse/core'
// ---cut---
useSpeechRecognition({
lang: 'en-US',
interimResults: true,
continuous: true,
})
Type Declarations
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?: MaybeRefOrGetter<string>
/**
* A number representing the maximum returned alternatives for each result.
*
* @see https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognition/maxAlternatives
* @default 1
*/
maxAlternatives?: number
}
export interface UseSpeechRecognitionReturn extends Supportable {
isListening: ShallowRef<boolean>
isFinal: ShallowRef<boolean>
recognition: SpeechRecognition | undefined
result: ShallowRef<string>
error: ShallowRef<SpeechRecognitionErrorEvent | Error | undefined>
toggle: (value?: boolean) => void
start: () => void
stop: () => void
}
/**
* 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,
): UseSpeechRecognitionReturn