AVSpeechUtteranceMBS properties

Online Documentation   -   Statistics   -   FAQ   -   Plugin Parts (All, Dependencies)   -   Class hierarchy

New in Version 22.2 22.3 22.4 22.5 23.0 23.1 23.2 23.3 23.4 23.5 24.0 24.1

The list of the   topics,   classes,   interfaces,   controls,   modules,   global methods by category,   global methods by name,   screenshots,   licenses   and   examples.

Platforms to show: All Mac Windows Linux Cross-Platform

Back to AVSpeechUtteranceMBS class.

AVSpeechUtteranceMBS.attributedSpeechString as NSAttributedStringMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Speech MBS AVFoundation Plugin 24.1 ✅ Yes ❌ No ❌ No ✅ Yes All
An attributed string that contains the text for speech synthesis.

You can’t change an utterance’s text after initializaiton. If you want the speech synthesizer to speak different text, create a new utterance.
(Read only property)

AVSpeechUtteranceMBS.Handle as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Speech MBS AVFoundation Plugin 24.1 ✅ Yes ❌ No ❌ No ✅ Yes All
The internal object reference.

(Read and Write property)

AVSpeechUtteranceMBS.pitchMultiplier as Single

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Speech MBS AVFoundation Plugin 24.1 ✅ Yes ❌ No ❌ No ✅ Yes All
The baseline pitch the speech synthesizer uses when speaking the utterance.

Before enqueing the utterance, set this property to a value within the range of 0.5 for lower pitch to 2.0 for higher pitch. The default value is 1.0. Setting this after enqueing the utterance has no effect.
(Read and Write property)

AVSpeechUtteranceMBS.postUtteranceDelay as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Speech MBS AVFoundation Plugin 24.1 ✅ Yes ❌ No ❌ No ✅ Yes All
The amount of time the speech synthesizer pauses after speaking an utterance before handling the next utterance in the queue.

When multiple utterances exist in the queue, the speech synthesizer pauses a minimum amount of time equal to the sum of the current utterance’s postUtteranceDelay and the next utterance’s preUtteranceDelay.
(Read and Write property)

AVSpeechUtteranceMBS.prefersAssistiveTechnologySettings as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Speech MBS AVFoundation Plugin 24.1 ✅ Yes ❌ No ❌ No ✅ Yes All
A Boolean that specifies whether assistive technology settings take precedence over the property values of this utterance.

If this property is true, but no assistive technology, such as VoiceOver, is on, the speech synthesizer uses the utterance property values.
(Read and Write property)

AVSpeechUtteranceMBS.preUtteranceDelay as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Speech MBS AVFoundation Plugin 24.1 ✅ Yes ❌ No ❌ No ✅ Yes All
The amount of time the speech synthesizer pauses before speaking the utterance.

When multiple utterances exist in the queue, the speech synthesizer pauses a minimum amount of time equal to the sum of the current utterance’s postUtteranceDelay and the next utterance’s preUtteranceDelay.
(Read and Write property)

AVSpeechUtteranceMBS.rate as Single

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Speech MBS AVFoundation Plugin 24.1 ✅ Yes ❌ No ❌ No ✅ Yes All
The rate the speech synthesizer uses when speaking the utterance.

The speech rate is a decimal representation within the range of AVSpeechUtteranceMinimumSpeechRate and AVSpeechUtteranceMaximumSpeechRate. Lower values correspond to slower speech, and higher values correspond to faster speech. The default value is AVSpeechUtteranceDefaultSpeechRate. Set this property before enqueing the utterance because setting it afterward has no effect.
(Read and Write property)

AVSpeechUtteranceMBS.speechString as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Speech MBS AVFoundation Plugin 24.1 ✅ Yes ❌ No ❌ No ✅ Yes All
A string that contains the text for speech synthesis.

You can’t change an utterance’s text after initializaiton. If you want the speech synthesizer to speak different text, create a new utterance.
(Read only property)

AVSpeechUtteranceMBS.voice as AVSpeechSynthesisVoiceMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Speech MBS AVFoundation Plugin 24.1 ✅ Yes ❌ No ❌ No ✅ Yes All
The voice the speech synthesizer uses when speaking the utterance.

If you don’t specify a voice, the speech synthesizer uses the system’s default voice to speak the utterance.
(Read and Write property)

AVSpeechUtteranceMBS.volume as Single

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Speech MBS AVFoundation Plugin 24.1 ✅ Yes ❌ No ❌ No ✅ Yes All
The volume the speech synthesizer uses when speaking the utterance.

Before enqueing the utterance, set this property to a value within the range of 0.0 for silent to 1.0 for loudest volume. The default value is 1.0. Setting this after enqueing the utterance has no effect.
(Read and Write property)

The items on this page are in the following plugins: MBS AVFoundation Plugin.


💬 Ask a question or report a problem