keys_tapi.h

这是法国Kaleido公司提供了一个手机mmi设计平台

/***************************************************************************
				KEYS_TAPI.h  -
				-------------
				begin                : 2007/03/29
				copyright            : (C) 2005 by DigitalAirways
				email                : [e-mail]
***************************************************************************/

/*
* Copyright (c) 2003-2005 DigitalAirways, sarl. All Rights Reserved.
*
* This software is the confidential and proprietary information of
* DigitalAirways, sarl. ("Confidential Information").  You shall not
* disclose such Confidential Information and shall use it only in
* accordance with the terms of the license agreement you entered into
* with DigitalAirways.
* A copy of this license is included in the licence.txt file included
* in this software package.
*/


// ********************* TEMPLATE *********************

// ****************************************************
// Property : TAPI_MODULE_FUNCTION
// Type     : TAPI_STATYPE_XXXXX
// Synchro  : R/W
// Descr.   : this a template description.
// <HERE THE DEFINED MACRO>
// ****************************************************

#ifndef KEYS_TAPI_H
#define KEYS_TAPI_H

// ******************** Properties of TAPI MANAGER ************************

#define TAPI_PROPERTY_AVAILABLE	    1 /* The property is available and accurate */
#define TAPI_PROPERTY_REFRESHING    2 /* The property is being refreshed */
#define TAPI_PROPERTY_UNIMPLEMENTED 3 /* The property is not yet implemented  */
#define TAPI_PROPERTY_UNKNOWN       4 /* The property is unknown */
#define TAPI_PROPERTY_INVALID       5 /* This action is not possible with this property */
#define TAPI_PROPERTY_BADPARAM		6 /* A parameter is invalid or unknown */

#define TAPI_STATYPE_UNKNOWN		0
#define TAPI_STATYPE_INT			1
#define TAPI_STATYPE_STRING			2
#define TAPI_STATYPE_SMALLARRAYLIST	3


/* last Error message. */
#define TAPI_LAST_ERROR			"TAPI_LAST_ERROR"


/*
 MISCELLANEOUS SETTINGS :  

 References: 

*/

// GSM Specific definitions properties.

// ****************************************************
// Property : TAPI_BATTERY_LEVEL
// Type     : TAPI_STATYPE_INT
// Accepted values:
//		0x00000000: unknown
//		0x000001xx: not plugged. xx=% of charge
//		0x000002xx: plugged. xx=% of battery charge
// Synchro  : R
// Descr.   : Current level of charge of the battery
#define TAPI_BATTERY_LEVEL 		"TAPI_BATTERY_LEVEL"
// Mask to get battery status.
#define TAPI_BATTERY_MASK_LEVEL		0x000000FF
#define TAPI_BATTERY_MASK_STATUS	0xFFFFFF00
// Possible status of battery:
#define TAPI_BATTERY_UNKNOWN	0x00000000
#define TAPI_BATTERY_UNPLUGGED	0x00000100
#define TAPI_BATTERY_PLUGGED	0x00000200

// ****************************************************

// ****************************************************
// Property : TAPI_RING_LEVEL
// Type     : TAPI_STATYPE_INT
// Accepted values:
//      0x000000xx: xx in %
// Synchro  : R/W
// Descr.   : set/get the level of the ringer
#define TAPI_RING_LEVEL 	"TAPI_RING_LEVEL"
// ****************************************************

// ****************************************************
// Property : TAPI_RING_STYLE
// Type     : TAPI_STATYPE_STRING
// Accepted values:
//      device dependent
// Synchro  : R/W
// Descr.   : set/get the style of the ringer
#define TAPI_RING_STYLE 	"TAPI_RING_STYLE" /* TAPI_STATYPE_STRING [R/W] */
// ****************************************************

// ****************************************************
// Property : TAPI_MICROPHONE_LEVEL
// Type     : TAPI_STATYPE_INT
// Accepted values:
//      0x000000xx: xx in %
// Synchro  : R/W
// Descr.   : set/get the level of the microphone
#define TAPI_MICROPHONE_LEVEL 	"TAPI_MICROPHONE_LEVEL"
// ****************************************************

// ****************************************************
// Property : TAPI_EARPHONE_LEVEL
// Type     : TAPI_STATYPE_INT
// Accepted values:
//      0x000000xx: xx in %
// Synchro  : R/W
// Descr.   : set/get the level of the earphone
#define TAPI_EARPHONE_LEVEL 	"TAPI_EARPHONE_LEVEL"
// ****************************************************


// ****************************************************
// Property : TAPI_SPEAKER_LEVEL
// Type     : TAPI_STATYPE_INT
// Accepted values:
//      0x000000xx: xx in %
// Synchro  : R/W
// Descr.   : set/get the level of the speaker
#define TAPI_SPEAKER_LEVEL 	"TAPI_SPEAKER_LEVEL"
// ****************************************************

// ****************************************************
// Property : TAPI_VIBRATOR_LEVEL
// Type     : TAPI_STATYPE_INT
// Accepted values:
//      0x000000xx: xx in %
// Synchro  : R/W
// Descr.   : set/get the level of the vibrator
#define TAPI_VIBRATOR_LEVEL 	"TAPI_VIBRATOR_LEVEL" /* TAPI_STATYPE_INT [R/W] */
// ****************************************************

// ****************************************************
// Property : TAPI_CALLS_LIST_STATE
// Type     : TAPI_STATYPE_SMALLARRAYLIST of querystrings (querystring: CALL description)
// Synchro  : R
// Descr.   : State of all calls.
#define TAPI_CALLS_LIST_STATE	 	"TAPI_CALLS_LIST_STATE"
// ****************************************************

// ****************************************************
// Property : TAPI_CALLS_LIST_REMOVE_ENDED_CALLS
// Type     : TAPI_STATYPE_INT
// Synchro  : W
// Descr.   : Allows to remove ended calls from TAPI_CALLS_LIST_STATE.
#define TAPI_CALLS_LIST_REMOVE_ENDED_CALLS	 	"TAPI_CALLS_LIST_REMOVE_ENDED_CALLS"
// ****************************************************
// ****************************************************
// Property : TAPI_CLOSE_ALL_CALL
// Type     : TAPI_STATYPE_INT
// Synchro  : W
// Descr.   : This property allows to close all calls.
#define TAPI_CLOSE_ALL_CALL	 	"TAPI_CLOSE_ALL_CALL"
// ****************************************************

// ****************************************************
// Property : TAPI_CALLS_LIST_REQUEST
// Type     : TAPI_STATYPE_SMALLARRAYLIST of querystrings (querystring: CALL description)
// Synchro  : R
// Descr.   : Allow to build request for calls operations.
#define TAPI_CALLS_LIST_REQUEST	 	"TAPI_CALLS_LIST_REQUEST"
// ****************************************************

// ****************************************************
// Property : TAPI_CALL_START_RINGING
// Type     : TAPI_STATYPE_INT
// Synchro  : W
// Descr.   : Allow to launch ring tone. Int is call index.
#define TAPI_CALL_START_RINGING	"TAPI_CALL_START_RINGING"
// ****************************************************

// ****************************************************
// Property : TAPI_CALL_STOP_RINGING
// Type     : TAPI_STATYPE_INT
// Synchro  : W
// Descr.   : Allow to stop ring tone. Int is call index.
#define TAPI_CALL_STOP_RINGING	"TAPI_CALL_STOP_RINGING"
// ****************************************************

// querystring's fields used in "CALL description"

//	id   I:  (mandatory) call ID as known by the MMI( = ID of this entry in the list of the calls = PRIMARY KEY)
#define CALL_FIELD_ID	"id"

#define CALL_ID_UNKNOWN -1

//	id   I:  (mandatory) call ID as known by the TAPI
#define CALL_FIELD_TID	"tid"



// state S: CALL's status
//   Possible exclusive values: note that some of these states may not be used in the MMI or in the TAPI.
//		CALL_STATE_UNKNOWN        : unknown 
//		CALL_STATE_REQINIT        : request to init a new call (OUTGOING only) (set by MMI to initiate a new call. TAPI must dial and set to CALL_STATE_INIT)    
//		CALL_STATE_INIT           : initialized (set by TAPI when the call is initialized but not yet ringing. TAPI must dial and the ack of the dialing will set it to CALL_STATE_RINGING)
//		CALL_STATE_RINGING        : ringing (set by TAPI. MMI must set it to CALL_STATE_REFUSED or CALL_STATE_ACCEPTED)
//		CALL_STATE_REQREFUSE      : request to refuse the call (set by MMI. TAPI must handle it and set it to ABORTED)
//		CALL_STATE_REQACCEPT      : request to accept the call (set by MMI. TAPI must handle it and set it to CALL_STATE_WAITESTABLISHED or CALL_STATE_ESTABLISHED)
//		CALL_STATE_ESTABLISHED    : established  (set by TAPI. MMI may handle it and set it to CALL_STATE_MMIACTIVE)
//		CALL_STATE_MMIESTABLISHED : established and active for the MMI (set by MMI)
//		CALL_STATE_REQHOLD        : request to hold the call (set by MMI. TAPI must handle it set it to CALL_STATE_HOLD)
//		CALL_STATE_HELD           : the call is held (set by TAPI. MMI may handle it and set it to CALL_STATE_MMIHOLD)
//		CALL_STATE_MMIHELD        : the call is held (set by MMI)
//		CALL_STATE_REQRELEASE     : request to release a held call (set by MMI. TAPI must handle it set it to CALL_STATE_RELEASE)
//		CALL_STATE_RELEASED       : the call is released (set by TAPI. MMI may handle it and set it to CALL_STATE_ESTABLISHED or to CALL_STATE_MMIESTABLISHED)
//		CALL_STATE_REQABORT       : request to abort (set by MMI. TAPI must handle it and set it to CALL_STATE_ABORTED)
//		CALL_STATE_ABORTED        : aborted (set by TAPI. MMI must handle it and set it to CALL_STATE_REQCLOSE)
//		CALL_STATE_REQCLOSE       : request to close (set by MMI. TAPI must handle it and delete the call descriptor)
//		CALL_STATE_CLOSED         : closed (set by TAPI. This descriptor can be deleted by the TAPI when needed...)
#define CALL_FIELD_STATE "state"

/* Actions that may be generated by TAPI -> MMI
#define Model__kAction_InCall 40
#define Model__kAction_EndCall 41
#define Model__kAction_CallEstablished 42

BEGIN: Missing ones:
These actions should be mainly defined in EB_Defs.h
*/

#ifndef Model__kAction_CallHeld
// TAPI additional actions
#define Model__kAction_CallHeld     57
#define Model__kAction_CallReleased 58

#endif // ndef Model__kAction_CallHeld

/*
END: Missing ones:
*/



// Note: the first character defines the class of the state
// cf. getCallInfo******ByStrings(...)
#define CALL_STATE_UNKNOWN     "UN"
#define CALL_STATE_REQINIT     "CA"
#define CALL_STATE_INIT        "CB"
#define CALL_STATE_RINGING     "CC"
#define CALL_STATE_REQREFUSE   "CD"
#define CALL_STATE_REQACCEPT   "CE"
#define CALL_STATE_ESTABLISHED "EA"
#define CALL_STATE_MMIESTABLISHED "EB"
#define CALL_STATE_REQHOLD     "EC"
#define CALL_STATE_HELD        "HA"
#define CALL_STATE_MMIHELD     "HB"
#define CALL_STATE_REQRELEASE  "HC"
#define CALL_STATE_RELEASED    "HD" /* next = established... */
#define CALL_STATE_REQABORT    "ED"
#define CALL_STATE_ABORTED     "FA"
#define CALL_STATE_REQCLOSE    "FB"
#define CALL_STATE_CLOSED      "FC"

// Note: the status' class may be used to know the "global" state of the call. 
//  For instance, a call that is not yet established uses the CALL_STATE_CLASS_CONNECTING class. 
//  This is used, for instance, to process calls that are in a state CALL_STATE_REQACCEPT as if they
//  were ringing when a ring notification is received.
// C* : Connection/Call
// E* : Established
// H* : Hold
// F* : Finished
#define CALL_STATE_CLASS_CONNECTING  "C"
#define CALL_STATE_CLASS_ESTABLISHED "E"
#define CALL_STATE_CLASS_HELD        "H"
#define CALL_STATE_CLASS_FINISHED    "F"


//	protocol I: 
//   Possible values are:
//		CALL_PROTOCOL_UNKNOWN
//		CALL_PROTOCOL_GSM    : GSM/3G
//		CALL_PROTOCOL_SIP    : SIP
//		CALL_PROTOCOL_SKYPE  : SKYPE
#define CALL_FIELD_PROTOCOL "prot"

#define CALL_PROTOCOL_UNKNOWN 0
#define CALL_PROTOCOL_GSM     1
#define CALL_PROTOCOL_SIP     2
#define CALL_PROTOCOL_SKYPE   3

//	ptype   S: (mandatory) protocol type (the actual values depend on the protocol and are protocol dependant)
#define CALL_FIELD_PTYPE	"ptype"
//	exturi   S: external URI (depend on the protocol; phone number for GSM)
#define CALL_FIELD_EXTURI	"exturi"
//	extname  S: name associated to EXTURI (caller name for instance)
#define CALL_FIELD_EXTNAME	"extname"
//	inturi   S: internal URI (depend on the protocol; phone number for GSM)
#define CALL_FIELD_INTURI	"inturi"
//	intname  S: name associated to INTURI (caller name for instance)
#define CALL_FIELD_INTNAME	"intname"
//  start    S: start time (in KALEIDO_TIME_TYPE)
#define CALL_FIELD_START	"start"
//	intout   I: 1: incoming call, 2: outgoing call
#define CALL_FIELD_INOUT	"inout"

#define CALL_INOUT_UNKNOWN  0
#define CALL_INOUT_INCOMING 1
#define CALL_INOUT_OUTGOING 2

//	confid   I: id of the conference
#define CALL_FIELD_CONFID	"confid"

// ****************************************************
// Property : TAPI_OUT_DTMF
// Type     : TAPI_STATYPE_STRING
// Synchro  : W
// Descr.   : this state allows to send DTMF tones during a call
#define TAPI_OUT_DTMF 	"TAPI_OUT_DTMF"
// ****************************************************

// ****************************************************
// Property : TAPI_CALL_SEND_NUMBER
// Type     : TAPI_STATYPE_STRING
// Synchro  : W only
// Descr.   : Allow to send a number to the network. For instance 2 + SEND on MMI will cause to put on hold a call
//            on GSM phone
#define TAPI_CALL_SEND_NUMBER		"TAPI_CALL_SEND_NUMBER"
// ****************************************************

// ****************************************************
// Property : TAPI_CLIP_STATE
// Type     : TAPI_STATYPE_INT
// Synchro  : R/W
// Descr.   : this allows to know(if forceWrite==false) the status or to set status of Line Identifier Presentation
// 0 : Disable
// 1 : Enable
// 2 : (RO) No Network.
#define TAPI_CLIP_STATE		"TAPI_CLIP_STATE"
// ****************************************************

// ****************************************************
// Property : TAPI_CLIR_STATE
// Type     : TAPI_STATYPE_INT
// Synchro  : R/W
// Descr.   : this allows to know(if forceWrite==false) the status or to set status of Calling Line Identification Restriction.
// 0 : disable
// 1 : enable
// 2 : network depend.
// 3 : unavailable.
#define TAPI_CLIR_STATE		"TAPI_CLIR_STATE"
// ****************************************************