ISpVoice::SetPriority
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 method sets the priority for the voice. The default priority is SPVPRI_NORMAL.
Syntax
HRESULT SetPriority(
SPVPRIORITY ePriority
);
Parameters
- ePriority
[in] Value indicating priority associated with the current voice. Possible values are defined by the SPVPRIORITY enumeration.
Return Value
The following table shows the possible return values.
| Value | Description |
|---|---|
S_OK |
Function completed successfully. |
E_INVALIDARG |
ePriority is not an acceptable priority value. |
Remarks
Assuming an output object which implements ISpAudio, speak requests of similar priority voices are queued, and are spoken one at a time in the order they are issued. That is, speak requests from normal priority voices are put in one queue, while speak requests from alert priority voices (with priority SPVPRI_ALERT) are put in another queue.
Alert priority voices take priority over normal voices. If there are one or more speak requests from alert priority voices pending, a normal voice that is speaking will be interrupted on the next alert boundary (see ISpVoice::SetAlertBoundary), all the queued alert priority voice speak requests will be processed, and then the normal voice will continue.
Voices with the SPVPRI_OVER priority speak over (mix with) all other audio in the system with no synchronization.
If the output object does not implement ISpAudio, no serialization will occur, and all voices will be treated as if their priority is SPVPRI_OVER.
Requirements
| Header | sapi.h, sapi.idl |
| Library | sapilib.lib |
| Windows Embedded CE | Windows CE .NET 4.1 and later |