NSSpeechSynthesizerMBS.attributesForVoice(voice as String) as NSVoiceMBS

Some examples using this method:

• /MacCocoa/Speech/NSSpeechSynthesizer

NSSpeechSynthesizerMBS.availableVoice(index as Integer) as String

The available voices can be listed using this function.
Index is from 0 to count-1.

Some examples using this method:

• /MacCocoa/Speech/NSSpeechSynthesizer

NSSpeechSynthesizerMBS.availableVoices as String()

MsgBox Join(NSSpeechSynthesizerMBS.availableVoices)

Same as availableVoice() and availableVoicesCount, but this function returns an array which is very useful for for-each-loops.

NSSpeechSynthesizerMBS.availableVoicesCount as Integer

Some examples using this method:

• /MacCocoa/Speech/NSSpeechSynthesizer

NSSpeechSynthesizerMBS.defaultVoice as String

dim s as NSSpeechSynthesizerMBS

s=new NSSpeechSynthesizerMBS

MsgBox s.defaultVoice

NSSpeechSynthesizerMBS.isAnyApplicationSpeaking as boolean

Some examples using this method:

• /MacCocoa/Speech/NSSpeechSynthesizer

NSSpeechSynthesizerMBS.NSSpeechCharacterModeProperty as String

dim s as new NSSpeechSynthesizerMBS
dim e as NSErrorMBS

call s.setObjectForProperty(s.NSSpeechModeLiteral, s.NSSpeechCharacterModeProperty, e)
msgBox s.objectForProperty(s.NSSpeechCharacterModeProperty, e)

call s.setObjectForProperty(s.NSSpeechModeNormal, s.NSSpeechCharacterModeProperty, e)
msgBox s.objectForProperty(s.NSSpeechCharacterModeProperty, e)

Get or set the synthesizer's current text-processing mode. A string that specifies whether the channel is currently in text input mode or phoneme input mode.
When the character-processing mode is NSSpeechModeNormal, input characters are spoken as you would expect to hear them. When the mode is NSSpeechModeLiteral, each character is spoken literally, so that the word "cat" is spoken "C–A–T".
Available in OS X v10.5 and later.

NSSpeechSynthesizerMBS.NSSpeechCommandDelimiterProperty as String

Set the embedded speech command delimiter characters to be used for the synthesizer. A dictionary that contains the delimiter information. See "Command Delimiter Keys" for the keys you can use to specify values in this dictionary.
By default, the opening delimiter is "[[" and the closing delimiter is "]]". Your application might need to change these delimiters temporarily if those character sequences occur naturally in a text buffer that is to be spoken. Your application can also disable embedded command processing by passing empty delimiters (as empty strings). See "Speech Command Delimiter" for the keys you can use to specify values in this dictionary.
Available in OS X v10.5 and later.

NSSpeechSynthesizerMBS.NSSpeechCommandPrefix as String

The command delimiter string that prefixes a command, by default, this is [[.
Available in OS X v10.5 and later.

NSSpeechSynthesizerMBS.NSSpeechCommandSuffix as String

The command delimiter string that suffixes a command,by default, this is ]].
Available in OS X v10.5 and later.

NSSpeechSynthesizerMBS.NSSpeechCurrentVoiceProperty as String

Set the current voice on the synthesizer to the specified voice. A dictionary that contains the phoneme symbols and example words defined for the current synthesizer.
Your application might use this information to show the user what symbols to use when entering phonemic text directly. See "NSSpeechPhonemeSymbolsProperty Dictionary Keys" for the keys you can use to specify values in this dictionary.
Available in OS X v10.5 and later.

NSSpeechSynthesizerMBS.NSSpeechDictionaryAbbreviations as String

An array of dictionary objects containing the keys NSSpeechDictionaryEntrySpelling and NSSpeechDictionaryEntryPhonemes.
Available in OS X v10.5 and later.

NSSpeechSynthesizerMBS.NSSpeechDictionaryEntryPhonemes as String

The phonemic representation of an entry. A string.
Available in OS X v10.5 and later.

NSSpeechSynthesizerMBS.NSSpeechDictionaryEntrySpelling as String

The spelling of an entry. A string.
Available in OS X v10.5 and later.

NSSpeechSynthesizerMBS.NSSpeechDictionaryLocaleIdentifier as String

The canonical locale identifier string describing the dictionary's locale. A locale is generally composed of three pieces of ordered information: a language code, a region code, and a variant code. Refer to documentation about NSLocale or Locales Programming Guide for more information
Available in OS X v10.5 and later.

NSSpeechSynthesizerMBS.NSSpeechDictionaryModificationDate as String

A string representation of the dictionary's last modification date in the international format (YYYY-MM-DD HH:MM:SS ±HHMM). If the same word appears across multiple dictionaries, the one from the dictionary with the most recent date will be used.
Available in OS X v10.5 and later.

NSSpeechSynthesizerMBS.NSSpeechDictionaryPronunciations as String

An array of dictionary objects containing the keys NSSpeechDictionaryEntrySpelling and NSSpeechDictionaryEntryPhonemes.

NSSpeechSynthesizerMBS.NSSpeechErrorCount as String

The number of errors that have occurred in processing the current text string, since the last call to objectForProperty with the NSSpeechErrorsProperty property. A Number
Using the NSSpeechErrorOldestCode keys and the NSSpeechErrorNewestCode keys, you can get information about the oldest and most recent errors that occurred since the last call to objectForProperty, but you cannot get information about any intervening errors.
Available in OS X v10.5 and later.

NSSpeechSynthesizerMBS.NSSpeechErrorNewestCharacterOffset as String

The position in the text string of the most recent error that occurred since the last call to objectForProperty with the NSSpeechErrorsProperty property. A Number.
Available in OS X v10.5 and later.

NSSpeechSynthesizerMBS.NSSpeechErrorNewestCode as String

The error code of the most recent error that occurred since the last call to objectForProperty with the NSSpeechErrorsProperty property. A number
Available in OS X v10.5 and later.

NSSpeechSynthesizerMBS.NSSpeechErrorOldestCharacterOffset as String

The position in the text string of the first error that occurred since the last call to objectForProperty with the NSSpeechErrorsProperty property. A number
Available in OS X v10.5 and later.

NSSpeechSynthesizerMBS.NSSpeechErrorOldestCode as String

The error code of the first error that occurred since the last call to objectForProperty with the NSSpeechErrorsProperty property. A Number
Available in OS X v10.5 and later.

NSSpeechSynthesizerMBS.NSSpeechErrorsProperty as String

Get speech-error information for the synthesizer. An Dictionary object that contains speech-error information. See "NSSpeechErrorProperty Dictionary Keys" for a description of the keys present in the dictionary.
This property lets you get information about various run-time errors that occur during speaking, such as the detection of badly formed embedded commands. Errors returned directly by the Speech Synthesis Manager are not reported here.
If your application implements the didEncounterErrorAtIndex event, the event can use this property to get error information.
Available in OS X v10.5 and later.

NSSpeechSynthesizerMBS.NSSpeechInputModeProperty as String

Get or set the synthesizer's current text-processing mode. A string that specifies whether the channel is currently in text input mode or phoneme input mode.The supported values are listed in "Speaking Modes for NSSpeechInputModeProperty."
When in phoneme-processing mode, a text string is interpreted to be a series of characters representing various phonemes and prosodic controls. Some synthesizers might support additional input-processing modes and define constants for these modes.
Available in OS X v10.5 and later.

NSSpeechSynthesizerMBS.NSSpeechModeLiteral as String

Indicates that each digit or character is spoken literally (so that 12 is spoken as "one, two", or the word "cat" is spoken as "C A T").
Available in OS X v10.5 and later.

NSSpeechSynthesizerMBS.NSSpeechModeNormal as String

Indicates that the synthesizer assembles digits into numbers (so that 12 is spoken as "twelve") and text into words.
Available in OS X v10.5 and later.

NSSpeechSynthesizerMBS.NSSpeechModePhoneme as String

Indicates that the synthesizer is in phoneme-processing mode. When in phoneme-processing mode, a text buffer is interpreted to be a series of characters representing various phonemes and prosodic controls.
Available in OS X v10.5 and later.

NSSpeechSynthesizerMBS.NSSpeechModeText as String

Indicates that the synthesizer is in text-processing mode.
Available in OS X v10.5 and later.

NSSpeechSynthesizerMBS.NSSpeechNumberModeProperty as String

dim s as new NSSpeechSynthesizerMBS
dim e as NSErrorMBS

call s.setObjectForProperty(s.NSSpeechModeLiteral, s.NSSpeechNumberModeProperty, e)
msgBox s.objectForProperty(s.NSSpeechNumberModeProperty, e)

call s.setObjectForProperty(s.NSSpeechModeNormal, s.NSSpeechNumberModeProperty, e)
msgBox s.objectForProperty(s.NSSpeechNumberModeProperty, e)

Get or set the synthesizer's current number-processing mode. A string that specifies whether the synthesizer is currently in normal or literal number-processing mode. The constants NSSpeechModeNormal and NSSpeechModeLiteral are the possible values of this string.
When the number-processing mode is NSSpeechModeNormal, the synthesizer assembles digits into numbers (so that "12" is spoken as "twelve"). When the mode is NSSpeechModeLiteral, each digit is spoken literally (so that "12" is spoken as "one, two").
Available in OS X v10.5 and later.

NSSpeechSynthesizerMBS.NSSpeechOutputToFileURLProperty as String

Set the speech output destination to a file or to the computer's speakers. A NSURL object. To write the speech output to a file, use the file's NSURL; to generate the sound through the computer's speakers, use nil.
Available in OS X v10.5 and later.

NSSpeechSynthesizerMBS.NSSpeechPhonemeInfoExample as String

An example word that illustrates the use of the phoneme.
Available in OS X v10.5 and later.

NSSpeechSynthesizerMBS.NSSpeechPhonemeInfoHiliteEnd as String

The character offset into the example word that identifies the location of the end of the phoneme.
Available in OS X v10.5 and later.

NSSpeechSynthesizerMBS.NSSpeechPhonemeInfoHiliteStart as String

The character offset into the example word that identifies the location of the beginning of the phoneme.
Available in OS X v10.5 and later.

NSSpeechSynthesizerMBS.NSSpeechPhonemeInfoOpcode as String

The opcode as Number.
Available in OS X v10.5 and later.

NSSpeechSynthesizerMBS.NSSpeechPhonemeInfoSymbol as String

The symbol used to represent the phoneme.
The symbol does not necessarily have a phonetic connection to the phoneme, but might simply be an abstract textual representation of it.
Available in OS X v10.5 and later.

NSSpeechSynthesizerMBS.NSSpeechPhonemeSymbolsProperty as String

Get a list of phoneme symbols and example words defined for the synthesizer. A Dictionary object that contains the phoneme symbols and example words defined for the current synthesizer
Your application might use this information to show the user what symbols to use when entering phonemic text directly. See "NSSpeechPhonemeSymbolsProperty Dictionary Keys" for a description of the keys present in the dictionary.
Available in OS X v10.5 and later.

NSSpeechSynthesizerMBS.NSSpeechPitchBaseProperty as String

dim s as new NSSpeechSynthesizerMBS
dim e as NSErrorMBS

dim n as Integer = s.objectForProperty(s.NSSpeechPitchBaseProperty, e)
msgBox str(n)

Get or set a synthesizer's baseline speech pitch. An number that specifies the baseline speech pitch.
Typical voice frequencies range from around 90 hertz for a low-pitched male voice to perhaps 300 hertz for a high-pitched child's voice. These frequencies correspond to approximate pitch values in the ranges of 30.000 to 40.000 and 55.000 to 65.000, respectively.
Note: The change in speech pitch may not be noticeable until the next sentence or paragraph is spoken.
Available in OS X v10.5 and later.

NSSpeechSynthesizerMBS.NSSpeechPitchModProperty as String

dim s as new NSSpeechSynthesizerMBS
dim e as NSErrorMBS

dim n as Double = s.objectForProperty(s.NSSpeechPitchModProperty, e)
msgBox str(n)

Get or set a synthesizer's pitch modulation. A number object that specifies the synthesizer's pitch modulation.
Pitch modulation is also expressed as a floating-point value in the range of 0.000 to 127.000. These values correspond to MIDI note values, where 60.000 is equal to middle C on a piano scale. The most useful speech pitches fall in the range of 40.000 to 55.000. A pitch modulation value of 0.000 corresponds to a monotone in which all speech is generated at the frequency corresponding to the speech pitch. Given a speech pitch value of 46.000, a pitch modulation of 2.000 would mean that the widest possible range of pitches corresponding to the actual frequency of generated text would be 44.000 to 48.000.

Note: The change in pitch modulation may not be noticeable until the next sentence or paragraph is spoken.
Available in OS X v10.5 and later.

NSSpeechSynthesizerMBS.NSSpeechRateProperty as String

dim s as new NSSpeechSynthesizerMBS
dim e as NSErrorMBS
dim value as Double = s.objectForProperty(s.NSSpeechRateProperty, e)
MsgBox str(value)

Get or set the synthesizer's baseline speech pitch. A number that specifies the synthesizer's baseline speech pitch.
Typical voice frequencies range from around 90 hertz for a low-pitched male voice to perhaps 300 hertz for a high-pitched child's voice. These frequencies correspond to approximate pitch values in the ranges of 30.000 to 40.000 and 55.000 to 65.000, respectively.
Available in OS X v10.5 and later.

NSSpeechSynthesizerMBS.NSSpeechRecentSyncProperty as String

Get the message code for the most recently encountered synchronization command. A number that specifies the most recently encountered synchronization command.

Available in OS X v10.5 and later.

NSSpeechSynthesizerMBS.NSSpeechResetProperty as String

Set a synthesizer back to its default state. There is no value associated with this property; to reset the channel to its default state, set the key to nil.
You can use this function to, for example, set speech pitch and speech rate to default values.
Available in OS X v10.5 and later.

NSSpeechSynthesizerMBS.NSSpeechStatusNumberOfCharactersLeft as String

The number of characters left in the input string of text.
When the value of this key is zero, you can destroy the input string.
Available in OS X v10.5 and later.

NSSpeechSynthesizerMBS.NSSpeechStatusOutputBusy as String

Indicates whether the synthesizer is currently producing speech.
A synthesizer is considered to be producing speech even at some times when no audio data is being produced through the computer's speaker. This occurs, for example, when the synthesizer is processing input, but has not yet initiated speech or when speech output is paused.
Available in OS X v10.5 and later.

NSSpeechSynthesizerMBS.NSSpeechStatusOutputPaused as String

Indicates whether speech output in the synthesizer has been paused by sending the message pauseSpeakingAtBoundary.
Available in OS X v10.5 and later.

NSSpeechSynthesizerMBS.NSSpeechStatusPhonemeCode as String

Indicates that the synthesizer is in phoneme-processing mode. When in phoneme-processing mode, a text buffer is interpreted to be a series of characters representing various phonemes and prosodic controls.
Available in OS X v10.5 and later.

NSSpeechSynthesizerMBS.NSSpeechStatusProperty as String

dim s as new NSSpeechSynthesizerMBS
dim e as NSErrorMBS

call s.startSpeakingString "Hello"

dim status as Dictionary = s.objectForProperty(s.NSSpeechStatusProperty, e)
dim CharactersLeft as Integer = status.Value(s.NSSpeechStatusNumberOfCharactersLeft)

MsgBox str(CharactersLeft)+" Characters left"

Get speech-status information for the synthesizer. A dictionary that contains speech-status information for the synthesizer. See "NSSpeechStatusProperty Dictionary Keys" for a description of the keys present in the dictionary.
Available in OS X v10.5 and later.

NSSpeechSynthesizerMBS.NSSpeechSynthesizerInfoIdentifier as String

The identifier of the speech synthesizer.
Available in OS X v10.5 and later.

NSSpeechSynthesizerMBS.NSSpeechSynthesizerInfoProperty as String

Get information about the speech synthesizer being used on the specified synthesizer. A dictionary object that contains information about the speech synthesizer being used on the specified synthesizer. See "Speech Synthesizer Property Keys" for a description of the keys present in the dictionary.
Available in OS X v10.5 and later.

NSSpeechSynthesizerMBS.NSSpeechSynthesizerInfoVersion as String

The version of the speech synthesizer.
Available in OS X v10.5 and later.