Share via


Note

Please see Azure Cognitive Services for Speech documentation for the latest supported speech solutions.

Microsoft Speech Platform

ISpVoice::SetAlertBoundary

ISpVoice::SetAlertBoundary specifies which event should be used as the insertion point for alert priority voice interruptions and ISpVoice::Pause calls.  

<pre IsFakePre="true" xmlns="http://www.w3.org/1999/xhtml"> <strong>HRESULT SetAlertBoundary(</strong><a runat="server" href="jj127462(v=msdn.10).md"><strong>SPEVENTENUM</strong></a> <em>eBoundary</em> <strong>);</strong> </pre>

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. 

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 normal priority voices, and pauses will only be able to occur on the specified event boundaries.

The default alert boundary event is SPEI_WORD_BOUNDARY.

See ISpVoice::SetPriority for more details on voice priorities.