Class TASCliSoundPlayDefinition

class TASCliSoundPlayDefinition;

Description

Defines when alarm sounds are to be played, and for how long.

Alarm sounds are played according to intervals that consist of a duration and an offset.

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.

The sound play definition is set using class RASCliSession.

Members

Defined in TASCliSoundPlayDefinition:
Duration(), Offset(), TASCliSoundPlayDefinition(), TASCliSoundPlayDefinition()

inline TASCliSoundPlayDefinition();

Description

Default constructor.

The default offset is zero, and the default duration is 30 seconds.

inline TASCliSoundPlayDefinition(TTimeIntervalMinutes aOffset, TTimeIntervalSeconds aDuration);

Description

Constructor that initializes the offset and duration to specified values.

Parameters

TTimeIntervalMinutes aOffset Time in minutes for the offset. TTimeIntervalSeconds aDuration Time in seconds for the duration.

inline TTimeIntervalMinutes Offset() const;

Description

Retrieves the offset.

Return value

TTimeIntervalMinutes The offset in minutes.

inline TTimeIntervalSeconds Duration() const;

Description

Retrieves the duration.

Return value

TTimeIntervalSeconds The duration in seconds.