sound » play(audio)
Description
This command plays one of the predefined sounds, or a user-defined audio file via the audio parameter.
Note that this command can only play MP3 and WAV files at this time. If you need support for additional audio encoding,
please feel free to request by create an
issue.
Note also that this command will automatically skip over when the execution is triggered in a CI (Jenkins) environment. I mean, “If a Nexial test makes a sound in an execution and no one is around to hear it, does it make a sound?” Any metaphysicists out there?
See below for sampling of predefined sounds.
Parameters
- audio - specify one of the predefined sounds, or the full path of one’s own audio file (MP3 or WAV only).
Example
Below is the list of predefined sounds available as part of Nexial distribution. More will be added from time to time.
| Name | Example | Sampling |
|---|---|---|
| alert1 | sound » play(audio) | alert1 |
|
| alert2 | sound » play(audio) | alert2 |
|
| alert3 | sound » play(audio) | alert3 |
|
| alert4 | sound » play(audio) | alert4 |
|
| alert5 | sound » play(audio) | alert5 |
|
| chime1 | sound » play(audio) | chime1 |
|
| chime2 | sound » play(audio) | chime2 |
|
| chime3 | sound » play(audio) | chime3 |
|
| chime4 | sound » play(audio) | chime4 |
|
| chime5 | sound » play(audio) | chime5 |
|
| chime6 | sound » play(audio) | chime6 |
|
| error1 | sound » play(audio) | error1 |
|
| error2 | sound » play(audio) | error2 |
|
| error3 | sound » play(audio) | error3 |
|
| error4 | sound » play(audio) | error4 |
|
| error5 | sound » play(audio) | error5 |
|
| error6 | sound » play(audio) | error6 |
|
| fail1 | sound » play(audio) | fail1 |
|
| fail2 | sound » play(audio) | fail2 |
|
| success1 | sound » play(audio) | success1 |
|
| success2 | sound » play(audio) | success2 |
|
| success3 | sound » play(audio) | success3 |
Alternatively, one could use custom audio file. For example:
sound »
play(audio)|$(syspath|data|fullpath)/myaudio.mp3