AVSpeechSynthesizerMBS.Constructor

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Speech	MBS AVFoundation Plugin	24.1	✅ Yes	❌ No	❌ No	✅ Yes	All

The constructor.

AVSpeechSynthesizerMBS.continueSpeaking as Boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Speech	MBS AVFoundation Plugin	24.1	✅ Yes	❌ No	❌ No	✅ Yes	All

Resumes speech from its paused point.

Returns true if speech resumes; otherwise, false.

This method only has an effect if the speech synthesizer is in a paused state.

AVSpeechSynthesizerMBS.Destructor

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Speech	MBS AVFoundation Plugin	24.1	✅ Yes	❌ No	❌ No	✅ Yes	All

The destructor.

AVSpeechSynthesizerMBS.pauseSpeakingAtBoundary(SpeechBoundary as Integer) as Boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Speech	MBS AVFoundation Plugin	24.1	✅ Yes	❌ No	❌ No	✅ Yes	All

Pauses speech at the boundary you specify.

boundary: An enumeration that describes whether to pause speech immediately or only after the synthesizer finishes speaking the current word.

Returns true if speech pauses; otherwise, false.

The boundary parameter also affects how the speech synthesizer resumes speaking text after a pause and call to continueSpeaking. If the boundary is SpeechBoundaryImmediate, speech resumes from the exact point where it pauses, even if that point occurs in the middle of speaking a word. If the boundary is SpeechBoundaryWord, speech resumes from the word that follows the last spoken word where it pauses.

AVSpeechSynthesizerMBS.requestPersonalVoiceAuthorization

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Speech	MBS AVFoundation Plugin	24.1	✅ Yes	❌ No	❌ No	✅ Yes	All

Prompts the user to authorize your app to use personal voices.

AVSpeechSynthesizerMBS.speakUtterance(utterance as AVSpeechUtteranceMBS)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Speech	MBS AVFoundation Plugin	24.1	✅ Yes	❌ No	❌ No	✅ Yes	All

Adds the utterance you specify to the speech synthesizer’s queue.

utterance: An AVSpeechUtteranceMBS instance that contains text to speak.
Discussion

Warning: Attempting to enqueue the same utterance more than once throws an exception.

Some examples using this method:

• /AVFoundation/AVSpeechSynthesis

AVSpeechSynthesizerMBS.stopSpeakingAtBoundary(SpeechBoundary as Integer) as Boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Speech	MBS AVFoundation Plugin	24.1	✅ Yes	❌ No	❌ No	✅ Yes	All

Stops speech at the boundary you specify.

boundary: An enumeration that describes whether to stop speech immediately or only after the synthesizer finishes speaking the current word.

Returns true if speech stops; otherwise, false.

Unlike pausing a speech synthesizer, which can resume after a pause, stopping the synthesizer immediately cancels speech and removes all unspoken utterances from the synthesizer’s queue.

AVSpeechSynthesizerMBS.writeUtterance(utterance as AVSpeechUtteranceMBS)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Speech	MBS AVFoundation Plugin	24.1	✅ Yes	❌ No	❌ No	✅ Yes	All

Generates speech for the utterance and invokes the callback with the audio buffer.

utterance: The utterance for synthesizing speech.

Call this method to receive audio buffers to store or further process synthesized speech.

Calls SpeechSynthesizerBuffer and SpeechSynthesizerMarker events later.