1、文档编号:系统类别 McWiLL 多媒体集群系统产品型号产品代号项目/产品名称 铁路项目 API 接口文档共 6 页(含封页)铁路项目 API 接口及 CAB 包制作文档(文档版本号:V1.01)拟 制: 终端产品部 日 期: 20130903审 核: 日 期:会 签: 日 期:批 准: 日 期:北京信威通信技术股份有限公司版权所有 不得复制I修订记录日 期 修订版本 描 述 作 者20130902 V1.00 初稿 贾彬20130903 V1.01 增加更换背景图部分 贾彬20130903 V1.02 增加手电筒开关控制接口 贾彬II目录一引言 .11.1 编写目的 11.2 背景、适用范围
2、 .11.3 术语和缩略 11.4 参考资料 1二接口定义 12.1 按键虚拟键值 .12.2 震动接口 12.3 声音接口 22.4 GPS 相关接口 22.5 睡眠控制接口 .32.6 手电筒开关控制接口 .3三CAB 包制作说明 .3四背景图更换 41一引言1.1 编写目的为铁路项目编写 API 调用接口文档,供铁路研发人员调用实现相应的功能。1.2 背景、适用范围铁路项目。1.3 术语和缩略1.4 参考资料Wi128 修改需求分析报告二接口定义2.1 按键虚拟键值左 键:VK_APP1(0xC1)左 键:VK_APP2(0xC2)中间 键:VK_LWIN(0x5B)挂断键键值: VK_
3、ESCAPE(0x1B)2.2 震动接口 初始化马达BOOL HW_MELODY_MotorInit();说明:如果初始化成功,返回 TRUE;否则返回 FALSE。应该在系统初始化时初始化马达。 打开马达BOOL HW_MELODY_MotorCtrl_ON();2说明:如果打开成功,返回 TRUE;否则返回 FALSE。 关闭马达BOOL HW_MELODY_MotorCtrl_OFF();说明:如果关闭成功,返回 TRUE;否则返回 FALSE。2.3 声音接口 设置按键音VOID SetKeyVolume(int volume);参数说明:volume:值为 0 表示不播放按键音值为
4、1 表示较小的按键音值为 2 表示较大的按键音 设置屏幕音VOID SetScrnVolume(int volume);参数说明:volume:值为 0 表示不播放触屏音值为 1 表示较小的触屏音值为 2 表示较大的触屏音 播放音乐文件VOID PlayMusic(LPCTSTR szFile, UINT volume);参数说明:szFile:表示音乐文件的路径,可支持 mp3,aac 等格式文件volume:表示播放声音的大小,从 1 开始的整数,值越大,声音越大 停止播放音乐文件VOID StopMusic();说明:如果当前正在播放音乐文件,停止播放。注意:在调用 PlayMusic
5、之后需要对应调用 StopMusic,否则会存在内存泄露。2.4 GPS 相关接口此处接口参数详细含义请参照 MSDN 中 mobile/wince 相关文档Function DescriptionGPSOpenDevice Creates a connection to the GPS Intermediate Driver.GPSCloseDevice Closes the connection to the GPS Intermediate Driver. 3GPSGetPosition Retrieves location information, including latitude
6、 and longitude.GPSGetDeviceState Retrieves information about the current state of the GPS hardware.2.5 睡眠控制接口 控制是否允许关闭屏幕VOID EnableUserIdle(BOOL enable);参数说明:enable:为 TRUE 表示允许关闭手持机屏幕为 FALSE 表示不允许关闭手持机屏幕,即屏幕会常亮,系统也不会进入睡眠状态 控制是否允许系统睡眠VOID EnableSystemIdle(BOOL enable);参数说明:enable:为 TRUE 表示允许系统睡眠,使用时需
7、要 保证允许关闭屏幕,不然系统不会睡眠。为 FALSE 表示不允许系统睡眠,此时如果是在允许关闭屏幕的状态,则系统会在一段时间之后进入睡眠状态2.6 手电筒开关控制接口 控制手电筒的打开与关闭VOID OpenCloseTorch(BOOL open);参数说明:Open:为 TRUE 表示打开手电筒为 FALSE 表示关闭手电筒三CAB 包制作说明 使用工具Wince Cab Manager 3.0 使用时注意要点1. 请在指定文件安装位置时指定到windows 目录,也即%CE2%目录2. 添加一个快捷方式指向应用程序文件,需要保证该快捷方式位置为:My Documents程序目录下3.
8、设计一个大小为 125*150 的 png 格式图标(可参照下面的 Setup.png) ,该图标的名称及位置需要与快捷方式的名称一致,例如:假设快捷方式的名称为文件传输,则该图标的全称应为文件传输.4png,其路径位于My Documents程序目录下4. 将生成的 CAB 文件安装到终端上5. 重启终端6. 请参考下面的文件传输工具 v0.8a.CAB 文件四背景图更换 准备图片背景图更换需要提供一张名为 standby_wallpaper.bmp 的图片,大小为 480*800,要求 16 位 565 的bmp 图片,制作方式可在 photoshop 中将已准备好的图片转为 16 位 565 的格式。 制作 cab 包制作一个 cab 包,假设名为 background.cab,在其中加入准备好的图片,其存放位置设置为 %CE2%,即windows 目录 安装 cab 包在终端上安装此 cab 包,然后重启终端即可看到更换后的背景请参照下列示例来制作: