展讯多媒体模块接口简介.doc

Mocor MMI Multim Interface User GuideVersion: 1.0.0DocCode: SW-MOCOR-UG-0004Date: 2008-03-03重要声明版权声明本文档中的任何内容受中华人民共和国著作权法的保护，版权所有 2008，展讯通信有限公司，保留所有权利，但注明引用其他方的内容除外。商标声明展讯通信有限公司和展讯通信有限公司的产品是展讯通信有限公司专有。在提及其他公司及其产品时将使用各自公司所拥有的商标，这种使用的目的仅限于引用。不作保证声明展讯通信有限公司不对此文档中的任何内容作任何明示或暗示的陈述或保证，而且不对特定目的的适销性及适用性或者任何间接、特殊或连带的损失承担任何责任。保密声明本文档（包括任何附件）包含的信息是保密信息。接收人了解其获得的本文档是保密的，除用于规定的目的外不得用于任何目的，也不得将本文档泄露给任何第三方。前 言文档说明本文档为MMI MULTIM模块的接口文档，详细描述了本模块提供给其他MMI模块的API接口。阅读对象本文档适合MMI软件开发人员和相关客户开发人员使用。内容介绍本文档包括三个章节，分别为： 第一章：模块的总体结构。简单介绍了MMI MULTIM模块的功能结构； 第二章：数据类型。介绍了对外部模块提供的数据结构。 第三章：提供给其他模块的接口。介绍了MMI MULTIM模块提供给外部模块的接口函数。文档约定本文档采用下面醒目标志来表示在操作过程中应该特别注意的地方。注意：提醒操作中应注意的事项。相关文档无。目 录第1章 模块的总体结构1-11.1 模块总体框架1-11.2 模块功能概述1-1第2章 数据类型2-12.1 枚举2-12.1.1 MMIAUDIO_TYPE_E2-12.1.2 MMIMULTIM_MUSIC_TYPE_E2-22.1.3 MMIMULTIM_DEVICE_TYPE_E2-3第3章 提供给其他模块的接口3-13.1 初始化接口3-13.1.1 MMIAPIMULTIM_Init3-13.1.2 MMIAPIMULTIM_InitModule3-13.2 其它接口3-23.2.1 MMIAPIMULTIM_FileNameIsValid3-23.2.2 MMIAPIMULTIM_GetMusicType3-23.2.3 MMIAPIMULTIM_GetNameAndSuffix3-33.2.4 MMIAPIMULTIM_OpenSelectMovieWin3-43.2.5 MMIAPIMULTIM_CloseSelectMovieWin3-53.2.6 MMIAPIMULTIM_OpenSelectMusicWin3-53.2.7 MMIAPIMULTIM_CloseSelectMusicWin3-63.2.8 MMIAPIMULTIM_PlayMusicFile3-63.2.9 MMIAPIMULTIM_CloseSelectPictureWin3-73.2.10 MMIAPIMULTIM_InitWallPaper3-83.2.11 MMIAPIMULTIM_IsWallPaperFile3-83.2.12 MMIAPIMULTIM_SetPictureToWallpaper3-93.2.13 MMIAPIMULTIM_CloseWin3-93.2.14 MMIAPIMULTIM_DoFileOperat3-103.2.15 MMIAPIMULTIM_OpenFileListWin3-103.2.16 MMIAPIMULTIM_PostMsgFileOptWin3-113.2.17 MMIAPIMULTIM_StopOperaSDPlug3-11-iii-第3章 提供给其他模块的接口第1章 模块的总体结构1.1 模块总体框架总体结构图如图 11所示。图 11 MULTIM模块在总体结构中的位置1.2 模块功能概述MULTIM模块主要是提供其他模块访问图片、音乐、视频文件的接口，主要功能有： 浏览：浏览图片或音乐或视频； 发送：将多媒体内容作为MMS发送； 删除：删除一条图片/音乐或所有图片/音乐； 设为：将图片设为墙纸或将音乐设为来电铃声； 重命名； 详情：查看一条图片/音乐的详细情况； 下载；保存下载铃声；3-11第2章 数据类型2.1 枚举2.1.1 MMIAUDIO_TYPE_E【含义】MMIAUDIO_TYPE_E定义了音频类型。【定义】typedef enumMMIAUDIO_MIDI,MMIAUDIO_GENERIC_TONE,MMIAUDIO_CUSTOM_TONE,MMIAUDIO_DTMF_TONE,MMIAUDIO_SMAF,MMIAUDIO_WAVE,MMIAUDIO_MP3,MMIAUDIO_WMA,MMIAUDIO_AMR,MMIAUDIO_ADPCM,MMIAUDIO_PCM,MMIAUDIO_AAC,MMIAUDIO_M4A,MMIAUDIO_TYPE_MAX MMIAUDIO_TYPE_E;【参数说明】参数名称含义MMIAUDIO_MIDIMIDI音乐格式MMIAUDIO_GENERIC_TONEGeneric ToneMMIAUDIO_CUSTOM_TONECustom ToneMMIAUDIO_DTMF_TONEDTMF ToneMMIAUDIO_SMAFSMAF音乐格式MMIAUDIO_WAVEWAV文件MMIAUDIO_MP3MP3类型MMIAUDIO_WMAWMA类型MMIAUDIO_AMRAMR类型MMIAUDIO_ADPCMADPCM格式MMIAUDIO_PCMPCM格式MMIAUDIO_AACAAC类型MMIAUDIO_M4AM4A格式MMIAUDIO_TYPE_MAX系统保留，不可使用2.1.2 MMIMULTIM_MUSIC_TYPE_E【含义】MMIMULTIM_MUSIC_TYPE_E定义了下载铃声类型。【定义】typedef enumMMIMULTIM_MUSIC_NO_TYPE,MMIMULTIM_TYPE_MIDI,MMIMULTIM_TYPE_MID,MMIMULTIM_TYPE_MMF,MMIMULTIM_TYPE_SMAF,MMIMULTIM_TYPE_WAV,MMIMULTIM_TYPE_MP3,MMIMULTIM_TYPE_WMA,MMIMULTIM_TYPE_AMR,MMIMULTIM_TYPE_AAC,MMIMULTIM_TYPE_M4A,MMIMULTIM_TYPE_MP4,MMIMULTIM_TYPE_3GP,MMIMULTIM_MAX_MUSIC_TYPE_NUM MMIMULTIM_MUSIC_TYPE_E;【参数说明】参数名称含义MMIMULTIM_MUSIC_NO_TYPE无类型MMIMULTIM_TYPE_MIDIMIDI类型MMIMULTIM_TYPE_MIDMIDI类型MMIMULTIM_TYPE_MMFMMF类型MMIMULTIM_TYPE_SMAFSMAF类型MMIMULTIM_TYPE_WAVWAV类型MMIMULTIM_TYPE_MP3MP3类型MMIMULTIM_TYPE_WMAWMA类型MMIMULTIM_TYPE_AMRAMR类型MMIMULTIM_TYPE_AACAAC类型MMIMULTIM_TYPE_M4AM4A类型MMIMULTIM_TYPE_MP4MP4类型MMIMULTIM_TYPE_3GP3GP类型MMIMULTIM_MAX_MUSIC_TYPE_NUM音乐的类型总数2.1.3 MMIMULTIM_DEVICE_TYPE_E【含义】MMIMULTIM_DEVICE_TYPE_E定义了存储设备类型【定义】typedef enum MMIMULTIM_DEVICE_NULL,MMIMULTIM_UDISK_ONLY,MMIMULTIM_SD_ONLY,MMIMULTIM_DEVICE_ALL,MMIMULTIM_DEVICE_MAX MMIMULTIM_DEVICE_TYPE_E;【参数说明】参数名称含义MMIMULTIM_DEVICE_NULL无存储设备MMIMULTIM_UDISK_ONLYU盘MMIMULTIM_SD_ONLYSD卡MMIMULTIM_DEVICE_ALLU盘和SD卡MMIMULTIM_DEVICE_MAX设备类型最大值第3章 提供给其他模块的接口3.1 初始化接口3.1.1 MMIAPIMULTIM_Init【函数原型】voidMMIAPIMULTIM_Init (void);【函数功能】该函数用于开机初始化，创建Picture、Music、Movie目录，初始化墙纸。【参数说明】无。【返回值】无。【注意事项】无。3.1.2 MMIAPIMULTIM_InitModule【函数原型】voidMMIAPIMULTIM_InitModule (void)【函数功能】该函数用于初始化Multim模块。【参数说明】无。【返回值】无。【注意事项】无。3.2 其它接口3.2.1 MMIAPIMULTIM_FileNameIsValid【函数原型】BOOLEANMMIAPIMULTIM_FileNameIsValid (TEXTEDIT_STRING_INFO_T*file_name_ptr);【函数功能】判断文件名是否有效。【参数说明】file_name_ptr：文件名结构指针。【返回值】TRUE：有效；FALSE：无效。【注意事项】无。3.2.2 MMIAPIMULTIM_GetMusicType【函数原型】MMIAUDIO_TYPE_E MMIAPIMULTIM_GetMusicType (uint8*file_name_ptr,uint16name_len);【函数功能】获得音频文件类型。【参数说明】file_name_ptr：文件名数据指针；name_len：文件名长度。【返回值】MMIAUDIO_TYPE_E。【注意事项】无。3.2.3 MMIAPIMULTIM_GetNameAndSuffix【函数原型】voidMMIAPIMULTIM_GetNameAndSuffix (uint16*name_suffix_ptr, uint16name_suffix_len, MMI_STRING_T*name_ptr, MMI_STRING_T*suffix_ptr );【函数功能】获得没有后缀名的文件名称，以及后缀名。【参数说明】name_suffix_ptr：输入的文件名指针name_suffix_len：输入文件名的长度name_ptr：输出不带后缀名的文件名指针suffix_ptr：输出后缀名指针【返回值】无。【注意事项】无。3.2.4 MMIAPIMULTIM_OpenSelectMovieWin【函数原型】BOOLEANMMIAPIMULTIM_OpenSelectMovieWin(MMIMULTIM_DEVICE_TYPE_Eselect_device, uint32select_movie,uint32max_size,BOOLEANis_need_data,MMI_WIN_ID_Twin_id,uint8*ticked_file,uint16cked_file_len );【函数功能】打开视频列表窗口。【参数说明】select_device：选择设备；select_movie：视频类型；max_size：允许的最大movie size；is_need_data：是否需要返回数据；win_id：窗口ID；ticked_file：需要打勾的文件名；ticked_file_len：需要打勾的文件名长度。【返回值】TRUE：成功；FALSE：失败。【注意事项】窗口的选项少，主要用于设置和彩信。3.2.5 MMIAPIMULTIM_CloseSelectMovieWin【函数原型】voidMMIAPIMULTIM_CloseSelectMovieWin (void);【函数功能】关闭视频列表窗口和视频选项窗口。【参数说明】无。【返回值】无。【注意事项】无。3.2.6 MMIAPIMULTIM_OpenSelectMusicWin【函数原型】BOOLEANMMIAPIMULTIM_OpenSelectMusicWin (MMIMULTIM_DEVICE_TYPE_Eselect_device,uint32select_music, uint32max_size,BOOLEANis_need_data,MMI_WIN_ID_Twin_id,uint8*ticked_file,uint16ticked_file_len);【函数功能】打开音频列表窗口。【参数说明】select_device：选择设备；select_movie：音频类型；max_size：允许的最大movie size；is_need_data：是否需要返回数据；win_id：窗口ID；ticked_file：需要打勾的文件名；ticked_file_len：需要打勾的文件名长度。【返回值】TRUE：成功；FALSE：失败。【注意事项】窗口的选项少。3.2.7 MMIAPIMULTIM_CloseSelectMusicWin【函数原型】voidMMIAPIMULTIM_CloseSelectMusicWin (void);【函数功能】关闭音频列表窗口。【参数说明】无。【返回值】无。【注意事项】无。3.2.8 MMIAPIMULTIM_PlayMusicFile【函数原型】BOOLEANMMIAPIMULTIM_PlayMusicFile (MMIAUDIO_HTYPEhandle_type,uint8*full_path_ptr,uint16full_path_len,uint32play_times,uint32vol,MMIAUDIO_END_CALLBACK_PFUNCcall_back);【函数功能】播放音频文件。【参数说明】handle_type：handle类型；full_path_ptr：文件全路径名指针；full_path_len：文件全路径名长度；play_times：播放次数；vol：播放音量；call_back：播放完的回调函数。【返回值】TRUE：成功；FALSE：失败。【注意事项】无。3.2.9 MMIAPIMULTIM_CloseSelectPictureWin【函数原型】voidMMIAPIMULTIM_CloseSelectPictureWin (void);【函数功能】关闭图片列表窗口。【参数说明】无。【返回值】无。【注意事项】无。3.2.10 MMIAPIMULTIM_InitWallPaper【函数原型】voidMMIAPIMULTIM_InitWallPaper (void);【函数功能】从NV中读取墙纸信息。【参数说明】无。【返回值】无。【注意事项】无。3.2.11 MMIAPIMULTIM_IsWallPaperFile【函数原型】BOOLEANMMIAPIMULTIM_IsWallPaperFile (uint8*full_path_ptr,uint16full_path_len);【函数功能】判断输入文件是否是墙纸。【参数说明】full_path_ptr：全路径名指针；full_path_len：全路径名长度；【返回值】TRUE：是；FALSE：不是。【注意事项】无。3.2.12 MMIAPIMULTIM_SetPictureToWallpaper【函数原型】BOOLEANMMIAPIMULTIM_SetPictureToWallpaper (uint8*full_path_ptr,uint16full_path_len);【函数功能】设置图片为墙纸。【参数说明】full_path_ptr：全路径名指针；full_path_len：全路径名长度；【返回值】TRUE：成功；FALSE：失败。【注意事项】无。3.2.13 MMIAPIMULTIM_CloseWin【函数原型】voidMMIAPIMULTIM_CloseWin (void);【函数功能】关闭Multim模块所有相关窗口。【参数说明】无。【返回值】无。【注意事项】无。3.2.14 MMIAPIMULTIM_DoFi