swiep_mode

Sets special recognition modes (such as magic word) in the endpointer.

Value

One of the following: begin_only, magic_word, selective_barge_in, begin_end.

Default

begin_only

How to set

Set in the browser, using the Vendor-Specific-Parameters header in a RECOGNIZE or SET-PARAMS request.

In Management Station set on the Nuance recognition service. If not using Management Station, set in a Recognizer configuration file (User-nrsxx.xml).

Usage

Seldom used. because most applications do not require the features. But when a feature is needed, this parameter is required.

Applicable for Nuance Recognizer. Not applicable for Dragon Voice recognition.

To use an voice browser message to set this parameter before a recognition event, you must also set swirec_barge_in_mode. (The endpointer and the recognizer must be set to the same mode.)

Set this parameter in conjunction with compatible recognizer modes. Typically, this parameter gets set when the application enables the magic_word or selective_barge_in mode for the next recognition (after which, the mode returns to the default).

Use this parameter to change between the available endpointer modes. (For a detailed description of the modes, see Controlling endpointing.)

  • begin_end: (Seldom used.) The endpointer detects the beginning and end of speech.
  • begin_only: (Frequently used.) The endpointer detects the beginning of speech; the recognizer detects the end.
  • selective_barge_in: (Prevents accidental barge-in while applications play long, informational prompts.) The endpointer detects the beginning of speech, and filters the speech sent to the recognizer. Do not terminate the current prompt until after the recognizer computes a successful result.

    When using this mode, the application typically instructs callers to speak a key word or phrase to interrupt the long prompt. As a result, callers can be less careful while listening, and can even talk to other people without accidentally interrupting the prompt.

  • magic_word: (Lets people have a conversation while the recognizer listens for a small number of command words, known as magic words.) The endpointer filters the conversation for magic word candidates and sends the candidate to the recognizer.

    This mode is similar to selective_barge_in except that the endpointer adds duration constraints to each candidate. In this mode, the application waits in the background triggered into action by the recognition of a magic word. There is typically no current prompt to be interrupted.

Browsers usually set this parameter in a RECOGNIZE request, and the parameter automatically reverts to the previous value after the recognition event. (Alternatively, browsers can use the SET-PARAMS method. See Configuring Recognizer with the browser.)

Vendor-Specific-Parameters: swiep_mode=begin_only

Related parameters