useSpeechRecognition

Category

Sensors

Export Size

705 B

Last Changed

3 hours ago

响应式 SpeechRecognition。

Can I use?

Demo

source

您的浏览器不支持语音识别 API， 查看更多详情

用法

import { useSpeechRecognition } from '@vueuse/core'

const {
  isSupported,
  isListening,
  isFinal,
  result,
  start,
  stop,
} = useSpeechRecognition()

选项

以下显示了选项的默认值，它们将直接传递给 SpeechRecognition API。

useSpeechRecognition({
  lang: 'zh-CN',
  interimResults: true,
  continuous: true,
})

Type Declarations

Show 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<
    SpeechRecognitionErrorEvent | undefined,
    SpeechRecognitionErrorEvent | undefined
  >
  toggle: (value?: boolean) => void
  start: () => void
  stop: () => void
}
export type UseSpeechRecognitionReturn = ReturnType<typeof useSpeechRecognition>

Source

Source • Demo • Docs

Contributors

jorshen

Changelog

No recent changes