Reco Set Input Modes

This Reco tool sets the Eic_RecoInputModes interaction attribute to the specified value. If the ‘Only supported modes’ checkbox is checked, only those bits in the interaction attribute will be set whose associated input modes are currently enabled by the session. For example, if the ‘Input Mode’ argument is "dtmf voice," but the server doesn’t support ASR or it was not enabled for the session of this interaction (‘Reco Initialize’), the interaction attribute will be set to "dtmf."

If the interaction does not yet have a session (Reco Initialize has not yet been called), the Eic_RecoInputModes attribute will only be constrained by whether ASR is supported or not. Thus, calling this tool before calling Reco Initialize and subsequently calling Reco Initialize with undefined Input Modes has the same effect as calling Reco Initialize with the Input Modes parameter defined.

After Reco Initialize has been called, this tool is useful to temporarily disable the ASR (or DTMF) input as needed for all subsequent inputs (unless again overwritten by the Reco Input or Reco Basic Input tools).

Note: If the session was initialized without ASR (DTMF only), forcing an input mode that enables voice input will not cause an ASR session to be created. The interaction attribute will be changed and thus the prompts may change, but the input will still be limited DTMF. The Reco Initialize tool must be used to activate ASR for a session.

Inputs

Interaction

Identifier of the interaction.

Input Modes

Input modes to enable. This parameter is optional, and by default is set to modes enabled by Reco Initialize or the default of the recognition subsystem (if no session).

Only set modes supported for the interaction

This checkbox specifies how the input modes are set. It is checked by default and will thus only set supported modes. For example, if the argument is "dtmf voice" and ASR is not installed or has not been initialized for this session, the Eic_RecoInputModes attribute is set to "1."

Uncheck this box if you want the Eic_RecoInputModes attribute to be set to the value of the Input Modes argument, regardless of whether the specified input modes are supported.

Outputs

Old Input Modes

A space delimited list of names of the previous value(s) of the Eic_RecoInputModes attribute.

Error Code

This output parameter contains the error code if the tool failed.

Error Text

Text accompanying the error code.

Exit Paths 

Success

This path is taken if the value has been set successfully.

None Set

This path is taken if the Eic_RecoInputModes attribute has been set to 0 because either the Input Modes argument is 0 or all modes are not supported (and the ‘Only supported modes’ checkbox is checked).

Failure

This path is taken if an error occurred.