1 // Copyright (c) 1999-2009 Nokia Corporation and/or its subsidiary(-ies).
2 // All rights reserved.
3 // This component and the accompanying materials are made available
4 // under the terms of "Eclipse Public License v1.0"
5 // which accompanies this distribution, and is available
6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
8 // Initial Contributors:
9 // Nokia Corporation - initial contribution.
16 #ifndef __ASCLISOUNDPLAY_H__
17 #define __ASCLISOUNDPLAY_H__
23 #include <asshddefs.h>
33 // ----> TASCliSoundPlayDefinition (header)
35 class TASCliSoundPlayDefinition
36 /** Defines when alarm sounds are to be played, and for how long.
38 Alarm sounds are played according to intervals that consist of a duration
41 The duration is the number of seconds that the alarm sound plays.
43 The offset is the number of minutes after the alarm expires that the alarm
46 The sound play definition is set using class RASCliSession.
55 inline TASCliSoundPlayDefinition();
57 inline TASCliSoundPlayDefinition(TTimeIntervalMinutes aOffset, TTimeIntervalSeconds aDuration);
63 inline TTimeIntervalMinutes Offset() const
64 /** Retrieves the offset.
66 @return The offset in minutes. */
69 inline TTimeIntervalSeconds Duration() const
70 /** Retrieves the duration.
72 @return The duration in seconds. */
76 private: // MEMBER DATA
80 * From the time an alarm is first displayed
82 TTimeIntervalMinutes iOffset;
85 * How long the alarm playing lasts
87 TTimeIntervalSeconds iDuration;
94 // ----> TASCliSoundPlayDefinition (inlines)
96 inline TASCliSoundPlayDefinition::TASCliSoundPlayDefinition()
97 : iOffset(KDefaultSoundPlayOffsetInSeconds), iDuration(KDefaultSoundPlayDurationInSeconds)
98 /** Default constructor.
100 The default offset is zero, and the default duration is 30 seconds. */
102 inline TASCliSoundPlayDefinition::TASCliSoundPlayDefinition(TTimeIntervalMinutes aOffset, TTimeIntervalSeconds aDuration)
103 : iOffset(aOffset), iDuration(aDuration)
104 /** Constructor that initializes the offset and duration to specified values.
106 @param aOffset Time in minutes for the offset.
107 @param aDuration Time in seconds for the duration. */