Description: Play an alarm sound. This statement is responsible for setting the Value of the alarm priority tags to the number of sessions playing that alarm priority.
Returns: Nothing
Usage: Steady State
Format: PlaySound(Alarm)
Parameters: Alarm { Alarm } { required } { no default: }
The object value of the alarm for which to play the sound. This parameter is maintained for backward compatibility only.
Comments: In versions of VTS prior to 7.5, alarm sounds were played using the system speaker. In VTS versions 7.5 and later, alarm sounds are generated using wave files and can be heard with a sound card and speakers.
A wave generator plug-in module produces the wave files to be played, and these are stored within the Resources directory within the VTS layer directory (e.g. C:\VTS\VTS\Resources\). All wave files generated by the WAVGenerator module are 16-bit 44.1kHz MONO.
The wave file name is a concatenated string of the two tones, the two times, and the number of cycles. The file name uses the tones and frequencies to precisely tell you what kind of a wave file it is, thereby preventing the creation of duplicate files which produce the same sound.
Note: The Beep function has been reserved for backward compatibility.
See Also: