Share via


Disable standby mode

Note

Standby mode is enabled by default for US English and unavailable for other languages.

Standby mode enables the user to start and stop recording using voice commands alone. In standby mode the microphone is on and Dragon Medical SpeechKit receives audio but doesn't send the audio to the Dragon Medical system. Dragon Medical SpeechKit processes the audio internally to recognize the wake up command, which resumes dictation.

Users can disable/enable it individually via the personalization & help screen, Options tab, Wake Word pane. This setting is saved in the Dragon Medical system and will be applied when the user logs on again.

For more information, see: Recording modes in iOS apps.

You can also disable standby mode programmatically so that your app no longer listens for the wake word. Proceed as follows:

Prerequisites

You've initialized a speech recognition session.

Procedure

To disable standby mode, call the setStandbyMode method on the shared session instance:

[[NUSASession sharedSession] setStandbyMode:NO];

To enable standby mode again, call setStandbyMode with the parameter YES.

setStandbyMode is reset to YES with each openForApplication call.

Remarks

  • By default, standby mode is enabled (setStandbyMode:YES) at the start of each session.
  • Standby mode must be enabled in the user settings and in your integration to be available. If standby mode is disabled in the user settings, calling setStandbyMode:YES doesn't override the user setting. If standby mode is disabled in your app, the user can't enable it in the user settings.
  • When standby mode is disabled, events that would normally start standby mode turn the microphone off instead. For example, the 'stop recording' and 'go to sleep' voice commands turn off the microphone instead of starting standby mode.
  • Depending on the app state when setStandbyMode is called, your app might switch immediately to a different state. This can affect the user experience. The possible state changes are as follows:
Initial state when setStandbyMode is called Enable/disable standby mode New state
Standby mode Enable Standby mode (no change)
Disable Microphone off
Microphone off Enable Standby mode
Disable Microphone off (no change)
Dictation, Text-To-Speech Enable or disable No change

See also

Recording modes in iOS apps