Skip to content
On this page

useSpeechSynthesis

Category
Export Size
1.28 kB
Last Changed
5 months ago

Reactive SpeechSynthesis.

Can I use?

Demo


Usage

ts
import { useSpeechSynthesis } from '@vueuse/core'

const {
  isSupported,
  isPlaying,
  status,
  voiceInfo,
  utterance,
  error,

  toggle,
  speak,
} = useSpeechSynthesis()
import { useSpeechSynthesis } from '@vueuse/core'

const {
  isSupported,
  isPlaying,
  status,
  voiceInfo,
  utterance,
  error,

  toggle,
  speak,
} = useSpeechSynthesis()

Options

The following shows the default values of the options, they will be directly passed to SpeechSynthesis API.

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

Type Declarations

Show Type Declarations
typescript
export declare type UseSpeechSynthesisStatus = "init" | "play" | "pause" | "end"
export interface UseSpeechSynthesisOptions extends ConfigurableWindow {
  /**
   * Language for SpeechSynthesis
   *
   * @default 'en-US'
   */
  lang?: MaybeComputedRef<string>
  /**
   * Gets and sets the pitch at which the utterance will be spoken at.
   *
   * @default 1
   */
  pitch?: SpeechSynthesisUtterance["pitch"]
  /**
   * Gets and sets the speed at which the utterance will be spoken at.
   *
   * @default 1
   */
  rate?: 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?: SpeechSynthesisUtterance["volume"]
}
/**
 * Reactive SpeechSynthesis.
 *
 * @see https://vueuse.org/useSpeechSynthesis
 * @see https://developer.mozilla.org/en-US/docs/Web/API/SpeechSynthesis SpeechSynthesis
 * @param options
 */
export declare function useSpeechSynthesis(
  text: MaybeComputedRef<string>,
  options?: UseSpeechSynthesisOptions
): {
  isSupported: Ref<boolean>
  isPlaying: Ref<boolean>
  status: Ref<UseSpeechSynthesisStatus>
  utterance: ComputedRef<SpeechSynthesisUtterance>
  error: Ref<SpeechSynthesisErrorEvent | undefined>
  toggle: (value?: boolean) => void
  speak: () => void
}
export declare type UseSpeechSynthesisReturn = ReturnType<
  typeof useSpeechSynthesis
>
export declare type UseSpeechSynthesisStatus = "init" | "play" | "pause" | "end"
export interface UseSpeechSynthesisOptions extends ConfigurableWindow {
  /**
   * Language for SpeechSynthesis
   *
   * @default 'en-US'
   */
  lang?: MaybeComputedRef<string>
  /**
   * Gets and sets the pitch at which the utterance will be spoken at.
   *
   * @default 1
   */
  pitch?: SpeechSynthesisUtterance["pitch"]
  /**
   * Gets and sets the speed at which the utterance will be spoken at.
   *
   * @default 1
   */
  rate?: 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?: SpeechSynthesisUtterance["volume"]
}
/**
 * Reactive SpeechSynthesis.
 *
 * @see https://vueuse.org/useSpeechSynthesis
 * @see https://developer.mozilla.org/en-US/docs/Web/API/SpeechSynthesis SpeechSynthesis
 * @param options
 */
export declare function useSpeechSynthesis(
  text: MaybeComputedRef<string>,
  options?: UseSpeechSynthesisOptions
): {
  isSupported: Ref<boolean>
  isPlaying: Ref<boolean>
  status: Ref<UseSpeechSynthesisStatus>
  utterance: ComputedRef<SpeechSynthesisUtterance>
  error: Ref<SpeechSynthesisErrorEvent | undefined>
  toggle: (value?: boolean) => void
  speak: () => void
}
export declare type UseSpeechSynthesisReturn = ReturnType<
  typeof useSpeechSynthesis
>

Source

SourceDemoDocs

Contributors

Anthony Fu
sibbng
Jelf
wheat
云游君

Changelog

v9.0.0-beta.1 on 7/20/2022
a524b - fix: remove duplicated onend, fix demo (#1941)
v9.0.0-beta.0 on 7/17/2022
db61f - fix: rename type Status to UseSpeechSynthesisStatus
v8.9.3 on 7/14/2022
011af - refactor!: remove voiceInfo, allow voice as ref (#1882)
42516 - fix!: rename type SpeechSynthesisOptions to UseSpeechSynthesisOptions (#1890)
v8.9.2 on 7/12/2022
81d92 - fix(all)!: isSupported becomes Ref instead of boolean for SSR compatibility (#1800)
v8.9.1 on 7/8/2022
a9ccc - feat(all): use MaybeComputedRef (#1768)

Released under the MIT License.