MBS Plugin Documentation

Search:

Statistics   -   FAQ   -   Plugin Parts (All, Dependencies)   -   Class hierarchie

New in Version 7.0 7.1 7.2 7.3 7.4 7.5 7.6 7.7 7.8 8.0 8.1 8.2 8.3 8.4 8.5 8.6 8.7 9.0

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

Platforms to show: All Mac Windows Linux Cross-Platform

class SpeechChannelMBS
class, Speech, MBS Mac Plugin (Speech), class SpeechChannelMBS, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: A SpeechMBS channel.
SpeechChannelMBS.close
method, Speech, MBS Mac Plugin (Speech), class SpeechChannelMBS, Plugin version: 3.4, Mac OS X: Works, 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.)
SpeechChannelMBS.ContinueSpeech as Boolean
method, Speech, MBS Mac Plugin (Speech), class SpeechChannelMBS, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Continue speaking.
Notes: Renamed from Continue to ContinueSpeech in v5.3 to fix a problem with Realbasic 2005r3.
SpeechChannelMBS.Lasterror as Integer
property, Speech, MBS Mac Plugin (Speech), class SpeechChannelMBS, Plugin version: 5.1, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The last error code.
Notes:
A Mac OS error code.
from the plugin -1 is bad parameter and 0 is success.
(Read only property)
SpeechChannelMBS.Paused as boolean
property, Speech, MBS Mac Plugin (Speech), class SpeechChannelMBS, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Are we paused?
Notes: (Read only property)
SpeechChannelMBS.PauseEndOfSentence as Boolean
method, Speech, MBS Mac Plugin (Speech), class SpeechChannelMBS, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Pauses speaking at the end of the current sentence.
SpeechChannelMBS.PauseEndOfWord as Boolean
method, Speech, MBS Mac Plugin (Speech), class SpeechChannelMBS, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Pauses speaking at the end of the current word.
SpeechChannelMBS.PauseImmediate as Boolean
method, Speech, MBS Mac Plugin (Speech), class SpeechChannelMBS, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Pauses speaking.
SpeechChannelMBS.PitchBase as double
property, Speech, MBS Mac Plugin (Speech), class SpeechChannelMBS, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The pich base used for speaking.
Notes: (Read and Write property)
SpeechChannelMBS.PitchModulation as double
property, Speech, MBS Mac Plugin (Speech), class SpeechChannelMBS, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The pich modulation used for speaking.
Notes: (Read and Write property)
SpeechChannelMBS.Playing as boolean
property, Speech, MBS Mac Plugin (Speech), class SpeechChannelMBS, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Are we playing?
Notes: (Read only property)
SpeechChannelMBS.Rate as double
property, Speech, MBS Mac Plugin (Speech), class SpeechChannelMBS, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The rate used for speaking.
Notes:
Normally around 175 words/minute.
(Read and Write property)
SpeechChannelMBS.Reset
method, Speech, MBS Mac Plugin (Speech), class SpeechChannelMBS, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Resets the SpeechMBS channel to some default values.
Notes: Resets e.g. pitchbase, pitchmodulation, volume, rate.
SpeechChannelMBS.SetOutputFile(file as folderitem) as boolean
method, Speech, MBS Mac Plugin (Speech), class SpeechChannelMBS, Plugin version: 4.1, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Sets the destination file.
Notes:
Returns true on success and false on any error.
Requires Mac OS X 10.3.
SpeechChannelMBS.Speak(s as string) as Boolean
method, Speech, MBS Mac Plugin (Speech), class SpeechChannelMBS, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Speak the given text.
Notes: v5.1: Now encoding safe and stores result in lasterror property.
SpeechChannelMBS.SpeakCharactersLiteral as Boolean
property, Speech, MBS Mac Plugin (Speech), class SpeechChannelMBS, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: whether to speak characters literal.
Notes:
Speaks Hello like "H-E-L-L-O"
(Read and Write property)
SpeechChannelMBS.SpeakNumbersLiteral as Boolean
property, Speech, MBS Mac Plugin (Speech), class SpeechChannelMBS, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: whether to speak numbers literal.
Notes:
Speaks 11 not like "elven", but like "one, one".
(Read and Write property)
SpeechChannelMBS.SpeechBusy as integer
method, Speech, MBS Mac Plugin (Speech), class SpeechChannelMBS, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Returns how much SpeechChannels are currently in use of you application.
SpeechChannelMBS.SpeechBusySystemWide as integer
method, Speech, MBS Mac Plugin (Speech), class SpeechChannelMBS, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Returns how much SpeechChannels are currently in use on this Mac.
SpeechChannelMBS.Stop as Boolean
method, Speech, MBS Mac Plugin (Speech), class SpeechChannelMBS, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Stops speaking.
SpeechChannelMBS.StopEndOfSentence as Boolean
method, Speech, MBS Mac Plugin (Speech), class SpeechChannelMBS, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Stops speaking at the end of the current sentence.
SpeechChannelMBS.StopEndOfWord as Boolean
method, Speech, MBS Mac Plugin (Speech), class SpeechChannelMBS, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Stops speaking at the end of the current word.
SpeechChannelMBS.StopImmediate as Boolean
method, Speech, MBS Mac Plugin (Speech), class SpeechChannelMBS, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Stops speaking.
SpeechChannelMBS.TextBytesToSpeak as integer
property, Speech, MBS Mac Plugin (Speech), class SpeechChannelMBS, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: How much text is left in the text buffer?
Notes: (Read only property)
SpeechChannelMBS.Voice as VoiceMBS
property, Speech, MBS Mac Plugin (Speech), class SpeechChannelMBS, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The VoiceMBS used for that SpeechChannelMBS.
Notes: (Read and Write property)
SpeechChannelMBS.Volume as double
property, Speech, MBS Mac Plugin (Speech), class SpeechChannelMBS, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The current volume.
Notes:
From 0 to 65535.
(Read and Write property)

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