|
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". |
|
7 // |
|
8 // Initial Contributors: |
|
9 // Nokia Corporation - initial contribution. |
|
10 // |
|
11 // Contributors: |
|
12 // |
|
13 // Description: |
|
14 // |
|
15 |
|
16 #ifndef __ASCLISOUNDPLAY_H__ |
|
17 #define __ASCLISOUNDPLAY_H__ |
|
18 |
|
19 // System includes |
|
20 #include <e32base.h> |
|
21 |
|
22 // User includes |
|
23 #include <asshddefs.h> |
|
24 |
|
25 // Type definitions |
|
26 |
|
27 // Constants |
|
28 |
|
29 // Enumerations |
|
30 |
|
31 |
|
32 // |
|
33 // ----> TASCliSoundPlayDefinition (header) |
|
34 // |
|
35 class TASCliSoundPlayDefinition |
|
36 /** Defines when alarm sounds are to be played, and for how long. |
|
37 |
|
38 Alarm sounds are played according to intervals that consist of a duration |
|
39 and an offset. |
|
40 |
|
41 The duration is the number of seconds that the alarm sound plays. |
|
42 |
|
43 The offset is the number of minutes after the alarm expires that the alarm |
|
44 sound plays. |
|
45 |
|
46 The sound play definition is set using class RASCliSession. |
|
47 @publishedAll |
|
48 @released |
|
49 */ |
|
50 { |
|
51 // |
|
52 public: // CONSTRUCT |
|
53 // |
|
54 |
|
55 inline TASCliSoundPlayDefinition(); |
|
56 |
|
57 inline TASCliSoundPlayDefinition(TTimeIntervalMinutes aOffset, TTimeIntervalSeconds aDuration); |
|
58 |
|
59 // |
|
60 public: // ACCESS |
|
61 // |
|
62 |
|
63 inline TTimeIntervalMinutes Offset() const |
|
64 /** Retrieves the offset. |
|
65 |
|
66 @return The offset in minutes. */ |
|
67 { return iOffset; } |
|
68 |
|
69 inline TTimeIntervalSeconds Duration() const |
|
70 /** Retrieves the duration. |
|
71 |
|
72 @return The duration in seconds. */ |
|
73 { return iDuration; } |
|
74 |
|
75 // |
|
76 private: // MEMBER DATA |
|
77 // |
|
78 |
|
79 /* |
|
80 * From the time an alarm is first displayed |
|
81 */ |
|
82 TTimeIntervalMinutes iOffset; |
|
83 |
|
84 /* |
|
85 * How long the alarm playing lasts |
|
86 */ |
|
87 TTimeIntervalSeconds iDuration; |
|
88 }; |
|
89 |
|
90 |
|
91 |
|
92 |
|
93 // |
|
94 // ----> TASCliSoundPlayDefinition (inlines) |
|
95 // |
|
96 inline TASCliSoundPlayDefinition::TASCliSoundPlayDefinition() |
|
97 : iOffset(KDefaultSoundPlayOffsetInSeconds), iDuration(KDefaultSoundPlayDurationInSeconds) |
|
98 /** Default constructor. |
|
99 |
|
100 The default offset is zero, and the default duration is 30 seconds. */ |
|
101 {} |
|
102 inline TASCliSoundPlayDefinition::TASCliSoundPlayDefinition(TTimeIntervalMinutes aOffset, TTimeIntervalSeconds aDuration) |
|
103 : iOffset(aOffset), iDuration(aDuration) |
|
104 /** Constructor that initializes the offset and duration to specified values. |
|
105 |
|
106 @param aOffset Time in minutes for the offset. |
|
107 @param aDuration Time in seconds for the duration. */ |
|
108 {} |
|
109 |
|
110 #endif |