NSSpeechSynthesizerMBS.attributesForVoice(voice as String) as NSVoiceMBS
shared method, Speech, MBS Cocoa Plugin (NSSpeechSynthesizer), class NSSpeechSynthesizerMBS, Console safe, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Returns information about a voice or nil.
Notes: Shared Methods require Realbasic 2006r4 or newer. In older REALbasic versions this function is available with the name NSSpeechSynthesizerMBS_attributesForVoice(voice as String) as NSVoiceMBS.

NSSpeechSynthesizerMBS.availableVoice(index as integer) as String
shared method, Speech, MBS Cocoa Plugin (NSSpeechSynthesizer), class NSSpeechSynthesizerMBS, Console safe, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Returns name of a voice.
Notes:
The available voices can be listed using this function.
Index is from 0 to count-1.
Shared Methods require Realbasic 2006r4 or newer. In older REALbasic versions this function is available with the name NSSpeechSynthesizerMBS_availableVoice(index as integer) as String.

NSSpeechSynthesizerMBS.availableVoicesCount as integer
shared method, Speech, MBS Cocoa Plugin (NSSpeechSynthesizer), class NSSpeechSynthesizerMBS, Console safe, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Number of voices available.
Notes: Shared Methods require Realbasic 2006r4 or newer. In older REALbasic versions this function is available with the name NSSpeechSynthesizerMBS_availableVoicesCount as integer.

class NSSpeechSynthesizerMBS
class, Speech, MBS Cocoa Plugin (NSSpeechSynthesizer), class NSSpeechSynthesizerMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The class to handle the cocoa speech synthesizing.
Notes: Available in Mac OS X v10.3 and later.

NSSpeechSynthesizerMBS.Constructor
method, Speech, MBS Cocoa Plugin (NSSpeechSynthesizer), class NSSpeechSynthesizerMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Initializes the class with the default voice.
Notes:
This constructor is needed for the events to fire.
The given voice must be valid!

NSSpeechSynthesizerMBS.Constructor(voice as string)
method, Speech, MBS Cocoa Plugin (NSSpeechSynthesizer), class NSSpeechSynthesizerMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Initializes the class with a voice.
Notes: This constructor is needed for the events to fire.

NSSpeechSynthesizerMBS.continueSpeaking
method, Speech, MBS Cocoa Plugin (NSSpeechSynthesizer), class NSSpeechSynthesizerMBS, Console safe, Plugin version: 7.7, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Continues speaking after it has been paused.
Notes: Mac OS X 10.5 only.

NSSpeechSynthesizerMBS.defaultVoice as String
shared method, Speech, MBS Cocoa Plugin (NSSpeechSynthesizer), class NSSpeechSynthesizerMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Provides the identifier of the default voice.
Example:

dim s as NSSpeechSynthesizerMBS

s=new NSSpeechSynthesizerMBS

MsgBox s.defaultVoice

Notes: Shared Methods require Realbasic 2006r4 or newer. In older REALbasic versions this function is available with the name NSSpeechSynthesizerMBS_defaultVoice as String.

NSSpeechSynthesizerMBS.didEncounterErrorAtIndex(characterIndex as integer, text as string, message as string)
event, Speech, MBS Cocoa Plugin (NSSpeechSynthesizer), class NSSpeechSynthesizerMBS, Plugin version: 7.7, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: An event called when an error has been found in the text while speaking.
Notes: Mac OS X 10.5 only.

NSSpeechSynthesizerMBS.didEncounterSyncMessage(message as string)
event, Speech, MBS Cocoa Plugin (NSSpeechSynthesizer), class NSSpeechSynthesizerMBS, Plugin version: 7.7, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: A sync message was found in the text.
Notes:
See Apple Speech documentation about the special tags you need to place in the text to get this event.
Mac OS X 10.5 only.

NSSpeechSynthesizerMBS.didFinishSpeaking(finishedSpeaking as boolean)
event, Speech, MBS Cocoa Plugin (NSSpeechSynthesizer), class NSSpeechSynthesizerMBS, Plugin version: 6.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Called when speaking through the sound output device is done.
Notes: finishedSpeaking is true when finished normally and false when StopSpeaking was called.

NSSpeechSynthesizerMBS.isAnyApplicationSpeaking as boolean
shared method, Speech, MBS Cocoa Plugin (NSSpeechSynthesizer), class NSSpeechSynthesizerMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Indicates whether any other application is currently speaking through the sound output device.
Notes: Shared Methods require Realbasic 2006r4 or newer. In older REALbasic versions this function is available with the name NSSpeechSynthesizerMBS_isAnyApplicationSpeaking as boolean.

NSSpeechSynthesizerMBS.IsSpeaking as boolean
method, Speech, MBS Cocoa Plugin (NSSpeechSynthesizer), class NSSpeechSynthesizerMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Indicates whether the receiver is currently generating synthesized speech.
Notes: true when the receiver is generating synthesized speech, false otherwise.

NSSpeechSynthesizerMBS.NSSpeechImmediateBoundary=0
const, Speech, MBS Cocoa Plugin (NSSpeechSynthesizer), class NSSpeechSynthesizerMBS, Plugin version: 7.7, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: One of the constants for the pauseSpeakingAtBoundary method.
Notes: Mac OS X 10.5 only.

NSSpeechSynthesizerMBS.NSSpeechSentenceBoundary=2
const, Speech, MBS Cocoa Plugin (NSSpeechSynthesizer), class NSSpeechSynthesizerMBS, Plugin version: 7.7, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: One of the constants for the pauseSpeakingAtBoundary method.
Notes: Mac OS X 10.5 only.

NSSpeechSynthesizerMBS.NSSpeechWordBoundary=1
const, Speech, MBS Cocoa Plugin (NSSpeechSynthesizer), class NSSpeechSynthesizerMBS, Plugin version: 7.7, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: One of the constants for the pauseSpeakingAtBoundary method.
Notes: Mac OS X 10.5 only.

NSSpeechSynthesizerMBS.pauseSpeakingAtBoundary(boundary as integer)
method, Speech, MBS Cocoa Plugin (NSSpeechSynthesizer), class NSSpeechSynthesizerMBS, Console safe, Plugin version: 7.7, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Pauses the speaking on the given boundary.
Example:

s.pauseSpeakingAtBoundary NSSpeechSentenceBoundary // pause on end of sentence.

Notes:
Mac OS X 10.5 only.
boundary can be NSSpeechImmediateBoundary, NSSpeechSentenceBoundary or NSSpeechWordBoundary.

NSSpeechSynthesizerMBS.phonemesFromText(text as string) as string
method, Speech, MBS Cocoa Plugin (NSSpeechSynthesizer), class NSSpeechSynthesizerMBS, Console safe, Plugin version: 7.7, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Returns the phonems from a given text.
Example:

dim s as new NSSpeechSynthesizerMBS

MsgBox s.phonemesFromText("Hello")

// shows "_hEHl1OW."

Notes: Mac OS X 10.5 only.

NSSpeechSynthesizerMBS.rate as double
method, Speech, MBS Cocoa Plugin (NSSpeechSynthesizer), class NSSpeechSynthesizerMBS, Console safe, Plugin version: 7.7, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The current rate of the speech.
Example:

dim s as NSSpeechSynthesizerMBS
s=new NSSpeechSynthesizerMBS
MsgBox str(s.rate)
// shows e.g. "160"

Notes:
Mac OS X 10.5 only.
(Read and Write runtime property)

NSSpeechSynthesizerMBS.setUsesFeedbackWindow(value as Boolean)
method, Speech, MBS Cocoa Plugin (NSSpeechSynthesizer), class NSSpeechSynthesizerMBS, Console safe, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Sets whether the receiver uses the speech feedback window.

NSSpeechSynthesizerMBS.SetVoice(voice as string) as boolean
method, Speech, MBS Cocoa Plugin (NSSpeechSynthesizer), class NSSpeechSynthesizerMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Sets the receiver’s current voice.
Notes: Returns true on success.

NSSpeechSynthesizerMBS.StartSpeakingString(text as string) as boolean
method, Speech, MBS Cocoa Plugin (NSSpeechSynthesizer), class NSSpeechSynthesizerMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Begins speaking synthesized text through the system’s default sound output device.
Example:

dim s as new NSSpeechSynthesizerMBS

s.rate=300 // not slow
s.volume=0.5 // not loud
call s.startSpeakingString "Hello World"

Notes:
Returns true when synthesis starts successfully, false otherwise.

If the receiver is currently speaking synthesized speech when startSpeakingString is called, that process is stopped before text is spoken.

When synthesis of text finishes normally or is stopped, the message didFinishSpeaking(true) is called.

NSSpeechSynthesizerMBS.StartSpeakingString(text as string, file as folderitem) as boolean
method, Speech, MBS Cocoa Plugin (NSSpeechSynthesizer), class NSSpeechSynthesizerMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Begins synthesizing text into a sound (AIFF) file.
Notes:
Returns true when synthesis starts successfully, false otherwise.

When synthesis of text finishes normally or is stopped, the message didFinishSpeaking(True) is called.

One example of how you might use this method is in an email program that automatically converts new messages into sound files that can be stored on an iPod for later listening.

NSSpeechSynthesizerMBS.startSpeakingString(Text as String, URL as string) as boolean
method, Speech, MBS Cocoa Plugin (NSSpeechSynthesizer), class NSSpeechSynthesizerMBS, Console safe, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Begins synthesizing text into a sound (AIFF) file.
Notes:
Returns true when synthesis starts successfully, false otherwise.

When synthesis of text finishes normally or is stopped, the message didFinishSpeaking(True) is called.

One example of how you might use this method is in an email program that automatically converts new messages into sound files that can be stored on an iPod for later listening.

NSSpeechSynthesizerMBS.StopSpeaking
method, Speech, MBS Cocoa Plugin (NSSpeechSynthesizer), class NSSpeechSynthesizerMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Stops synthesis in progress.
Notes: If the receiver is currently generating speech, synthesis is halted, and the message didFinishSpeaking(false) is called.

NSSpeechSynthesizerMBS.stopSpeakingAtBoundary(boundary as integer)
method, Speech, MBS Cocoa Plugin (NSSpeechSynthesizer), class NSSpeechSynthesizerMBS, Console safe, Plugin version: 7.7, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Stops speech on the next w
Notes: Mac OS X 10.5 only.

NSSpeechSynthesizerMBS.UsesFeedbackWindow as boolean
method, Speech, MBS Cocoa Plugin (NSSpeechSynthesizer), class NSSpeechSynthesizerMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Indicates whether the receiver uses the speech feedback window.

NSSpeechSynthesizerMBS.Voice as string
method, Speech, MBS Cocoa Plugin (NSSpeechSynthesizer), class NSSpeechSynthesizerMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The current voice.
Example:

dim s as NSSpeechSynthesizerMBS
s=new NSSpeechSynthesizerMBS
MsgBox s.voice
// shows e.g. "com.apple.speech.synthesis.voice.Zarvox"

NSSpeechSynthesizerMBS.volume as double
method, Speech, MBS Cocoa Plugin (NSSpeechSynthesizer), class NSSpeechSynthesizerMBS, Console safe, Plugin version: 7.7, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The volume of the speech.
Example:

dim s as NSSpeechSynthesizerMBS
s=new NSSpeechSynthesizerMBS
MsgBox str(s.volume)
// shows e.g. 1

Notes:
No sound is zero, full sound one.
Mac OS X 10.5 only.
(Read and Write runtime property)

NSSpeechSynthesizerMBS.willSpeakPhoneme(phonemeOpcode as integer)
event, Speech, MBS Cocoa Plugin (NSSpeechSynthesizer), class NSSpeechSynthesizerMBS, Plugin version: 6.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Sent just before a synthesized phoneme is spoken through the sound output device.
Notes:
phonemeOpcode: Phoneme that sender is about to speak into the sound output device.

One use of this method might be to animate a mouth on screen to match the generated speech.

Important: The delegate is not sent this message when the SpeechSynthesizer object is synthesizing speech to a file (startSpeakingString).

NSSpeechSynthesizerMBS.willSpeakWord(Position as integer, Length as integer, Text as String)
event, Speech, MBS Cocoa Plugin (NSSpeechSynthesizer), class NSSpeechSynthesizerMBS, Plugin version: 6.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Sent just before a synthesized word is spoken through the sound output device.
Notes:
Position and Length: Word that sender is about to speak into the sound output device.
text: Text that is being synthesized by sender.

One use of this method might be to visually highlight the word being spoken.

Important: The delegate is not sent this message when the SpeechSynthesizer object is synthesizing speech to a file (startSpeakingString).