AlmTone

VTS Functions > A Functions

AlmTone

Description: This statement sets the pitch and duration of the alarm tone.

Format: AlmTone(Tone1, Time1, Tone2, Time2, N)

Returns: Nothing

Usage: Script or Steady State

Parameters: Tone1 { numeric } { required } { no default: }

Any numeric expression giving the frequency of the first alarm tone in the sequence.

Time1 { numeric } { required } { no default: }

Any numeric expression giving the duration in seconds of the first alarm tone in the sequence.

Tone2 { numeric } { required } { no default: }

Any numeric expression giving the frequency of the second alarm tone in the sequence.

Time2 { numeric } { required } { no default: }

Any numeric expression giving the duration in seconds of the second alarm tone in the sequence.

N { numeric } { required } { no default: }

Any numeric expression giving the number of times to repeat the two tone sequence when an alarm occurs.

Comments: The tone sequence is sounded on the computer's internal speaker for any alarm that has the beeper option selected. If a second alarm occurs before the tones for an alarm are complete, the tone count is reset and the tones continue. Note that none of the values are set if any parameters are Invalid.

Example:

AlmTone(2000, 0.1, 0, 0.4, 3);

In this example, the alarm sound changes to a 2000 Hz tone for 0.1 seconds, followed by 0.4 seconds of silence. This alarm sound cycle is repeated 3 times.