Free Download

Knowledge Base

Back to support overview

Play Sound

Plays a specified sound.

Identifier: play_sound

Attributes

  • sound: Contains a string identifying the sound that should be played. Either a predefined sound or an asset can be used to reference media (e.g., MP3, WAV).
    • Required: Yes
    • Default value: Empty
  • loop: Plays a sound in an endless loop. To stop the sound, see StopSoundAction.
    • Required: No
    • Default value: False

Available Sounds

  • CONFIRM
  • ERROR
  • DENY
  • NEXT
  • PREVIOUS
  • DISCONNECT
  • CONNECT
  • SPEECH_SUCCESS
  • SPEECH_FAILURE
  • BEEP
  • CLUCK

Examples

<play_sound id="connect_to_server" sound="CONNECT"/>
<play_sound id="play_song" sound="xai:/sound/album/sesame_street/mana_mana.mp3?version=1"/>

Stop Sound

Stops the currently playing sound.

Identifier: stop_sound

Example

<stop_sound id="stop_sound"/>

Text to Speech

Creates speech output based on a text.

Identifier: text_to_speech

Elements

  • input: Contains the text input that is converted into speech output.
  • input_to_resolve: Contains the text input that is first evaluated by the WF engine before it is converted into speech output.

Examples

To convert the location of the current pick into speech output:

<text_to_speech id="say_location">
    <param name="input_to_resolve"><![CDATA[?{"Aisle "+ pickOrder.groups[activeGroup].picks[0].source.label.substring(2,3) +" Location " + pickOrder.groups[activeGroup].picks[0].source.label.substring(4,7)}?]]>
    </param>
</text_to_speech>

To add "Location 5" to the speech output:

<text_to_speech id="say_location">
    <param name="input">Location 5</param>
</text_to_speech>