技术文件 技术文件名称 :IAlert 接口使用说明 技术文件编号 : 版 本 :V1.0 共页 ( 包括封面 ) 拟制 审核 会签 标准化 批准 中兴通讯股份有限公司
XX 软件模块详细设计说明 版本号 修改记录 文件编号 版本号 拟制人 / 修改人 拟制 / 修改日期 1 V1.0 胡曦 2005-08-12 新建 更改理由 主要更改内容 ( 写要点即可 ) 注 1: 每次更改归档文件 ( 指归档到事业部或公司档案室的文件 ) 时, 需填写此表 注 2: 文件第一次归档时, 更改理由 主要更改内容 栏写 无 < 本文中的所有信息均为中兴通讯股份有限公司信息, 务请妥善保管, 未经公司明确作出的书面许可, 不得为任何目的 以任何形式或手段 ( 包括电子 机械 复印 录音或其它形式 ) 对本文档的任何部分进行复制 存储 引入检索系统或者传播 > 本文中的所有信息均为中兴通讯股份有限公司内部信息, 不得向外传播
1 IALERT 接口功能...3 2 数据的定义...3 2.1 呼叫类型的定义...3 2.2 振铃类型的定义...3 2.3 IALERT 接口函数的定义...4 3 接口定义...5 3.1 IALERT_ADDREF(P)...5 3.2 IALERT_RELEASE(P)...5 3.3 IALERT_STARTALERTING(PO, CALL_TYPE, PHONE_NUMBER, ALERT_TYPE)...5 3.4 IALERT_SETALARMRINGERFILE(PO, RINGERFILE)...5 3.5 IALERT_STOPALERTING(PO)...5 3.6 IALERT_SETMUTECTL(PO, MUTE_ON)...5 3.7 IALERT_GETINFO(PO, CALL_TYPE, PHONE_NUMBER, PHONENUMBERBUFSIZE, ALERT_TYPE) 6 4 接口的使用...6 4.1 设置变量保存 IALERT 指针...6 4.2 创建实例...6 4.3 播放铃音...6 4.4 停止播放铃音...6 4.5 释放接口...6 本文中的所有信息均为中兴通讯股份有限公司内部信息, 不得向外传播 2
1 IAlert 接口功能 IAlert 接口用于提供闹钟 来电 来短信 日历中日程安排 通话过程中的分钟提示等用到的响铃 振动的功能 2 数据的定义 2.1 呼叫类型的定义 #define AEEALERT_CALLTYPE_VOICE 0 #define AEEALERT_CALLTYPE_CSDATA 1 #define AEEALERT_CALLTYPE_PSDATA 2 #define AEEALERT_CALLTYPE_VIDEO 3 #define AEEALERT_CALLTYPE_FAX 4 #define AEEALERT_CALLTYPE_TEST 5 2.2 振铃类型的定义 typedef enum{ AEEALERT_ALERT_NONE = 0, AEEALERT_ALERT_NORMAL, AEEALERT_ALERT_CALLWAITING, AEEALERT_ALERT_DIALTONE, AEEALERT_ALERT_RINGBACK, AEEALERT_ALERT_BUSY, AEEALERT_ALERT_ANSWER, AEEALERT_ALERT_INTERCEPT, AEEALERT_ALERT_ABBR_INTERCEPT, AEEALERT_ALERT_REORDER, AEEALERT_ALERT_ABBR_REORDER, AEEALERT_ALERT_ABBR_ALERT, AEEALERT_ALERT_FADE_TONE, AEEALERT_ALERT_SPECIAL_INFO, AEEALERT_ALERT_CONFIRM, AEEALERT_ALERT_CALLWAIT_SIGNAL, AEEALERT_ALERT_PIP, AEEALERT_ALERT_ISDN_NORMAL, AEEALERT_ALERT_ISDN_INTERGROUP, AEEALERT_ALERT_ISDN_SPECIAL, AEEALERT_ALERT_ISDN_PING, AEEALERT_ALERT_IS54B_LONG_M, AEEALERT_ALERT_IS54B_LONG_H, AEEALERT_ALERT_IS54B_LONG_L, AEEALERT_ALERT_IS54B_SS_M, AEEALERT_ALERT_IS54B_SS_H, AEEALERT_ALERT_IS54B_SS_L, 本文中的所有信息均为中兴通讯股份有限公司内部信息, 不得向外传播 3
AEEALERT_ALERT_IS54B_SSL_M, AEEALERT_ALERT_IS54B_SSL_H, AEEALERT_ALERT_IS54B_SSL_L, AEEALERT_ALERT_IS54B_SS2_M, AEEALERT_ALERT_IS54B_SS2_H, AEEALERT_ALERT_IS54B_SS2_L, AEEALERT_ALERT_IS54B_SLS_M, AEEALERT_ALERT_IS54B_SLS_H, AEEALERT_ALERT_IS54B_SLS_L, AEEALERT_ALERT_IS54B_SSSS_M, AEEALERT_ALERT_IS54B_SSSS_H, AEEALERT_ALERT_IS54B_SSSS_L, AEEALERT_ALERT_IS54B_PBX_LONG_M, AEEALERT_ALERT_IS54B_PBX_LONG_H, AEEALERT_ALERT_IS54B_PBX_LONG_L, AEEALERT_ALERT_IS54B_PBX_SS_M, AEEALERT_ALERT_IS54B_PBX_SS_H, AEEALERT_ALERT_IS54B_PBX_SS_L, AEEALERT_ALERT_IS54B_PBX_SSL_M, AEEALERT_ALERT_IS54B_PBX_SSL_H, AEEALERT_ALERT_IS54B_PBX_SSL_L, AEEALERT_ALERT_IS54B_PBX_SLS_M, AEEALERT_ALERT_IS54B_PBX_SLS_H, AEEALERT_ALERT_IS54B_PBX_SLS_L, AEEALERT_ALERT_IS54B_PBX_SSSS_M, AEEALERT_ALERT_IS54B_PBX_SSSS_H, AEEALERT_ALERT_IS54B_PBX_SSSS_L, AEEALERT_ALERT_IS53A_PPPP_M, AEEALERT_ALERT_IS53A_PPPP_H, AEEALERT_ALERT_IS53A_PPPP_L, AEEALERT_ALERT_WAP, AEEALERT_ALERT_EMAIL, AEEALERT_ALERT_MMS, AEEALERT_ALERT_SMS, AEEALERT_ALERT_WARNING, AEEALERT_ALERT_ALARM, AEEALERT_ALERT_MINUTE_MINDER, AEEALERT_ALERT_MAX = 0x10000000 }AEEALERTType; 2.3 IAlert 接口函数的定义 AEEINTERFACE(IALERT) { INHERIT_IQueryInterface(IALERT); 本文中的所有信息均为中兴通讯股份有限公司内部信息, 不得向外传播 4
int (*StartAlerting)(IALERT *po, uint8 call_type, AECHAR *phone_number, AEEALERTType alert_type); int (*SetAlarmRingerFile)(IALERT *po,char* ringerfile); int (*StopAlerting)(IALERT *po); int (*SetMuteCtl)(IALERT *po, boolean mute_on); int (*SetRect)(IALERT *po, AEERect* trect); int (*GetRect)(IALERT *po, AEERect *prect); int (*GetInfo)(IALERT *po, uint8 *call_type,aechar *phone_number, uint16 phonenumberbufsize, AEEALERTType *alert_type); }; 3 接口定义 3.1 IAlert_AddRef(p) 功能 : 增加对 IAlert 接口的引用 参数说明 : p:ialert 接口指针 返回值说明 : 当前 IAlert 接口的引用数目 3.2 IALERT_Release(p) 功能 : 减少对 IAlert 接口的引用 参数说明 : p:ialert 接口指针 返回值说明 : 当前 IAlert 接口的引用数目 3.3 IALERT_StartAlerting(po, call_type, phone_number, alert_type) 功能 : 开始播放铃音 根据系统的配置, 如果启动了振动 或是设置为使用振 动的情景模式, 在播放的同时启动振动 如果设置静音, 不播放铃音 call_type 呼叫的类型 phone_number 对于来电时的主叫号码, 对于闹钟, 日历等振铃时为空 alert_type 振铃的类型 3.4 IALERT_SetAlarmRingerFile(po, ringerfile) 功能 : 设置播放的铃音文件 ringerfile 铃音文件名 3.5 IALERT_StopAlerting(po) 功能 : 停止播放铃音 3.6 IALERT_SetMuteCtl(po, mute_on) 功能 : 设置静音或取消 mute_on TRUE 表示设置静音,FALSE 表示取消静音 本文中的所有信息均为中兴通讯股份有限公司内部信息, 不得向外传播 5
3.7 IALERT_GetInfo(po, call_type, phone_number, phonenumberbufsize, alert_type) 功能 : 获取振铃的信息参数说明 : 输入 po IAlert 接口指针 phonenumberbufsize 存储 phone_number 的缓冲区的大小输出 : call_type 呼叫的类型 phone_number 如果 phonenumberbufsize>0, 返回来电中的主叫号码 alert_type 振铃的类型 4 接口的使用 4.1 设置变量保存 IAlert 指针 上下文中添加 IALERT 4.2 创建实例 * m_pialert; // instance of IALERT 在应用初始化中添加创建实例 ISHELL_CreateInstance(pMe->a.m_pIShell,AEECLSID_ALERT,(void**) &pme->m_pialert); 4.3 播放铃音当闹钟到时, 播放铃音 a) 调用 IALERT_SetAlarmRingerFile(IALERT* pialert, char* ringerfile) 设置待播放的铃音文件, 其中 ringerfile 是铃音文件的全路径名 b) 调用 IALERT_StartAlerting(IALERT*pIAlert,0,NULL, AEEALERT_ALERT_ALARM); 播放铃音 IWINMGR_AddRef(p) 4.4 停止播放铃音调用 IALERT_StopAlerting(pIAlert); 停止播放铃音 4.5 释放接口应用退出或不在需要该接口时, 调用 IALERT_Release(pIAlert); 释放 IALERT 接口 功能 : 增加对 IWinMgr 接口的引用 参数说明 : piwinmgr:iwinmgr 接口指针 返回值说明 : 当前 IWinMgr 接口的引用数目 本文中的所有信息均为中兴通讯股份有限公司内部信息, 不得向外传播 6