Class

AVSpeechSynthesizer

The AVSpeechSynthesizer class produces synthesized speech from text on an iOS device, and provides methods for controlling or monitoring the progress of ongoing speech.

Overview

To speak some amount of text, you must first create an AVSpeechUtterance instance containing the text. (Optionally, you may also use the utterance object to control parameters affecting its speech, such as voice, pitch, and rate.) Then, pass it to the speak(_:) method on a speech synthesizer instance to speak that utterance.

The speech synthesizer maintains a queue of utterances to be spoken. If the synthesizer is not currently speaking, calling speak(_:) begins speaking that utterance immediately (or begin waiting through its preUtteranceDelay if one is set). If the synthesizer is speaking, utterances are added to a queue and spoken in the order they are received.

After speech has begun, you can use the synthesizer object to pause or stop speech. After speech is paused, it may be continued from the point at which it left off; stopping ends speech entirely, removing any utterances yet to be spoken from the synthesizer’s queue.

You may monitor the speech synthesizer by examining its speaking and paused properties, or by setting a delegate. Messages in the AVSpeechSynthesizerDelegate protocol are sent as significant events occur during speech synthesis.

Symbols

Synthesizing Speech

func speak(AVSpeechUtterance)

Enqueues an utterance to be spoken.

Controlling Speech Synthesis

func continueSpeaking()

Continues speech from the point at which it left off.

func pauseSpeaking(at: AVSpeechBoundary)

Pauses speech at the specified boundary constraint.

var isPaused: Bool

A Boolean value that indicates whether speech has been paused.

var isSpeaking: Bool

A Boolean value that indicates whether the synthesizer is speaking.

func stopSpeaking(at: AVSpeechBoundary)

Stops all speech at the specified boundary constraint.

Managing the Delegate

var delegate: AVSpeechSynthesizerDelegate?

The delegate object for the speech synthesizer.

Constants

AVSpeechBoundary

Constraints describing when speech may be paused or stopped.

Relationships

Inherits From

Conforms To