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

Source

SpeechVoiceEvents? alertBoundary

Gets and sets the alert boundary, which specifies how a speaking voice pauses itself for alerts.

allowAudioOutputFormatChangesOnNextSet

Source

Bool? allowAudioOutputFormatChangesOnNextSet

Gets and sets the flag that specifies whether the voice is allowed to adjust its audio output format automatically.

audioOutput

Source

SpObjectToken? audioOutput

Gets the audio output object

audioOutputStream

Source

ISpeechBaseStream? audioOutputStream

Gets the audio output stream

displayUI

Source

Void displayUI(Int? hWndParent, Str? title, Str? typeOfUI, Variant? extraData := Variant.<ctor>(""))

Initiates the display of the specified UI.

eventInterests

Source

SpeechVoiceEvents? eventInterests

Gets and sets the types of events received by the voice.

getAudioOutputs

Source

ISpeechObjectTokens? getAudioOutputs(Str? requiredAttributes := "", Str? optionalAttributes := "")

Returns a selection of available audio output tokens.

getVoices

Source

ISpeechObjectTokens? getVoices(Str? requiredAttributes := "", Str? optionalAttributes := "")

Returns a selection of voices available to the voice.

isUISupported

Source

Bool? isUISupported(Str? typeOfUI, Variant? extraData := Variant.<ctor>(""))

Determines if the specified UI is supported.

makeFromDispatch

Source

new makeFromDispatch(Dispatch dispatch)

makeFromProgId

Source

new makeFromProgId()

pause

Source

Void pause()

Pauses the voices rendering.

priority

Source

SpeechVoicePriority? priority

Gets and sets the priority level of the voice.

progId

Source

const static Str progId := "SAPI.SpVoice"

rate

Source

Int? rate

Gets and sets the speaking rate of the voice.

resume

Source

Void resume()

Resumes the voices rendering.

Source

Int? skip(Str? type, Int? numItems)

Skips rendering the specified number of items.

speak

Source

Int? speak(Str? text, SpeechVoiceSpeakFlags? flags := SpeechVoiceSpeakFlags.SVSFDefault)

Initiates the speaking of a text string, text file or wave file by the voice.

speakCompleteEvent

Source

Int? speakCompleteEvent()

Gets an event handle from the voice that will be signaled when the voice finishes speaking.

speakStream

Source

Int? speakStream(ISpeechBaseStream? stream, SpeechVoiceSpeakFlags? flags := SpeechVoiceSpeakFlags.SVSFDefault)

Initiates the speaking of a text stream or sound file by the voice.

status

Source

ISpeechVoiceStatus? status { private set }

Returns the current speaking and event status of the voice in an ISpeechVoiceStatus object.

synchronousSpeakTimeout

Source

Int? synchronousSpeakTimeout

SyncSpeakTimeout

voice

Source

SpObjectToken? voice

Gets and sets the currently active member of the Voices collection.

volume

Source

Int? volume

Gets and sets the base volume (loudness) level of the voice.

waitUntilDone

Source

Bool? waitUntilDone(Int? msTimeout)

Blocks the caller until either the voice has finished speaking or the specified time interval has elapsed.

withEvents

Source

Void withEvents(Obj eventSink)