《软件接口文档v》由会员分享，可在线阅读，更多相关《软件接口文档v（40页珍藏版）》请在金锄头文库上搜索。
1、案卷号接口文档-V2.0日期2011-07-22研发平台软件项目软件项目接口文档作 者：完成日期：签收人：签收日期：修改情况记录:版本号修改批准人修改人安装日期签收人2.0目录第1章引言31.1 编写目的31.2 术语31.3 参考文献3第2章接口定义42.1同步接口指令4引言1.1编写目的说明对程序系统的接口设计、数据结构设计等，为开发编码奠定基础。本文档描述本地UI软件的JavaScript代码和STB浏览器组件库iPanel之间的交互接 口，包括请求的格式，请求结果的格式，相关错误的定义，以及请求和结果返回的交互流程。本文的主要读者为需要系统前端开发人员、STB开发人员，以及需要了解本前
2、端与STB 接口的相关人员。1.2 术语术语或缩写词IPTVSTBHTMLJavaScriptCSSDOMJSON说明性定义交互式网络电视机顶盒超文本置标语言一种应用于客户端Web开发的脚本语言层叠样式表文档对象模型专门为浏览器中的网页上运行的JavaScript代码而设计的一种数据格式XML iPanel可扩展置标语言IPTV终端浏览器1.3 参考文献序号资料名文件编号发表日期出版单位第2章接口定义本软件页面与底层交互采用iPanel扩展的ioctlRead/Write方式进行，数据交换采用 json字符串/String方式。2.1同步接口指令媒体播控媒体类型约定:0-电影；1-音乐；2-图
3、片；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 串”）功能写入媒体暂停路径及类型。参数属性名称Name媒体路径Type媒体类型返回无举例iPanel.i
4、octlWrite(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媒体高度返回
5、无举例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
6、”)语法iPanel. ioctlWrite (Media. Forward,参数 json 串)功能写入媒体播放快进模式及类型。参数属性名称Mode快进模式Type媒体类型返回举例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 (M
7、edia. GetVolume)功能读取媒体播放音量。参数无返回String举例20语法iPanel. ioctlRead (getMemoryItem ”)功能获取记忆的功能导航。参数无返回String举例20语法iPanel. ioctlWrite (setMemoryItem”,index)功能设置记忆的功能导航。参数无返回无举例语法iPanel. ioctlRead(Media. GetMute )功能读取媒体播放静音设置。参数无返回String举例0语法iPanel. ioctlWrite(Media. SetBook”,参数 String”)功能写入媒体订购信息。参数属性名称Nam
8、e媒体名称返回返回ok或者失败信息（资费不够等）举例iPanel.ioctlWrite(Media. SetBook ”,”/mnt/hd/ 逃亡鳄鱼岛.avi )语法iPanel. ioctlRead(Media. GetBook,Name)功能读取媒体订购信息。参数属性名称Name媒体名称Count媒体总份数Price媒体总资费（元）返回Json 串举例name”:/mnt/hd/ 逃亡鳄鱼岛.avi,count:2,price:66.50 语法iPanel. ioctlRead(Media. GetCurrentDownFile)功能读取下载媒体信息。参数属性名称Name媒体名称Size
9、媒体大小Speed下载速度Percent下载百分比DownedSize已下载大小Status下载状态返回Json 串举例name”:/mnt/hd/ 逃亡鳄鱼岛.avi,size:102445676KB,speed:538KB/S ,percent:15%,downedsize:34567KB ,status:正在下载语法iPanel. ioctlRead(Media. GetFileInfo,path)path当刖媒体路径功能读取媒体信息。参数属性名称Name媒体名称singer演唱者currentPlayTime当前播放时间during媒体时长loopMode循环模式videoOutput
10、视频输出other其他信息返回Json 串举例 name: /mnt/hd/ 逃亡鳄鱼岛 1.avi , singer: ”德华”，currentPlayTime: 00:00:32, duration: 0:01:00 ,loopMode:全循环, videoOutput: sVideo , other:16:9字幕:无双声道”;语法iPanel. ioctlRead(Media. GetNextFileInfo,path)path当刖媒体路径功能读取子集中下一个媒体信息，以便播放。没有子集返回空参数属性名称Name媒体名称singer演唱者currentPlayTime当前播放时间duri
11、ng媒体时长loopMode循环模式videoOutput视频输出other其他信息返回Json 串举例 name: /mnt/hd/ 逃亡鳄鱼岛 1.avi , 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；
12、2-gif语法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,path) path:文件路径如/mnt/hd/逃亡.avi功能获取下载完成的子集 我的专区 电视剧。参数属性名称path文件路径返回json举例 no: 1, name: /mnt/hd/ 放牛班的春天 01.avi , no: 2, name: /mnt/hd/ 放牛班的春天 02.avi ;语法iPanel. ioctlRead(FSO.GetFiles,MenuIndex,fileLength,usb)Menuindex: 菜单索引如1, 2, 3usb :外置移动硬盘还是置硬盘功能读取指定类型的媒体的总数量。
