useSpeechRecognition

分类

传感器

导出大小

714 B

上次更改

8 个月前

响应式的语音识别。

我能用吗？

演示

源代码演示 (beta)

您的浏览器不支持 SpeechRecognition API，查看更多详情

用法

import { useSpeechRecognition
 } from '@vueuse/core'

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

选项

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

useSpeechRecognition
({
  lang
: 'en-US',
  interimResults
: true,
  continuous
: true,
})

类型声明

显示类型声明

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://mdn.org.cn/en-US/docs/Web/API/SpeechRecognition/maxAlternatives
   * @default 1
   */
  maxAlternatives
?: number
}
/**
 * Reactive SpeechRecognition.
 *
 * @see https://vueuse.org.cn/useSpeechRecognition
 * @see https://mdn.org.cn/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
>