软件接口文档v20.docx

1、软件接口文档v20案卷号接口文档-V2.0日期2011-07-22研发平台软件项目软件项目接口文档作 者： 完成日期： 签 收 人： 签收日期： 修改情况记录：版本号修改批准人修改人安装日期签收人2.0引言1.1 编写目的说明对程序系统的接口设计、数据结构设计等，为开发编码奠定基础。本文档描述本地UI软件的JavaScript代码和STB浏览器组件库iPanel之间的交互接口，包括请求的格式，请求结果的格式，相关错误的定义，以及请求和结果返回的交互流程。本文的主要读者为需要系统前端开发人员、STB开发人员，以及需要了解本前端与STB接口的相关人员。1.2 术语术语或缩写词 说明性定义IPTV

2、交互式网络电视STB 机顶盒HTML 超文本置标语言JavaScript 一种应用于客户端Web开发的脚本语言CSS 层叠样式表DOM 文档对象模型JSON 专门为浏览器中的网页上运行的JavaScript代码而设计的一种数据格式XML 可扩展置标语言iPanel IPTV终端浏览器1.3 参考文献序号资料名文件编号发表日期出版单位第2章 接口定义本软件页面与底层交互采用iPanel扩展的ioctlRead/Write方式进行，数据交换采用json字符串/String方式。2.1 同步接口指令媒体播控媒体类型约定:0-电影；1-音乐；2-图片；3-文本静音模式约定:0-关闭（off）；1-打开

3、(on)视频类型约定:0-高清；1-标清；2-普通；3-片花；语法iPanel.ioctlWrite(Media.Open, )功能写入媒体播放路径及类型。参数属性 名称Name 媒体路径Type 媒体类型返回无举例iPanel.ioctlWrite(Media.Open,name:/mnt/hd/逃亡鳄鱼岛.avi,type:0)语法iPanel.ioctlWrite(Media. Pause, )功能写入媒体暂停路径及类型。参数属性 名称Name 媒体路径Type 媒体类型返回无举例iPanel.ioctlWrite(Media. Pause,name:/mnt/hd/逃亡鳄鱼岛.avi,

4、type:0)语法iPanel.ioctlWrite(Media. Resume, )功能写入媒体继续路径及类型。参数属性 名称Name 媒体路径Type 媒体类型返回无举例iPanel.ioctlWrite(Media. Resume,name:/mnt/hd/逃亡鳄鱼岛.avi,type:0)语法iPanel.ioctlWrite(Media. Position, )功能写入媒体播放位置参数。参数属性 名称x 媒体x坐标y 媒体y坐标w 媒体宽度h 媒体高度返回无举例iPanel.ioctlWrite(Media. Position,x:0,y:0,w:1280,h:720)语法iPane

5、l.ioctlRead(Media. Position)功能读取媒体播放位置参数。参数无返回Json串举例返回JSON串：x:0,y:0,w:1280,h:720语法iPanel. ioctlWrite (Media. Stop,)功能写入媒体播放停止路径及类型。参数属性 名称Name 媒体路径Type 媒体类型返回无 举例iPanel.ioctlWrite(Media. Stop ,name:/mnt/hd/逃亡鳄鱼岛.avi,type:0)语法iPanel. ioctlWrite (Media. Forward,)功能写入媒体播放快进模式及类型。参数属性 名称Mode 快进模式Type 媒

6、体类型返回举例iPanel.ioctlWrite(Media. Forward,mode:8,type:0)语法iPanel. ioctlWrite (Media. Rewind,)功能写入媒体播放快退模式及类型。参数属性 名称Mode 快退模式Type 媒体类型返回举例iPanel.ioctlWrite(Media. Forward,mode:8,type:0)语法iPanel. ioctlRead (Media. GetVolume)功能读取媒体播放音量。参数无返回String举例20语法iPanel. ioctlRead (getMemoryItem”)功能获取记忆的功能导航。参数无返回

7、String举例20语法iPanel. ioctlWrite (setMemoryItem”,index)功能设置记忆的功能导航。参数无返回无举例语法iPanel. ioctlRead(Media. GetMute )功能读取媒体播放静音设置。参数无返回String举例0语法iPanel. ioctlWrite(Media. SetBook,)功能写入媒体订购信息。参数属性 名称Name 媒体名称返回返回ok 或者失败信息（资费不够等）举例iPanel.ioctlWrite(Media. SetBook ,/mnt/hd/逃亡鳄鱼岛.avi )语法iPanel. ioctlRead(Media

8、. 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:102445676

9、KB,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

10、, 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.av

11、i , 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)MenuI

12、ndex： 菜单索引如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,

13、 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个子模块（下载状态、帮助、设置）可分

14、别控制*【移动信息】8， 当关闭外置节目播放时，移动信息中不显示外置节目 当关闭外置文件播放时，移动信息中不显示外置文件 当终端未登录服务器时，移动信息中不显示外置文件*【动听世界】9，*【自定义模块A】，*【自定义模块B】，*【自定义模块C】，*【自定义模块D】，*【自定义模块E】参数返回json举例9,10,1,2,3,4,5,6,7,8SPDIF输出编码方式约定:0-PCM编码；1-数字编码声道输出方式约定:0-双声道；1-5.1声道视频高清（HDMI）输出方式约定:0-1080i；1-1080p；2-720p视频标清输出方式约定:0-AV视频高清Ypbpr输出方式约定: 0-1080i

15、；1-1080p；2-720p电视输出标准约定: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离线； 软件查询模

16、式方式约定: 0-出厂设置；1-版本升级；2-版本信息；3- 网络状态查询； 软键盘开关约定: 0-打开；1-关闭网络状态约定:var NetWorkStatusMode = ERROR: 0, name: 网络连接异常请检查连接, setname: 网络连接异常请检查连接, icon: red , CONNECTING: 1, name: 正在连接, setname: 与服务器正在连接, icon: orange , SUCCESS: 2, name: 连接成功 正在登录, setname: 与服务器连接成功,正在登录, icon: orange , NORMAL: 3, name: 网络连

17、接正常, 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:

18、green ;账户登录模式约定:var NetworkSetMode = DYNAMIC: 0, /动态配置 STATIC: 1, /静态IP ADSL_ACCOUNT: 2, /ADSL账户 ADSL_LOGIN: 3, /ADSL登录 ADSL_OFFLINE: 4, /ADSL离线 WIFI_SEARCH: 5, /无线网络搜索 WIFI_DYNAMIC: 6, /无线网络动态 WIFI_STATIC: 7 /无线网络静态;语法iPanel. ioctlWrite (System. SetAudioSPDIFOutPut,)功能写入系统音频SPDIF配置信息。参数属性 名称SPDIF s

19、pdif输出返回无举例iPanel.ioctlWrite(System. SetAudioSPDIFOutPut ,0)语法iPanel. ioctlRead(System. GetAudioSPDIFOutPut)功能读取系统音频SPDIF配置信息。参数属性 名称SPDIF spdif输出返回String举例0语法iPanel. ioctlWrite (System. SetAudioChanelOutPut,)功能写入系统音频Chanel配置信息。参数属性 名称Chanel 声道输出返回无举例iPanel.ioctlWrite(System. SetAudioChanelOutPut ,0

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

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

22、ideo 视频输出模式返回无举例iPanel.ioctlWrite(System. SetVideoYpbprOutPut,0)语法iPanel. ioctlRead (System. GetVideoYpbprOutPut)功能读取系统视频高清Ypbpr配置信息。参数无返回String举例0语法iPanel. ioctlWrite(System.SetTVSystem,)功能写入系统初始电视标准配置信息。参数属性 名称System 电视标准返回无举例iPanel.ioctlWrite(System.SetTVSystem,0)语法iPanel. ioctlRead (System.GetTV

23、System)功能读取系统初始电视标准配置信息。参数返回String举例0语法iPanel. ioctlWrite (System.SetTVScale,)功能写入系统初始电视比例配置信息。参数属性 名称Scale 电视比例返回无举例iPanel.ioctlWrite(System.SetTVScale ,0)语法iPanel. ioctlRead (System.GetTVScale)功能写入系统初始电视比例配置信息。参数无返回String举例0语法iPanel. ioctlWrite (System.SetNetworkMode,)功能写入系统初始当前网络设置模式。参数属性 名称Mode

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

25、WareQueryMode)功能读取系统初始网络动态配置信息。参数无返回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,)功能写入系统初始网络静态配置信息。参数属性 名称IP ip地址Mask mask地址Gateway gateway地址DnsIP dns ip地址返回无举例iPanel.ioctlWrite(System.SetNetworkStatic ,ip:127.0.0.1,mask:127.0.0.1,gateway:127.0.0.1,dns:1