ISpVoice::SetAlertBoundary

  • Article

This method specifies the event to use as the insertion point for alert priority voice interruptions (see ISpVoice::SetPriority for more details on voice priorities) and ISpVoice::Pause calls.

HRESULT SetAlertBoundary(
  SPEVENTENUM eBoundary
);

Parameters

  • eBoundary
    [in] SPEVENTENUM enumeration value that specifies which event to use for the alert insertion point. Appropriate events to use for this purpose include SPEI_WORD_BOUNDARY, SPEI_SENTENCE_BOUNDARY, SPEI_PHONEME, SPEI_VISEME, and possibly SPEI_VOICE_CHANGE or SPEI_TTS_BOOKMARK (though using these last two may be a bit strange).

Return Values

The following table shows the possible return values.

Value Description
S_OK Function completed successfully.
E_INVALIDARG eBoundary is invalid.

Remarks

Events, such as word and sentence boundaries, are queued by the TTS engine during text rendering. Alert priority voices will only be able to interrupt typical priority voices, and pauses will only be able to occur, on the specified event boundaries.

The default alert boundary event is SPEI_WORD_BOUNDARY.

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.