Class default

constructor

• new default(options?): default

• Parameters

  • options: Partial<SpeechOptions> = {}

  Returns default

effects

options

ready

speech

utter

voice

cancel

• cancel(): void

• Forced cancellation of all broadcasts, and immediate cancellation of those being broadcast

  Returns void

getCurrentUtter

• getCurrentUtter(): null | SpeechSynthesisUtterance

• get current utter

  Returns null | SpeechSynthesisUtterance

  result - utter: SpeechSynthesisUtterance

getVoice

• getVoice(): Promise<undefined | SpeechSynthesisVoice>

• get voice

  Returns Promise<undefined | SpeechSynthesisVoice>

  result voice: SpeechSynthesisVoice

pause

• pause(): void

• Suspension of all broadcasts and immediate cancellation of those being broadcast

  Returns void

remove

• remove(effectKey): boolean

• Remove unconsumed speak

  Parameters

  • effectKey: symbol

    key of effect

  Returns boolean

  result - cancellation result true=Cancellation success false=Broadcast content not found or broadcast consumed

resume

• resume(): void

• Resume all broadcasts and immediately cancel those being broadcast

  Returns void

speak

• speak(content, utterOptions?): symbol

• speak

  Parameters

  • content: string

    speak text

  • utterOptions: Partial<Pick<SpeechSynthesisUtterance, "text" | "lang" | "onerror" | "onpause" | "onboundary" | "onend" | "onmark" | "onresume" | "onstart" | "pitch" | "rate" | "voice" | "volume">> = {}

    utter options: UtterOptions

  Returns symbol

  result - effectKey: symbol

speaking

• speaking(): void

• do speaking

  Returns void