软件接口文档

模卷号接口文档日期2011-07-22研发平台软件项目软件项目接口文档作者：达成日期：签收人：签收日期：改正情况 记录 混凝土 养护记录下载土方回填监理旁站记录免费下载集备记录下载集备记录下载集备记录下载 ：版本号改正批准人改正人安装日期签收人目录第1章引言.............................................错误!未定义 书 关于书的成语关于读书的排比句社区图书漂流公约怎么写关于读书的小报汉书pdf 签。编写目的.........................................错误!未定义书签。术语.............................................错误!未定义书签。参照文件.........................................错误!未定义书签。第2章接口定义.........................................错误!未定义书签。同步接口指令.....................................错误!未定义书签。引言1.1编写目的说明对程序系统的接口设计、数据构造设计等，为开发编码确立基础。本文档描绘本地UI软件的JavaScript代码和STB浏览器组件库iPanel之间的交互接口，包括恳求的格式，恳求结果的格式，有关错误的定义，以及恳求和结果返回的交互流程。本文的主要读者为需要系统前端开发人员、STB开发人员，以及需要认识本前端与接口的有关人员。STB1.2术语术语或缩写词IPTVSTBHTMLJavaScriptCSSDOMJSONXMLiPanelIPTV说明性定义交互式网络电视机顶盒超文本置标语言一种应用于客户端Web开发的脚本语言层叠样式表文档对象模型特意为浏览器中的网页上运行的JavaScript一种数据格式可扩展置标语言终端浏览器代码而设计的1.3参照文件序号资料名文件编号发表日期出版单位第2章接口定义本软件页面与底层交互采用iPanel扩展的ioctlRead/Write方式进行，数据互换采用json字符串/String方式。2.1同步接口指令媒体播控媒体种类约定:0->电影；1->音乐；2->图片；3->文本静音模式约定:0->封闭（off）；1->翻开(on)视频种类约定:0->高清；1->标清；2->普通；3->片花；语("","<参数json串>")法功写入媒体播放路径及种类。能参属性名称数Name媒体路径Type媒体种类返无回举("","{"name":"/mnt/hd/逃亡鳄鱼岛.avi","type":"0"}")例语("Media.Pause","<参数json串>")法功写入媒体暂停路径及种类。能参数属性名称Name媒体路径Type媒体种类返无回举("Media.Pause","{"name":"/mnt/hd/逃亡鳄鱼例岛.avi","type":"0"}")语("Media.Resume","<参数json串>")法功写入媒体持续路径及种类。能参数属性名称Name媒体路径Type媒体种类返无回举("Media.Resume","{"name":"/mnt/hd/逃亡鳄鱼例岛.avi","type":"0"}")语("Media.Position","<参数json串>")法功写入媒体播放地点参数。能参属性名称数x媒体x坐标y媒体y坐标w媒体宽度h媒体高度返无回举("Media.例Position","{"x":"0","y":"0","w":"1280","h":"720"}")语("Media.Position")法功读取媒体播放地点参数。能参无数返Json串回举返回JSON串：{"x":"0","y":"0","w":"1280","h":"720"}例语iPanel.ioctlWrite("Media.Stop","<参数json串>")法功写入媒体播放停止路径及种类。能参数属性名称Name媒体路径Type媒体种类返无回举("Media.Stop","{"name":"/mnt/hd/逃亡鳄鱼例岛.avi","type":"0"}")语iPanel.ioctlWrite("Media.Forward","<参数json串>")法功写入媒体播放快进模式及种类。能参属性名称数Mode快进模式Type媒体种类返回举("Media.Forward","{"mode":"8","type":"0"}")例语iPanel.ioctlWrite("Media.Rewind","<参数json串>")法功写入媒体播放快退模式及种类。能参数属性名称Mode快退模式Type媒体种类返回举("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或许失败信息（资费不够等）回举("Media.SetBook","/mnt/hd/逃亡鳄鱼岛.avi")例语iPanel.ioctlRead("Media.GetBook,Name")法功读取媒体订购信息。能参数属性名称Name媒体名称Count媒体总份数Price媒体总资费(元)返Json串回举{"name":"/mnt/hd/逃亡鳄鱼岛.avi例","count":"2","price":""}语iPanel.ioctlRead("Media.GetCurrentDownFile")法功读取下载媒体信息。能参数属性名称Name媒体名称Size媒体大小Speed下载速度Percent下载百分比DownedSize已下载大小Status下载状态返Json串回举{"name":"/mnt/hd/逃亡鳄鱼岛.avi例","size":"6KB","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/逃亡鳄鱼岛","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/逃亡鳄鱼岛","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(",MenuIndex,currentFileIndex,usb")法MenuIndex：菜单索引如1，2，3，currentFileIndex：目前文件索引如1，2，3，usb：外置移动硬盘仍是内置硬盘功读取指定种类,指定链表地点的文件列表。能参数属性名称Name媒体名称返Json串回举{"/mnt/hd/逃亡鳄鱼岛.avi","/mnt/hd/逃亡.avi"}例语iPanel.ioctlRead(",path")法path：文件路径如/mnt/hd/逃亡.avi功获取下载达成的子集我的专区电视剧。能参属性名称数path文件路径返json回举[{'no':'1','name':'/mnt/hd/放牛班的春天'},例{'no':'2','name':'/mnt/hd/放牛班的春天'}];语iPanel.ioctlRead(",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->声道视频高清（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,ioctlWrite("System.SetAudioSPDIFOutPut","<参数String串>")功写入系统音频SPDIF配置信息。能参属性名称数SPDIFspdif输出返无回举("System.SetAudioSPDIFOutPut","0")例语iPanel.ioctlRead("System.GetAudioSPDIFOutPut")法功读取系统音频SPDIF配置信息。能参数返String回属性名称SPDIFspdif输出举"0"例语iPanel.ioctlWrite("System.SetAudioChanelOutPut","<法参数String串>")功写入系统音频Chanel配置信息。能参属性名称数Chanel声道输出返无回举("System.SetAudioChanelOutPut","0")例语iPanel.ioctlRead("System.GetAudioChanelOutPut")法功读取系统音频Chanel配置信息。能参无数返String回举"0"例语iPanel.ioctlWrite("System.SetVideoHDMIOutPut","<参法数String>")功写入系统视频高清配置信息。能参属性名称数video视频输出模式返无回举("System.SetVideoHDMIOutPut","0")例语iPanel.ioctlRead("System.GetVideoHDMIOutPut")法功读取系统视频高清配置信息。能参数返String回属性名称video音频输出模式举0例语iPanel.ioctlWrite("System.SetVideoSDOutPut","<参数法String>")功写入系统视频标清配置信息。能参属性名称数video视频输出模式返无回举("System.SetVideoSDOutPut","0")例语iPanel.ioctlRead("System.GetVideoSDOutPut")法功读取系统视频标清配置信息。能参无数返String回举0例语iPanel.ioctlWrite("System.SetVideoYpbprOutPut","<法参数String>")功写入系统视频高清Ypbpr配置信息。能参属性名称数video视频输出模式返无回举("System.SetVideoYpbprOutPut","0")例语iPanel.ioctlRead("System.GetVideoYpbprOutPut")法功读取系统视频高清Ypbpr配置信息。能参无数返String回举0例语iPanel.ioctlWrite("","<参数String>")法功写入系统初始电视标准配置信息。能参属性名称数System电视标准返无回举("","0")例语iPanel.ioctlRead("")法功读取系统初始电视标准配置信息。能参数返String回举0例语iPanel.ioctlWrite("","<参数String>")法功写入系统初始电视比率配置信息。能参属性名称数Scale电视比率返无回举("","0")例语iPanel.ioctlRead("")法功写入系统初始电视比率配置信息。能参无数返String回举0例语iPanel.ioctlWrite("","<参数String>")法功写入系统初始目前网络设置模式。能参属性名称数Mode设置模式返无回举("System.SetNetworkMode","0")例语iPanel.ioctlRead("System.GetNetworkMode")法功读取系统初始网络设置模式。能参无数返String回举0例语iPanel.ioctlWrite("","<法功写入系统初始目前网络设置模式。能参属性参数String>")名称数Mode设置模式返无回举("System.SetSoftWareQueryMode","0")例语iPanel.ioctlRead("System.GetSoftWareQueryMode")法功读取系统初始网络动向配置信息。能参无数返String回举0例语iPanel.ioctlWrite("","")法功写入系统初始网络动向配置信息。能参无数返String（0成功1失败）回举("","")例语iPanel.ioctlRead("")法功读取系统初始网络动向配置信息。能参无数返String回举例语iPanel.ioctlWrite("","<参数json串>")法功写入系统初始网络静态配置信息。能参数属性名称IPip地点Maskmask地点Gatewaygateway地点DnsIPdnsip地点返无回举("","{"ip":"","mask":"","gateway":"",例"dns":""}")语iPanel.ioctlRead("")法功读取系统初始网络静态配置信息。能参无数返json串回举{"ip":"","mask":"","gateway":"",例"dns":""}语iPanel.ioctlWrite("","<参数json串>")法功写入系统初始网络ADSL账户配置信息。能参数属性名称Name用户名Password密码返无回举("","{"name":"tony","password":"tu84556"}")例语iPanel.ioctlRead("")法功读取系统初始网络ADSL账户配置信息。能参无数返json串回举{"name":"tony","password":"tu84556"}例语iPanel.ioctlWrite("","")法功写入系统初始软件恢复出厂配置信息。能参无数返无回举("","")例语iPanel.ioctlWrite("","<参数String>")法功写入版本升级指令。能参无数返无回举("","-1")例语iPanel.ioctlRead("")法功读取版本升级指令信息。能参无数返String回举""例语iPanel.ioctlRead("")法功读取系统初始软件版本信息。能参无数返json串回举{"functionver":"jxhy","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移动磁盘节余容量返无回举("","{"functionver":"jxhy","pagever":"jxp2004",例"vedioout":"svedio","vedioscale":"4:3","localvolumn":"109GB","localremainvolumn":"20GB","mobilevolumn":"200GB","mobileremainvolumn":"40GB"}")语iPanel.ioctlRead("")法功读取系统初始软件网络状态信息。能参无数返Json串回举{"status":"0","method":"1","macaddress":例"00-25-5E-FF-27-48"，"currentip":""}语iPanel.ioctlWrite("","<参数Json串>")法功写入系统初始软件网络状态信息。能参属性名称数Statuas网络状态method登录方式macaddressmac地点currentip目前ip返无回举("","0")例语法功写入系统初始磁盘管理配置信息。能参属性名称数Mode管理方式返回无举("","0")例语iPanel.ioctlRead("")法功读取系统初始磁盘管理配置信息。能参无数返String回举0例语iPanel.ioctlWrite("","<参数json串>")法功写入系统初始账号配置信息。能参数属性名称Name用户名Password密码IPIP返无回举("","{"name":"tony","password":"tu84556",例"ipname":""，"ip":""}")语iPanel.ioctlRead("")法功读取系统初始账号配置信息。能参无数返Json串回举{"name":"tony","password":"tu84556",例"inputmode":"0","ipfamilyselected":{"ipname":"北京建新","ip":""},"ipfamily":[{"ipname":"中国电信","ip":""},{"ipname":"中国联通","ip":""}]}语iPanel.ioctlWrite("","<参数String>")法功写入系统初始下载路径配置信息。能参属性名称数Mode路径模式返无回举("","0")例语iPanel.ioctlRead("System.GetDownPath")法功读取系统初始下载路径配置信息。能参无数返String回举0例语iPanel.ioctlWrite("","<参数String>")法功写入系统初始字幕大小配置信息。能参数返无回属性名称Mode大小方式举("","0")例语iPanel.ioctlRead("")法功读取系统初始字幕大小配置信息。能参无数返String回举0例语iPanel.ioctlWrite("","<参数String>")法功写入系统初始字幕颜色配置信息。能参属性名称数Mode颜色方式返无回举("","0")例语iPanel.ioctlRead("","<参数String>")法功读取系统初始字幕颜色配置信息。能参无数返String回举0例语iPanel.ioctlRead("")法功读取系统主界面导航菜单配置信息。能参无数返String数组回举["0","1","2"]例语iPanel.ioctlWrite("","<参数String>")法功写入软键盘开关指令。能参属性名称数Mode开关模式返无回举("","0")例语iPanel.ioctlWrite("","<参数String>")法功写入ADSL登录指令。能参String数返String回举("System.SetNetworkADSLLogin","0")例语iPanel.ioctlRead("")法功读取ADSL登录指令。能参无数返String回举"0"例语iPanel.ioctlWrite("","<参数String>")法功写入ADSL退出指令。能参String数返无回举("System.SetNetworkADSLLogout","0")例语iPanel.ioctlRead("")法功读取ADSL退出指令。能参无数返String回举"0"例语iPanel.ioctlRead("")法功读取无线网络设施状态。能参无数返String回举"0"例语iPanel.ioctlRead("")法功读取无线网络搜寻列表。能参无数返Json串回举[{"name":"jx2009","ip":"",例"stongvalue":"80%"},{"name":"home","ip":"","stongvalue":"50%"},{"name":"n123","ip":"","stongvalue":"10%"}]语iPanel.ioctlWrite("","<参数json串>")法功写入WIFI账户登录指令。能参属性名称数NameSSIDPassword密钥返无回举("System.SetWIFILogin例","{"name":"tony","password":"tu84556"}")语iPanel.ioctlRead("法功读取WIFI账户登录指令。能参无数返String（0成功1失败）回举"0"例语iPanel.ioctlWrite("","")法功写入WIFI动向配置指令。能参无数返无回举("","0")例语iPanel.ioctlRead("")法功读取WIFI动向配置指令。能参无数返String（0成功1失败）回举"0"例语iPanel.ioctlWrite("","<参数json串>")法功写入WIFI静态配置信息。能参属性名称数IPip地点Maskmask地点Gatewaygateway地点DnsIPdnsip地点返无回举("","{"ip":"","mask":"","gateway":"",例"dns":""}")语iPanel.ioctlRead("")法功读取WIFI静态配置。能参无数返json串回举{"ip":"","mask":"","gateway":"",例"dns":""}