Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SpeechSynthesis

This Web Speech API interface is the controller interface for the speech service; this can be used to retrieve information about the synthesis voices available on the device, start and pause speech, and other commands besides.

Hierarchy

  • EventTarget
    • SpeechSynthesis

Index

Properties

Methods

Properties

onvoiceschanged

onvoiceschanged: null | ((this: internal.SpeechSynthesis, ev: Event) => any)

Readonly paused

paused: boolean

Readonly pending

pending: boolean

Readonly speaking

speaking: boolean

Methods

addEventListener

  • addEventListener<K>(type: K, listener: ((this: internal.SpeechSynthesis, ev: SpeechSynthesisEventMap[K]) => any), options?: boolean | AddEventListenerOptions): void
  • addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void

cancel

  • cancel(): void

  • Returns void

dispatchEvent

  • dispatchEvent(event: Event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    Parameters

    • event: Event

    Returns boolean

getVoices

pause

  • pause(): void

  • Returns void

removeEventListener

  • removeEventListener<K>(type: K, listener: ((this: internal.SpeechSynthesis, ev: SpeechSynthesisEventMap[K]) => any), options?: boolean | EventListenerOptions): void
  • removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void

resume

  • resume(): void

  • Returns void

speak

Generated using TypeDoc