author | Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> |
Wed, 23 Jun 2010 18:12:20 +0300 | |
changeset 45 | 6b911d05207e |
parent 37 | ba76fc04e6c2 |
child 46 | bc5a64e5bc3c |
permissions | -rw-r--r-- |
37 | 1 |
/* |
2 |
* Copyright (c) 2005-2008 Nokia Corporation and/or its subsidiary(-ies). |
|
3 |
* All rights reserved. |
|
4 |
* This component and the accompanying materials are made available |
|
5 |
* under the terms of "Eclipse Public License v1.0" |
|
6 |
* which accompanies this distribution, and is available |
|
7 |
* at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
8 |
* |
|
9 |
* Initial Contributors: |
|
10 |
* Nokia Corporation - initial contribution. |
|
11 |
* |
|
12 |
* Contributors: |
|
13 |
* |
|
14 |
* Description: This file defines the protocol independent interface of the Phone Engine. |
|
15 |
* |
|
16 |
*/ |
|
17 |
||
18 |
#ifndef PEVIRTUALENGINE_H |
|
19 |
#define PEVIRTUALENGINE_H |
|
20 |
||
21 |
// INCLUDES |
|
22 |
#include <badesca.h> |
|
23 |
#include <bldvariant.hrh> //protocol definition, component configuration definitions |
|
24 |
#include <cphcntcontactid.h> |
|
25 |
#include <ctsydomainpskeys.h> |
|
26 |
#include <etelmm.h> |
|
27 |
#include <exterror.h> |
|
28 |
#include <fbs.h> |
|
29 |
#include <mccecall.h> |
|
30 |
#include <mmtsy_names.h> |
|
31 |
#include <networkhandlingdomainpskeys.h> |
|
32 |
#include <phclttypes.h> |
|
33 |
#include <Profile.hrh> |
|
34 |
#include <rmmcustomapi.h> |
|
35 |
#include <rsssettings.h> |
|
36 |
#include <sysutil.h> |
|
37 |
||
38 |
||
39 |
// CONSTANTS |
|
40 |
||
41 |
//Call origin types |
|
42 |
enum TPECallOrigin |
|
43 |
{ |
|
44 |
EPECallOriginPhone, |
|
45 |
EPECallOriginClient, |
|
46 |
EPECallOriginSAT |
|
47 |
}; |
|
48 |
||
49 |
//Output types |
|
50 |
enum TPEAudioOutput |
|
51 |
{ |
|
52 |
EPENotActive, |
|
53 |
EPEHandset, |
|
54 |
EPELoudspeaker, |
|
55 |
EPEWiredAudioAccessory, |
|
56 |
EPEBTAudioAccessory, |
|
57 |
EPETTY |
|
58 |
}; |
|
59 |
||
60 |
//Error types |
|
61 |
enum TPEErrorType |
|
62 |
{ |
|
63 |
EPECcp = 0, |
|
64 |
EPECch |
|
65 |
}; |
|
66 |
||
67 |
// PhoneEngine Errors |
|
68 |
const TInt KErrPhoneEngineErrorBase = -30000; |
|
69 |
const TInt KErrPhoneEngineNoWcdmaNetwork = KErrPhoneEngineErrorBase - 1; |
|
70 |
const TInt KErrPhoneEngineVideoCallNotAllowedDuringRestore = KErrPhoneEngineErrorBase - 2; |
|
71 |
const TInt KErrPhoneEngineVideoCallSetupFailed = KErrPhoneEngineErrorBase - 3; |
|
72 |
||
73 |
// Phone Engine dll uid |
|
74 |
const TUid KUidPhoneEngine = { 0x1000A86C }; |
|
75 |
||
76 |
// Maximum length of phone number |
|
77 |
const TInt KPEPhoneNumberMaxLength = 100; |
|
78 |
//Phone number type defined using the custom maximum length |
|
79 |
typedef TBuf<KPEPhoneNumberMaxLength> TPEPhoneNumber; |
|
80 |
//Maximum length of dtmf string |
|
81 |
const TInt KPEDtmfMaxLength = KPEPhoneNumberMaxLength; |
|
82 |
||
83 |
//Maximum number of the SS service groups |
|
84 |
const TInt KPEMaxServiceGroup = 53; // Maximum value taken from etelmm.h(TMobileService) |
|
85 |
||
86 |
const TInt KPEAutomaticAnswerTimeout = 5000000; // 5 seconds; |
|
87 |
||
88 |
// Enumerations for variant messages |
|
89 |
// For enumeration TPEMessagesToPhoneEngine |
|
90 |
const TInt KPEMessagesToPhoneEngineGsmFirst = 11000; |
|
91 |
const TInt KPEMessagesToPhoneEngineGsmLast = 12999; |
|
92 |
const TInt KPEMessagesToPhoneEngineVariantFirst = KPEMessagesToPhoneEngineGsmFirst; |
|
93 |
||
94 |
// For enumeration TPEMessagesFromPhoneEngine |
|
95 |
const TInt KPEMessagesFromPhoneEngineGsmFirst = 11000; |
|
96 |
const TInt KPEMessagesFromPhoneEngineGsmLast = 12999; |
|
97 |
const TInt KPEMessagesFromPhoneEngineVariantFirst = KPEMessagesFromPhoneEngineGsmFirst; |
|
98 |
||
99 |
// Used when initializing number variables with non negative value range. |
|
100 |
const TInt KPENumberInitValue = -1; |
|
101 |
//CallId not used in SendErrorMessageL |
|
102 |
const TInt KPECallIdNotUsed = -1; |
|
103 |
//ErrorCode not used in SendErrorMessageL |
|
104 |
const TInt KPEErrorCodeNotUsed = -1; |
|
105 |
// Informs to phone engine that dont send message to the phone application |
|
106 |
const TInt KPEDontSendMessage = 1; |
|
107 |
||
108 |
// Maximum lenght of timer |
|
109 |
const TInt KPESsTimerMaxLength = 2; |
|
110 |
||
111 |
// Audio player repeats tone forever |
|
112 |
const TInt KPEAudioPlayerRepeatForever = -2; |
|
113 |
// Default Audio volume value |
|
114 |
const TInt KPEDefaultAudioVolume = 7; |
|
115 |
// Default volume value for accessory |
|
116 |
const TInt KPEDefaultAccessoryVolume = 5; |
|
117 |
// Default keypad volume |
|
118 |
const TProfileKeypadVolume KPEDefaultKeypadVolume = EProfileKeypadVolumeLevel2; |
|
119 |
||
120 |
// Dtmf stop character, PE handles internally DTMF characters as lowercase. |
|
121 |
const TUint KPEDtmfStopCharLowercase = 'w'; |
|
122 |
const TUint KPEDtmfStopCharUppercase = 'W'; |
|
123 |
const TUint KPEDtmfPauseCharLowercase = 'p'; |
|
124 |
const TUint KPEDtmfPauseCharUppercase = 'P'; |
|
125 |
const TUint KPEDtmfPlusChar = '+'; |
|
126 |
||
127 |
enum TPELoggingIndicator |
|
128 |
{ |
|
129 |
EPENormalLogging = 0, |
|
130 |
EPEContinuousLogging |
|
131 |
}; |
|
132 |
||
133 |
// Maximum Length of profile name |
|
134 |
const TInt KPEProfileNameLength = 64; |
|
135 |
// Profile is alerting all incoming calls. |
|
136 |
_LIT( KPEAlertForAllCalls, "1"); |
|
137 |
// Informs how many profiles there are |
|
138 |
const TInt KPEProfileGroups = 3; |
|
139 |
// Informs how much time it take's to change ringing tone volume from minimum to maximum(Ascending) |
|
140 |
const TInt KPERingingToneRampDuration = 5000000; |
|
141 |
// Informs how many ringing tone volume levels there are in the profile db |
|
142 |
const TInt KPEProfileRingingToneLevels = 10; |
|
143 |
// Includes default tone volume |
|
144 |
const TInt KPEDefaultToneVolume = 30000; |
|
145 |
// Contact group id string length |
|
146 |
const TInt KPEContactGroupString = 100; |
|
147 |
||
148 |
//The length of a pause created during dialling by the comma character (',') measured in seconds. |
|
149 |
const TUint KPEDefaultInterval = 2; |
|
150 |
||
151 |
// CommDB constants for Data calls |
|
152 |
// Internet Access Point service type |
|
153 |
_LIT( KPEIAPServiceTypeName, "IAP\\IAPServiceType" ); |
|
154 |
// Dial Out Internet Serivce Provider Table name |
|
155 |
_LIT( KPEIAPDialOutISPTableName, "DialOutISP" ); |
|
156 |
// Dial In Internet Service Provider Table name |
|
157 |
_LIT( KPEIAPDialInISPTableName, "DialInISP" ); |
|
158 |
// Access Point Name column on IAP table |
|
159 |
_LIT( KPEIAPAccessPointName, "IAP\\NAME" ); |
|
160 |
||
161 |
const TInt KPEMaxAudioOutputs = EPETTY + 1; // enum count |
|
162 |
||
163 |
// DATA TYPES |
|
164 |
||
165 |
// Contact name definition |
|
166 |
typedef TBuf<KCntMaxTextFieldLength> TPEContactName; |
|
167 |
// Contact company definition |
|
168 |
typedef TBuf<KCntMaxTextFieldLength> TPEContactCompany; |
|
169 |
// Contact group definition |
|
170 |
typedef TBuf<KCntMaxTextFieldLength> TPEContactGroup; |
|
171 |
// Contact filename definition |
|
172 |
typedef TBuf<KMaxFileName> TPEContactFileName; |
|
173 |
// Contact group ids sting |
|
174 |
typedef TBuf<KPEContactGroupString> TPEContactGroupId; |
|
175 |
//Dtmf-string definition |
|
176 |
typedef TBuf<KPEDtmfMaxLength> TPEDtmfString; |
|
177 |
//Profile name definition |
|
178 |
typedef TBuf<KPEProfileNameLength> TPEProfileName; |
|
179 |
//Call control caps |
|
180 |
typedef TUint32 TPECallControlCaps; |
|
181 |
//User to user info |
|
182 |
typedef TBuf<KPhCltUUILength> TPEUserToUserInfo; |
|
183 |
||
184 |
// Phone identity parameters type. |
|
185 |
typedef TBuf<RMobilePhone::KPhoneManufacturerIdSize> TPEManufacturer; |
|
186 |
typedef TBuf<RMobilePhone::KPhoneModelIdSize> TPEModel; |
|
187 |
typedef TBuf<KSysUtilVersionTextLength> TPERevision; |
|
188 |
typedef TBuf<RMobilePhone::KPhoneSerialNumberSize> TPESerialNumber; |
|
189 |
||
190 |
//Call States |
|
191 |
typedef TUint TPEState; |
|
192 |
||
193 |
enum |
|
194 |
{ |
|
195 |
// Call states 0 - 499 |
|
196 |
EPEStateUnknown = 0, |
|
197 |
EPEStateIdle, |
|
198 |
EPEStateDialing, |
|
199 |
EPEStateEmergencyDialing, |
|
200 |
EPEStateRinging, |
|
201 |
EPEStateConnecting, |
|
202 |
EPEStateConnected, |
|
203 |
EPEStateHangingUp, |
|
204 |
EPEStateHeld, |
|
205 |
EPEStateAnswering, |
|
206 |
EPEStateRejecting, |
|
207 |
EPEStateDisconnecting, |
|
208 |
// conference call states |
|
209 |
EPEStateConferenceIdle, |
|
210 |
EPEStateConnectedConference, |
|
211 |
EPEStateHeldConference, |
|
212 |
EPEStateCreatingConference, |
|
213 |
EPEStateHangingUpConference, |
|
214 |
EPEStateSwappingConference, |
|
215 |
EPEStateResumeHoldConference, |
|
216 |
EPEStateGoingOneToOne, |
|
217 |
EPEStateAddingConferenceMember, |
|
218 |
EPEStateAddedConferenceMember, |
|
219 |
EPEStateDroppingConferenceMember, |
|
220 |
EPEStateDroppedConferenceMember, |
|
221 |
// maximum value for boundary checks |
|
222 |
EPEStateMaximumState = 1000 |
|
223 |
}; |
|
224 |
||
225 |
NONSHARABLE_STRUCT( TPEErrorInfo ) |
|
226 |
{ |
|
227 |
//Symbian OS error code |
|
228 |
TInt iErrorCode; |
|
229 |
//Call Id number, equals KPECallIdNotUsed if call id is not available or is |
|
230 |
//invalid for this error condition |
|
231 |
TInt iCallId; |
|
232 |
// Error type( Cch or Ccp ) |
|
233 |
TPEErrorType iErrorType; |
|
45
6b911d05207e
Revision: 201023
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
37
diff
changeset
|
234 |
//Protocol spesific error code |
6b911d05207e
Revision: 201023
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
37
diff
changeset
|
235 |
TInt iProtocolSpesificErrorCode; |
37 | 236 |
}; |
237 |
||
238 |
enum TPECallType |
|
239 |
{ // maintain compatibility with P&S type enum |
|
240 |
// Used to initialize call type information |
|
241 |
EPECallTypeUninitialized = EPSCTsyCallTypeUninitialized, |
|
242 |
// Circuit switched voice call |
|
243 |
EPECallTypeCSVoice = EPSCTsyCallTypeCSVoice, |
|
244 |
// Circuit switched multimedia call |
|
245 |
EPECallTypeVideo = EPSCTsyCallTypeH324Multimedia, |
|
246 |
// Packet switched voice call |
|
247 |
EPECallTypeVoIP = EPSCTsyCallTypeVoIP |
|
248 |
}; |
|
249 |
||
250 |
enum TPEPinCode |
|
251 |
{ |
|
252 |
EPEPinCode, |
|
253 |
EPEPin2Code |
|
254 |
}; |
|
255 |
||
256 |
enum TPEPhoneCommandType |
|
257 |
{ |
|
258 |
EPESendingFlash |
|
259 |
}; |
|
260 |
||
261 |
// Enumeration which defines the search keys with which |
|
262 |
// contact information is searched |
|
263 |
enum TPEFindContactKey |
|
264 |
{ |
|
265 |
//Search keys |
|
266 |
EPEFindWithPhoneNumber = 0, |
|
267 |
EPEFindWithContactId, |
|
268 |
EPEFindKeyNotDefined |
|
269 |
}; |
|
270 |
||
271 |
enum TPESecurityCommand |
|
272 |
{ |
|
273 |
EPESecurityCommandUnknown, |
|
274 |
EPESecurityCommandChangePinCode, |
|
275 |
EPESecurityCommandUnblockPinCode, |
|
276 |
EPESecurityCommandChangeBarringPassword, |
|
277 |
EPESecurityCommandChangeSimLock |
|
278 |
}; |
|
279 |
||
280 |
enum TPEPhoneNumberIdType |
|
281 |
{ |
|
282 |
EPEUnknownNumber, |
|
283 |
EPEMobileNumber, |
|
284 |
EPEPager, |
|
285 |
EPETelephoneNumber, |
|
286 |
EPEVmbxNumberLine1, |
|
287 |
EPEVmbxNumberLine2, |
|
288 |
EPEPrivateNumber, |
|
289 |
EPEEmergencyNumber, |
|
290 |
EPEFaxNumber, |
|
291 |
EPEVoipNumber, |
|
292 |
EPEVideoNumber, |
|
293 |
EPEAssistantNumber, |
|
294 |
EPECarNumber, |
|
295 |
EPEHomeNumber, |
|
296 |
EPEWorkNumber |
|
297 |
}; |
|
298 |
||
299 |
enum TPERxTimeSlots |
|
300 |
{ |
|
301 |
EPERxSlots1 = 1, |
|
302 |
EPERxSlots2 = 2, |
|
303 |
EPERxSlots3 = 3 |
|
304 |
}; |
|
305 |
||
306 |
//VoiceMailBoxNumbers |
|
307 |
NONSHARABLE_STRUCT( TPEVoiceMailBoxNumberInfo ) |
|
308 |
{ |
|
309 |
TPEPhoneNumber iVMBXL1; // Line 1 VoiceMailBoxNumber |
|
310 |
TPEPhoneNumber iVMBXL2; // Line 2 VoiceMailBoxNumber |
|
311 |
TPEPhoneNumber iDTMFVMBXL1; // Line 1 DTMFVoiceMailBoxNumber |
|
312 |
TPEPhoneNumber iDTMFVMBXL2; // Line 2 DTMFVoiceMailBoxNumber |
|
313 |
}; |
|
314 |
||
315 |
// Contains information of call audio route parameters |
|
316 |
NONSHARABLE_STRUCT( TPEPhoneAudioRouteParameters ) |
|
317 |
{ |
|
318 |
TPEAudioOutput iAudioOutput; |
|
319 |
TPEAudioOutput iPreviousOutput; |
|
320 |
TBool iShowNote; |
|
321 |
}; |
|
322 |
||
323 |
// Enumerate definitions for MMI Service Codes from MMETel API: |
|
324 |
||
325 |
// FUNCTION PROTOTYPES |
|
326 |
// None. |
|
327 |
||
328 |
// FORWARD DECLARATIONS |
|
329 |
||
330 |
class MPEEngineInfo; |
|
331 |
||
332 |
// CLASS DECLARATION |
|
333 |
||
334 |
/** |
|
335 |
* Offers message interface from phone engine to phone application. |
|
336 |
* |
|
337 |
* @lib phonenegine.lib |
|
338 |
* @since S60 v.4.0 |
|
339 |
*/ |
|
340 |
NONSHARABLE_CLASS( MEngineMonitor ) |
|
341 |
{ |
|
342 |
||
343 |
public: |
|
344 |
||
345 |
enum TPEMessagesFromPhoneEngine |
|
346 |
{ |
|
347 |
// Audio messages 1000 - 1999 |
|
348 |
EPEMessageAudioDtmfEvent = 1000, |
|
349 |
EPEMessageAudioDTMFPlayComplete, |
|
350 |
EPEMessageAudioMuteChanged, |
|
351 |
EPEMessageAudioOutputChanged, |
|
352 |
EPEMessageAudioOutputPreferenceChanged, |
|
353 |
EPEMessageAudioPlayStopped, |
|
354 |
EPEMessageAudioVolumeChanged, |
|
355 |
EPEMessageAvailableAudioOutputsChanged, |
|
356 |
||
357 |
// Call messages 2000 - 2999 |
|
358 |
EPEMessageAnswer = 2000, |
|
359 |
EPEMessageAnswering, |
|
360 |
EPEMessageCallAdded, |
|
361 |
EPEMessageCallControlCapsChanged, |
|
362 |
EPEMessageCallWaiting, |
|
363 |
EPEMessageCallWaitingAnswered, |
|
364 |
EPEMessageChangedCallDuration, |
|
365 |
EPEMessageConferenceCapsChange, |
|
366 |
EPEMessageConferenceIdle, |
|
367 |
EPEMessageConnected, |
|
368 |
EPEMessageConnectedConference, |
|
369 |
EPEMessageConnecting, |
|
370 |
EPEMessageContinuingDTMFSending, |
|
371 |
EPEMessageDialing, |
|
372 |
EPEMessageDialingError, |
|
373 |
EPEMessageDisconnecting, |
|
374 |
EPEMessageDisconnectingConference, |
|
375 |
EPEMessageDisconnectingWithInband, //UI doesn't get this message, it is mapped as EPEMessageDisconnecting |
|
376 |
EPEMessageDTMFSendingAborted, |
|
377 |
EPEMessageHeld, |
|
378 |
EPEMessageHeldConference, |
|
379 |
EPEMessageIdle, |
|
380 |
EPEMessageIncoming, |
|
381 |
EPEMessageInitiatedEmergencyCall, |
|
382 |
EPEMessageInitiatedEmergencyWhileActiveVideo, |
|
383 |
EPEMessageIssuingUSSDRequest, |
|
384 |
EPEMessageIssuedUSSDRequest, |
|
385 |
EPEMessagePacketNetworkDetached, |
|
386 |
EPEMessageRemoteBusy, |
|
387 |
EPEMessageRemoteTerminated, |
|
388 |
EPEMessageSendingDTMF, |
|
389 |
EPEMessageSentDTMF, |
|
390 |
EPEMessageSentSSString, |
|
391 |
EPEMessageStoppedDTMF, |
|
392 |
EPEMessageSwapped, |
|
393 |
EPEMessageTransferDone, |
|
394 |
EPEMessageTransferring, |
|
395 |
EPEMessageUnknown, |
|
396 |
EPEMessageWentOneToOne, |
|
397 |
EPEMessageRemotePartyInfoChanged, |
|
398 |
EPEMessageConnectingWithInband, //UI doesn't get this message, it is mapped as EPEMessageConnecting |
|
399 |
||
400 |
EPEMessageUnattendedTransferRequest, |
|
401 |
||
402 |
EPEMessageRemoteForwarding, |
|
403 |
EPEMessageMovedPermanently, |
|
404 |
EPEMessageMultipleChoices, |
|
45
6b911d05207e
Revision: 201023
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
37
diff
changeset
|
405 |
EPEMessageColpNumberAvailable, |
37 | 406 |
|
407 |
// Contact messages 3000 - 3999 |
|
408 |
EPEMessageThumbnailLoadingCompleted = 3000, |
|
409 |
||
410 |
// Error messages 4000 - 4999 |
|
411 |
EPEMessageError = 4000, |
|
412 |
EPEMessageAudioHandlingError, |
|
413 |
EPEMessageCallHandlingError, |
|
414 |
EPEMessageConferenceErrorAddCall, |
|
415 |
EPEMessageConferenceErrorRemoveCall, |
|
416 |
EPEMessageConferenceErrorSwap, |
|
417 |
EPEMessageConferenceErrorHold, |
|
418 |
EPEMessageConferenceErrorResume, |
|
419 |
EPEMessageConferenceErrorGoOneToOne, |
|
420 |
EPEMessageConferenceErrorCurrentCallsToConference, |
|
421 |
EPEMessageConferenceErrorHangUp, |
|
422 |
EPEMessageContactHandlingError, |
|
423 |
EPEMessageLogHandlingError, |
|
424 |
EPEMessageServiceHandlingError, |
|
425 |
||
426 |
// Network messages 5000 - 5999 |
|
427 |
EPEMessageCallSecureStatusChanged= 5000, |
|
428 |
EPEMessageNetworkRegistrationStatusChange, |
|
429 |
||
430 |
// Parser messages 6000 - 6999 |
|
431 |
EPEMessageActivateRfsDeep = 6000, |
|
432 |
EPEMessageActivateRfsNormal, |
|
433 |
EPEMessageShowBTDeviceAddress, |
|
434 |
EPEMessageShowBTLoopback, |
|
435 |
EPEMessageShowWlanMacAddress, |
|
436 |
EPEMessageSSRequestFailed, |
|
437 |
EPEMessageBTDebugMode, |
|
438 |
||
439 |
// Security messages 7000 - 7999 |
|
440 |
EPEMessageBadBarringPasswordChange = 7000, |
|
441 |
EPEMessageBadPin1Change, |
|
442 |
EPEMessageBadPin1Unblock, |
|
443 |
EPEMessageBadPin2Change, |
|
444 |
EPEMessageBadPin2Unblock, |
|
445 |
EPEMessageBarringPasswordChanged, |
|
446 |
EPEMessageChangedSimLock, |
|
447 |
EPEMessageFailedChangeSimLock, |
|
448 |
EPEMessageFailedNewPin1AndPin2NotEqual, // Error message, NewPin1 and NewPin2 are not equal |
|
449 |
EPEMessageFailedSecurityCommandAlreadyActive, // Error message, SecurityCommand is already active |
|
450 |
EPEMessagePin1Changed, |
|
451 |
EPEMessagePin1Unblocked, |
|
452 |
EPEMessagePin2Changed, |
|
453 |
EPEMessagePin2Unblocked, |
|
454 |
EPEMessageSIMChanged, |
|
455 |
EPEMessageSIMStateChanged, |
|
456 |
||
457 |
// Settings and Shared Data messages 8000 - 8999 |
|
458 |
EPEMessageProfileChanged = 8000, |
|
459 |
||
460 |
// Startup messages 9000 - 9999 |
|
461 |
EPEMessagePEConstructionReady = 9000, // Phone Engine is initialized and fully operational |
|
462 |
EPEMessagePEConstructionFailed, |
|
463 |
EPEMessagePEConstructionTwoPhaseReady, |
|
464 |
// Miscellaneous messages 10000 - 10999 |
|
465 |
EPEMessageDoNotSendMe = 10000, |
|
466 |
EPEMessageInValidEmergencyNumber, |
|
467 |
EPEMessageLogEventSaved, |
|
468 |
EPEMessageStartATDialing, |
|
469 |
EPEMessageValidEmergencyNumber, |
|
470 |
EPEMessageMuteRingingTone, |
|
471 |
||
472 |
// Audio messages 11000 - 11199 |
|
473 |
||
474 |
// Call messages 11200 - 11399 |
|
475 |
EPEMessageActiveBarring = KPEMessagesFromPhoneEngineGsmFirst + 200, |
|
476 |
EPEMessageActiveCallForwarding, |
|
477 |
EPEMessageAddedConferenceMember, |
|
478 |
EPEMessageALSLineChanged, |
|
479 |
EPEMessageCallBarred, |
|
480 |
EPEMessageIncCallIsForw, |
|
481 |
EPEMessageIncCallForwToC, |
|
482 |
EPEMessageOutCallForwToC, |
|
483 |
EPEMessageForwardUnconditionalModeActive, |
|
484 |
EPEMessageForwardConditionallyModeActive, |
|
485 |
EPEMessageDroppedConferenceMember, |
|
486 |
EPEMessageGoingOneToOne, |
|
487 |
EPEMessageRemoteCreatedConference, |
|
488 |
EPEMessageRemoteHeld, |
|
489 |
EPEMessageRemoteResumed, |
|
490 |
EPEMessageTempClirSuppressUnsuccessful, |
|
491 |
EPEMessageTempClirActivationUnsuccessful, |
|
492 |
EPEMessageShowIncCallGroupIndex, |
|
493 |
EPEMessageDataPortLoaned, |
|
494 |
// Contact messages 11400 - 11599 |
|
495 |
||
496 |
// Error messages 11600 - 11799 |
|
497 |
||
498 |
// VoIP service messages 11800 - 12999 |
|
499 |
EPEMessageServiceEnabled = KPEMessagesFromPhoneEngineGsmFirst + 800, |
|
500 |
EPEMessageServiceEnabling, |
|
501 |
EPEMessageNoService, |
|
502 |
EPEMessageServiceDisabled, |
|
503 |
||
504 |
// Parser messages 12000 - 12199 |
|
505 |
EPEMessageIssuedSSRequest = KPEMessagesFromPhoneEngineGsmFirst + 1000, |
|
506 |
EPEMessageIssuingSSRequest, |
|
507 |
||
508 |
// Security messages 12200 - 12399 |
|
509 |
EPEMessageSecureNotSpecified, |
|
510 |
||
511 |
// Settings and Shared Data messages 12400 - 12599 |
|
512 |
EPEMessageAlsStatusChanged = KPEMessagesFromPhoneEngineGsmFirst + 1400, |
|
513 |
EPEMessageBarringNotification, |
|
514 |
EPEMessageClipStatusNotification, |
|
515 |
EPEMessageClirStatusNotification, |
|
516 |
EPEMessageCnapStatusNotification, |
|
517 |
EPEMessageColpStatusNotification, |
|
518 |
EPEMessageColrStatusNotification, |
|
519 |
EPEMessageForwardingNotification, |
|
520 |
EPEMessageVmbxNumberLine1Changed, |
|
521 |
EPEMessageVmbxNumberLine2Changed, |
|
522 |
EPEMessageWaitingNotification, |
|
523 |
||
524 |
||
525 |
// Miscellaneous messages 12600 - 12799 |
|
526 |
||
527 |
// Last 12999 |
|
528 |
// Exposing this allows the compiler to detect the overlapping enumerations. |
|
529 |
EPEMessageLastVariantItem = KPEMessagesFromPhoneEngineGsmLast |
|
530 |
}; |
|
531 |
||
532 |
/** |
|
533 |
* HandleError |
|
534 |
* Phone Application implements this callback method to provide a framework |
|
535 |
* for proceeding in an error condition. |
|
536 |
* @param aErrorInfo is the call id number. |
|
537 |
*/ |
|
538 |
virtual void HandleError( const TPEErrorInfo& aErrorInfo ) = 0; |
|
539 |
||
540 |
/** |
|
541 |
* HandleMessage |
|
542 |
* Phone Application implements this callback method to provide a response |
|
543 |
* for an event message sent by the Phone Engine. |
|
544 |
* @param aMessage specifies the event that has taken place |
|
545 |
* @param aCallId is the call id number. |
|
546 |
*/ |
|
547 |
virtual void HandleMessage( const TInt aMessage, const TInt aCallId ) = 0; |
|
548 |
||
549 |
}; // MEngineMonitor |
|
550 |
||
551 |
||
552 |
// Maximum number of the conference members. |
|
553 |
const TInt KPEMaximumNumberOfConferenceMembers = 5; |
|
554 |
// Maximum number of voice calls |
|
555 |
const TInt KPEMaximumNumberOfVoiceCalls = 8; // Phone engine user can change this value if needed. |
|
556 |
// Maximum number of data calls |
|
557 |
const TInt KPEMaximumNumberOfDataCalls = 2; |
|
558 |
// Maximum number of conference calls |
|
559 |
const TInt KPEMaximumNumberOfConferenceCalls = 1; |
|
560 |
// Maximum number of all calls |
|
561 |
const TInt KPEMaximumNumberOfCalls = KPEMaximumNumberOfVoiceCalls + |
|
562 |
KPEMaximumNumberOfDataCalls + KPEMaximumNumberOfConferenceCalls; |
|
563 |
||
564 |
// Emergency CallId |
|
565 |
const TInt KPEEmergencyCallId = KPEMaximumNumberOfVoiceCalls - 1; |
|
566 |
// Conference Call ID |
|
567 |
const TInt KPEConferenceCallID = KPEMaximumNumberOfVoiceCalls; |
|
568 |
||
569 |
// Invalid call index, note not the same as call id |
|
570 |
const TInt KPEInvalidCallIndex = -1; |
|
571 |
// These two are needed in TPECallInfo's conference field |
|
572 |
// Indicates, that this is Conference Master |
|
573 |
const TInt KPEConferenceMaster = -1; |
|
574 |
// Indicates, that this is Normal voice call |
|
575 |
const TInt KPENormalVoiceCall = -2; |
|
576 |
||
577 |
// All MMI Service Codes are defined in standard 3GPP TS 02.30 V7.1.1, Annex C. |
|
578 |
// MMI Service Codes: No service code was specified |
|
579 |
_LIT( KPENoServiceCode, "" ); |
|
580 |
// MMI Service Codes: All teleservices |
|
581 |
_LIT( KPEAllTeleservices, "10" ); |
|
582 |
// MMI Service Codes: Voice teleservices |
|
583 |
_LIT( KPETelephony, "11" ); |
|
584 |
// MMI Service Codes: All Data Services |
|
585 |
_LIT( KPEAllDataServices, "12" ); |
|
586 |
// MMI Service Codes: Fax Services |
|
587 |
_LIT( KPEFacsimileServices, "13" ); |
|
588 |
// MMI Service Codes: SMS Services |
|
589 |
_LIT( KPEShortMessageServices, "16" ); |
|
590 |
// MMI Service Codes: Voice Group Call Service |
|
591 |
_LIT( KPEVoiceGroupCallService, "17" ); |
|
592 |
// MMI Service Codes: Voice Broadcast Service |
|
593 |
_LIT( KPEVoiceBroadcastService, "18" ); |
|
594 |
// MMI Service Codes: All teleservices except SMS |
|
595 |
_LIT( KPEAllTeleservicesExceptSMS, "19" ); |
|
596 |
// MMI Service Codes: All Bearer Service |
|
597 |
_LIT( KPEAllBearerServices, "20" ); |
|
598 |
// MMI Service Codes: All Async Services |
|
599 |
_LIT( KPEAllAsyncServices, "21" ); |
|
600 |
// MMI Service Codes: All Sync Services |
|
601 |
_LIT( KPEAllSyncServices, "22" ); |
|
602 |
// MMI Service Codes: All Data Circuit Sync |
|
603 |
_LIT( KPEAllDataCircuitSync, "24" ); |
|
604 |
// MMI Service Codes: All Data Circuit Async |
|
605 |
_LIT( KPEAllDataCircuitAsync, "25" ); |
|
606 |
// MMI Service Codes: All Dedicated Packet Access |
|
607 |
_LIT( KPEAllDedicatedPacketAccess, "26" ); |
|
608 |
// MMI Service Codes: All Dedicated Pad Access |
|
609 |
_LIT( KPEAllDedicatedPadAccess, "27" ); |
|
610 |
// MMI Service Codes: All Gprs Beares Services |
|
611 |
_LIT( KPEAllGprsBearerServices, "99" ); |
|
612 |
// MMI Service Codess: PLMN specific teleservices |
|
613 |
_LIT( KPEAllPlmnSpecificTeleservices, "50" ); |
|
614 |
_LIT( KPEPlmnSpecificTeleservice1, "51" ); |
|
615 |
_LIT( KPEPlmnSpecificTeleservice2, "52" ); |
|
616 |
_LIT( KPEPlmnSpecificTeleservice3, "53" ); |
|
617 |
_LIT( KPEPlmnSpecificTeleservice4, "54" ); |
|
618 |
_LIT( KPEPlmnSpecificTeleservice5, "55" ); |
|
619 |
_LIT( KPEPlmnSpecificTeleservice6, "56" ); |
|
620 |
_LIT( KPEPlmnSpecificTeleservice7, "57" ); |
|
621 |
_LIT( KPEPlmnSpecificTeleservice8, "58" ); |
|
622 |
_LIT( KPEPlmnSpecificTeleservice9, "59" ); |
|
623 |
_LIT( KPEPlmnSpecificTeleservice10, "60" ); |
|
624 |
_LIT( KPEPlmnSpecificTeleservice11, "61" ); |
|
625 |
_LIT( KPEPlmnSpecificTeleservice12, "62" ); |
|
626 |
_LIT( KPEPlmnSpecificTeleservice13, "63" ); |
|
627 |
_LIT( KPEPlmnSpecificTeleservice14, "64" ); |
|
628 |
_LIT( KPEPlmnSpecificTeleservice15, "65" ); |
|
629 |
// MMI Service Codess: PLMN specific bearer services |
|
630 |
_LIT( KPEAllPlmnSpecificBearerServices, "70" ); |
|
631 |
_LIT( KPEPlmnSpecificBearerService1, "71" ); |
|
632 |
_LIT( KPEPlmnSpecificBearerService2, "72" ); |
|
633 |
_LIT( KPEPlmnSpecificBearerService3, "73" ); |
|
634 |
_LIT( KPEPlmnSpecificBearerService4, "74" ); |
|
635 |
_LIT( KPEPlmnSpecificBearerService5, "75" ); |
|
636 |
_LIT( KPEPlmnSpecificBearerService6, "76" ); |
|
637 |
_LIT( KPEPlmnSpecificBearerService7, "77" ); |
|
638 |
_LIT( KPEPlmnSpecificBearerService8, "78" ); |
|
639 |
_LIT( KPEPlmnSpecificBearerService9, "79" ); |
|
640 |
_LIT( KPEPlmnSpecificBearerService10, "80" ); |
|
641 |
_LIT( KPEPlmnSpecificBearerService11, "81" ); |
|
642 |
_LIT( KPEPlmnSpecificBearerService12, "82" ); |
|
643 |
_LIT( KPEPlmnSpecificBearerService13, "83" ); |
|
644 |
_LIT( KPEPlmnSpecificBearerService14, "84" ); |
|
645 |
_LIT( KPEPlmnSpecificBearerService15, "85" ); |
|
646 |
// ALS |
|
647 |
_LIT( KPEAuxVoiceService, "89" ); |
|
648 |
||
649 |
//Fax Modem UI application UID |
|
650 |
const TInt KPEFaxModemUIUid = 0x1000594E; |
|
651 |
// TPESimState fisrt value |
|
652 |
const TInt KPEStartupEnumerationFirstValue = 100; |
|
653 |
||
654 |
// Indicates that dtmf sending is possible with this call. |
|
655 |
const TUint KPECapsDtmf = 0x00080000; |
|
656 |
||
657 |
// SIM states |
|
658 |
enum TPESimState |
|
659 |
{ |
|
660 |
EPESimStatusUninitialized = KPEStartupEnumerationFirstValue, |
|
661 |
EPESimUsable, // The Sim card is fully usable. |
|
662 |
EPESimReadable, // The SIM card is not fully usable, but the emergency number can be read. |
|
663 |
EPESimNotReady, // The Sim card is present but not ready or usable. |
|
664 |
EPESimNotPresent, // The Sim card is not present. |
|
665 |
EPESimNotSupported // SIM/RUIM is not supported. Some CDMA phones do not support a SIM/RUIM at all. |
|
666 |
}; |
|
667 |
||
668 |
// Supplementary Services action type |
|
669 |
enum TPESSAction |
|
670 |
{ |
|
671 |
EPESSActionUnspecified = 0, |
|
672 |
EPESSActivation, |
|
673 |
EPESSDeactivation, |
|
674 |
EPESSInterrogation, |
|
675 |
EPESSRegistration, |
|
676 |
EPESSErasure, |
|
677 |
EPEPasswordOperation |
|
678 |
}; |
|
679 |
||
680 |
// Supplementary Services type |
|
681 |
enum TPESSType |
|
682 |
{ |
|
683 |
EPESSTypeUnspecified = 0, |
|
684 |
EPECallForwardingNotReachable, |
|
685 |
EPECallForwardingNoReply, |
|
686 |
EPECallForwardingBusy, |
|
687 |
EPECallForwardingUnconditional, |
|
688 |
EPECallForwardingAll, |
|
689 |
EPECallForwardingAllConditional, |
|
690 |
EPECallBarringAllOutgoing, |
|
691 |
EPECallBarringAllOutgoingInternational, |
|
692 |
EPECallBarringAllOutgoingInternationalExcHome, |
|
693 |
EPECallBarringAllIncoming, |
|
694 |
EPECallBarringAllIncomingWhenRoaming, |
|
695 |
EPECallBarringAllServices, |
|
696 |
EPECallBarringAllOutgoingServices, |
|
697 |
EPECallBarringAllIncomingServices, |
|
698 |
EPECallBarringPassword, |
|
699 |
EPECallWaiting, |
|
700 |
EPEClip, |
|
701 |
EPEClir, |
|
702 |
EPECnap, |
|
703 |
EPEColp, |
|
704 |
EPEColr, |
|
705 |
EPEEmlpp, |
|
706 |
EPEMsp, |
|
707 |
EPESpnp, |
|
708 |
EPEPin, |
|
709 |
EPEUnblockPin, |
|
710 |
EPESimLock |
|
711 |
}; |
|
712 |
||
713 |
//Forwarded information definition |
|
714 |
NONSHARABLE_STRUCT( TPEForwardedInfo ) |
|
715 |
{ |
|
716 |
RMobilePhone::TMobilePhoneCFCondition iCondition; |
|
717 |
RMobilePhone::TMobileService iServiceGroup; |
|
718 |
RMobilePhone::TMobilePhoneCFStatus iStatus; |
|
719 |
TPEPhoneNumber iPhoneNumber; |
|
720 |
TInt iTimeout; |
|
721 |
}; |
|
722 |
||
723 |
// Forwarding information definition |
|
724 |
NONSHARABLE_STRUCT( TPEForwardingInfo ) |
|
725 |
{ |
|
726 |
TInt iGroupCount; |
|
727 |
TFixedArray<TPEForwardedInfo, KPEMaxServiceGroup> iForwardedInfo; |
|
728 |
}; |
|
729 |
||
730 |
NONSHARABLE_STRUCT( TPEActiveForwardInfo ) |
|
731 |
{ |
|
732 |
RMobilePhone::TMobilePhoneCFActive iActiveType; |
|
733 |
RMobilePhone::TMobileService iServiceGroup; |
|
734 |
}; |
|
735 |
||
736 |
//Wait information definition |
|
737 |
NONSHARABLE_STRUCT( TPEWaitInfo ) |
|
738 |
{ |
|
739 |
RMobilePhone::TMobileService iServiceGroup; |
|
740 |
RMobilePhone::TMobilePhoneCWStatus iStatus; |
|
741 |
}; |
|
742 |
||
743 |
// Waiting information definition |
|
744 |
NONSHARABLE_STRUCT( TPEWaitingInfo ) |
|
745 |
{ |
|
746 |
TInt iGroupCount; |
|
747 |
TFixedArray<TPEWaitInfo, KPEMaxServiceGroup> iWaitInfo; |
|
748 |
}; |
|
749 |
||
750 |
//Barred information definition |
|
751 |
NONSHARABLE_STRUCT( TPEBarredInfo ) |
|
752 |
{ |
|
753 |
RMobilePhone::TMobilePhoneCBCondition iCondition; |
|
754 |
RMobilePhone::TMobileService iServiceGroup; |
|
755 |
RMobilePhone::TMobilePhoneCBStatus iStatus; |
|
756 |
}; |
|
757 |
||
758 |
// Barring information definition |
|
759 |
NONSHARABLE_STRUCT( TPEBarringInfo ) |
|
760 |
{ |
|
761 |
TInt iGroupCount; |
|
762 |
TFixedArray<TPEBarredInfo, KPEMaxServiceGroup> iBarredInfo; |
|
763 |
}; |
|
764 |
||
765 |
// Contains information of the Suplementary Services command. |
|
766 |
NONSHARABLE_STRUCT( TPESSCommandInfo ) // For SS Commands. |
|
767 |
{ |
|
768 |
TPESSAction action; // SS Action |
|
769 |
/*RMobilePhone::TMobileService*/ TInt group; // MMI Service Code |
|
770 |
TPESSType type; // Supplementary Services type |
|
771 |
}; |
|
772 |
||
773 |
NONSHARABLE_STRUCT( TPEConferenceMemberInfo ) |
|
774 |
{ |
|
775 |
TName iConferenceMemberName; |
|
776 |
TInt iConferenceMemberId; |
|
777 |
}; |
|
778 |
||
779 |
/** |
|
780 |
* Offers message interface from phone application to phone engine. |
|
781 |
* |
|
782 |
* ?more_complete_description |
|
783 |
* |
|
784 |
* @lib phoneengine |
|
785 |
* @since S60 v4.0 |
|
786 |
*/ |
|
787 |
NONSHARABLE_CLASS( MPEPhoneModel ) |
|
788 |
{ |
|
789 |
public: |
|
790 |
||
791 |
typedef TInt TPEMessagesToPhoneEngine; |
|
792 |
||
793 |
enum |
|
794 |
{ |
|
795 |
// Audio messages 1000 - 1999 |
|
796 |
EPEMessageSetAudioMute = 1000, |
|
797 |
EPEMessageSetAudioVolume, |
|
798 |
EPEMessageSetAudioOutput, |
|
799 |
||
800 |
// Call messages 2000 - 2999 |
|
801 |
EPEMessageAnswer = 2000, |
|
802 |
EPEMessageClientDial, |
|
803 |
EPEMessageContinueDTMFSending, |
|
804 |
EPEMessageDial, |
|
805 |
EPEMessagePlayDTMF, |
|
806 |
EPEMessageEndDTMF, |
|
807 |
EPEMessagePhoneNumberEdited, |
|
808 |
EPEMessageRelease, |
|
809 |
EPEMessageReleaseAll, |
|
810 |
EPEMessageReject, |
|
811 |
EPEMessageSendDTMF, |
|
812 |
EPEMessageStopDTMFSending, |
|
813 |
EPEMessageStopTonePlay, |
|
814 |
EPEMessageAutomaticAnswerOff, //UI sends when soft reject is needed |
|
815 |
EPEMessageTerminateAllConnections, |
|
816 |
EPEMessageSetSwitchToCallFlag, |
|
817 |
EPEMessageSwitchToVideoOrVoice, |
|
818 |
EPEMessageSatCallRequestCompleted, |
|
819 |
EPEMessageClientDialEmergency, |
|
820 |
EPEMessageReplaceActive, |
|
821 |
EPEMessageContinueEmergencyCallInitialization, |
|
822 |
EPEMessageAcceptUnattendedTransfer, |
|
823 |
EPEMessageRejectUnattendedTransfer, |
|
824 |
||
825 |
EPEMessageDoUnattendedTransfer, |
|
826 |
EPEMessageForwardCallToAddress, |
|
827 |
EPEMessageDialServiceCall, |
|
828 |
// Contact messages 3000 - 3999 |
|
829 |
||
830 |
// Error messages 4000 - 4999 |
|
831 |
||
832 |
// Network messages 5000 - 5999 |
|
833 |
||
834 |
// Parser messages 6000 - 6999 |
|
835 |
||
836 |
// Security messages 7000 - 7999 |
|
837 |
||
838 |
// Service messages 8000 - 8999 |
|
839 |
EPEMessageDisableService = 8000, |
|
840 |
||
841 |
// Startup messages 9000 - 9999 |
|
842 |
EPEMessagePEConstructionReady = 9000, |
|
843 |
||
844 |
// Miscellaneous messages 10000 - 10999 |
|
845 |
EPEMessageCheckEmergencyNumber = 10000 // Request engine to check is entered number emergency. |
|
846 |
||
847 |
// Variant messages 11000 - 12999 |
|
848 |
// From KPEMessagesToPhoneEngineGsmFirst |
|
849 |
// to KPEMessagesToPhoneEngineGsmLast |
|
850 |
}; |
|
851 |
||
852 |
virtual ~MPEPhoneModel() {}; |
|
853 |
||
854 |
/** |
|
855 |
* Returns pointer to information object (CPEEngineInfo) |
|
856 |
* |
|
857 |
* @since S60 v4.0 |
|
858 |
* @return Return pointer to CPEEngineInfo object |
|
859 |
*/ |
|
860 |
virtual MPEEngineInfo* EngineInfo() = 0; |
|
861 |
||
862 |
/** |
|
863 |
* Reroutes messages from the phone application to the message handler |
|
864 |
* |
|
865 |
* @since S60 v4.0 |
|
866 |
* @param aMessage is the message code |
|
867 |
*/ |
|
868 |
virtual void HandleMessage( const TInt aMessage ) = 0; |
|
869 |
||
870 |
/** |
|
871 |
* Returns the name of the specified message to PhoneEngine |
|
872 |
* |
|
873 |
* @since S60 v4.0 |
|
874 |
* @param aMessage is the message code |
|
875 |
* @return String containing the name of the message |
|
876 |
*/ |
|
877 |
virtual TPtrC NameByMessageToPhoneEngine( const TInt aMessage ) const = 0; |
|
878 |
||
879 |
/** |
|
880 |
* Returns the name of the specified message from PhoneEngine |
|
881 |
* |
|
882 |
* @param aMessage is the message code |
|
883 |
* @return String containing the name of the message |
|
884 |
*/ |
|
885 |
virtual TPtrC NameByMessageFromPhoneEngine( const TInt aMessage ) const = 0; |
|
886 |
||
887 |
}; // MPEPhoneModel |
|
888 |
||
889 |
/** |
|
890 |
* Utility class for call id. |
|
891 |
* |
|
892 |
* @lib PhoneEngine.lib |
|
893 |
*/ |
|
894 |
NONSHARABLE_CLASS( CallIdCheck ) |
|
895 |
{ |
|
896 |
public: |
|
897 |
static inline TBool IsValid( TInt aCallId ) |
|
898 |
{ |
|
899 |
return aCallId >= 0 && aCallId < KPEMaximumNumberOfCalls; |
|
900 |
} |
|
901 |
static inline TBool IsVoice( TInt aCallId ) |
|
902 |
{ |
|
903 |
return aCallId >= 0 && aCallId < KPEMaximumNumberOfVoiceCalls; |
|
904 |
} |
|
905 |
static inline TBool IsConference( TInt aCallId ) |
|
906 |
{ |
|
907 |
return aCallId >= KPEMaximumNumberOfVoiceCalls && |
|
908 |
aCallId < ( KPEMaximumNumberOfVoiceCalls + KPEMaximumNumberOfConferenceCalls ); |
|
909 |
} |
|
910 |
static inline TBool IsVideo( TInt aCallId ) |
|
911 |
{ |
|
912 |
return aCallId >= ( KPEMaximumNumberOfVoiceCalls + KPEMaximumNumberOfConferenceCalls ) |
|
913 |
&& aCallId < ( KPEMaximumNumberOfVoiceCalls + KPEMaximumNumberOfConferenceCalls + |
|
914 |
KPEMaximumNumberOfDataCalls ); |
|
915 |
} |
|
916 |
}; |
|
917 |
||
918 |
#endif // PEVIRTUALENGINE_H |
|
919 |
||
920 |
//End of file |