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

onvoiceschanged paused pending speaking

Methods

addEventListener cancel dispatchEvent getVoices pause removeEventListener resume speak

Properties

onvoiceschanged

onvoiceschanged: ((this: SpeechSynthesis, ev: Event) => any)

Type declaration

- (this: SpeechSynthesis, ev: Event): any
- Parameters
  - this: SpeechSynthesis
  - ev: Event
  Returns any

`Readonly` paused

paused: boolean

`Readonly` pending

pending: boolean

`Readonly` speaking

speaking: boolean

Methods

addEventListener

addEventListener<K>(type: K, listener: ((this: SpeechSynthesis, ev: SpeechSynthesisEventMap[K]) => any), options?: boolean | AddEventListenerOptions): void
Type Parameters
- K extends "voiceschanged"
Parameters
- type: K
- listener: ((this: SpeechSynthesis, ev: SpeechSynthesisEventMap[K]) => any)
  - - (this: SpeechSynthesis, ev: SpeechSynthesisEventMap[K]): any
    - Parameters
      
      this: SpeechSynthesis
      
      ev: SpeechSynthesisEventMap[K]
      
      Returns any
- Optional options: boolean | AddEventListenerOptions
Returns void
Overrides EventTarget.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:13861
addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void
Overrides EventTarget.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:13862

cancel

cancel(): void
Returns void
- Defined in node_modules/typescript/lib/lib.dom.d.ts:13856

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
Inherited from EventTarget.dispatchEvent
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5309

getVoices

getVoices(): SpeechSynthesisVoice[]
Returns SpeechSynthesisVoice[]
- Defined in node_modules/typescript/lib/lib.dom.d.ts:13857

pause

pause(): void
Returns void
- Defined in node_modules/typescript/lib/lib.dom.d.ts:13858

removeEventListener

removeEventListener<K>(type: K, listener: ((this: SpeechSynthesis, ev: SpeechSynthesisEventMap[K]) => any), options?: boolean | EventListenerOptions): void
Type Parameters
- K extends "voiceschanged"
Parameters
- type: K
- listener: ((this: SpeechSynthesis, ev: SpeechSynthesisEventMap[K]) => any)
  - - (this: SpeechSynthesis, ev: SpeechSynthesisEventMap[K]): any
    - Parameters
      
      this: SpeechSynthesis
      
      ev: SpeechSynthesisEventMap[K]
      
      Returns any
- Optional options: boolean | EventListenerOptions
Returns void
Overrides EventTarget.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:13863
removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | EventListenerOptions
Returns void
Overrides EventTarget.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:13864

resume

resume(): void
Returns void
- Defined in node_modules/typescript/lib/lib.dom.d.ts:13859

speak

speak(utterance: SpeechSynthesisUtterance): void
Parameters
- utterance: SpeechSynthesisUtterance
Returns void
- Defined in node_modules/typescript/lib/lib.dom.d.ts:13860

Interface SpeechSynthesis

Hierarchy

Index

Properties

Methods

Properties

onvoiceschanged

Type declaration

Parameters

this: SpeechSynthesis

ev: Event

Returns any

Readonly paused

Readonly pending

Readonly speaking

Methods

addEventListener

Type Parameters

K extends "voiceschanged"

Parameters

type: K

listener: ((this: SpeechSynthesis, ev: SpeechSynthesisEventMap[K]) => any)

Parameters

this: SpeechSynthesis

ev: SpeechSynthesisEventMap[K]

Returns any

Optional options: boolean | AddEventListenerOptions

Returns void

Parameters

type: string

listener: EventListenerOrEventListenerObject

Optional options: boolean | AddEventListenerOptions

Returns void

cancel

Returns void

dispatchEvent

Parameters

event: Event

Returns boolean

getVoices

Returns SpeechSynthesisVoice[]

pause

Returns void

removeEventListener

Type Parameters

K extends "voiceschanged"

Parameters

type: K

listener: ((this: SpeechSynthesis, ev: SpeechSynthesisEventMap[K]) => any)

Parameters

this: SpeechSynthesis

ev: SpeechSynthesisEventMap[K]

Returns any

Optional options: boolean | EventListenerOptions

Returns void

Parameters

type: string

listener: EventListenerOrEventListenerObject

Optional options: boolean | EventListenerOptions

Returns void

resume

Returns void

speak

Parameters

utterance: SpeechSynthesisUtterance

Returns void

Settings

Member Visibility

Theme

`Readonly` paused

`Readonly` pending

`Readonly` speaking

`Optional` options: boolean | AddEventListenerOptions

`Optional` options: boolean | AddEventListenerOptions

`Optional` options: boolean | EventListenerOptions

`Optional` options: boolean | EventListenerOptions