stack/v1/packages/mosaic/framework/skills/vueuse-functions/references/useSpeechRecognition.md

category

category
Sensors

useSpeechRecognition

Reactive SpeechRecognition.

Can I use?

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;
}
/**
 * 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: ComputedRef<boolean>;
  isListening: ShallowRef<boolean, boolean>;
  isFinal: ShallowRef<boolean, boolean>;
  recognition: SpeechRecognition | undefined;
  result: ShallowRef<string, string>;
  error: ShallowRef<
    Error | SpeechRecognitionErrorEvent | undefined,
    Error | SpeechRecognitionErrorEvent | undefined
  >;
  toggle: (value?: boolean) => void;
  start: () => void;
  stop: () => void;
};
export type UseSpeechRecognitionReturn = ReturnType<typeof useSpeechRecognition>;