软件接口文档.docx

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

2、盒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-打开(on)视频类型约定:0-高清；

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

4、avi,type:0)语法(Media. Position, )功能写入媒体播放位置参数。参数属性 名称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,)功能写入媒体播放停止路径及类型。参数属性 名称Name 媒体路径Type 媒体类型返回无 举例(Media. Stop ,name:/mnt/h

5、d/逃亡鳄鱼岛.avi,type:0)语法iPanel. ioctlWrite (Media. Forward,)功能写入媒体播放快进模式及类型。参数属性 名称Mode 快进模式Type 媒体类型返回举例(Media. Forward,mode:8,type:0)语法iPanel. ioctlWrite (Media. Rewind,)功能写入媒体播放快退模式及类型。参数属性 名称Mode 快退模式Type 媒体类型返回举例(Media. Forward,mode:8,type:0)语法iPanel. ioctlRead (Media. GetVolume)功能读取媒体播放音量。参数无返回St

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

7、/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串举

8、例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: 刘德华,

9、 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串

10、举例 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,

11、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

12、/放牛班的春天 ;语法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】