Stop() method

Elements/Objects that the method can be called on

• <dtmf ...>
  • Attribute description:
    • Stops dtmf collection and returns results received up to the point when collection was stopped.
    • Any subsequent keystrokes entered by the user, however, will remain in the platform buffer unless explicitly flushed.
    • The result of calling Stop() will be an onReco or onNoReco event and the return of a result, or an onError event.
    • If the dtmf object has not been started, this call has no effect.
    • In telephony profiles, the Stop() method is executed automatically by the detection of a disconnect (the order of firing is as follows: listen, dtmf, PromptQueue), and the relevant event thrown with status code -30.
      
  • Syntax: Object.Stop();
    
  • Parameters: none
    
  • Retrun Value: none
    
  • Exception: There are no explicit exceptions associated with this method.
    • However, if there is any problem an onError event is fired and the status codes as outlined in onError are set.

• <listen ...>
  • Attribute description:
    • The Stop method is a call to end the recognition process (or recording if the record tag is present).
    • The listen object stops processing audio, and the recognizer returns recognition results on the audio received up to the point where recording was stopped. Once the recognition process completes, all the recognition resources used by listen are released.
    • The result of calling Stop() will be an onReco or onNoReco event and the return of a recognition result, or an onError event.
      • For recording-only listens, unless there is a recording error, the onReco event will fire as a result, once the platform completes the audio recording.
    • Note that this method need not be used explicitly for typical recognitions in automatic mode (see 2.2.6 in the SALT 1.0 Specs), since the recognizer itself will stop the listen object on endpoint detection after recognizing a complete grammar match.
    • If the listen has not been started, the method call has no effect.
    • In telephony profiles, the Stop() method is executed automatically by the detection of a disconnect (the order of firing is as follows: listen, dtmf, PromptQueue), and as a result onReco or onNoReco is thrown.
      • For recording-only listens, the method results in onReco and a status code of -30.
  • Syntax: Object.Stop();
    
  • Parameters: none
    
  • Retrun Value: none
    
  • Exception: There are no explicit exceptions associated with this method.
    • However, if Stop() is called before speech is detected, the onNoReco event is fired and status code is set to -11, and if there is any problem then an onError event is fired and the status codes are set as outlined in onError section.

• PromptQueue
• Attribute description:
  • Stop playback and flush the subqueue.
  • If playback has been paused, the method simply flushes the current subqueue.
  • If playback is not underway at all, the method has no effect.
    
• Syntax: PromptQueue.Stop();
  
• Parameters: none
  
• Retrun Value: none
  
• Exception: There are no explicit exceptions associated with this method.

Example

Extra info

For details on usage of this element, see the SALT Specification, Version 1.0.