软件接口文档v

1、案卷号接口文档 -V2.0日期2011-07-22研发平台软件项目软件项目接口文档作者：完成日期：签收人：签收日期：修改情况记录：版本号修改批准人修改人安装日期签收人2.0Word 文档目录第 1 章引言 .31.1编写目的31.2术语31.3参考文献3第 2 章接口定义 .42.1同步接口指令4Word 文档引言1.1编写目的说明对程序系统的接口设计、数据结构设计等，为开发编码奠定基础。本文档描述本地UI 软件的 JavaScript代码和 STB浏览器组件库iPanel之间的交互接口，包括请求的格式，请求结果的格式， 相关错误的定义， 以及请求和结果返回的交互流程。本文的主要读者为需要系统

2、前端开发人员、STB开发人员，以及需要了解本前端与STB接口的相关人员。1.2术语术语或缩写词说明性定义IPTV交互式网络电视STB机顶盒HTML超文本置标语言JavaScript一种应用于客户端Web开发的脚本语言CSS层叠样式表DOM文档对象模型JSON专门为浏览器中的网页上运行的JavaScript代码而设计的一种数据格式XML可扩展置标语言iPanelIPTV终端浏览器1.3参考文献序号资料名文件编号发表日期出版单位Word 文档第2章接口定义本软件页面与底层交互采用 iPanel 扩展的 ioctlRead/Write 方式进行，数据交换采用 json 字符串 /String 方式。

3、2.1同步接口指令媒体播控媒体类型约定 :0-> 电影； 1->音乐； 2-> 图片； 3-> 文本静音模式约定 :0-> 关闭（ off ）；1-> 打开 (on)视频类型约定 :0-> 高清； 1->标清； 2-> 普通； 3-> 片花；语法iPanel.ioctlWrite("Media.Open", "<参数 json 串 >")功能写入媒体播放路径及类型。参数属性名称Name媒体路径Type媒体类型返回无举例iPanel.ioctlWrite("Media.Ope

4、n",""name":"/mnt/hd/逃亡鳄鱼岛 .avi","type":"0"")语法iPanel.ioctlWrite("Media.Pause", "<参数 json 串 >")功能写入媒体暂停路径及类型。参数属性名称Word 文档Name媒体路径Type媒体类型返回无举例iPanel.ioctlWrite("Media. Pause",""name":"/mnt/

5、hd/逃亡鳄鱼岛 .avi","type":"0"")语法iPanel.ioctlWrite("Media.Resume", "< 参数 json 串 >")功能写入媒体继续路径及类型。参数属性名称Name媒体路径Type媒体类型返回无举例iPanel.ioctlWrite("Media. Resume",""name":"/mnt/hd/ 逃亡鳄鱼岛 .avi","type":"0&

6、quot;")语法iPanel.ioctlWrite("Media.Position", "< 参数 json 串 >")功能写入媒体播放位置参数。参数属性名称x媒体 x 坐标y媒体 y 坐标w媒体宽度h媒体高度Word 文档返回无举例iPanel.ioctlWrite("Media.Position",""x":"0","y":"0","w":"1280","h"

7、:"720"")语法iPanel.ioctlRead("Media. Position")功能读取媒体播放位置参数。参数无返回Json 串举例返回 JSON 串： "x":"0","y":"0","w":"1280","h":"720"语法iPanel. ioctlWrite ("Media.Stop","< 参数 json 串 >")

8、功能写入媒体播放停止路径及类型。参数属性名称Name媒体路径Type媒体类型返回无举例iPanel.ioctlWrite("Media. Stop ",""name":"/mnt/hd/ 逃亡鳄鱼岛 .avi","type":"0"")语法iPanel. ioctlWrite ("Media.Forward","< 参数 json 串>")功能写入媒体播放快进模式及类型。参数属性名称Word 文档Mode快进模式Type媒体

9、类型返回举例iPanel.ioctlWrite("Media.Forward",""mode":"8","type":"0"")语法iPanel. ioctlWrite ("Media.Rewind","< 参数 json 串 >")功能写入媒体播放快退模式及类型。参数属性名称Mode快退模式Type媒体类型返回举例iPanel.ioctlWrite("Media.Forward",""

10、;mode":"8","type":"0"")语法iPanel. ioctlRead ("Media. GetVolume")功能读取媒体播放音量。参数无返回String举例20语法iPanel. ioctlRead ("getMemoryItem ”)Word 文档功能获取记忆的功能导航。参数无返回String举例20语法iPanel. ioctlWrite ("setMemoryItem”,index)功能设置记忆的功能导航。参数无返回无举例语法iPanel. ioctl

11、Read("Media. GetMute ")功能读取媒体播放静音设置。参数无返回String举例0语法iPanel. ioctlWrite("Media.SetBook","< 参数 String>")功能写入媒体订购信息。参数属性名称Name媒体名称返回返回 ok 或者失败信息（资费不够等）Word 文档举例iPanel.ioctlWrite("Media. SetBook ","/mnt/hd/逃亡鳄鱼岛 .avi")语法iPanel. ioctlRead("Medi

12、a. GetBook,Name")功能读取媒体订购信息。参数属性名称Name媒体名称Count媒体总份数Price媒体总资费 (元 )返回Json 串举例"name":"/mnt/hd/ 逃亡鳄鱼岛 .avi","count":"2","price":"66.50 "语法iPanel. ioctlRead("Media. GetCurrentDownFile")功能读取下载媒体信息。参数属性名称Name媒体名称Size媒体大小Speed下载速度P

13、ercent下载百分比DownedSize已下载大小Status下载状态Word 文档返回Json 串举例"name":"/mnt/hd/ 逃亡鳄鱼岛 .avi","size":"102445676KB","speed":"538KB/S ","percent":"15%","downedsize":"34567KB ","status":"正在下载 "语法

14、iPanel. ioctlRead("Media. GetFileInfo,path")path当前媒体路径功能参数读取媒体信息。属性名称Name媒体名称singer演唱者currentPlayTime当前播放时间during媒体时长loopMode循环模式videoOutput视频输出other其他信息返回Json 串举例 "name": "/mnt/hd/ 逃亡鳄鱼岛1.avi ", "singer": " 德华 ","currentPlayTime": "00

15、:00:32", "duration": "0:01:00 ","loopMode": " 全循环", "videoOutput": "sVideo ", "other":"16:9 字幕 :无双声道 "Word 文档语法iPanel. ioctlRead("Media. GetNextFileInfo,path")path当前媒体路径功能参数读取子集中下一个媒体信息，以便播放。没有子集返回空属性名称Nam

16、e媒体名称singer演唱者currentPlayTime当前播放时间during媒体时长loopMode循环模式videoOutput视频输出other其他信息返回Json 串举例 "name": "/mnt/hd/ 逃亡鳄鱼岛1.avi ", "singer": " 德华 ","currentPlayTime": "00:00:32", "duration": "0:01:00 ","loopMode": &qu

17、ot; 全循环", "videoOutput": "sVideo ", "other":"16:9 字幕 :无双声道 "媒体类型约定 :0-> 电影； 1->音乐； 2-> 图片电影风格类型约定 :0-> 剧情片； 1-> 喜剧片； 2-> 恐怖片； 3-> 科幻片音乐风格类型约定 :0-> 流行； 1-> 古典； 2-> 民歌； 3-> 港台Word 文档图片容器格式约定 :0->jpg ；1->png；2->gif语法

18、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,p

19、ath")path：文件路径如/mnt/hd/ 逃亡 .avi功能获取下载完成的子集我的专区电视剧。参数属性名称path文件路径返回json举例 'no': '1', 'name': '/mnt/hd/ 放牛班的春天 01.avi' , 'no': '2', 'name': '/mnt/hd/ 放牛班的春天 02.avi' Word 文档;语法iPanel. ioctlRead("FSO.GetFiles,MenuIndex,fileLength,

20、usb")MenuIndex ： 菜单索引如1， 2， 3usb ：外置移动硬盘还是置硬盘功能参数读取指定类型的媒体的总数量。属性名称length文件长度返回String举例12语法iPanel. ioctlRead("local. menuItems ")功能读取菜单。* 【电视剧场】 1* 【我的影视】 2* 【家庭院线】 3* 【我的专区】 4* 【信息空间】 5，* 【热门推荐】 6，* 【帮助】7，帮助模块中的3 个子模块（下载状态、帮助、设置）可分别控制* 【移动信息】 8，当关闭外置节目播放时，移动信息中不显示外置节目当关闭外置文件播放时，移动信息中

21、不显示外置文件当终端未登录服务器时，移动信息中不显示外置文件* 【动听世界】 9，* 【自定义模块 A】，* 【自定义模块 B】，Word 文档* 【自定义模块 C】，* 【自定义模块 D】，* 【自定义模块 E】参数返回json举例"9","10","1","2","3","4","5","6","7","8"SPDIF输出编码方式约定 :0->PCM 编码； 1-> 数字编码声道输

22、出方式约定 :0-> 双声道； 1->5.1 声道视频高清（ HDMI）输出方式约定 :0->1080i ；1->1080p；2->720p视频标清输出方式约定 :0->AV视频高清 Ypbpr 输出方式约定 : 0->1080i ；1->1080p；2->720p电视输出标准约定 :0->NTSC；1->PAL电视比例约定 :0->4:3 ；1->16:9网络状态约定 :0-> 网络断开； 1-> 网络连接； 2-> 网络不存在磁盘管理方式约定 :0-> 本地磁盘格式化； 1-> 移动

23、磁盘格式化； 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->

24、; adslWord 文档离线；软件查询模式方式约定: 0-> 出厂设置；1-> 版本升级；2-> 版本信息；3->网络状态查询；软键盘开关约定 : 0-> 打开； 1-> 关闭网络状态约定 :varNetWorkStatusMode = ERROR: 0, name:' 网络连接异常请检查连接' , setname:" 网络连接异常请检查连接" , icon:"red", CONNECTING: 1, name:' 正在连接 ' , setname:" 与服务器正在连接 &q

25、uot; , icon:"orange", SUCCESS: 2, name:' 连接成功正在登录 ' , setname:" 与服务器连接成功 , 正在登录 " , icon:"orange", NORMAL: 3, name:' 网络连接正常 ' , setname:" 网络连接正常" , icon:"green",W_ERROR: 4,name:' 无线网络连接异常请检查连接' ,setname:" 无线网络连接异常请检查连接&qu

26、ot; , icon:"red", W_CONNECTING: 5, name:' 无线正在连接 ' , setname:" 无线与服务器正在连接 " , icon:"orange", W_SUCCESS: 6, name:' 无线连接成功正在登录 ' , setname:"无线与服务器连接成功正在登录 " , icon:"orange", W_NORMAL: 7, name:' 无线网络连接正常 ' , setname:" 无线网络连接

27、正常 " , icon:"green"Word 文档;账户登录模式约定 :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&quo

28、t;,"< 参数String 串 >")功能写入系统音频 SPDIF 配置信息。参数属性名称SPDIFspdif 输出返回无举例iPanel.ioctlWrite("System. SetAudioSPDIFOutPut ","0")Word 文档语法iPanel. ioctlRead("System. GetAudioSPDIFOutPut")功能读取系统音频 SPDIF 配置信息。参数属性名称SPDIFspdif 输出返回String举例"0"语法iPanel. ioctlWri

29、te ("System.SetAudioChanelOutPut","< 参数String 串 >")功能写入系统音频 Chanel 配置信息。参数属性名称Chanel声道输出返回无举例iPanel.ioctlWrite("System. SetAudioChanelOutPut ","0")语法iPanel. ioctlRead("System. GetAudioChanelOutPut")功能读取系统音频 Chanel 配置信息。参数无返回String举例"0"

30、;语法iPanel. ioctlWrite ("System. SetVideoHDMIOutPut","<参数Word 文档String>")功能参数写入系统视频高清配置信息。属性名称video视频输出模式返回无举例iPanel.ioctlWrite("System. SetVideoHDMIOutPut ","0")语法iPanel. ioctlRead ("System. GetVideoHDMIOutPut")功能参数读取系统视频高清配置信息。属性名称video音频输出模式返

31、回String举例0语法iPanel. ioctlWrite ("System. SetVideoSDOutPut","< 参数String>")功能参数写入系统视频标清配置信息。属性名称video视频输出模式返回无举例iPanel.ioctlWrite("System. SetVideoSDOutPut ","0")Word 文档语法iPanel. ioctlRead ("System. GetVideoSDOutPut")功能读取系统视频标清配置信息。参数无返回String举例0

32、语法iPanel. ioctlWrite ("System. SetVideoYpbprOutPut","< 参数String>")功能参数写入系统视频高清Ypbpr 配置信息。属性名称video视频输出模式返回无举例iPanel.ioctlWrite("System. SetVideoYpbprOutPut","0")语法iPanel. ioctlRead ("System. GetVideoYpbprOutPut")功能读取系统视频高清Ypbpr 配置信息。参数无返回String

33、举例0语法iPanel. ioctlWrite("System.SetTVSystem","<参数 String>")功能写入系统初始电视标准配置信息。Word 文档参数属性名称System电视标准返回无举例iPanel.ioctlWrite("System.SetTVSystem","0")语法iPanel. ioctlRead ("System.GetTVSystem")功能读取系统初始电视标准配置信息。参数返回String举例0语法iPanel. ioctlWrite (&qu

34、ot;System.SetTVScale","<参数 String>")功能写入系统初始电视比例配置信息。参数属性名称Scale电视比例返回无举例iPanel.ioctlWrite("System.SetTVScale ","0")语法iPanel. ioctlRead ("System.GetTVScale")功能写入系统初始电视比例配置信息。参数无返回StringWord 文档举例0语法iPanel. ioctlWrite ("System.SetNetworkMode"

35、;,"<参数String>")功能参数写入系统初始当前网络设置模式。属性名称Mode设置模式返回无举例iPanel.ioctlWrite("System. SetNetworkMode ","0")语法iPanel. ioctlRead ("System. GetNetworkMode")功能读取系统初始网络设置模式。参数无返回String举例0语法iPanel. ioctlWrite ("System.SetSoftWareQueryMode","<参数String

36、>")功能参数写入系统初始当前网络设置模式。属性名称Mode设置模式返回无Word 文档举例iPanel.ioctlWrite("System. SetSoftWareQueryMode","0")语法iPanel. ioctlRead ("System. GetSoftWareQueryMode")功能读取系统初始网络动态配置信息。参数无返回String举例0语法iPanel. ioctlWrite ("System.SetNetworkDynamic","")功能写入系统初始

37、网络动态配置信息。参数无返回String（ 0 成功 1 失败）举例iPanel.ioctlWrite("System.SetNetworkDynamic","")语法iPanel. ioctlRead ("System.GetNetworkDynamic")功能读取系统初始网络动态配置信息。参数无返回String举例语法iPanel. ioctlWrite ("System.SetNetworkStatic","<参数 json串 >")Word 文档功能参数写入系统初始网络静态配

38、置信息。属性名称IPip 地址Maskmask 地址Gatewaygateway 地址DnsIPdns ip 地址返回无举例语法iPanel. ioctlRead ("System.GetNetworkStatic")功能读取系统初始网络静态配置信息。参数无返回json 串举例语法iPanel. ioctlWrite("System.SetNetworkADSLAccount","<参数json 串>")功能参数写入系统初始网络ADSL 账户配置信息。属性名称Word 文档Name用户名Password密码返回无举例iPa

39、nel.ioctlWrite("System.SetNetworkADSLAccount",""name":"tony","password":"tu84556"")语法iPanel. ioctlRead("System.GetNetworkADSLAccount")功能读取系统初始网络ADSL 账户配置信息。参数无返回json 串举例"name":"tony","password":"

40、tu84556"语法iPanel. ioctlWrite("System.SetFactory","")功能写入系统初始软件恢复出厂配置信息。参数无返回无举例iPanel.ioctlWrite("System.SetFactory","")语法iPanel. ioctlWrite("System.SetUpgrade","<参数 String>")功能写入版本升级指令。参数无返回无Word 文档举例iPanel.ioctlWrite("Syst

41、em.SetUpgrade","-1")语法iPanel. ioctlRead ("System.GetUpgrade")功能读取版本升级指令信息。参数无返回String举例""语法iPanel. ioctlRead ("System.GetVersion")功能读取系统初始软件版本信息。参数无返回json 串举例"functionver":"jxhy20080344","pagever":"jxp2004","ve

42、dioout":"svedio","vedioscale":"4:3","localvolumn":"109GB","localremainvolumn":"20GB","mobilevolumn":"200GB","mobileremainvolumn":"40GB"语法iPanel. ioctlWrite ("System. SetVersion &qu

43、ot;,"<参数 json 串>")功能读取系统初始软件版本信息。参数属性名称FunctionVer功能版本PageVer页面版本Word 文档VedioOut输出设置VedioScale视频比例LocalVolumn本地磁盘容量LocalRemainVolumn本地磁盘剩余容量MobileVolumn移动磁盘容量MobileRemainVolumn移动磁盘剩余容量返回无举例iPanel.ioctlWrite("System.SetVersion",""functionver":"jxhy2008034

44、4","pagever":"jxp2004","vedioout":"svedio","vedioscale":"4:3","localvolumn":"109GB","localremainvolumn":"20GB","mobilevolumn":"200GB","mobileremainvolumn":"40GB

45、"")语法iPanel. ioctlRead("System.GetNetworkStatus")功能读取系统初始软件网络状态信息。参数无返回Json 串举例"status":"0","method":"1","macaddress":"00-25-5E-FF-27-48" ，语法iPanel. ioctlWrite ("System.SetNetworkStatus","<参数 Json串 >

46、")Word 文档功能写入系统初始软件网络状态信息。参数属性名称tatuas网络状态Smethod登录方式macaddressmac 地址currentip当前 ip返回无举例iPanel.ioctlWrite("System.SetNetworkStatus ","0 ")语法iPanel. ioctlWrite("System.SetDiskManager ","<参数 String>")功能参数写入系统初始磁盘管理配置信息。属性名称Mode管理方式返回无举例iPanel.ioctlWri

47、te("System.SetDiskManager","0")语法iPanel. ioctlRead ("System.GetDiskManager")功能读取系统初始磁盘管理配置信息。参数无返回String举例0Word 文档语法iPanel. ioctlWrite("System.SetAcount","<参数 json 串 >")功能写入系统初始账号配置信息。参数属性名称Name用户名Password密码IPIP返回无举例iPanel.ioctlWrite("Syst

48、em.SetAcount",""name":"tony","password":"tu84556","ipname":"" ，语法iPanel. ioctlRead ("System.GetAcount")功能读取系统初始账号配置信息。参数无返回Json 串举例"name":"tony","password":"tu84556", "inputmo

49、de":"0","ipfamilyselected":"ipname":"建新"ipfamily": "ipname":"中国电信 "ipname":" 中国联通语法iPanel. ioctlWrite("System.SetDownPath","<参数 String>")功能写入系统初始下载路径配置信息。Word 文档参数属性名称Mode路径模式返回无举例iPanel.ioctlWr

50、ite("System.SetDownPath ","0")语法iPanel. ioctlRead ("System. GetDownPath")功能读取系统初始下载路径配置信息。参数无返回String举例0语法iPanel. ioctlWrite("System.SetFontSize","< 参数 String>")功能写入系统初始字幕大小配置信息。参数属性名称Mode大小方式返回无举例iPanel.ioctlWrite("System.SetFontSize"

51、;,"0")语法iPanel. ioctlRead ("System.GetFontSize")功能读取系统初始字幕大小配置信息。参数无返回StringWord 文档举例0语法iPanel. ioctlWrite("System.SetFontColor","<参数 String>")功能写入系统初始字幕颜色配置信息。参数属性名称Mode颜色方式返回无举例iPanel.ioctlWrite("System.SetFontColor ","0")语法iPanel.

52、ioctlRead ("System.GetFontColor","< 参数 String>")功能读取系统初始字幕颜色配置信息。参数无返回String举例0语法iPanel. ioctlRead("System.GetNaviMenu")功能读取系统主界面导航菜单配置信息。参数无返回String 数组举例"0","1","2"语法iPanel. ioctlWrite("System.SetSoftKeyWord","<参数 String>")Word 文档功能参数写入软键盘开关指令。属性名称Mode开关模式返回无举例iPanel.ioctlWrite("System.SetSoftKeyWord ","0")语法iPanel. ioctlWrite("System.SetNetworkADSLLogin","<参数S