Queue() method

Elements/Objects that the method can be called on

• <prompt ...>
• Attribute description:
  • Queue the prompt onto the prompt subqueue.
  • Takes an optional argument of type string (which may be markup, as for inline content).
    • If no argument is provided, the method queues the inline content of the object.
    • If an argument is provided, the value of the argument is treated as the string to be output instead of inline content, and is subject to any relevant features specified in the prompt's attributes (i.e. bargein, xmlns and xml:lang).
  • After an individual prompt has finished normal playback, the onComplete event is thrown, and its status code is set to zero.
    
• Syntax: Object.Queue([strText]);
  
• Parameters:
  • strText: optional. String holding the text or markup to be sent to the speech output engine.
    • If present, this value is used instead of the contents of the object.
    • The content specified in the argument is treated exactly as if it were inline content in terms of resolving external references, etc..
• Retrun Value: none
  
• Exception: In In the event of a problem with queuing the prompt, e.g. that external content cannot be retrieved and no alternate inline text is provided (see the content element), the onError event is thrown, and the prompt's status code is set to one of the relevant values described in the onError section.

Example

Extra info

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