useSpeechSynthesis

分类

传感器

导出大小

736 B

上次更改

2 个月前

响应式的 SpeechSynthesis。

我可以使用吗？

演示

源代码演示 (beta)

朗读文本

朗读中大家好！早上好！

语言

音高

语速

音量

用法

import { useSpeechSynthesis
 } from '@vueuse/core'

const {
  isSupported
,
  isPlaying
,
  status
,
  voiceInfo
,
  utterance
,
  error
,
  stop
,
  toggle
,
  speak
,
} = useSpeechSynthesis
()

选项

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

useSpeechSynthesis
({
  lang
: 'en-US',
  pitch
: 1,
  rate
: 1,
  volume
: 1,
})

类型声明

显示类型声明

export type UseSpeechSynthesisStatus
 = "init" | "play" | "pause" | "end"
export interface UseSpeechSynthesisOptions extends ConfigurableWindow {
  /**
   * Language for SpeechSynthesis
   *
   * @default 'en-US'
   */
  lang
?: MaybeRefOrGetter
<string>
  /**
   * Gets and sets the pitch at which the utterance will be spoken at.
   *
   * @default 1
   */
  pitch
?: MaybeRefOrGetter
<SpeechSynthesisUtterance["pitch"]>
  /**
   * Gets and sets the speed at which the utterance will be spoken at.
   *
   * @default 1
   */
  rate
?: MaybeRefOrGetter
<SpeechSynthesisUtterance["rate"]>
  /**
   * Gets and sets the voice that will be used to speak the utterance.
   */
  voice
?: MaybeRef
<SpeechSynthesisVoice>
  /**
   * Gets and sets the volume that the utterance will be spoken at.
   *
   * @default 1
   */
  volume
?: MaybeRefOrGetter
<SpeechSynthesisUtterance["volume"]>
  /**
   * Callback function that is called when the boundary event is triggered.
   */
  onBoundary
?: (event
: SpeechSynthesisEvent) => void
}
/**
 * Reactive SpeechSynthesis.
 *
 * @see https://vueuse.org.cn/useSpeechSynthesis
 * @see https://mdn.org.cn/en-US/docs/Web/API/SpeechSynthesis SpeechSynthesis
 */
export declare function useSpeechSynthesis
(
  text
: MaybeRefOrGetter
<string>,
  options
?: UseSpeechSynthesisOptions,
): {
  isSupported
: ComputedRef
<boolean>
  isPlaying
: ShallowRef
<boolean, boolean>
  status
: ShallowRef
<UseSpeechSynthesisStatus
, UseSpeechSynthesisStatus
>
  utterance
: ComputedRef
<SpeechSynthesisUtterance>
  error
: ShallowRef
<
    SpeechSynthesisErrorEvent | undefined,
    SpeechSynthesisErrorEvent | undefined
  >
  stop
: () => void
  toggle
: (value
?: boolean) => void
  speak
: () => void
}
export type UseSpeechSynthesisReturn
 = ReturnType
<typeof useSpeechSynthesis
>