Platforms to show: All Mac Windows Linux Cross-Platform
Back to WinSpeechMBS class.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Speech | MBS Win Plugin | 3.4 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
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 |
Type specifies which UI you want.
Title is optional the title of the window.
You can optionally specify a parent window.
Lasterror is set.
See also:
WinSpeechMBS.DisplayUI(type as string, title as string, parent as window)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Speech | MBS Win Plugin | 8.1 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop only |
Type specifies which UI you want.
Title is optional the title of the window.
You can optionally specify a parent window.
Lasterror is set.
See also:
WinSpeechMBS.DisplayUI(type as string, title as string="")
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Speech | MBS Win Plugin | 8.1 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop only |
Type specifies which UI you want.
Title is optional the title of the window.
You can optionally specify a parent window.
Lasterror is set.
See also:
WinSpeechMBS.IsUISupported(type as string) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Speech | MBS Win Plugin | 8.1 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
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.ListVoices as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Speech | MBS Win Plugin | 3.3 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
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 nil on the end of the list.
Some examples using this method:
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Speech | MBS Win Plugin | 3.3 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Speech | MBS Win Plugin | 3.3 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
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 |
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 |
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 |
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 |
msTimeout: Timeout period in milliseconds. INFINITE may be used to prevent this method from timing out.
INFINITE is -1.
Lasterror is set.
The items on this page are in the following plugins: MBS Win Plugin.