Monkeybread Xojo plugin - WinSpeechMBS methods

WinSpeechMBS.close

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Speech	MBS Win Plugin	3.4	❌ No	✅ Yes	❌ No	❌ No	Desktop, Console & Web

The destructor.

There is no need to call this method except you want to free all resources of this object now without waiting for Xojo to do it for you.

WinSpeechMBS.DisplayUI(type as string, title as string, parent as DesktopWindow)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Speech	MBS Win Plugin	22.0	❌ No	✅ Yes	❌ No	❌ No	Desktop only

Displays the UI from the underlying text-to-speech engine's object token.

Type specifies which UI you want.
Title is optional the title of the window.
You can optionally specify a parent window.
Lasterror is set.

Some examples using this method:

WinSpeechMBS.NextVoice as WinVoiceMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Speech	MBS Win Plugin	3.3	❌ No	✅ Yes	❌ No	❌ No	Desktop, Console & Web

Returns the next voice in the list.

Returns nil on the end of the list.

Some examples using this method:

WinSpeechMBS.Pause

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Speech	MBS Win Plugin	3.3	❌ No	✅ Yes	❌ No	❌ No	Desktop, Console & Web

Pauses speech.

WinSpeechMBS.Resume

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Speech	MBS Win Plugin	3.3	❌ No	✅ Yes	❌ No	❌ No	Desktop, Console & Web

Resumes speech.

WinSpeechMBS.Skip(sentenceCount as Integer) as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Speech	MBS Win Plugin	8.1	❌ No	✅ Yes	❌ No	❌ No	Desktop, Console & Web

Causes the voice to skip forward or backward the specified number of items within the text of the current speak call.

sentenceCount is the number of sentences to skip. If negative, you skip backward.
Returns the actual number of items skipped.
Lasterror is set.

WinSpeechMBS.Speak(text as string, Purge as Boolean = false, ContainsXML as boolean = false)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Speech	MBS Win Plugin	3.3	❌ No	✅ Yes	❌ No	❌ No	Desktop, Console & Web

Speaks a string.

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.

If ContainsXML is true, you can include xml commands in the text. See MSDN page:
http://msdn.microsoft.com/en-us/library/ms717077%28v=vs.85%29.aspx

WinSpeechMBS.SpeakFile(file as folderitem, unicodestring as string, AudioFormat as Integer = 0, ContainsXML as boolean = false)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Speech	MBS Win Plugin	4.1	❌ No	✅ Yes	❌ No	❌ No	Desktop, Console & Web

Speaks a string to a file.

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.

For AudioFormat, please use kAudioFormat* constants. Default is 22Khz Mono which is default format for speech API.

If ContainsXML is true, you can include xml commands in the text. See MSDN page:
http://msdn.microsoft.com/en-us/library/ms717077%28v=vs.85%29.aspx

Some examples using this method:

WinSpeechMBS.WaitUntilDone(msTimeout as Integer)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Speech	MBS Win Plugin	8.1	❌ No	✅ Yes	❌ No	❌ No	Desktop, Console & Web

Blocks the caller until either the voice has completed speaking or the specified time interval has elapsed.

msTimeout: Timeout period in milliseconds. INFINITE may be used to prevent this method from timing out.

INFINITE is -1.

Lasterror is set.