Platforms to show: All Mac Windows Linux Cross-Platform

Speech

Classes for Text to Speech on Mac and Windows.

• Classes
  • class AVSpeechSynthesisMarkerMBS
    • method Constructor
    • method copy as AVSpeechSynthesisMarkerMBS
    • shared method markerWithBookmarkName(mark as string, atByteSampleOffset as Integer) as AVSpeechSynthesisMarkerMBS
    • shared method markerWithMarkerType(type as integer, TextRange as NSRangeMBS, byteSampleOffset as Integer) as AVSpeechSynthesisMarkerMBS
    • shared method markerWithParagraphRange(TextRange as NSRangeMBS, byteSampleOffset as Integer) as AVSpeechSynthesisMarkerMBS
    • shared method markerWithPhonemeString(phoneme as string, atByteSampleOffset as Integer) as AVSpeechSynthesisMarkerMBS
    • shared method markerWithSentenceRange(TextRange as NSRangeMBS, byteSampleOffset as Integer) as AVSpeechSynthesisMarkerMBS
    • shared method markerWithWordRange(TextRange as NSRangeMBS, byteSampleOffset as Integer) as AVSpeechSynthesisMarkerMBS
    • property bookmarkName as String
    • property byteSampleOffset as Integer
    • property Handle as Integer
    • property mark as Integer
    • property phoneme as String
    • property textRange as NSRangeMBS
  • class AVSpeechSynthesisVoiceMBS
    • method Constructor
    • shared method SpeechUtteranceDefaultSpeechRate as Single
    • shared method SpeechUtteranceMaximumSpeechRate as Single
    • shared method SpeechUtteranceMinimumSpeechRate as Single
    • shared method speechVoices as AVSpeechSynthesisVoiceMBS()
    • shared method VoiceIdentifierAlex as String
    • shared method voiceWithIdentifier(identifier as string) as AVSpeechSynthesisVoiceMBS
    • shared method voiceWithLanguage(languageCode as string) as AVSpeechSynthesisVoiceMBS
    • property audioFileSettings as Dictionary
    • shared property currentLanguageCode as String
    • property gender as Integer
    • property Handle as Integer
    • property identifier as String
    • property language as String
    • property name as String
    • property quality as Integer
    • property voiceTraits as Integer
  • class AVSpeechSynthesizerMBS
    • method Constructor
    • method continueSpeaking as Boolean
    • method Destructor
    • shared method IPANotationAttribute as String
    • method pauseSpeakingAtBoundary(SpeechBoundary as Integer) as Boolean
    • method requestPersonalVoiceAuthorization
    • method speakUtterance(utterance as AVSpeechUtteranceMBS)
    • method stopSpeakingAtBoundary(SpeechBoundary as Integer) as Boolean
    • method writeUtterance(utterance as AVSpeechUtteranceMBS)
    • property Handle as Integer
    • property isPaused as Boolean
    • property isSpeaking as Boolean
    • property mixToTelephonyUplink as Boolean
    • shared property personalVoiceAuthorizationStatus as Integer
    • property usesApplicationAudioSession as Boolean
    • event availableVoicesDidChange
    • event didCancelSpeechUtterance(utterance as AVSpeechUtteranceMBS)
    • event didContinueSpeechUtterance(utterance as AVSpeechUtteranceMBS)
    • event didFinishSpeechUtterance(utterance as AVSpeechUtteranceMBS)
    • event didPauseSpeechUtterance(utterance as AVSpeechUtteranceMBS)
    • event didStartSpeechUtterance(utterance as AVSpeechUtteranceMBS)
    • event requestPersonalVoiceAuthorizationCompleted(status as Integer)
    • event SpeechSynthesizerBuffer(buffer as AVAudioBufferMBS)
    • event SpeechSynthesizerMarker(markers() as AVSpeechSynthesisMarkerMBS)
    • event willSpeakMarker(marker as AVSpeechSynthesisMarkerMBS, utterance as AVSpeechUtteranceMBS)
    • event willSpeakRangeOfSpeechString(characterRange as NSRangeMBS, utterance as AVSpeechUtteranceMBS)
  • class AVSpeechUtteranceMBS
    • method Constructor(s as NSAttributedStringMBS)
    • method Constructor(s as string)
    • method copy as AVSpeechUtteranceMBS
    • shared method speechUtteranceWithAttributedString(s as NSAttributedStringMBS) as AVSpeechUtteranceMBS
    • shared method speechUtteranceWithSSMLRepresentation(s as string) as AVSpeechUtteranceMBS
    • shared method speechUtteranceWithString(s as string) as AVSpeechUtteranceMBS
    • property attributedSpeechString as NSAttributedStringMBS
    • property Handle as Integer
    • property pitchMultiplier as Single
    • property postUtteranceDelay as Double
    • property prefersAssistiveTechnologySettings as Boolean
    • property preUtteranceDelay as Double
    • property rate as Single
    • property speechString as String
    • property voice as AVSpeechSynthesisVoiceMBS
    • property volume as Single
  • class NSSpeechRecognizerMBS
    • method commands as string()
    • method Destructor
    • method SetCommands(commands() as string)
    • method StartListening
    • method StopListening
    • property BlocksOtherRecognizers as boolean
    • property DisplayedCommandsTitle as string
    • property ListensInForegroundOnly as boolean
    • event DidRecognizeCommand(command as string)
  • class NSSpeechSynthesizerMBS
    • method addSpeechDictionary(speechDictionary as dictionary)
    • shared method attributesForVoice(voice as String) as NSVoiceMBS
    • shared method availableVoice(index as Integer) as String
    • shared method availableVoices as String()
    • shared method availableVoicesCount as Integer
    • method Constructor
    • method Constructor(voice as string)
    • method continueSpeaking
    • shared method defaultVoice as String
    • method Destructor
    • shared method isAnyApplicationSpeaking as boolean
    • shared method NSSpeechCharacterModeProperty as String
    • shared method NSSpeechCommandDelimiterProperty as String
    • shared method NSSpeechCommandPrefix as String
    • shared method NSSpeechCommandSuffix as String
    • shared method NSSpeechCurrentVoiceProperty as String
    • shared method NSSpeechDictionaryAbbreviations as String
    • shared method NSSpeechDictionaryEntryPhonemes as String
    • shared method NSSpeechDictionaryEntrySpelling as String
    • shared method NSSpeechDictionaryLocaleIdentifier as String
    • shared method NSSpeechDictionaryModificationDate as String
    • shared method NSSpeechDictionaryPronunciations as String
    • shared method NSSpeechErrorCount as String
    • shared method NSSpeechErrorNewestCharacterOffset as String
    • shared method NSSpeechErrorNewestCode as String
    • shared method NSSpeechErrorOldestCharacterOffset as String
    • shared method NSSpeechErrorOldestCode as String
    • shared method NSSpeechErrorsProperty as String
    • shared method NSSpeechInputModeProperty as String
    • shared method NSSpeechModeLiteral as String
    • shared method NSSpeechModeNormal as String
    • shared method NSSpeechModePhoneme as String
    • shared method NSSpeechModeText as String
    • shared method NSSpeechNumberModeProperty as String
    • shared method NSSpeechOutputToFileURLProperty as String
    • shared method NSSpeechPhonemeInfoExample as String
    • shared method NSSpeechPhonemeInfoHiliteEnd as String
    • shared method NSSpeechPhonemeInfoHiliteStart as String
    • shared method NSSpeechPhonemeInfoOpcode as String
    • shared method NSSpeechPhonemeInfoSymbol as String
    • shared method NSSpeechPhonemeSymbolsProperty as String
    • shared method NSSpeechPitchBaseProperty as String
    • shared method NSSpeechPitchModProperty as String
    • shared method NSSpeechRateProperty as String
    • shared method NSSpeechRecentSyncProperty as String
    • shared method NSSpeechResetProperty as String
    • shared method NSSpeechStatusNumberOfCharactersLeft as String
    • shared method NSSpeechStatusOutputBusy as String
    • shared method NSSpeechStatusOutputPaused as String
    • shared method NSSpeechStatusPhonemeCode as String
    • shared method NSSpeechStatusProperty as String
    • shared method NSSpeechSynthesizerInfoIdentifier as String
    • shared method NSSpeechSynthesizerInfoProperty as String
    • shared method NSSpeechSynthesizerInfoVersion as String
    • shared method NSSpeechVolumeProperty as String
    • method objectForProperty(PropertyName as string, byref error as NSErrorMBS) as Variant
    • method pauseSpeakingAtBoundary(boundary as Integer)
    • method phonemesFromText(text as string) as string
    • method setObjectForProperty(value as Variant, PropertyName as string, byref error as NSErrorMBS) as boolean
    • method SetVoice(voice as string) as boolean
    • method StartSpeakingString(text as string) as boolean
    • method StartSpeakingString(text as string, file as folderitem) as boolean
    • method startSpeakingString(Text as String, URL as string) as boolean
    • method StopSpeaking
    • method stopSpeakingAtBoundary(boundary as Integer)
    • property IsSpeaking as boolean
    • property rate as Double
    • property UsesFeedbackWindow as boolean
    • property Voice as string
    • property volume as Double
    • event didEncounterErrorAtIndex(characterIndex as Integer, text as string, message as string)
    • event didEncounterSyncMessage(message as string)
    • event didFinishSpeaking(finishedSpeaking as boolean)
    • event willSpeakPhoneme(phonemeOpcode as Integer)
    • event willSpeakWord(Position as Integer, Length as Integer, Text as String)
  • class NSVoiceMBS
    • method Age as Integer
    • method Constructor
    • method Demotext as String
    • method Gender as String
    • shared method GenderFemale as String
    • shared method GenderMale as String
    • shared method GenderNeuter as String
    • method Identifier as String
    • method Language as String
    • method LocaleIdentifier as String
    • method Name as String
    • shared method NSVoiceAge as String
    • shared method NSVoiceDemoText as String
    • shared method NSVoiceGender as String
    • shared method NSVoiceIdentifier as String
    • shared method NSVoiceIndividuallySpokenCharacters as String
    • shared method NSVoiceLanguage as String
    • shared method NSVoiceLocaleIdentifier as String
    • shared method NSVoiceName as String
    • shared method NSVoiceSupportedCharacters as String
    • method Properties as Dictionary
  • class WinSpeechMBS
    • method close
    • method DisplayUI(type as string, title as string, parent as DesktopWindow)
    • method DisplayUI(type as string, title as string, parent as window)
    • method DisplayUI(type as string, title as string="")
    • method IsUISupported(type as string) as boolean
    • method ListVoices as boolean
    • method NextVoice as WinVoiceMBS
    • method Pause
    • method Resume
    • method Skip(sentenceCount as Integer) as Integer
    • method Speak(text as string, Purge as Boolean = false, ContainsXML as boolean = false)
    • method SpeakFile(file as folderitem, unicodestring as string, AudioFormat as Integer = 0, ContainsXML as boolean = false)
    • method WaitUntilDone(msTimeout as Integer)
    • property Handle as Integer
    • property IsDone as Boolean
    • property IsSpeaking as Boolean
    • property Lasterror as Integer
    • property Priority as Integer
    • property Rate as Integer
    • property SyncSpeakTimeout as Integer
    • property Voice as WinVoiceMBS
    • property Volume as Integer
  • class WinVoiceMBS
    • method Description as string
    • property Handle as Integer
    • property Lasterror as Integer

Release notes

• Version 24.1
  • Added AVSpeechSynthesizerMBS and related classes.

The items on this page are in the following plugins: MBS AVFoundation Plugin, MBS MacCocoa Plugin, MBS Win Plugin.