classafFancomSapi::SpVoice
sys::Obj afFancomSapi::SpVoice
The SpVoice object brings the text-to-speech (TTS) engine capabilities to applications using SAPI automation.
http://msdn.microsoft.com/en-us/library/ee125640%28v=vs.85%29.aspx
@clsid {96749377-3391-11D2-9EE3-00C04F797396}
- alertBoundary
SpeechVoiceEvents? alertBoundary
Gets and sets the alert boundary, which specifies how a speaking voice pauses itself for alerts.
- allowAudioOutputFormatChangesOnNextSet
Bool? allowAudioOutputFormatChangesOnNextSet
Gets and sets the flag that specifies whether the voice is allowed to adjust its audio output format automatically.
- audioOutput
SpObjectToken? audioOutput
Gets the audio output object
- audioOutputStream
ISpeechBaseStream? audioOutputStream
Gets the audio output stream
- displayUI
Void displayUI(Int? hWndParent, Str? title, Str? typeOfUI, Variant? extraData := Variant.<ctor>(""))
Initiates the display of the specified UI.
- eventInterests
SpeechVoiceEvents? eventInterests
Gets and sets the types of events received by the voice.
- getAudioOutputs
ISpeechObjectTokens? getAudioOutputs(Str? requiredAttributes := "", Str? optionalAttributes := "")
Returns a selection of available audio output tokens.
- getVoices
ISpeechObjectTokens? getVoices(Str? requiredAttributes := "", Str? optionalAttributes := "")
Returns a selection of voices available to the voice.
- isUISupported
Bool? isUISupported(Str? typeOfUI, Variant? extraData := Variant.<ctor>(""))
Determines if the specified UI is supported.
- makeFromDispatch
new makeFromDispatch(Dispatch dispatch)
- makeFromProgId
new makeFromProgId()
- pause
Void pause()
Pauses the voices rendering.
- priority
SpeechVoicePriority? priority
Gets and sets the priority level of the voice.
- progId
const static Str progId := "SAPI.SpVoice"
- rate
Int? rate
Gets and sets the speaking rate of the voice.
- resume
Void resume()
Resumes the voices rendering.
- skip
Int? skip(Str? type, Int? numItems)
Skips rendering the specified number of items.
- speak
Int? speak(Str? text, SpeechVoiceSpeakFlags? flags := SpeechVoiceSpeakFlags.SVSFDefault)
Initiates the speaking of a text string, text file or wave file by the voice.
- speakCompleteEvent
Int? speakCompleteEvent()
Gets an event handle from the voice that will be signaled when the voice finishes speaking.
- speakStream
Int? speakStream(ISpeechBaseStream? stream, SpeechVoiceSpeakFlags? flags := SpeechVoiceSpeakFlags.SVSFDefault)
Initiates the speaking of a text stream or sound file by the voice.
- status
ISpeechVoiceStatus? status { private set }
Returns the current speaking and event status of the voice in an
ISpeechVoiceStatus
object.- synchronousSpeakTimeout
Int? synchronousSpeakTimeout
SyncSpeakTimeout
- voice
SpObjectToken? voice
Gets and sets the currently active member of the Voices collection.
- volume
Int? volume
Gets and sets the base volume (loudness) level of the voice.
- waitUntilDone
Bool? waitUntilDone(Int? msTimeout)
Blocks the caller until either the voice has finished speaking or the specified time interval has elapsed.
- withEvents