软件接口文档v2.0

研发平台软件项目

软件项目接口文档

作者：

完成日期：

签收人：

签收日期：

修改情况记录：

第1章引言 (3)

1.1编写目的 (3)

1.2术语 (3)

1.3参考文献 (3)

第2章接口定义 (4)

2.1同步接口指令 (4)

1.1编写目的

说明对程序系统的接口设计、数据结构设计等，为开发编码奠定基础。

本文档描述本地UI软件的JavaScript代码和STB浏览器组件库iPanel之间的交互接口，包括请求的格式，请求结果的格式，相关错误的定义，以及请求和结果返回的交互流程。

本文的主要读者为需要系统前端开发人员、STB开发人员，以及需要了解本前端与STB 接口的相关人员。

1.2术语

术语或缩写词说明性定义

IPTV 交互式网络电视

STB 机顶盒

HTML 超文本置标语言

JavaScript 一种应用于客户端Web开发的脚本语言

CSS 层叠样式表

DOM 文档对象模型

JSON 专门为浏览器中的网页上运行的JavaScript代码而设计的

一种数据格式

XML 可扩展置标语言

iPanel IPTV终端浏览器

1.3参考文献

第2章接口定义

本软件页面与底层交互采用iPanel扩展的ioctlRead/Write方式进行，数据交换采用json字符串/String方式。

2.1同步接口指令

读取菜单。

*【电视剧场】1

*【我的影视】2

*【家庭院线】3

*【我的专区】4

*【信息空间】5，

*【热门推荐】6，

*【帮助】7，帮助模块中的3个子模块（下载状态、帮助、设置）可分别控制*【移动信息】8，

当关闭外置节目播放时，移动信息中不显示外置节目

当关闭外置文件播放时，移动信息中不显示外置文件

当终端未登录服务器时，移动信息中不显示外置文件

*【动听世界】9，

*【自定义模块A】，

*【自定义模块B】，

离线；

软件查询模式方式约定: 0->出厂设置；1->版本升级；2->版本信息；3-> 网络状态查询；

软键盘开关约定: 0->打开；1->关闭

网络状态约定:

var NetWorkStatusMode = [

{ ERROR: 0, name: '网络连接异常请检查连接', setname: "网络连接异常请检查连接", icon: "red" },

{ CONNECTING: 1, name: '正在连接', setname: "与服务器正在连接", icon: "orange" },

{ SUCCESS: 2, name: '连接成功正在登录', setname: "与服务器连接成功,正在登录", icon: "orange" },

{ NORMAL: 3, name: '网络连接正常', setname: "网络连接正常", icon: "green" },

{ W_ERROR: 4, name: '无线网络连接异常请检查连接', setname: "无线网络连接异常请检查连接", icon: "red" },

{ W_CONNECTING: 5, name: '无线正在连接', setname: "无线与服务器正在连接", icon: "orange" },

{ W_SUCCESS: 6, name: '无线连接成功正在登录', setname: "无线与服务器连接成功正在登录", icon: "orange" },

{ W_NORMAL: 7, name: '无线网络连接正常', setname: "无线网络连接正常", icon: "green" }