|
sl@0
|
1 |
/*
|
|
sl@0
|
2 |
* Copyright (c) 2004 Nokia Corporation and/or its subsidiary(-ies).
|
|
sl@0
|
3 |
* All rights reserved.
|
|
sl@0
|
4 |
* This component and the accompanying materials are made available
|
|
sl@0
|
5 |
* under the terms of "Eclipse Public License v1.0"
|
|
sl@0
|
6 |
* which accompanies this distribution, and is available
|
|
sl@0
|
7 |
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
sl@0
|
8 |
*
|
|
sl@0
|
9 |
* Initial Contributors:
|
|
sl@0
|
10 |
* Nokia Corporation - initial contribution.
|
|
sl@0
|
11 |
*
|
|
sl@0
|
12 |
* Contributors:
|
|
sl@0
|
13 |
*
|
|
sl@0
|
14 |
* Description: This file contains definitions of GlobalAudioSettings.
|
|
sl@0
|
15 |
*
|
|
sl@0
|
16 |
*/
|
|
sl@0
|
17 |
|
|
sl@0
|
18 |
|
|
sl@0
|
19 |
|
|
sl@0
|
20 |
#ifndef GLOBALAUDIOSETTINGS_H
|
|
sl@0
|
21 |
#define GLOBALAUDIOSETTINGS_H
|
|
sl@0
|
22 |
|
|
sl@0
|
23 |
#include <e32base.h>
|
|
sl@0
|
24 |
|
|
sl@0
|
25 |
class CGlobalAudioSettingsImpl;
|
|
sl@0
|
26 |
class MAudioSettingsObserver;
|
|
sl@0
|
27 |
class MAudioClientsListObserver;
|
|
sl@0
|
28 |
|
|
sl@0
|
29 |
/**
|
|
sl@0
|
30 |
* API for accessing global settings that affects Audio behavior.
|
|
sl@0
|
31 |
*
|
|
sl@0
|
32 |
* This is API is intended to be used by Adaptation to read system attributes
|
|
sl@0
|
33 |
* that affect audio behavior. This API also provides notification when any
|
|
sl@0
|
34 |
* of these attribute values change.
|
|
sl@0
|
35 |
*
|
|
sl@0
|
36 |
* @lib GlobalAudioSettings.lib
|
|
sl@0
|
37 |
* @since S60 3.2
|
|
sl@0
|
38 |
*/
|
|
sl@0
|
39 |
class CGlobalAudioSettings : public CBase
|
|
sl@0
|
40 |
{
|
|
sl@0
|
41 |
public:
|
|
sl@0
|
42 |
enum TAudioClientListType
|
|
sl@0
|
43 |
{
|
|
sl@0
|
44 |
EActiveAudioClients,
|
|
sl@0
|
45 |
EPausedAudioClients
|
|
sl@0
|
46 |
};
|
|
sl@0
|
47 |
|
|
sl@0
|
48 |
enum TGASRingingType
|
|
sl@0
|
49 |
{
|
|
sl@0
|
50 |
/** The tone is played in a loop.
|
|
sl@0
|
51 |
*/
|
|
sl@0
|
52 |
EGASRingingTypeRinging = 0,
|
|
sl@0
|
53 |
/**
|
|
sl@0
|
54 |
* The tone is played in a loop. On the 1st round, the volume is gradually
|
|
sl@0
|
55 |
* increment from the lowest level to the set level.
|
|
sl@0
|
56 |
*/
|
|
sl@0
|
57 |
EGASRingingTypeAscending = 1,
|
|
sl@0
|
58 |
/** The tone is played only once.
|
|
sl@0
|
59 |
*/
|
|
sl@0
|
60 |
EGASRingingTypeRingingOnce = 2,
|
|
sl@0
|
61 |
/**
|
|
sl@0
|
62 |
* The phone only beeps once instead of playing the tone if one has been set.
|
|
sl@0
|
63 |
*/
|
|
sl@0
|
64 |
EGASRingingTypeBeepOnce = 3,
|
|
sl@0
|
65 |
/** The phone is silent.
|
|
sl@0
|
66 |
* This Ringing type is set when the phone is in silence mode.
|
|
sl@0
|
67 |
*/
|
|
sl@0
|
68 |
EGASRingingTypeSilent = 4
|
|
sl@0
|
69 |
};
|
|
sl@0
|
70 |
|
|
sl@0
|
71 |
enum TGASKeypadVolume
|
|
sl@0
|
72 |
{
|
|
sl@0
|
73 |
EGASKeypadVolumeOff = 0,
|
|
sl@0
|
74 |
EGASKeypadVolumeLevel1 = 1,
|
|
sl@0
|
75 |
EGASKeypadVolumeLevel2 = 2,
|
|
sl@0
|
76 |
EGASKeypadVolumeLevel3 = 3
|
|
sl@0
|
77 |
};
|
|
sl@0
|
78 |
public:
|
|
sl@0
|
79 |
/**
|
|
sl@0
|
80 |
* function for creating the GlobalAudioSettings
|
|
sl@0
|
81 |
*
|
|
sl@0
|
82 |
*/
|
|
sl@0
|
83 |
IMPORT_C static CGlobalAudioSettings* NewL(MAudioSettingsObserver& aAudioSettingsObserver);
|
|
sl@0
|
84 |
|
|
sl@0
|
85 |
/**
|
|
sl@0
|
86 |
* Destructor.
|
|
sl@0
|
87 |
*
|
|
sl@0
|
88 |
*/
|
|
sl@0
|
89 |
IMPORT_C ~CGlobalAudioSettings();
|
|
sl@0
|
90 |
|
|
sl@0
|
91 |
/**
|
|
sl@0
|
92 |
* Returns warning tones status set in the current profile.
|
|
sl@0
|
93 |
*
|
|
sl@0
|
94 |
* If warning tones are disabled in the current profile, Adaptation
|
|
sl@0
|
95 |
* should reject play requests having preferences mapped to warning tones.
|
|
sl@0
|
96 |
*
|
|
sl@0
|
97 |
* @since S60 3.2
|
|
sl@0
|
98 |
* @return TBool aEnable. ETrue if warning tones are enabled else EFalse.
|
|
sl@0
|
99 |
*/
|
|
sl@0
|
100 |
IMPORT_C TBool IsWarningTonesEnabled();
|
|
sl@0
|
101 |
|
|
sl@0
|
102 |
/**
|
|
sl@0
|
103 |
* Returns message tones status set in the current profile.
|
|
sl@0
|
104 |
*
|
|
sl@0
|
105 |
* If message tones are disabled in the current profile, Adaptation
|
|
sl@0
|
106 |
* should reject play requests having preferences mapped to message tones.
|
|
sl@0
|
107 |
*
|
|
sl@0
|
108 |
* @since S60 3.2
|
|
sl@0
|
109 |
* @return TBool aEnable. ETrue if message tones are enabled else EFalse.
|
|
sl@0
|
110 |
*/
|
|
sl@0
|
111 |
IMPORT_C TBool IsMessageTonesEnabled();
|
|
sl@0
|
112 |
|
|
sl@0
|
113 |
/**
|
|
sl@0
|
114 |
* Returns current silent profile status.
|
|
sl@0
|
115 |
*
|
|
sl@0
|
116 |
* @since S60 3.2
|
|
sl@0
|
117 |
* @return TBool aEnable. ETrue if current profile is silent profile
|
|
sl@0
|
118 |
* else EFalse.
|
|
sl@0
|
119 |
*/
|
|
sl@0
|
120 |
IMPORT_C TBool IsSilentProfileEnabled();
|
|
sl@0
|
121 |
|
|
sl@0
|
122 |
/**
|
|
sl@0
|
123 |
* Returns vibra status set in the current profile..
|
|
sl@0
|
124 |
*
|
|
sl@0
|
125 |
* If vibra is enabled in the current profile and vibra is not part of the
|
|
sl@0
|
126 |
* content, Adaptation should play vibra periodically for play requests
|
|
sl@0
|
127 |
* having preferences mapped to vibra settings.
|
|
sl@0
|
128 |
*
|
|
sl@0
|
129 |
* @since S60 3.2
|
|
sl@0
|
130 |
* @return TBool aEnable. ETrue if current profile vibra active else EFalse.
|
|
sl@0
|
131 |
*/
|
|
sl@0
|
132 |
IMPORT_C TBool IsVibraEnabled();
|
|
sl@0
|
133 |
|
|
sl@0
|
134 |
/**
|
|
sl@0
|
135 |
* Returns PublicSilence feature.
|
|
sl@0
|
136 |
*
|
|
sl@0
|
137 |
* If PublicSilence feature is enabled and if current profile is Silent
|
|
sl@0
|
138 |
* Profile, For all play requests having preferences mapped to Public
|
|
sl@0
|
139 |
* Silence setting, audio should only be played out via private accessory.
|
|
sl@0
|
140 |
* If no private accessory is connected, then playback should be rejected.
|
|
sl@0
|
141 |
*
|
|
sl@0
|
142 |
* @since S60 3.2
|
|
sl@0
|
143 |
* @return TBool aEnable. ETrue if PublicSilentMode is set else EFalse.
|
|
sl@0
|
144 |
*/
|
|
sl@0
|
145 |
IMPORT_C TBool IsPublicSilenceEnabled();
|
|
sl@0
|
146 |
|
|
sl@0
|
147 |
/**
|
|
sl@0
|
148 |
* Returns Message Alert Tone
|
|
sl@0
|
149 |
*
|
|
sl@0
|
150 |
*
|
|
sl@0
|
151 |
* The filename selected as the message alert tone in the
|
|
sl@0
|
152 |
* current profile.
|
|
sl@0
|
153 |
*
|
|
sl@0
|
154 |
*
|
|
sl@0
|
155 |
*
|
|
sl@0
|
156 |
* @return TDesC& aMessageAlertToneName. z:\\resource\\No_Sound.wav is returned if sound is off,else selected filename
|
|
sl@0
|
157 |
* is returned
|
|
sl@0
|
158 |
*/
|
|
sl@0
|
159 |
IMPORT_C TDesC& MessageAlertTone();
|
|
sl@0
|
160 |
|
|
sl@0
|
161 |
/**
|
|
sl@0
|
162 |
* Returns Email Alert Tone status
|
|
sl@0
|
163 |
*
|
|
sl@0
|
164 |
*
|
|
sl@0
|
165 |
* The filename selected as the email alert tone in the
|
|
sl@0
|
166 |
* current profile
|
|
sl@0
|
167 |
*
|
|
sl@0
|
168 |
*
|
|
sl@0
|
169 |
*
|
|
sl@0
|
170 |
* @return TBool aEnable. ETrue if current profile message tone is on else EFalse.
|
|
sl@0
|
171 |
*/
|
|
sl@0
|
172 |
IMPORT_C TBool IsMessageAlertToneEnabled();
|
|
sl@0
|
173 |
/**
|
|
sl@0
|
174 |
* Returns Email Alert Tone
|
|
sl@0
|
175 |
*
|
|
sl@0
|
176 |
*
|
|
sl@0
|
177 |
* The filename selected as the email alert tone in the
|
|
sl@0
|
178 |
* current profile
|
|
sl@0
|
179 |
*
|
|
sl@0
|
180 |
*
|
|
sl@0
|
181 |
*
|
|
sl@0
|
182 |
* @return TDesC& aEmailAlertToneName. z:\\resource\\No_Sound.wav is returned if sound is off,else selected filename
|
|
sl@0
|
183 |
* is returned
|
|
sl@0
|
184 |
*/
|
|
sl@0
|
185 |
IMPORT_C TDesC& EmailAlertTone();
|
|
sl@0
|
186 |
|
|
sl@0
|
187 |
/**
|
|
sl@0
|
188 |
* Returns Email Alert Tone status
|
|
sl@0
|
189 |
*
|
|
sl@0
|
190 |
*
|
|
sl@0
|
191 |
* The filename selected as the email alert tone in the
|
|
sl@0
|
192 |
* current profile
|
|
sl@0
|
193 |
*
|
|
sl@0
|
194 |
*
|
|
sl@0
|
195 |
*
|
|
sl@0
|
196 |
* @return TBool aEnable. ETrue if current profile email alert tone is on else EFalse.
|
|
sl@0
|
197 |
*/
|
|
sl@0
|
198 |
IMPORT_C TBool IsEmailAlertToneEnabled();
|
|
sl@0
|
199 |
/**
|
|
sl@0
|
200 |
* Returns the RingingType
|
|
sl@0
|
201 |
*
|
|
sl@0
|
202 |
*
|
|
sl@0
|
203 |
* Ringing type set in the current profile
|
|
sl@0
|
204 |
*
|
|
sl@0
|
205 |
*
|
|
sl@0
|
206 |
*
|
|
sl@0
|
207 |
*
|
|
sl@0
|
208 |
* @return TGASRingingType aRingingType.
|
|
sl@0
|
209 |
*/
|
|
sl@0
|
210 |
|
|
sl@0
|
211 |
IMPORT_C TGASRingingType RingingType();
|
|
sl@0
|
212 |
|
|
sl@0
|
213 |
/**
|
|
sl@0
|
214 |
* Returns Videocall Alert Tone
|
|
sl@0
|
215 |
*
|
|
sl@0
|
216 |
*
|
|
sl@0
|
217 |
* The filename selected as the video call alert tone in the
|
|
sl@0
|
218 |
* current profile
|
|
sl@0
|
219 |
*
|
|
sl@0
|
220 |
*
|
|
sl@0
|
221 |
*
|
|
sl@0
|
222 |
* @return TDesC& aVideoCallAlertToneName. z:\\resource\\No_Sound.wav is returned if sound is off,else selected filename
|
|
sl@0
|
223 |
* is returned
|
|
sl@0
|
224 |
*/
|
|
sl@0
|
225 |
|
|
sl@0
|
226 |
IMPORT_C TDesC& VideoCallAlertTone();
|
|
sl@0
|
227 |
/**
|
|
sl@0
|
228 |
* Returns Videocall Alert Tone status
|
|
sl@0
|
229 |
*
|
|
sl@0
|
230 |
*
|
|
sl@0
|
231 |
* The filename selected as the video call alert tone in the
|
|
sl@0
|
232 |
* current profile
|
|
sl@0
|
233 |
*
|
|
sl@0
|
234 |
*
|
|
sl@0
|
235 |
*
|
|
sl@0
|
236 |
* @return TBool aEnable. ETrue if current profile videocall alert tone is on else EFalse.
|
|
sl@0
|
237 |
*/
|
|
sl@0
|
238 |
IMPORT_C TBool IsVideoCallAlertToneEnabled();
|
|
sl@0
|
239 |
/**
|
|
sl@0
|
240 |
* Returns Ringing Alert Tone
|
|
sl@0
|
241 |
*
|
|
sl@0
|
242 |
*
|
|
sl@0
|
243 |
* The filename selected as the ringing alert tone in the
|
|
sl@0
|
244 |
* current profile
|
|
sl@0
|
245 |
*
|
|
sl@0
|
246 |
*
|
|
sl@0
|
247 |
* @return TDesC& aRingingAlertTone1Name. z:\\resource\\No_Sound.wav is returned if sound is off,else selected filename
|
|
sl@0
|
248 |
* is returned
|
|
sl@0
|
249 |
*
|
|
sl@0
|
250 |
*/
|
|
sl@0
|
251 |
|
|
sl@0
|
252 |
IMPORT_C TDesC& RingingAlertTone1();
|
|
sl@0
|
253 |
/**
|
|
sl@0
|
254 |
* Returns Ringing Alert Tone1 status
|
|
sl@0
|
255 |
*
|
|
sl@0
|
256 |
*
|
|
sl@0
|
257 |
* The filename selected as the ringing alert tone in the
|
|
sl@0
|
258 |
* current profile
|
|
sl@0
|
259 |
*
|
|
sl@0
|
260 |
*
|
|
sl@0
|
261 |
*
|
|
sl@0
|
262 |
* @return TBool aEnable. ETrue if current profile ringing alert tone is on else EFalse.
|
|
sl@0
|
263 |
*/
|
|
sl@0
|
264 |
IMPORT_C TBool IsRingingAlertTone1Enabled();
|
|
sl@0
|
265 |
|
|
sl@0
|
266 |
/**
|
|
sl@0
|
267 |
* Returns Ringing Alert Tone 2
|
|
sl@0
|
268 |
*
|
|
sl@0
|
269 |
*
|
|
sl@0
|
270 |
* The filename selected as the ringing alert tone in the
|
|
sl@0
|
271 |
* current profile for the alternate line
|
|
sl@0
|
272 |
*
|
|
sl@0
|
273 |
*
|
|
sl@0
|
274 |
*
|
|
sl@0
|
275 |
* @return TDesC& aRingingAlertTone2Name. z:\\resource\\No_Sound.wav is returned if sound is off,else selected filename
|
|
sl@0
|
276 |
* is returned
|
|
sl@0
|
277 |
*/
|
|
sl@0
|
278 |
|
|
sl@0
|
279 |
IMPORT_C TDesC& RingingAlertTone2();
|
|
sl@0
|
280 |
/**
|
|
sl@0
|
281 |
* Returns Ringing Alert Tone 2
|
|
sl@0
|
282 |
*
|
|
sl@0
|
283 |
*
|
|
sl@0
|
284 |
* The filename selected as the ringing alert tone in the
|
|
sl@0
|
285 |
* current profile for the alternate line
|
|
sl@0
|
286 |
*
|
|
sl@0
|
287 |
*
|
|
sl@0
|
288 |
*
|
|
sl@0
|
289 |
* @return TBool aEnable. ETrue if current profile ringing alert tone of alternate line is on else EFalse.
|
|
sl@0
|
290 |
*/
|
|
sl@0
|
291 |
IMPORT_C TBool IsRingingAlertTone2Enabled();
|
|
sl@0
|
292 |
|
|
sl@0
|
293 |
/**
|
|
sl@0
|
294 |
* Returns Ringing Keypad Volume
|
|
sl@0
|
295 |
*
|
|
sl@0
|
296 |
*
|
|
sl@0
|
297 |
* The key tone volume selected in the
|
|
sl@0
|
298 |
* current profile
|
|
sl@0
|
299 |
*
|
|
sl@0
|
300 |
*
|
|
sl@0
|
301 |
*
|
|
sl@0
|
302 |
* @return TGASKeypadVolume aKeypadToneVolume.returns EGASKeypadVolumeOff sound is off,else selected volume level
|
|
sl@0
|
303 |
* is returned
|
|
sl@0
|
304 |
*/
|
|
sl@0
|
305 |
|
|
sl@0
|
306 |
IMPORT_C TGASKeypadVolume KeyPadToneVolume();
|
|
sl@0
|
307 |
|
|
sl@0
|
308 |
/**
|
|
sl@0
|
309 |
* Returns silent mode status.
|
|
sl@0
|
310 |
*
|
|
sl@0
|
311 |
*
|
|
sl@0
|
312 |
* @return TBool aEnable. ETrue if the silent mode is enabled else EFalse.
|
|
sl@0
|
313 |
* Ringingtype is set to EGASRingingTypeSilent when silence mode is enabled
|
|
sl@0
|
314 |
*/
|
|
sl@0
|
315 |
|
|
sl@0
|
316 |
IMPORT_C TBool IsSilenceModeEnabled();
|
|
sl@0
|
317 |
/**
|
|
sl@0
|
318 |
* Registers audio clients list observer.
|
|
sl@0
|
319 |
*
|
|
sl@0
|
320 |
* When registered successfully, the observer will start receiveing
|
|
sl@0
|
321 |
* callback defined in MAudioClientsListObserver when audio clients list
|
|
sl@0
|
322 |
* changes.
|
|
sl@0
|
323 |
*
|
|
sl@0
|
324 |
* @since S60 3.2
|
|
sl@0
|
325 |
* @param MAudioClientsListObserver& aObserver. A reference to class
|
|
sl@0
|
326 |
* implementing MAudioClientsListObserver interface.
|
|
sl@0
|
327 |
* @return TInt. KErrNone if successful. KErrAlreadyExists if the observer
|
|
sl@0
|
328 |
* is already registered. Otherwise a systemwide error code.
|
|
sl@0
|
329 |
*/
|
|
sl@0
|
330 |
IMPORT_C TInt RegisterAudioClientsListObserver(
|
|
sl@0
|
331 |
MAudioClientsListObserver& aObserver );
|
|
sl@0
|
332 |
|
|
sl@0
|
333 |
/**
|
|
sl@0
|
334 |
* Unregisters audio clients list observer.
|
|
sl@0
|
335 |
*
|
|
sl@0
|
336 |
* When unregistered, the observer will no longer receive callback when
|
|
sl@0
|
337 |
* audio clients list changes.
|
|
sl@0
|
338 |
*
|
|
sl@0
|
339 |
* @since S60 3.2
|
|
sl@0
|
340 |
* @param MAudioClientsListObserver& aObserver. A reference to class
|
|
sl@0
|
341 |
* implementing MAudioClientsListObserver interface.
|
|
sl@0
|
342 |
* @return TInt. KErrNone if successful. KErrNotFound if the observer
|
|
sl@0
|
343 |
* is not registered.
|
|
sl@0
|
344 |
*/
|
|
sl@0
|
345 |
IMPORT_C TInt UnregisterAudioClientsListObserver(
|
|
sl@0
|
346 |
MAudioClientsListObserver& aObserver);
|
|
sl@0
|
347 |
|
|
sl@0
|
348 |
/**
|
|
sl@0
|
349 |
* Gets audio clients list.
|
|
sl@0
|
350 |
*
|
|
sl@0
|
351 |
* On return of this function, the parameter aList will contain active
|
|
sl@0
|
352 |
* audio client application process ids.
|
|
sl@0
|
353 |
*
|
|
sl@0
|
354 |
* The parameter aList will be reset in the case
|
|
sl@0
|
355 |
*
|
|
sl@0
|
356 |
* @since S60 3.2
|
|
sl@0
|
357 |
* @param TAudioClientListType aFilter. Type of client list.
|
|
sl@0
|
358 |
* @param RArray<TProcessId>& aList. A reference to RArray.
|
|
sl@0
|
359 |
* @return TInt. KErrNone if successful. KErrBadName if
|
|
sl@0
|
360 |
* aType is not one of the TAudioClientListType enumeration.
|
|
sl@0
|
361 |
* Otherwise a systemwide error code.
|
|
sl@0
|
362 |
* In case of error, the array aList will be reset.
|
|
sl@0
|
363 |
*/
|
|
sl@0
|
364 |
IMPORT_C TInt GetAudioClientsList(
|
|
sl@0
|
365 |
TAudioClientListType aType,
|
|
sl@0
|
366 |
RArray<TProcessId>& aList );
|
|
sl@0
|
367 |
|
|
sl@0
|
368 |
private:
|
|
sl@0
|
369 |
CGlobalAudioSettings();
|
|
sl@0
|
370 |
/**
|
|
sl@0
|
371 |
* Second Phase Costructor for GlobalAudioSettings Instance
|
|
sl@0
|
372 |
* @since 3.2
|
|
sl@0
|
373 |
* @param void
|
|
sl@0
|
374 |
*/
|
|
sl@0
|
375 |
void ConstructL( MAudioSettingsObserver& aAudioSettingsObserver );
|
|
sl@0
|
376 |
|
|
sl@0
|
377 |
private:
|
|
sl@0
|
378 |
CGlobalAudioSettingsImpl* iBody;
|
|
sl@0
|
379 |
};
|
|
sl@0
|
380 |
|
|
sl@0
|
381 |
#endif
|
|
sl@0
|
382 |
// End of file
|