软件接口文档v

`案卷号接口文档-V2.0日期2011-07-22研发平台软件项目软件项目接口文档作者：完成日期：签收人：签收日期：修改情况记录：版本号修改批准人修改人安装日期签收人2.0第1章目录TOC\o"1-3"\t"章,1,节,2,1级条,3,2级条,4"第1章引言31.1编写目的31.2术语31.3参考文献3第2章接口定义42.1同步接口指令4引言1.1编写目的说明对程序系统的接口 设计 领导形象设计圆作业设计ao工艺污水处理厂设计附属工程施工组织设计清扫机器人结构设计 、数据结构设计等，为开发编码奠定基础。本文档描述本地UI软件的JavaScript代码和STB浏览器组件库iPanel之间的交互接口，包括请求的格式，请求结果的格式，相关错误的定义，以及请求和结果返回的交互流程。本文的主要读者为需要系统前端开发人员、STB开发人员，以及需要了解本前端与STB接口的相关人员。1.2术语术语或缩写词说明性定义IPTV交互式网络电视STB机顶盒HTML超文本置标语言JavaScript一种应用于客户端Web开发的脚本语言CSS层叠样式 表 关于同志近三年现实表现材料材料类招标技术评分表图表与交易pdf视力表打印pdf用图表说话 pdf DOM文档对象模型JSON专门为浏览器中的网页上运行的JavaScript代码而设计的一种数据格式XML可扩展置标语言iPanelIPTV终端浏览器1.3参考文献序号资料名文件编号发表日期出版单位第2章接口定义本软件页面与底层交互采用iPanel扩展的ioctlRead/Write方式进行，数据交换采用json字符串/String方式。2.1同步接口指令媒体播控媒体类型约定:0->电影；1->音乐；2->图片；3->文本静音模式约定:0->关闭（off）；1->打开(on)视频类型约定:0->高清；1->标清；2->普通；3->片花；语法iPanel.ioctlWrite("Media.Open","<参数json串>")功能写入媒体播放路径及类型。参数属性名称Name媒体路径Type媒体类型返回无举例iPanel.ioctlWrite("Media.Open","{"name":"/mnt/hd/逃亡鳄鱼岛.avi","type":"0"}")语法iPanel.ioctlWrite("Media.Pause","<参数json串>")功能写入媒体暂停路径及类型。参数属性名称Name媒体路径Type媒体类型返回无举例iPanel.ioctlWrite("Media.Pause","{"name":"/mnt/hd/逃亡鳄鱼岛.avi","type":"0"}")语法iPanel.ioctlWrite("Media.Resume","<参数json串>")功能写入媒体继续路径及类型。参数属性名称Name媒体路径Type媒体类型返回无举例iPanel.ioctlWrite("Media.Resume","{"name":"/mnt/hd/逃亡鳄鱼岛.avi","type":"0"}")语法iPanel.ioctlWrite("Media.Position","<参数json串>")功能写入媒体播放位置参数。参数属性名称x媒体x坐标y媒体y坐标w媒体宽度h媒体高度返回无举例iPanel.ioctlWrite("Media.Position","{"x":"0","y":"0","w":"1280","h":"720"}")语法iPanel.ioctlRead("Media.Position")功能读取媒体播放位置参数。参数无返回Json串举例返回JSON串：{"x":"0","y":"0","w":"1280","h":"720"}语法iPanel.ioctlWrite("Media.Stop","<参数json串>")功能写入媒体播放停止路径及类型。参数属性名称Name媒体路径Type媒体类型返回无举例iPanel.ioctlWrite("Media.Stop","{"name":"/mnt/hd/逃亡鳄鱼岛.avi","type":"0"}")语法iPanel.ioctlWrite("Media.Forward","<参数json串>")功能写入媒体播放快进模式及类型。参数属性名称Mode快进模式Type媒体类型返回举例iPanel.ioctlWrite("Media.Forward","{"mode":"8","type":"0"}")语法iPanel.ioctlWrite("Media.Rewind","<参数json串>")功能写入媒体播放快退模式及类型。参数属性名称Mode快退模式Type媒体类型返回举例iPanel.ioctlWrite("Media.Forward","{"mode":"8","type":"0"}")语法iPanel.ioctlRead("Media.GetVolume")功能读取媒体播放音量。参数无返回String举例20语法iPanel.ioctlRead("getMemoryItem”)功能获取记忆的功能导航。参数无返回String举例20语法iPanel.ioctlWrite("setMemoryItem”,index)功能设置记忆的功能导航。参数无返回无举例语法iPanel.ioctlRead("Media.GetMute")功能读取媒体播放静音设置。参数无返回String举例0语法iPanel.ioctlWrite("Media.SetBook","<参数String>")功能写入媒体订购信息。参数属性名称Name媒体名称返回返回ok或者失败信息（资费不够等）举例iPanel.ioctlWrite("Media.SetBook","/mnt/hd/逃亡鳄鱼岛.avi")语法iPanel.ioctlRead("Media.GetBook,Name")功能读取媒体订购信息。参数属性名称Name媒体名称Count媒体总份数Price媒体总资费(元)返回Json串举例{"name":"/mnt/hd/逃亡鳄鱼岛.avi","count":"2","price":"66.50"}语法iPanel.ioctlRead("Media.GetCurrentDownFile")功能读取下载媒体信息。参数属性名称Name媒体名称Size媒体大小Speed下载速度Percent下载百分比DownedSize已下载大小Status下载状态返回Json串举例{"name":"/mnt/hd/逃亡鳄鱼岛.avi","size":"102445676KB","speed":"538KB/S","percent":"15%","downedsize":"34567KB","status":"正在下载"}语法iPanel.ioctlRead("Media.GetFileInfo,path")path当前媒体路径功能读取媒体信息。参数属性名称Name媒体名称singer演唱者currentPlayTime当前播放时间during媒体时长loopMode循环模式videoOutput视频输出other其他信息返回Json串举例{"name":"/mnt/hd/逃亡鳄鱼岛1.avi","singer":"德华","currentPlayTime":"00:00:32","duration":"0:01:00","loopMode":"全循环","videoOutput":"sVideo","other":"16:9字幕:无双声道"};语法iPanel.ioctlRead("Media.GetNextFileInfo,path")path当前媒体路径功能读取子集中下一个媒体信息，以便播放。没有子集返回空参数属性名称Name媒体名称singer演唱者currentPlayTime当前播放时间during媒体时长loopMode循环模式videoOutput视频输出other其他信息返回Json串举例{"name":"/mnt/hd/逃亡鳄鱼岛1.avi","singer":"德华","currentPlayTime":"00:00:32","duration":"0:01:00","loopMode":"全循环","videoOutput":"sVideo","other":"16:9字幕:无双声道"};媒体类型约定:0->电影；1->音乐；2->图片电影风格类型约定:0->剧情片；1->喜剧片；2->恐怖片；3->科幻片音乐风格类型约定:0->流行；1->古典；2->民歌；3->港台图片容器格式约定:0->jpg；1->png；2->gif语法iPanel.ioctlRead("FSO.GetFiles,MenuIndex,currentFileIndex,usb")MenuIndex：菜单索引如1，2，3，currentFileIndex：当前文件索引如1，2，3，usb：外置移动硬盘还是置硬盘功能读取指定类型,指定链表位置的文件列表。参数属性名称Name媒体名称返回Json串举例{"/mnt/hd/逃亡鳄鱼岛.avi","/mnt/hd/逃亡.avi"}语法iPanel.ioctlRead("Media.getSubDrama,path")path：文件路径如/mnt/hd/逃亡.avi功能获取下载完成的子集我的专区电视剧。参数属性名称path文件路径返回json举例[{'no':'1','name':'/mnt/hd/放牛班的春天01.avi'},{'no':'2','name':'/mnt/hd/放牛班的春天02.avi'}];语法iPanel.ioctlRead("FSO.GetFiles,MenuIndex,fileLength,usb")MenuIndex：菜单索引如1，2，3usb：外置移动硬盘还是置硬盘功能读取指定类型的媒体的总数量。参数属性名称length文件长度返回String举例12语法iPanel.ioctlRead("local.menuItems")功能读取菜单。*【电视剧场】1*【我的影视】2*【家庭院线】3*【我的专区】4*【信息空间】5，*【热门推荐】6，*【帮助】7，帮助模块中的3个子模块（下载状态、帮助、设置）可分别控制*【移动信息】8，当关闭外置节目播放时，移动信息中不显示外置节目当关闭外置文件播放时，移动信息中不显示外置文件当终端未登录服务器时，移动信息中不显示外置文件*【动听世界】9，*【自定义模块A】，*【自定义模块B】，*【自定义模块C】，*【自定义模块D】，*【自定义模块E】参数返回json举例["9","10","1","2","3","4","5","6","7","8"]SPDIF输出编码方式约定:0->PCM编码；1->数字编码声道输出方式约定:0->双声道；1->5.1声道视频高清（HDMI）输出方式约定:0->1080i；1->1080p；2->720p视频标清输出方式约定:0->AV视频高清Ypbpr输出方式约定:0->1080i；1->1080p；2->720p电视输出 标准 excel标准偏差excel标准偏差函数exl标准差函数国标检验抽样标准表免费下载红头文件格式标准下载 约定:0->NTSC；1->PAL电视比例约定:0->4:3；1->16:9网络状态约定:0->网络断开；1->网络连接；2->网络不存在磁盘管理方式约定:0->本地磁盘格式化；1->移动磁盘格式化；2->磁盘整理下载路径方式约定:0->移动硬盘；1->置硬盘字体大小方式约定:0->大字体；1->中字体；2->小字体；字体颜色方式约定:0->红；1->橙；2->黄；3->绿；4->青；5->蓝；6->紫；7->白；网络设置模式方式约定:0->WIFI搜索；1->WIFI静态配置；2->WIFI动态配置；3->动态；4->静态；5->adsl账户；6->adsl登录；7->adsl离线；软件查询模式方式约定:0->出厂设置；1->版本升级；2->版本信息；3->网络状态查询；软键盘开关约定:0->打开；1->关闭网络状态约定:varNetWorkStatusMode=[{ERROR:0,name:'网络连接异常请检查连接',setname:"网络连接异常请检查连接",icon:"red"},{CONNECTING:1,name:'正在连接',setname:"与服务器正在连接",icon:"orange"},{SUCCESS:2,name:'连接成功正在登录',setname:"与服务器连接成功,正在登录",icon:"orange"},{NORMAL:3,name:'网络连接正常',setname:"网络连接正常",icon:"green"},{W_ERROR:4,name:'无线网络连接异常请检查连接',setname:"无线网络连接异常请检查连接",icon:"red"},{W_CONNECTING:5,name:'无线正在连接',setname:"无线与服务器正在连接",icon:"orange"},{W_SUCCESS:6,name:'无线连接成功正在登录',setname:"无线与服务器连接成功正在登录",icon:"orange"},{W_NORMAL:7,name:'无线网络连接正常',setname:"无线网络连接正常",icon:"green"}];账户登录模式约定:varNetworkSetMode={DYNAMIC:0,//动态配置STATIC:1,//静态IPADSL_ACCOUNT:2,//ADSL账户ADSL_LOGIN:3,//ADSL登录ADSL_OFFLINE:4,//ADSL离线WIFI_SEARCH:5,//无线网络搜索WIFI_DYNAMIC:6,//无线网络动态WIFI_STATIC:7//无线网络静态};语法iPanel.ioctlWrite("System.SetAudioSPDIFOutPut","<参数String串>")功能写入系统音频SPDIF配置信息。参数属性名称SPDIFspdif输出返回无举例iPanel.ioctlWrite("System.SetAudioSPDIFOutPut","0")语法iPanel.ioctlRead("System.GetAudioSPDIFOutPut")功能读取系统音频SPDIF配置信息。参数属性名称SPDIFspdif输出返回String举例"0"语法iPanel.ioctlWrite("System.SetAudioChanelOutPut","<参数String串>")功能写入系统音频Chanel配置信息。参数属性名称Chanel声道输出返回无举例iPanel.ioctlWrite("System.SetAudioChanelOutPut","0")语法iPanel.ioctlRead("System.GetAudioChanelOutPut")功能读取系统音频Chanel配置信息。参数无返回String举例"0"语法iPanel.ioctlWrite("System.SetVideoHDMIOutPut","<参数String>")功能写入系统视频高清配置信息。参数属性名称video视频输出模式返回无举例iPanel.ioctlWrite("System.SetVideoHDMIOutPut","0")语法iPanel.ioctlRead("System.GetVideoHDMIOutPut")功能读取系统视频高清配置信息。参数属性名称video音频输出模式返回String举例0语法iPanel.ioctlWrite("System.SetVideoSDOutPut","<参数String>")功能写入系统视频标清配置信息。参数属性名称video视频输出模式返回无举例iPanel.ioctlWrite("System.SetVideoSDOutPut","0")语法iPanel.ioctlRead("System.GetVideoSDOutPut")功能读取系统视频标清配置信息。参数无返回String举例0语法iPanel.ioctlWrite("System.SetVideoYpbprOutPut","<参数String>")功能写入系统视频高清Ypbpr配置信息。参数属性名称video视频输出模式返回无举例iPanel.ioctlWrite("System.SetVideoYpbprOutPut","0")语法iPanel.ioctlRead("System.GetVideoYpbprOutPut")功能读取系统视频高清Ypbpr配置信息。参数无返回String举例0语法iPanel.ioctlWrite("System.SetTVSystem","<参数String>")功能写入系统初始电视标准配置信息。参数属性名称System电视标准返回无举例iPanel.ioctlWrite("System.SetTVSystem","0")语法iPanel.ioctlRead("System.GetTVSystem")功能读取系统初始电视标准配置信息。参数返回String举例0语法iPanel.ioctlWrite("System.SetTVScale","<参数String>")功能写入系统初始电视比例配置信息。参数属性名称Scale电视比例返回无举例iPanel.ioctlWrite("System.SetTVScale","0")语法iPanel.ioctlRead("System.GetTVScale")功能写入系统初始电视比例配置信息。参数无返回String举例0语法iPanel.ioctlWrite("System.SetNetworkMode","<参数String>")功能写入系统初始当前网络设置模式。参数属性名称Mode设置模式返回无举例iPanel.ioctlWrite("System.SetNetworkMode","0")语法iPanel.ioctlRead("System.GetNetworkMode")功能读取系统初始网络设置模式。参数无返回String举例0语法iPanel.ioctlWrite("System.SetSoftWareQueryMode","<参数String>")功能写入系统初始当前网络设置模式。参数属性名称Mode设置模式返回无举例iPanel.ioctlWrite("System.SetSoftWareQueryMode","0")语法iPanel.ioctlRead("System.GetSoftWareQueryMode")功能读取系统初始网络动态配置信息。参数无返回String举例0语法iPanel.ioctlWrite("System.SetNetworkDynamic","")功能写入系统初始网络动态配置信息。参数无返回String（0成功1失败）举例iPanel.ioctlWrite("System.SetNetworkDynamic","")语法iPanel.ioctlRead("System.GetNetworkDynamic")功能读取系统初始网络动态配置信息。参数无返回String举例192.168.0.1语法iPanel.ioctlWrite("System.SetNetworkStatic","<参数json串>")功能写入系统初始网络静态配置信息。参数属性名称IPip地址Maskmask地址Gatewaygateway地址DnsIPdnsip地址返回无举例iPanel.ioctlWrite("System.SetNetworkStatic","{"ip":"127.0.0.1","mask":"127.0.0.1","gateway":"127.0.0.1","dns":"127.0.0.1"}")语法iPanel.ioctlRead("System.GetNetworkStatic")功能读取系统初始网络静态配置信息。参数无返回json串举例{"ip":"127.0.0.1","mask":"127.0.0.1","gateway":"127.0.0.1","dns":"127.0.0.1"}语法iPanel.ioctlWrite("System.SetNetworkADSLAccount","<参数json串>")功能写入系统初始网络ADSL账户配置信息。参数属性名称Name用户名Password密码返回无举例iPanel.ioctlWrite("System.SetNetworkADSLAccount","{"name":"tony","password":"tu84556"}")语法iPanel.ioctlRead("System.GetNetworkADSLAccount")功能读取系统初始网络ADSL账户配置信息。参数无返回json串举例{"name":"tony","password":"tu84556"}语法iPanel.ioctlWrite("System.SetFactory","")功能写入系统初始软件恢复出厂配置信息。参数无返回无举例iPanel.ioctlWrite("System.SetFactory","")语法iPanel.ioctlWrite("System.SetUpgrade","<参数String>")功能写入版本升级指令。参数无返回无举例iPanel.ioctlWrite("System.SetUpgrade","-1")语法iPanel.ioctlRead("System.GetUpgrade")功能读取版本升级指令信息。参数无返回String举例""语法iPanel.ioctlRead("System.GetVersion")功能读取系统初始软件版本信息。参数无返回json串举例{"functionver":"jxhy20080344","pagever":"jxp2004","vedioout":"svedio","vedioscale":"4:3","localvolumn":"109GB","localremainvolumn":"20GB","mobilevolumn":"200GB","mobileremainvolumn":"40GB"}语法iPanel.ioctlWrite("System.SetVersion","<参数json串>")功能读取系统初始软件版本信息。参数属性名称FunctionVer功能版本PageVer页面版本VedioOut输出设置VedioScale视频比例LocalVolumn本地磁盘容量LocalRemainVolumn本地磁盘剩余容量MobileVolumn移动磁盘容量MobileRemainVolumn移动磁盘剩余容量返回无举例iPanel.ioctlWrite("System.SetVersion","{"functionver":"jxhy20080344","pagever":"jxp2004","vedioout":"svedio","vedioscale":"4:3","localvolumn":"109GB","localremainvolumn":"20GB","mobilevolumn":"200GB","mobileremainvolumn":"40GB"}")语法iPanel.ioctlRead("System.GetNetworkStatus")功能读取系统初始软件网络状态信息。参数无返回Json串举例{"status":"0","method":"1","macaddress":"00-25-5E-FF-27-48"，"currentip":"127.0.0.1"}语法iPanel.ioctlWrite("System.SetNetworkStatus","<参数Json串>")功能写入系统初始软件网络状态信息。参数属性名称Statuas网络状态method登录方式macaddressmac地址currentip当前ip返回无举例iPanel.ioctlWrite("System.SetNetworkStatus","0")语法iPanel.ioctlWrite("System.SetDiskManager","<参数String>")功能写入系统初始磁盘管理配置信息。参数属性名称Mode管理方式返回无举例iPanel.ioctlWrite("System.SetDiskManager","0")语法iPanel.ioctlRead("System.GetDiskManager")功能读取系统初始磁盘管理配置信息。参数无返回String举例0语法iPanel.ioctlWrite("System.SetAcount","<参数json串>")功能写入系统初始账号配置信息。参数属性名称Name用户名Password密码IPIP返回无举例iPanel.ioctlWrite("System.SetAcount","{"name":"tony","password":"tu84556","ipname":""，"ip":"127.0.0.1"}")语法iPanel.ioctlRead("System.GetAcount")功能读取系统初始账号配置信息。参数无返回Json串举例{"name":"tony","password":"tu84556","inputmode":"0","ipfamilyselected":{"ipname":"建新","ip":"192.3.8.1"},"ipfamily":[{"ipname":"中国电信","ip":"127.0.0.1"},{"ipname":"中国联通","ip":"167.8.9.1"}]}语法iPanel.ioctlWrite("System.SetDownPath","<参数String>")功能写入系统初始下载路径配置信息。参数属性名称Mode路径模式返回无举例iPanel.ioctlWrite("System.SetDownPath","0")语法iPanel.ioctlRead("System.GetDownPath")功能读取系统初始下载路径配置信息。参数无返回String举例0语法iPanel.ioctlWrite("System.SetFontSize","<参数String>")功能写入系统初始字幕大小配置信息。参数属性名称Mode大小方式返回无举例iPanel.ioctlWrite("System.SetFontSize","0")语法iPanel.ioctlRead("System.GetFontSize")功能读取系统初始字幕大小配置信息。参数无返回String举例0语法iPanel.ioctlWrite("System.SetFontColor","<参数String>")功能写入系统初始字幕颜色配置信息。参数属性名称Mode颜色方式返回无举例iPanel.ioctlWrite("System.SetFontColor","0")语法iPanel.ioctlRead("System.GetFontColor","<参数String>")功能读取系统初始字幕颜色配置信息。参数无返回String举例0语法iPanel.ioctlRead("System.GetNaviMenu")功能读取系统主界面导航菜单配置信息。参数无返回String数组举例["0","1","2"]语法iPanel.ioctlWrite("System.SetSoftKeyWord","<参数String>")功能写入软键盘开关指令。参数属性名称Mode开关模式返回无举例iPanel.ioctlWrite("System.SetSoftKeyWord","0")语法iPanel.ioctlWrite("System.SetNetworkADSLLogin","<参数String>")功能写入ADSL登录指令。参数String返回String举例iPanel.ioctlWrite("System.SetNetworkADSLLogin","0")语法iPanel.ioctlRead("System.GetNetworkADSLLogin")功能读取ADSL登录指令。参数无返回String举例"0"语法iPanel.ioctlWrite("System.SetNetworkADSLLogout","<参数String>")功能写入ADSL退出指令。参数String返回无举例iPanel.ioctlWrite("System.SetNetworkADSLLogout","0")语法iPanel.ioctlRead("System.GetNetworkADSLLogout")功能读取ADSL退出指令。参数无返回String举例"0"语法iPanel.ioctlRead("System.GetWiFiStatus")功能读取无线网络设备状态。参数无返回String举例"0"语法iPanel.ioctlRead("System.GetWiFiList")功能读取无线网络搜索列表。参数无返回Json串举例[{"name":"jx2009","ip":"182.156.124.119","stongvalue":"80%"},{"name":"home","ip":"132.116.224.100","stongvalue":"50%"},{"name":"n123","ip":"222.134.137.111","stongvalue":"10%"}]语法iPanel.ioctlWrite("System.SetWIFILogin","<参数json串>")功能写入WIFI账户登录指令。参数属性名称NameSSIDPassword密钥返回无举例iPanel.ioctlWrite("System.SetWIFILogin","{"name":"tony","password":"tu84556"}")语法iPanel.ioctlRead("System.GetWIFILogin)功能读取WIFI账户登录指令。参数无返回String（0成功1失败）举例"0"语法iPanel.ioctlWrite("System.SetWIFIDynamic","")功能写入WIFI动态配置指令。参数无返回无举例iPanel.ioctlWrite("System.SetWIFIDynamic","0")语法iPanel.ioctlRead("System.GetWIFIDynamic")功能读取WIFI动态配置指令。参数无返回String（0成功1失败）举例"0"语法iPanel.ioctlWrite("System.SetWIFIStaic","<参数json串>")功能写入WIFI静态配置信息。参数属性名称IPip地址Maskmask地址Gatewaygateway地址DnsIPdnsip地址返回无举例iPanel.ioctlWrite("System.SetWIFIStaic","{"ip":"127.0.0.1","mask":"127.0.0.1","gateway":"127.0.0.1","dns":"127.0.0.1"}")语法iPanel.ioctlRead("System.GetWIFIStatic")功能读取WIFI静态配置。参数无返回json串举例{"ip":"127.0.0.1","mask":"127.0.0.1","gateway":"127.0.0.1","dns":"127.0.0.1"}PAGEWord文档