SPVOICESTATUS
Other versions of this page are also available for the following:
.gif "A hyphen indicates that the information in this topic is not relevant for this platform, or that the platform does not support the API that is listed.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
8/28/2008
This structure contains voice status information. This structure is retrieved by ISpVoice::GetStatus.
Syntax
typedef struct SPVOICESTATUS{
ULONG ulCurrentStream;
ULONG ulLastStreamQueued;
HRESULT hrLastResult;
DWORD dwRunningState;
ULONG ulInputWordPos;
ULONG ulInputWordLen;
ULONG ulInputSentPos;
ULONG ulInputSentLen;
LONG lBookmarkId;
SPPHONEID PhonemeId;
SPVISEMES VisemeId;
DWORD dwReserved1;
DWORD dwReserved2;
} SPVOICESTATUS;
Members
- ulCurrentStream
Number of the current stream being synthesized or receiving output. See ISpVoice::Speak for more information on stream numbers.
- ulLastStreamQueued
Number of the last stream queued.
- hrLastResult
Result of the last call to ISpVoice::Speak or ISpVoice::SpeakStream.
- dwRunningState
Value that indicates voice status: currently speaking, finished with all pending speak requests, or waiting to speak. The possible values are defined for the SPRUNSTATE enumeration. A value of 0 indicates that the voice is currently waiting to speak.
- ulInputWordPos
Character position within the input text of the word currently being processed.
- ulInputWordLen
Length of the word currently being processed.
- ulInputSentPos
Character position within the input text of the sentence currently being processed.
- ulInputSentLen
Length of the sentence currently being processed.
- lBookmarkId
Current bookmark string (in base 10) converted to a long integer. If the string of the current bookmark does not begin with an integer, lBookmarkId is zero. For example, if the bookmark name is "123Bookmark", the lBookmarkId member is "123". If the bookmark name is "hello", the lBookmarkId member is 0.
- PhonemeId
Current phoneme identifier. See International Phoneme Representation.
- VisemeId
Current viseme identifier. See International Phoneme Representation.
- dwReserved1
Reserved for future use.
- dwReserved2
Reserved for future use.
Requirements
| Header | sapi.h, sapi.idl |
| Windows Embedded CE | Windows CE .NET 4.1 and later |