软件接口文档v0讲解VIP免费

软件项目开发接口文档v2.0案卷号接口文档-V2.0日期2011-07-22研发平台软件项目软件项目接口文档作者：完成日期：签收人：签收日期：修改情况记录：版本号修改批准人修改人安装日期签收人2.0软件项目开发接口文档v2.0目录第1章引言.............................................................31.1编写目的...................................................................................................................31.2术语...........................................................................................................................31.3参考文献...................................................................................................................3第2章接口定义.........................................................42.1同步接口指令...........................................................................................................4软件项目开发接口文档v2.0引言1.1编写目的说明对程序系统的接口设计、数据结构设计等，为开发编码奠定基础。本文档描述本地UI软件的JavaScript代码和STB浏览器组件库iPanel之间的交互接口，包括请求的格式，请求结果的格式，相关错误的定义，以及请求和结果返回的交互流程。本文的主要读者为需要系统前端开发人员、STB开发人员，以及需要了解本前端与STB接口的相关人员。1.2术语术语或缩写词说明性定义IPTV交互式网络电视STB机顶盒HTML超文本置标语言JavaScript一种应用于客户端Web开发的脚本语言CSS层叠样式表DOM文档对象模型JSON专门为浏览器中的网页上运行的JavaScript代码而设计的一种数据格式XML可扩展置标语言iPanelIPTV终端浏览器1.3参考文献序号资料名文件编号发表日期出版单位软件项目开发接口文档v2.0第2章接口定义本软件页面与底层交互采用iPanel扩展的ioctlRead/Write方式进行，数据交换采用json字符串/String方式。2.1同步接口指令媒体播控媒体类型约定:0->电影；1->音乐；2->图片；3->文本静音模式约定:0->关闭（off）；1->打开(on)视频类型约定:0->高清；1->标清；2->普通；3->片花；语法iPanel.ioctlWrite("Media.Open","<参数json串>")功能写入媒体播放路径及类型。参数属性名称Name媒体路径Type媒体类型返回无举例iPanel.ioctlWrite("Media.Open","{"name":"/mnt/hd/逃亡鳄鱼岛.avi","type":"0"}")语法iPanel.ioctlWrite("Media.Pause","<参数json串>")功能写入媒体暂停路径及类型。参数属性名称软件项目开发接口文档v2.0Name媒体路径Type媒体类型返回无举例iPanel.ioctlWrite("Media.Pause","{"name":"/mnt/hd/逃亡鳄鱼岛.avi","type":"0"}")语法iPanel.ioctlWrite("Media.Resume","<参数json串>")功能写入媒体继续路径及类型。参数属性名称Name媒体路径Type媒体类型返回无举例iPanel.ioctlWrite("Media.Resume","{"name":"/mnt/hd/逃亡鳄鱼岛.avi","type":"0"}")语法iPanel.ioctlWrite("Media.Position","<参数json串>")功能写入媒体播放位置参数。参数属性名称x媒体x坐标y媒体y坐标w媒体宽度h媒体高度软件项目开发接口文档v2.0返回无举例iPanel.ioctlWrite("Media.Position","{"x":"0","y":"0","w":"1280","h":"720"}")语法iPanel.ioctlRead("Media.Position")功能读取媒体播放位置参数。参数无返回Json串举例返回JSON串：{"x":"0","y":"0","w":"1280","h":"720"}语法iPanel.ioctlWrite("Media.Stop","<参数json串>")功能写入媒体播放停止路径及类型。参数属性名称Name媒体路径Type媒体类型返回无举例iPanel.ioctlWrite("Media.Stop","{"name":"/mnt/hd/逃亡鳄鱼岛.avi","type":"0"}")语法iPanel.ioctlWrite("Media.Forward","<参数json串>")功能写入媒体播放快进模式及类型。参数属性名称软件项目开发接口文档v2.0Mode快进模式Type媒体类型返回举例iPanel.ioctlWrite("Media.Forward","{"mode":"8","type":"0"}")语法iPanel.ioctlWrite("Media.Rewind","<参数json串>")功能写入媒体播放快退模式及类型。参数属性名称Mode快退模式Type媒体类...