Share via


ISpVoice::SetAlertBoundary (Windows Embedded CE 6.0)

1/6/2010

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.

Syntax

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 Value

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

Header sapi.h, sapi.idl
Library sapilib.lib
Windows Embedded CE Windows CE .NET 4.1 and later

See Also

Reference

ISpVoice
SAPI Interfaces