《软件接口文档v20》由会员分享，可在线阅读，更多相关《软件接口文档v20（36页珍藏版）》请在金锄头文库上搜索。
1、软件项目开发接口文档V2.0案卷号接口文档-V2.0日期2011-07-22研发平台软件项目软件项目接口文档作 者：完成日期：签收人：签收日期：修改情况记录:版本号修改批准人修改人安装日期签收人2.0目录第1章弓I言 31.1 编写目的31.2 术语31.3 参考文献3第2章接口定义 42.1同步接口指令4引言1.1编写目的说明对程序系统的接口设计、数据结构设计等，为开发编码奠定基础。本文档描述本地 UI软件的JavaScript代码和STB浏览器组件库iPanel之间的交互接 口，包括请求的格式，请求结果的格式，相关错误的定义，以及请求和结果返回的交互流程。本文的主要读者为需要系统前端开发人
2、员、STB开发人员，以及需要了解本前端与STB接口的相关人员。1.2术语术语或缩写词说明性定义IPTV交互式网络电视STB机顶盒HTML超文本置标语言JavaScript一种应用于客户端 Web开发的脚本语言CSS层叠样式表DOM文档对象模型JSON专门为浏览器中的网页上运行的JavaSc一种数据格式XML可扩展置标语言iPanelIPTV终端浏览器代码而设计的1.3参考文献序号资料名文件编号发表日期出版单位第2章接口定义本软件页面与底层交互采用iPanel扩展的ioctIRead/Write方式进行，数据交换采用json字符串/String 方式。2.1 同步接口指令媒体播控媒体类型约疋:0
3、-电影；1-音乐；2-图片；3-文本静音模式约定:0-关闭(of ); 1-打开(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,)功能写入媒体暂停路径及类型。参数属性名称NameType媒体路径媒体类型返回无举例iPanel.ioctlWrite(Medi
4、a.Pause,name:/mnt/hd/逃亡鳄鱼岛.avi,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:
5、1280,h:720)语法iPanel.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,)功能写入媒体播放快进模式及类型。参数属性名
6、称ModeType快进模式媒体类型返回举例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)功能读取媒体播放音量。参数无返回Stri ng举例20语法iPanel. ioctlRead (getMemoryItem ”
7、)功能获取记忆的功能导航。参数无返回Stri ng举例20语法iPanel. ioctlWrite (setMemoryltem ”,index)功能设置记忆的功能导航。参数无返回无举例语法iPanel. ioctlRead(Media. GetMute )功能读取媒体播放静音设置。参数无返回Stri ng举例0语法iPanel. ioctlWrite(Media. SetBook,jpg ; 1-png; 2-gif语法iPanel.ioctlRead(FSO.GetFiles,Menulndex,currentFilelndex,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, nam
