swirec_return_waveform

Returns waveforms in recognition results.

Value

Boolean

Default

1 (enabled)

How to set

Shown in precedence order (see Rules of parameter precedence):

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

In a parameter grammar.

In a grammar using a <meta> tag (see the text on recognition-time parameters in Parameters set in grammar files).

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

Usage

Useful when an application saves waveforms for some purpose, or does a playback of collected audio to the caller. Does not affect waveforms saved to the Recognizer’s call logs.

Performance

Significantly increases the size of the returned result and may affect performance on systems where Nuance speech products and Nuance Speech Server are on separate hosts.

Browsers usually set this parameter in a RECOGNIZE request, and the parameter automatically reverts to the previous value after the recognition event. (The SET-PARAMS method defines the value for the duration of the session, or until another SET-PARAMS call.)

This property generates the following MRCP header:

Vendor-Specific-Parameters: swirec_return_waveform=”1”

Sample definition in a grammar file:

<meta name="swirec_return_waveform" content="1"/>