Export (0) Print
Expand All

ISpeechVoiceStatus Interface (SAPI 5.4)

Speech API 5.4
Microsoft Speech API 5.4

ISpeechVoiceStatus

The ISpeechVoiceStatus automation interface defines the types of information returned by the SpVoice.Status method.

Most ISpeechVoiceStatus properties consist of real-time feedback from the text-to-speech (TTS) engine. These properties are equivalent to parameters returned by voice events, and like voice events, they are used only with asynchronous speech. It may be advantageous for some applications to retrieve these elements by calling Status occasionally, rather than by receiving events constantly.

It should be noted that voice status and voice events are closely associated with the status of the audio output device. A voice speaking to a file stream produces no audio output and has no audio output status. As a result, ISpeechVoiceStatus always displays the voice as inactive.

Use of the ISpeechVoiceStatus is demonstrated in a code example at the end of this section.


Automation Interface Elements

The ISpeechVoiceStatus automation interface contains the following elements:


PropertiesDescription
CurrentStreamNumber PropertyRetrieves the number of the text input stream being spoken by the TTS engine.
InputSentenceLength PropertyRetrieves the length of the sentence currently being spoken by the TTS engine.
InputSentencePosition PropertyRetrieves the position one character prior to the beginning of the sentence currently being spoken by the TTS engine.
InputWordLength PropertyRetrieves the length of the word currently being spoken by the TTS engine.
InputWordPosition PropertyRetrieves the position one character prior to the beginning of the word currently being spoken by the TTS engine.
LastBookmark PropertyRetrieves the string value of the last bookmark encountered by the TTS engine.
LastBookmarkId PropertyRetrieves the ID of the last bookmark encountered by the TTS engine.
LastHResult PropertyRetrieves the HResult, or internal status code, from the last Speak or SpeakStream operation performed by the TTS engine.
LastStreamNumberQueued PropertyRetrieves the number of the last audio stream spoken by the TTS engine.
PhonemeId PropertyRetrieves the ID of the current phoneme being spoken by the TTS engine.
RunningState PropertyRetrieves the run state of the voice, which indicates whether the voice is speaking or inactive.
VisemeId PropertyGets the ID of the current viseme being spoken by the TTS engine.
Show:
© 2014 Microsoft