软件接口文档v2.0
软件项目开发接口文档 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 可扩展置标语言iPanel IPTV 终端浏览器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", "")功能 写入媒体播放路径及类型。参数 属性 名称Name 媒体路径Type 媒体类型返回 无举例 iPanel.ioctlWrite("Media.Open",""name":"/mnt/hd/ 逃亡鳄鱼岛 .avi","type":"0"") 语法 iPanel.ioctlWrite("Media. Pause", "")功能 写入媒体暂停路径及类型。参数 属性 名称软件项目开发接口文档 v2.0 Name 媒体路径Type 媒体类型返回 无举例 iPanel.ioctlWrite("Media. 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 媒体高度软件项目开发接口文档 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","")功能 写入媒体播放停止路径及类型。参数 属性 名称Name 媒体路径Type 媒体类型返回 无举例 iPanel.ioctlWrite("Media. Stop ",""name":"/mnt/hd/ 逃亡鳄鱼岛 .avi","type":"0"")语法 iPanel. ioctlWrite ("Media. Forward","")功能 写入媒体播放快进模式及类型。参数 属性 名称软件项目开发接口文档 v2.0 Mode 快进模式Type 媒体类型返回举例 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 ” )软件项目开发接口文档 v2.0 功能 获取记忆的功能导航。参数 无返回 String 举例 20语法 iPanel. ioctlWrite ("setMemoryItem ” ,index)功能 设置记忆的功能导航。参数 无返回 无举例语法 iPanel. ioctlRead("Media. GetMute ")功能 读取媒体播放静音设置。参数 无返回 String 举例 0语法 iPanel. ioctlWrite("Media. SetBook","")功能 写入媒体订购信息。参数 属性 名称Name 媒体名称返回 返回 ok 或者失败信息（资费不够等）软件项目开发接口文档 v2.0 举例 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 媒体大小Speed 下载速度Percent 下载百分比DownedSize 已下载大小Status 下载状态软件项目开发接口文档 v2.0 返回 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 视频输出other 其他信息返回 Json 串举例 "name": "/mnt/hd/ 逃亡鳄鱼岛 1.avi ", "singer": " 刘德华 ", "currentPlayTime": "00:00:32", "duration": "0:01:00 ", "loopMode": " 全循环 ", "videoOutput": "sVideo ", "other": "16:9 字幕 :无 双声道 " ; 软件项目开发接口文档 v2.0 语法 iPanel. ioctlRead("Media. GetNextFileInfo,path") path 当前媒体路径功能 读取子集中下一个媒体信息，以便播放。没有子集返回空参数 属性 名称Name 媒体名称singer 演唱者currentPlayTime 当前播放时间during 媒体时长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->港台软件项目开发接口文档 v2.0 图片容器格式约定 :0->jpg ； 1->png； 2->gif 语法 iPanel. ioctlRead("FSO.GetFiles,MenuIndex,currentFileIndex,usb") MenuIndex ： 菜单索引如 1， 2， 3，currentFileIndex ：当前文件索引如 1， 2， 3，usb ：外置移动硬盘还是内置硬盘功能 读取指定类型 ,指定链表位置的文件列表。参数 属性 名称Name 媒体名称返回 Json 串举例 "/mnt/hd/ 逃亡鳄鱼
