1---
2category: Sensors
3---
4 
5# useSpeechRecognition
6 
7Reactive [SpeechRecognition](https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognition).
8 
9> [Can I use?](https://caniuse.com/mdn-api_speechrecognitionevent)
10 
11## Usage
12 
13```ts
14import { useSpeechRecognition } from '@vueuse/core'
15 
16const {
17  isSupported,
18  isListening,
19  isFinal,
20  result,
21  start,
22  stop,
23} = useSpeechRecognition()
24```
25 
26### Options
27 
28The following shows the default values of the options, they will be directly passed to [SpeechRecognition API](https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognition).
29 
30```ts
31import { useSpeechRecognition } from '@vueuse/core'
32// ---cut---
33useSpeechRecognition({
34  lang: 'en-US',
35  interimResults: true,
36  continuous: true,
37})
38```
39 
40## Type Declarations
41 
42```ts
43export interface UseSpeechRecognitionOptions extends ConfigurableWindow {
44  /**
45   * Controls whether continuous results are returned for each recognition, or only a single result.
46   *
47   * @default true
48   */
49  continuous?: boolean
50  /**
51   * Controls whether interim results should be returned (true) or not (false.) Interim results are results that are not yet final
52   *
53   * @default true
54   */
55  interimResults?: boolean
56  /**
57   * Language for SpeechRecognition
58   *
59   * @default 'en-US'
60   */
61  lang?: MaybeRefOrGetter<string>
62  /**
63   * A number representing the maximum returned alternatives for each result.
64   *
65   * @see https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognition/maxAlternatives
66   * @default 1
67   */
68  maxAlternatives?: number
69}
70export interface UseSpeechRecognitionReturn extends Supportable {
71  isListening: ShallowRef<boolean>
72  isFinal: ShallowRef<boolean>
73  recognition: SpeechRecognition | undefined
74  result: ShallowRef<string>
75  error: ShallowRef<SpeechRecognitionErrorEvent | Error | undefined>
76  toggle: (value?: boolean) => void
77  start: () => void
78  stop: () => void
79}
80/**
81 * Reactive SpeechRecognition.
82 *
83 * @see https://vueuse.org/useSpeechRecognition
84 * @see https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognition SpeechRecognition
85 * @param options
86 */
87export declare function useSpeechRecognition(
88  options?: UseSpeechRecognitionOptions,
89): UseSpeechRecognitionReturn
90```
91