Interface SpeechSynthesisUtterance

This Web Speech API interface represents a speech request. It contains the content the speech service should read and information about how to read it (e.g. language, pitch and volume.)

MDN Reference

Hierarchy

EventTarget
- SpeechSynthesisUtterance

Index

Properties

lang onboundary onend onerror onmark onpause onresume onstart pitch rate text voice volume

Methods

addEventListener dispatchEvent removeEventListener

Properties

lang

lang: string

MDN Reference

onboundary

onboundary: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: SpeechSynthesisUtterance
  - ev: SpeechSynthesisEvent
  Returns any

onend

onend: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: SpeechSynthesisUtterance
  - ev: SpeechSynthesisEvent
  Returns any

onerror

onerror: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: SpeechSynthesisUtterance
  - ev: SpeechSynthesisErrorEvent
  Returns any

onmark

onmark: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: SpeechSynthesisUtterance
  - ev: SpeechSynthesisEvent
  Returns any

onpause

onpause: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: SpeechSynthesisUtterance
  - ev: SpeechSynthesisEvent
  Returns any

onresume

onresume: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: SpeechSynthesisUtterance
  - ev: SpeechSynthesisEvent
  Returns any

onstart

onstart: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: SpeechSynthesisUtterance
  - ev: SpeechSynthesisEvent
  Returns any

pitch

pitch: number

MDN Reference

rate

rate: number

MDN Reference

text

text: string

MDN Reference

voice

voice: null | SpeechSynthesisVoice

MDN Reference

volume

volume: number

MDN Reference

Methods

addEventListener

addEventListener<K>(type, listener, options?): void
Type Parameters
- K extends keyof SpeechSynthesisUtteranceEventMap
Parameters
- type: K
- listener: ((this, ev) => any)
  - - (this, ev): any
    - Parameters
      this: SpeechSynthesisUtterance
      ev: SpeechSynthesisUtteranceEventMap[K]
      Returns any
- Optional options: boolean | AddEventListenerOptions
Returns void
Overrides EventTarget.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:21539
addEventListener(type, listener, options?): 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:21540

dispatchEvent

dispatchEvent(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.

MDN Reference
Parameters
- event: Event
Returns boolean
Inherited from EventTarget.dispatchEvent
- Defined in node_modules/typescript/lib/lib.dom.d.ts:8215

removeEventListener

removeEventListener<K>(type, listener, options?): void
Type Parameters
- K extends keyof SpeechSynthesisUtteranceEventMap
Parameters
- type: K
- listener: ((this, ev) => any)
  - - (this, ev): any
    - Parameters
      this: SpeechSynthesisUtterance
      ev: SpeechSynthesisUtteranceEventMap[K]
      Returns any
- Optional options: boolean | EventListenerOptions
Returns void
Overrides EventTarget.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:21541
removeEventListener(type, listener, options?): 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:21542

Interface SpeechSynthesisUtterance

Hierarchy

Index

Properties

Methods

Properties

lang

onboundary

Type declaration

Parameters

this: SpeechSynthesisUtterance

ev: SpeechSynthesisEvent

Returns any

onend

Type declaration

Parameters

this: SpeechSynthesisUtterance

ev: SpeechSynthesisEvent

Returns any

onerror

Type declaration

Parameters

this: SpeechSynthesisUtterance

ev: SpeechSynthesisErrorEvent

Returns any

onmark

Type declaration

Parameters

this: SpeechSynthesisUtterance

ev: SpeechSynthesisEvent

Returns any

onpause

Type declaration

Parameters

this: SpeechSynthesisUtterance

ev: SpeechSynthesisEvent

Returns any

onresume

Type declaration

Parameters

this: SpeechSynthesisUtterance

ev: SpeechSynthesisEvent

Returns any

onstart

Type declaration

Parameters

this: SpeechSynthesisUtterance

ev: SpeechSynthesisEvent

Returns any

pitch

rate

text

voice

volume

Methods

addEventListener

Type Parameters

K extends keyof SpeechSynthesisUtteranceEventMap

Parameters

type: K

listener: ((this, ev) => any)

Parameters

this: SpeechSynthesisUtterance

ev: SpeechSynthesisUtteranceEventMap[K]

Returns any

Optional options: boolean | AddEventListenerOptions

Returns void

Parameters

type: string

listener: EventListenerOrEventListenerObject

Optional options: boolean | AddEventListenerOptions

Returns void

dispatchEvent

Parameters

event: Event

Returns boolean

removeEventListener

Type Parameters

K extends keyof SpeechSynthesisUtteranceEventMap

Parameters

`Optional` options: boolean | AddEventListenerOptions

`Optional` options: boolean | AddEventListenerOptions

`Optional` options: boolean | EventListenerOptions

`Optional` options: boolean | EventListenerOptions