saiTtsSetKillOnBargeIn

Enables or disables kill-on-barge-in support for a specified synthesizer.

Prototype

DWORD saiTtsSetKillOnBargeIn ( SAI_SYNTHESIZER_HANDLE synthHd, BOOL value )

Argument

Description

synthHd

Handle associated with a synthesizer resource.

value

One of the following values:

  • TRUE: Kill-on-barge-in support is enabled.

  • FALSE: Kill-on-barge-in support is disabled.


Return values

Return value

Description

SUCCESS

 

SAIERR_INVALID_PARAMETER

One of the specified arguments is invalid.

SAIERR_UNSUPPORTED_SPEECH_PARAMETER

Speech engine does not support the specified parameter.


Details

When kill-on-barge-in is enabled, the synthesizer stops all active or pending speech requests when it is notified of a barge-in condition. If the recognizer and the synthesizer are in the same session, the recognizer engine can notify the synthesizer engine of barge-in detection and ask the synthesizer to immediately stop all speech requests. In both cases, the application performs the same action, except that the synthesizer is notified earlier when the recognizer and synthesizer are in the same session.

Note: In either case, SAIEVN_START_OF_SPEECH is sent to the application. The application must close the loop by calling saiNotifyBargeInToSynthesizer and specifying the proxySyncId received in SAIEVN_START_OF_SPEECH.

For more information, refer to Implementing a barge-in enabled prompt.

See also

saiTtsGetKillOnBargeIn