Sound Control

Use of sound is one of several ways that the Alarm Server notifies the user. By configuring sound the Alarm Server is able to:

• silence all alarms (RASCliSession::SetAlarmSoundState()) - the current alarm sound is silenced. No sound is played when an alarm expires

• silence all alarms until a specific time (RASCliSession::SetAlarmSoundsSilentUntil()) - the sound playing is silenced until a specific time. No sound is played for any alarms notifying before this time

• silence all alarms for a specified period (RASCliSession::SetAlarmSoundsSilentFor()). This silences the current sound for a given amount of time. No sound is played for any alarms notifying during this period

• cancel alarm silence (RASCliSession::CancelAlarmSilence()) - if the current alarm sound has been silenced, this cancels the silent state

• configure alarm sound play intervals (RASCliSession::SetAlarmPlayIntervalsL()). This updates sound play intervals, which specify the duration of the ‘play / silence / play’, when an alarm expires

• determine whether alarm sound playing is temporarily silenced (RASCliSession::AlarmSoundsTemporarilySilenced()). This returns ETrue if alarm sound playing is temporarily silenced, otherwise EFalse is specified.

The sound play definition (TASCliSoundPlayDefinition) is set using the RASCliSession class. Alarm sounds are played according to intervals that consist of a duration and an offset. The TASCliSoundPlayDefinition class defines when alarm sounds are to be played, and for how long. The duration is the number of seconds that the alarm sound plays. The offset is the number of minutes after the alarm expires that the alarm sound plays.

As shown below, alarm play intervals consist of a duration and an onset. At each offset, the Alarm Server makes a request to the Alarm Alert Server to show the alarm and play the alarm sound. At the end of each duration period, the Alarm Server makes a request to the Alarm Alert Server to hide the alarm and stop playing the alarm sound.