SPVSTATE
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 information about the state of a voice.
Syntax
typedef [restricted] struct SPVSTATE{
SPVACTIONS eAction;
LANGID LangID;
WORD wReserved;
long EmphAdj;
long RateAdj;
ULONG Volume;
SPVPITCH PitchAdj;
ULONG SilenceMSecs;
SPPHONEID* pPhoneIds;
SPPARTOFSPEECH ePartOfSpeech;
SPVCONTEXT Context;
} SPVSTATE;
Members
- eAction
Action to take for the text fragment with which the voice is associated. Possible values are defined for the SPVACTIONS enumeration. The typical action is to speak the fragment (SPVA_Speak).
- LangID
Language identifier associated with the voice. The identifier is set using the <Lang> XML tag.
- wReserved
Reserved for future use.
- EmphAdj
Value indicating if the text should be emphasized. A value of 0 specifies no emphasis, while 1 specifies emphasis. This value is set using the <Emph> XML tag.
- RateAdj
Rate associated with the voice. This value is set using the <Rate> XML tag. This value should be combined with the baseline rate to yield the final rate value. The baseline rate can be either the default, or a value set by ISpVoice::SetRate.
- Volume
Volume associated with the voice. It is set using the <Volume> XML tag. This value should be combined with the baseline volume to yield the final volume value. The baseline volume can be either the default, or a value set by ISpVoice::SetVolume.
- PitchAdj
Pitch associated with the voice. It is set using the <Pitch> XML tag.
- SilenceMSecs
Length of a silence, in milliseconds, to be inserted into the audio output. This value is always 0 unless eAction is set to SPVA_Silence. This value is set using the <Silence> XML tag.
- pPhoneIds
Pointer to a null-terminated array of phoneme identifiers representing the pronunciation, possibly associated with text, to be inserted into the audio output. The value is set using the <Pron> XML tag.
- ePartOfSpeech
A part of speech value to associate with the voice. Possible values are defined for the SPPARTOFSPEECH enumeration. This value is set using the <PartOfSp> XML tag.
- Context
A voice context to associate with the voice. This context is represented by an SPVCONTEXT structure. It is set through the <Context> XML tag.
Requirements
| Header | sapi.h, sapi.idl |
| Windows Embedded CE | Windows CE .NET 4.1 and later |