Platforms to show: All Mac Windows Linux Cross-Platform

Back to WinSpeechMBS class.

WinSpeechMBS.Handle as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Speech MBS Win Plugin 3.3 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
The handle to the speech object.

If handle is 0 there is no Speech software installed.
(Read only property)

WinSpeechMBS.IsDone as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Speech MBS Win Plugin 3.3 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Returns true if the voice has finished speaking.

Lasterror is set.
(Read only property)

WinSpeechMBS.IsSpeaking as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Speech MBS Win Plugin 3.3 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Returns true if the voice is speaking.

Lasterror is set.
(Read only property)

WinSpeechMBS.Lasterror as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Speech MBS Win Plugin 3.3 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
The last error code reported.

You may get the Speech SDK from Microsoft for more details.
(Read only property)

WinSpeechMBS.Priority as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Speech MBS Win Plugin 8.1 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
The current voice priority level.

The default priority is SPVPRI_NORMAL.
Lasterror is set.

Assuming an output object which implements ISpAudio, speak requests of similar priority voices are queued, and are spoken one at a time in the order they are issued. That is, speak requests from normal priority voices are put in one queue, while speak requests from alert priority voices (with priority SPVPRI_ALERT) are put in another queue.

Alert priority voices take priority over normal voices. If one or more speak requests from alert priority voices are pending, a normal voice that is speaking will be interrupted on the next alert boundary (see ISpVoice::SetAlertBoundary). When all the queued alert priority voice speak requests have been processed, the normal voice will continue.

Voices with the SPVPRI_OVER priority speak over (mix with) all other audio in the system with no synchronization. SPVPRI_OVER priority voices only mix on Windows 2000.

If the output object does not implement ISpAudio, no serialization will occur, and all voices will be treated as if their priority is SPVPRI_OVER.
(Read and Write property)

WinSpeechMBS.Rate as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Speech MBS Win Plugin 3.3 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
The current text rendering rate adjustment.

Ranges from kMinRate to kMaxRate.
(Read and Write property)

WinSpeechMBS.SyncSpeakTimeout as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Speech MBS Win Plugin 8.1 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
The timeout interval in milliseconds after which, synchronous Speak calls to this instance of the voice will timeout.

Timeouts occur when waiting for access to the output object. This means that for a normal priority voice (see Priority for more information on priorities) and an output device which implements ISpAudio, a timeout may occur while waiting to reacquire the output object after an interruption by an alert priority voice. For voices of both normal and alert priorities, a timeout may also occur while waiting to reacquire the output object after the voice has been paused and resumed (see Pause and Resume).

Wait times are not accumulated - that is, if a voice waits for n milliseconds to initially acquire the output object, and is then paused and resumed, it will again wait for up to msTimeout milliseconds to reacquire the output object, not msTimeout - n milliseconds.
(Read and Write property)

WinSpeechMBS.Voice as WinVoiceMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Speech MBS Win Plugin 3.3 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
The current used voice.

Set to nil to use the default voice.
(Read and Write property)

WinSpeechMBS.Volume as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Speech MBS Win Plugin 3.3 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
The volume for the voice.

Ranges from kMinVolume to kMaxVolume.
(Read and Write property)

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


The biggest plugin in space...