VueUseuseSpeechSynthesis
Reactive SpeechSynthesis.
Demo
Usage
ts
import { useSpeechSynthesis } from '@vueuse/core'
const {
isSupported,
isPlaying,
status,
voiceInfo,
utterance,
error,
stop,
toggle,
speak,
} = useSpeechSynthesis()
import { useSpeechSynthesis } from '@vueuse/core'
const {
isSupported,
isPlaying,
status,
voiceInfo,
utterance,
error,
stop,
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 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>
stop: () => void
toggle: (value?: boolean) => void
speak: () => void
}
export type UseSpeechSynthesisReturn = ReturnType<typeof useSpeechSynthesis>
export 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>
stop: () => void
toggle: (value?: boolean) => void
speak: () => void
}
export type UseSpeechSynthesisReturn = ReturnType<typeof useSpeechSynthesis>
Source
Contributors
Anthony Fu
sibbng
Jelf
wheat
zwkkwz1
云游君Changelog
v9.13.0 on 2/18/2023v9.0.0-beta.1 on 7/20/2022v9.0.0-beta.0 on 7/17/2022db61f - fix: rename type Status to UseSpeechSynthesisStatusv8.9.3 on 7/14/2022v8.9.2 on 7/12/2022v8.9.1 on 7/8/2022