软件接口文档

研发平台软件项目 软件项目接口文档

作 者：

完成日期：

签 收 人： 签收日期：

修改情况记录：

版本号 修改批准人 修改人 安装日期 签收人 目录

第1章

第2章

引言 ............................................. 错误!未定义书签。 编写目的 ......................................... 错误!未定义书签。 术语 ............................................. 错误!未定义书签。 参考文献 ......................................... 错误!未定义书签。 接口定义 ......................................... 错误!未定义书签。 同步接口指令 ..................................... 错误!未定义书签。

引言

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

同步接口指令

媒体播控 媒体类型约定:0->电影；1->音乐；2->图片；3->文本 静音模式约定:0->关闭（off）；1->打开(on) 视频类型约定:0->高清；1->标清；2->普通；3->片花； 语(\"\参数json串>\") 法 功写入媒体播放路径及类型。 能 参数 属性 名称 Name 媒体路径 Type 媒体类型 返无 回 举(\"\逃亡鳄鱼岛.avi\ 例 语(\"Media. Pause\参数json串>\") 法 功写入媒体暂停路径及类型。 能 参数 属性 名称 Name 媒体路径 Type 媒体类型 返无 回 举(\"Media. Pause\逃亡鳄鱼例 岛.avi\ 语(\"Media. Resume\参数json串>\") 法 功写入媒体继续路径及类型。 能 参数 属性 名称 Name 媒体路径 Type 媒体类型 返无 回 举(\"Media. Resume\逃亡鳄鱼例 岛.avi\ 语(\"Media. Position\参数json串>\") 法 功写入媒体播放位置参数。 能 参数 属性 名称 x 媒体x坐标 y 媒体y坐标 w 媒体宽度 h 媒体高度 返无 回 举(\"Media. 例 Position\ 语(\"Media. Position\") 法 功读取媒体播放位置参数。 能 参无 数 返Json串 回 举返回JSON串：{\"x\":\"0\ 例 语iPanel. ioctlWrite (\"Media. Stop\参数json串>\") 法 功写入媒体播放停止路径及类型。 能 参数 属性 名称 Name 媒体路径 Type 媒体类型 返无 回 举(\"Media. Stop \逃亡鳄鱼例 岛.avi\ 语iPanel. ioctlWrite (\"Media. Forward\参数json串>\") 法 功写入媒体播放快进模式及类型。 能 参属性 名称 数 Mode 快进模式 Type 媒体类型 返 回 举(\"Media. Forward\ 例 语iPanel. ioctlWrite (\"Media. Rewind\参数json串>\") 法 功写入媒体播放快退模式及类型。 能 参数 属性 名称 Mode 快退模式 Type 媒体类型 返 回 举(\"Media. Forward\ 例 语iPanel. ioctlRead (\"Media. GetVolume\") 法 功读取媒体播放音量。 能 参无 数 返String 回 举20 例 语iPanel. ioctlRead (\"getMemoryItem”) 法 功能 获取记忆的功能导航。 参无 数 返String 回 举20 例 语iPanel. ioctlWrite (\"setMemoryItem”,index) 法 功设置记忆的功能导航。 能 参无 数 返无 回 举 例 语iPanel. ioctlRead(\"Media. GetMute \") 法 功读取媒体播放静音设置。 能 参无 数 返String 回 举0 例 语iPanel. ioctlWrite(\"Media. SetBook\参数String>\") 法 功写入媒体订购信息。 能 参数 属性 名称 Name 媒体名称 返返回ok 或者失败信息（资费不够等） 回 举(\"Media. SetBook \逃亡鳄鱼岛.avi \") 例 语iPanel. ioctlRead(\"Media. GetBook,Name\") 法 功读取媒体订购信息。 能 参数 属性 名称 Name 媒体名称 Count 媒体总份数 Price 媒体总资费(元) 返Json串 回 举{\"name\":\"/mnt/hd/逃亡鳄鱼岛.avi 例 \ 语iPanel. ioctlRead(\"Media. GetCurrentDownFile\") 法 功读取下载媒体信息。 能 参数 属性 名称 Name 媒体名称 Size 媒体大小 Speed 下载速度 Percent 下载百分比 DownedSize 已下载大小 Status 下载状态 返Json串 回 举{\"name\":\"/mnt/hd/逃亡鳄鱼岛.avi 例 \\正在下载\ 语iPanel. ioctlRead(\"Media. GetFileInfo,path\") 法 path 当前媒体路径 功读取媒体信息。 能 参数 属性 名称 Name 媒体名称 singer 演唱者 currentPlayTime 当前播放时间 during 媒体时长 loopMode 循环模式 videoOutput 视频输出 other 其他信息 返Json串 回 举{ \"name\": \"/mnt/hd/逃亡鳄鱼岛 \刘德华\例 \"currentPlayTime\": \"00:00:32\ \"loopMode\": \"全循环 \\"other\": \"16:9 字幕:无 双声道\" }; 语iPanel. ioctlRead(\"Media. GetNextFileInfo,path\") 法 path 当前媒体路径 功读取子集中下一个媒体信息，以便播放。没有子集返回空 能 参数 属性 名称 Name 媒体名称 singer 演唱者 currentPlayTime 当前播放时间 during 媒体时长 loopMode 循环模式 videoOutput 视频输出 other 其他信息 返Json串 回 举{ \"name\": \"/mnt/hd/逃亡鳄鱼岛 \刘德华\例 \"currentPlayTime\": \"00:00:32\ \"loopMode\": \"全循环 \\"other\": \"16:9 字幕:无 双声道\" }; 媒体类型约定:0->电影；1->音乐；2->图片 电影风格类型约定:0->剧情片；1->喜剧片；2->恐怖片；3->科幻片 音乐风格类型约定:0->流行；1->古典；2->民歌；3->港台 图片容器格式约定:0->jpg；1->png；2->gif 语iPanel. ioctlRead(\ 法 MenuIndex： 菜单索引如1，2，3， currentFileIndex：当前文件索引如1，2，3， usb ：外置移动硬盘还是内置硬盘 功读取指定类型,指定链表位置的文件列表。 能 参数 属性 名称 Name 媒体名称 返Json串 回 举{\"/mnt/hd/逃亡鳄鱼岛.avi \逃亡.avi\ 例 语iPanel. ioctlRead(\ 法 path：文件路径如 /mnt/hd/逃亡.avi 功获取下载完成的子集 我的专区 电视剧。 能 参数 属性 名称 path 文件路径 返json 回 举[{ 'no': '1', 'name': '/mnt/hd/放牛班的春天' }, 例 { 'no': '2', 'name': '/mnt/hd/放牛班的春天' } ]; 语iPanel. ioctlRead(\ 法 MenuIndex： 菜单索引如1，2，3 usb ：外置移动硬盘还是内置硬盘 功读取指定类型的媒体的总数量。 能 参数 属性 名称 length 文件长度 返String 回 举12 例 语iPanel. ioctlRead(\"local. menuItems \") 法 功读取菜单。 能 *【电视剧场】1 *【我的影视】2 *【家庭院线】3 *【我的专区】4 *【信息空间】5， *【热门推荐】6， *【帮助】 7， *【移动信息】8， *【动听世界】9， *【自定义模块A】， *【自定义模块B】， 帮助模块中的3个子模块（下载状态、帮助、设置）可分别控制 当关闭外置节目播放时，移动信息中不显示外置节目 当关闭外置文件播放时，移动信息中不显示外置文件 当终端未登录服务器时，移动信息中不显示外置文件 *【自定义模块C】， *【自定义模块D】， *【自定义模块E】 参数 返json 回 举例 [\"9\ SPDIF输出编码方式约定:0->PCM编码；1->数字编码 声道输出方式约定:0->双声道；1->声道 视频高清（HDMI）输出方式约定:0->1080i；1->1080p；2->720p 视频标清输出方式约定:0->AV 视频高清Ypbpr输出方式约定: 0->1080i；1->1080p；2->720p 电视输出标准约定:0->NTSC；1->PAL 电视比例约定:0->4:3；1->16:9 网络状态约定:0->网络断开；1->网络连接；2->网络不存在 磁盘管理方式约定:0->本地磁盘格式化；1->移动磁盘格式化；2->磁盘整理 下载路径方式约定:0->移动硬盘；1->内置硬盘 字体大小方式约定:0->大字体；1->中字体；2->小字体； 字体颜色方式约定: 0->红；1->橙；2->黄；3->绿；4->青；5->蓝；6->紫； 7->白；

网络设置模式方式约定: 0-> WIFI搜索；1-> WIFI静态配置；2-> WIFI动态配置；3->动态；4->静态；5->adsl账户；6-> adsl登录；7-> adsl离线；

软件查询模式方式约定: 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\" } ]; 账户登录模式约定: var NetworkSetMode = { DYNAMIC: 0, ioctlWrite (\"System. SetAudioSPDIFOutPut\参数String串>\") 功写入系统音频SPDIF配置信息。 能 参数 返无 回 举(\"System. SetAudioSPDIFOutPut \ 例 属性 名称 SPDIF spdif输出 语iPanel. ioctlRead(\"System. GetAudioSPDIFOutPut\") 法 功读取系统音频SPDIF配置信息。 能 参数 属性 名称 SPDIF spdif输出 返String 回 举\"0\" 例 语iPanel. ioctlWrite (\"System. SetAudioChanelOutPut\法 参数String串>\") 功写入系统音频Chanel配置信息。 能 参数 返无 回 举(\"System. SetAudioChanelOutPut \ 例 属性 名称 Chanel 声道输出 语iPanel. ioctlRead(\"System. GetAudioChanelOutPut\") 法 功读取系统音频Chanel配置信息。 能 参无 数 返String 回 举\"0\" 例 语iPanel. ioctlWrite (\"System. SetVideoHDMIOutPut\参法 数String>\") 功写入系统视频高清配置信息。 能 参数 返无 回 举(\"System. SetVideoHDMIOutPut \ 例 属性 名称 video 视频输出模式 语iPanel. ioctlRead (\"System. GetVideoHDMIOutPut\") 法 功读取系统视频高清配置信息。 能 参数 属性 名称 video 音频输出模式 返String 回 举0 例 语iPanel. ioctlWrite (\"System. SetVideoSDOutPut\参数法 String>\") 功写入系统视频标清配置信息。 能 参数 返无 回 举(\"System. SetVideoSDOutPut \ 例 属性 名称 video 视频输出模式 语iPanel. ioctlRead (\"System. GetVideoSDOutPut\") 法 功读取系统视频标清配置信息。 能 参无 数 返String 回 举0 例 语iPanel. ioctlWrite (\"System. SetVideoYpbprOutPut\法 参数String>\") 功写入系统视频高清Ypbpr配置信息。 能 参数 返无 回 举(\"System. SetVideoYpbprOutPut\ 例 属性 名称 video 视频输出模式 语iPanel. ioctlRead (\"System. GetVideoYpbprOutPut\") 法 功读取系统视频高清Ypbpr配置信息。 能 参无 数 返String 回 举0 例 语iPanel. ioctlWrite(\"\参数String>\") 法 功写入系统初始电视标准配置信息。 能 参数 返无 回 举(\"\ 例 属性 名称 System 电视标准 语iPanel. ioctlRead (\"\") 法 功读取系统初始电视标准配置信息。 能 参 数 返String 回 举0 例 语iPanel. ioctlWrite (\"\参数String>\") 法 功写入系统初始电视比例配置信息。 能 参数 返无 回 举(\" \ 例 属性 名称 Scale 电视比例 语iPanel. ioctlRead (\"\") 法 功写入系统初始电视比例配置信息。 能 参无 数 返String 回 举0 例 语iPanel. ioctlWrite (\"\参数String>\") 法 功写入系统初始当前网络设置模式。 能 参数 返无 回 举(\"System. SetNetworkMode \ 例 属性 名称 Mode 设置模式 语iPanel. ioctlRead (\"System. GetNetworkMode\") 法 功读取系统初始网络设置模式。 能 参无 数 返String 回 举0 例 语iPanel. ioctlWrite (\"\参数String>\") 法 功写入系统初始当前网络设置模式。 能 参数 返无 回 举(\"System. SetSoftWareQueryMode\ 例 属性 名称 Mode 设置模式 语iPanel. ioctlRead (\"System. GetSoftWareQueryMode\") 法 功读取系统初始网络动态配置信息。 能 参无 数 返String 回 举0 例 语iPanel. ioctlWrite (\"\ 法 功写入系统初始网络动态配置信息。 能 参无 数 返String （0 成功 1 失败） 回 举(\"\ 例 语iPanel. ioctlRead (\"\") 法 功读取系统初始网络动态配置信息。 能 参无 数 返String 回 举 例 语iPanel. ioctlWrite (\"\参数json串>\") 法 功写入系统初始网络静态配置信息。 能 参数 属性 名称 IP ip地址 Mask mask地址 Gateway gateway地址 DnsIP dns ip地址 返无 回 举(\" \ 例 \"dns\":\"\ 语iPanel. ioctlRead (\"\") 法 功读取系统初始网络静态配置信息。 能 参无 数 返json串 回 举{\"ip\":\"\ 例 \"dns\":\"\ 语iPanel. ioctlWrite(\"\参数json串>\") 法 功写入系统初始网络ADSL账户配置信息。 能 参数 属性 名称 Name 用户名 Password 密码 返无 回 举(\" \ 例 语iPanel. ioctlRead(\"\") 法 功读取系统初始网络ADSL账户配置信息。 能 参无 数 返json串 回 举{\"name\":\"tony\ 例 语iPanel. ioctlWrite(\"\ 法 功写入系统初始软件恢复出厂配置信息。 能 参无 数 返无 回 举(\"\ 例 语iPanel. ioctlWrite(\"\参数String>\") 法 功写入版本升级指令。 能 参无 数 返无 回 举(\"\ 例 语iPanel. ioctlRead (\"\") 法 功读取版本升级指令信息。 能 参无 数 返String 回 举\"\" 例 语iPanel. ioctlRead (\"\") 法 功读取系统初始软件版本信息。 能 参无 数 返json串 回 举{\"functionver\":\"jxhy\ 例 \"vedioout\":\"svedio\ \"localvolumn\":\"109GB\ \"mobilevolumn\":\"200GB\ 语iPanel. ioctlWrite (\"System. SetVersion \参数json法 串>\") 功读取系统初始软件版本信息。 能 参数 属性 名称 FunctionVer 功能版本 PageVer 页面版本 VedioOut 输出设置 VedioScale 视频比例 LocalVolumn 本地磁盘容量 LocalRemainVolumn 本地磁盘剩余容量 MobileVolumn 移动磁盘容量 MobileRemainVolumn 移动磁盘剩余容量 返无 回 举(\" \ 例 \"vedioout\":\"svedio\ \"localvolumn\":\"109GB\ \"mobilevolumn\":\"200GB\ 语iPanel. ioctlRead(\"\") 法 功读取系统初始软件网络状态信息。 能 参无 数 返Json串 回 举{\"status\":\"0\ 例 \"00-25-5E-FF-27-48\"，\" currentip \":\"\ 语iPanel. ioctlWrite (\"\参数Json串>\") 法 功写入系统初始软件网络状态信息。 能 参数 属性 名称 Statuas 网络状态 method 登录方式 macaddress mac地址 currentip 当前ip 返无 回 举(\" \ 例 语iPanel. ioctlWrite(\" \参数String>\") 法 功写入系统初始磁盘管理配置信息。 能 参数 返无 回 属性 名称 Mode 管理方式 举(\"\ 例 语iPanel. ioctlRead (\"\") 法 功读取系统初始磁盘管理配置信息。 能 参无 数 返String 回 举0 例 语iPanel. ioctlWrite(\"\参数json串>\") 法 功写入系统初始账号配置信息。 能 参数 属性 名称 Name 用户名 Password 密码 IP IP 返无 回 举(\" \ 例 \"ipname\":\"\"，\" ip \":\"\ 语iPanel. ioctlRead (\"\") 法 功读取系统初始账号配置信息。 能 参无 数 返Json串 回 举{\"name\":\"tony\例 \"inputmode\":\"0\北京建新\中国电信\中国联通\ 语iPanel. ioctlWrite(\"\参数String>\") 法 功写入系统初始下载路径配置信息。 能 参数 返无 回 属性 名称 Mode 路径模式 举(\" \ 例 语iPanel. ioctlRead (\"System. GetDownPath\") 法 功读取系统初始下载路径配置信息。 能 参无 数 返String 回 举0 例 语iPanel. ioctlWrite(\"\参数String>\") 法 功写入系统初始字幕大小配置信息。 能 参数 返无 回 属性 名称 Mode 大小方式 举(\"\ 例 语iPanel. ioctlRead (\"\") 法 功读取系统初始字幕大小配置信息。 能 参无 数 返String 回 举0 例 语iPanel. ioctlWrite(\"\参数String>\") 法 功写入系统初始字幕颜色配置信息。 能 参数 返无 回 属性 名称 Mode 颜色方式 举(\" \ 例 语iPanel. ioctlRead (\"\参数String>\") 法 功读取系统初始字幕颜色配置信息。 能 参无 数 返String 回 举0 例 语iPanel. ioctlRead(\"\") 法 功读取系统主界面导航菜单配置信息。 能 参无 数 返String数组 回 举[\"0\ 例 语iPanel. ioctlWrite(\"\参数String>\") 法 功写入软键盘开关指令。 能 参数 返无 回 举(\" \ 例 属性 名称 Mode 开关模式 语iPanel. ioctlWrite(\"\参数String>\") 法 功写入ADSL登录指令。 能 参String 数 返String 回 举(\"System. SetNetworkADSLLogin\ 例 语iPanel. ioctlRead (\" \") 法 功读取ADSL登录指令。 能 参无 数 返String 回 举\"0\" 例 语iPanel. ioctlWrite(\"\参数String>\") 法 功写入ADSL退出指令。 能 参String 数 返无 回 举(\"System. SetNetworkADSLLogout\ 例 语iPanel. ioctlRead (\"\") 法 功读取ADSL退出指令。 能 参无 数 返String 回 举\"0\" 例 语iPanel. ioctlRead(\"\") 法 功读取无线网络设备状态。 能 参无 数 返String 回 举\"0\" 例 语iPanel. ioctlRead (\"\") 法 功读取无线网络搜索列表。 能 参无 数 返Json串 回 举[{\"name\":\"jx2009\ 例 \"stongvalue\":\"80%\ \"stongvalue\":\"50%\ {\"name\":\"n123\ \"stongvalue\":\"10%\ 语iPanel. ioctlWrite(\"\参数json串>\") 法 功写入WIFI账户登录指令。 能 参数 属性 名称 Name SSID Password 密钥 返无 回 举(\"System. SetWIFILogin 例 \ 语iPanel. ioctlRead (\" 法 功读取WIFI账户登录指令。 能 参无 数 返String （0 成功 1 失败） 回 举\"0\" 例 语iPanel. ioctlWrite (\"\ 法 功写入WIFI动态配置指令。 能 参无 数 返无 回 举(\"\ 例 语iPanel. ioctlRead (\"\") 法 功读取WIFI动态配置指令。 能 参无 数 返String （0 成功 1 失败） 回 举\"0\" 例 语iPanel. ioctlWrite (\"\参数json串>\") 法 功写入WIFI静态配置信息。 能 参数 属性 名称 IP ip地址 Mask mask地址 Gateway gateway地址 DnsIP dns ip地址 返无 回 举(\" \ 例 \"dns\":\"\ 语iPanel. ioctlRead(\"\") 法 功读取WIFI静态配置。 能 参无 数 返json串 回 举{\"ip\":\"\ 例 \"dns\":\"\