class WinSpeechMBS
class, Speech, MBS Win Plugin (WinSpeech), class WinSpeechMBS, Plugin version: 3.3, Mac OS X: Does nothing, Windows: Works, Linux x86: Does nothing, Feedback.

Function: A class for speech on Windows.
Notes: You need to install the "Microsoft Reader" to get this working.

WinSpeechMBS.close
method, Speech, MBS Win Plugin (WinSpeech), class WinSpeechMBS, Plugin version: 3.4, Mac OS X: Does nothing, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The destructor.
Notes:
There is no need to call this method except you want to free all resources of this object now without waiting for Realbasic to do it for you.
(e.g. some Realbasic versions crash on Windows if there are plugin objects not closed.)

WinSpeechMBS.DisplayUI(type as string, title as string="", parent as window=nil)
method, Speech, MBS Win Plugin (WinSpeech), class WinSpeechMBS, Plugin version: 8.1, Mac OS X: Does nothing, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Displays the UI from the underlying text-to-speech engine's object token.
Notes:
Type specifies which UI you want.
Title is optional the title of the window.
You can optionally specify a parent window.
Lasterror is set.

WinSpeechMBS.Handle as Integer
property, Speech, MBS Win Plugin (WinSpeech), class WinSpeechMBS, Plugin version: 3.3, Mac OS X: Does nothing, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The handle to the speech object.
Notes:
If handle is 0 there is no Speech software installed.
(Read only property)

WinSpeechMBS.IsDone as Boolean
property, Speech, MBS Win Plugin (WinSpeech), class WinSpeechMBS, Plugin version: 3.3, Mac OS X: Does nothing, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Returns true if the voice has finished speaking.
Notes:
Lasterror is set.
(Read only property)

WinSpeechMBS.IsSpeaking as Boolean
property, Speech, MBS Win Plugin (WinSpeech), class WinSpeechMBS, Plugin version: 3.3, Mac OS X: Does nothing, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Returns true if the voice is speaking.
Notes:
Lasterror is set.
(Read only property)

WinSpeechMBS.IsUISupported(type as string) as boolean
method, Speech, MBS Win Plugin (WinSpeech), class WinSpeechMBS, Plugin version: 8.1, Mac OS X: Does nothing, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Checks if the underlying text-to-speech engine's object token supports the requested UI.
Notes:
Returns whether the specified UI is supported. True indicates the UI is supported, and false indicates the UI is not supported.
Lasterror is set.

WinSpeechMBS.kMaxRate as Integer
property, Speech, MBS Win Plugin (WinSpeech), class WinSpeechMBS, Plugin version: 3.3, Mac OS X: Does nothing, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The maximum for the rate property.
Notes: (Read only property)

WinSpeechMBS.kMaxVolume as Integer
property, Speech, MBS Win Plugin (WinSpeech), class WinSpeechMBS, Plugin version: 3.3, Mac OS X: Does nothing, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The maximum for the volume property.
Notes: (Read only property)

WinSpeechMBS.kMinRate as Integer
property, Speech, MBS Win Plugin (WinSpeech), class WinSpeechMBS, Plugin version: 3.3, Mac OS X: Does nothing, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The minimum for the rate property.
Notes: (Read only property)

WinSpeechMBS.kMinVolume as Integer
property, Speech, MBS Win Plugin (WinSpeech), class WinSpeechMBS, Plugin version: 3.3, Mac OS X: Does nothing, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The minimum for the volume property.
Notes: (Read only property)

WinSpeechMBS.Lasterror as Integer
property, Speech, MBS Win Plugin (WinSpeech), class WinSpeechMBS, Plugin version: 3.3, Mac OS X: Does nothing, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The last error code reported.
Notes:
You may get the Speech SDK from Microsoft for more details.
(Read only property)

WinSpeechMBS.ListVoices as boolean
method, Speech, MBS Win Plugin (WinSpeech), class WinSpeechMBS, Plugin version: 3.3, Mac OS X: Does nothing, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Makes a list of voices which is later returned using the NextVoice function.

WinSpeechMBS.NextVoice as WinVoiceMBS
method, Speech, MBS Win Plugin (WinSpeech), class WinSpeechMBS, Plugin version: 3.3, Mac OS X: Does nothing, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Returns the next voice in the list.
Notes: Returns nil on the end of the list.

WinSpeechMBS.Pause
method, Speech, MBS Win Plugin (WinSpeech), class WinSpeechMBS, Plugin version: 3.3, Mac OS X: Does nothing, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Pauses speech.

WinSpeechMBS.Priority as Integer
property, Speech, MBS Win Plugin (WinSpeech), class WinSpeechMBS, Plugin version: 8.1, Mac OS X: Does nothing, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The current voice priority level.
Notes:
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.PriorityAlert = 1
const, Speech, MBS Win Plugin (WinSpeech), class WinSpeechMBS, Plugin version: 8.1, Mac OS X: Does nothing, Windows: Works, Linux x86: Does nothing, Feedback.

Function: One of the priority constants.

WinSpeechMBS.PriorityNormal = 0
const, Speech, MBS Win Plugin (WinSpeech), class WinSpeechMBS, Plugin version: 8.1, Mac OS X: Does nothing, Windows: Works, Linux x86: Does nothing, Feedback.

Function: One of the priority constants.

WinSpeechMBS.PriorityOver = 2
const, Speech, MBS Win Plugin (WinSpeech), class WinSpeechMBS, Plugin version: 8.1, Mac OS X: Does nothing, Windows: Works, Linux x86: Does nothing, Feedback.

Function: One of the priority constants.

WinSpeechMBS.Rate as Integer
property, Speech, MBS Win Plugin (WinSpeech), class WinSpeechMBS, Plugin version: 3.3, Mac OS X: Does nothing, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The current text rendering rate adjustment.
Notes:
Ranges from kMinRate to kMaxRate.
(Read and Write property)

WinSpeechMBS.Resume
method, Speech, MBS Win Plugin (WinSpeech), class WinSpeechMBS, Plugin version: 3.3, Mac OS X: Does nothing, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Resumes speech.

WinSpeechMBS.Skip(sentenceCount as integer) as integer
method, Speech, MBS Win Plugin (WinSpeech), class WinSpeechMBS, Plugin version: 8.1, Mac OS X: Does nothing, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Causes the voice to skip forward or backward the specified number of items within the text of the current speak call.
Notes:
sentenceCount is the number of sentences to skip. If negative, you skip backward.
Returns the actual number of items skipped.
Lasterror is set.

WinSpeechMBS.SPDUI_AddRemoveWord = "AddRemoveWord"
const, Speech, MBS Win Plugin (WinSpeech), class WinSpeechMBS, Plugin version: 8.1, Mac OS X: Does nothing, Windows: Works, Linux x86: Does nothing, Feedback.

Function: One of the constants for the User Intefaces used with IsUISupported and DisplayUI.

WinSpeechMBS.SPDUI_AudioProperties = "AudioProperties"
const, Speech, MBS Win Plugin (WinSpeech), class WinSpeechMBS, Plugin version: 8.1, Mac OS X: Does nothing, Windows: Works, Linux x86: Does nothing, Feedback.

Function: One of the constants for the User Intefaces used with IsUISupported and DisplayUI.

WinSpeechMBS.SPDUI_AudioVolume = "AudioVolume"
const, Speech, MBS Win Plugin (WinSpeech), class WinSpeechMBS, Plugin version: 8.1, Mac OS X: Does nothing, Windows: Works, Linux x86: Does nothing, Feedback.

Function: One of the constants for the User Intefaces used with IsUISupported and DisplayUI.

WinSpeechMBS.SPDUI_EngineProperties = "EngineProperties"
const, Speech, MBS Win Plugin (WinSpeech), class WinSpeechMBS, Plugin version: 8.1, Mac OS X: Does nothing, Windows: Works, Linux x86: Does nothing, Feedback.

Function: One of the constants for the User Intefaces used with IsUISupported and DisplayUI.

WinSpeechMBS.SPDUI_MicTraining = "MicTraining"
const, Speech, MBS Win Plugin (WinSpeech), class WinSpeechMBS, Plugin version: 8.1, Mac OS X: Does nothing, Windows: Works, Linux x86: Does nothing, Feedback.

Function: One of the constants for the User Intefaces used with IsUISupported and DisplayUI.

WinSpeechMBS.SPDUI_RecoProfileProperties = "RecoProfileProperties"
const, Speech, MBS Win Plugin (WinSpeech), class WinSpeechMBS, Plugin version: 8.1, Mac OS X: Does nothing, Windows: Works, Linux x86: Does nothing, Feedback.

Function: One of the constants for the User Intefaces used with IsUISupported and DisplayUI.

WinSpeechMBS.SPDUI_UserTraining = "UserTraining"
const, Speech, MBS Win Plugin (WinSpeech), class WinSpeechMBS, Plugin version: 8.1, Mac OS X: Does nothing, Windows: Works, Linux x86: Does nothing, Feedback.

Function: One of the constants for the User Intefaces used with IsUISupported and DisplayUI.

WinSpeechMBS.Speak(unicodestring as string, Purge as Boolean=false)
method, Speech, MBS Win Plugin (WinSpeech), class WinSpeechMBS, Plugin version: 3.3, Mac OS X: Does nothing, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Speaks a string.
Notes:
The string must be a 16bit unicode string.

Version 7.8 of the plugins convert to unicode automatically.

If Purge is true an existing speech will be stopped.

WinSpeechMBS.SpeakFile(file as folderitem, unicodestring as string)
method, Speech, MBS Win Plugin (WinSpeech), class WinSpeechMBS, Plugin version: 4.1, Mac OS X: Does nothing, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Speaks a string to a file.
Notes:
The string must be a 16bit unicode string.
File is a valid folderitem where the WAV file is stored.
The function will not return before the speaking is complete.
Lasterror is set.

Version 7.8 of the plugins convert to unicode automatically.

WinSpeechMBS.SyncSpeakTimeout as Integer
property, Speech, MBS Win Plugin (WinSpeech), class WinSpeechMBS, Plugin version: 8.1, Mac OS X: Does nothing, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The timeout interval in milliseconds after which, synchronous Speak calls to this instance of the voice will timeout.
Notes:
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
property, Speech, MBS Win Plugin (WinSpeech), class WinSpeechMBS, Plugin version: 3.3, Mac OS X: Does nothing, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The current used voice.
Notes:
Set to nil to use the default voice.
(Read and Write property)

WinSpeechMBS.Volume as Integer
property, Speech, MBS Win Plugin (WinSpeech), class WinSpeechMBS, Plugin version: 3.3, Mac OS X: Does nothing, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The volume for the voice.
Notes:
Ranges from kMinVolume to kMaxVolume.
(Read and Write property)

WinSpeechMBS.WaitUntilDone(msTimeout as integer)
method, Speech, MBS Win Plugin (WinSpeech), class WinSpeechMBS, Plugin version: 8.1, Mac OS X: Does nothing, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Blocks the caller until either the voice has completed speaking or the specified time interval has elapsed.
Notes:
msTimeout: Timeout period in milliseconds. INFINITE may be used to prevent this method from timing out.

INFINITE is -1.

Lasterror is set.