ISpVoice::SetPriority

  • Article

This method sets the priority for the voice. The default priority is SPVPRI_NORMAL.

HRESULT SetPriority(
  SPVPRIORITY ePriority
);

Parameters

  • ePriority
    [in] Value indicating priority associated with the current voice. Possible values are defined by the SPVPRIORITY enumeration.

Return Values

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

OS Versions: Windows CE .NET 4.1 and later.
Header: Sapi.h, Sapi.idl.
Link Library: Sapilib.lib.

See Also

ISpVoice | SAPI Interfaces

 Last updated on Saturday, April 10, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.