软件接口文档.docx
《软件接口文档.docx》由会员分享，可在线阅读，更多相关《软件接口文档.docx（30页珍藏版）》请在冰豆网上搜索。
软件接口文档
案卷号
接口文档
日期
2011-07-22
研发平台软件项目
软件项目接口文档
作者：
完成日期：
签收人：
签收日期：
修改情况记录：
版本号
修改批准人
修改人
安装日期
签收人
引言
1.1编写目的
说明对程序系统的接口设计、数据结构设计等，为开发编码奠定基础。
本文档描述本地UI软件的JavaScript代码和STB浏览器组件库iPanel之间的交互接口，包括请求的格式，请求结果的格式，相关错误的定义，以及请求和结果返回的交互流程。
本文的主要读者为需要系统前端开发人员、STB开发人员，以及需要了解本前端与STB接口的相关人员。
1.2术语
术语或缩写词说明性定义
IPTV交互式网络电视
STB机顶盒
HTML超文本置标语言
JavaScript一种应用于客户端Web开发的脚本语言
CSS层叠样式表
DOM文档对象模型
JSON专门为浏览器中的网页上运行的JavaScript代码而设计的
一种数据格式
XML可扩展置标语言
iPanelIPTV终端浏览器
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媒体类型
返回
无
举例
（"","{"name":
"/mnt/hd/逃亡鳄鱼岛.avi","type":
"0"}"）
语法
（"Media.Pause","<参数json串>"）
功能
写入媒体暂停路径及类型。
参数
属性名称
Name媒体路径
Type媒体类型
返回
无
举例
（"Media.Pause","{"name":
"/mnt/hd/逃亡鳄鱼岛.avi","type":
"0"}"）
语法
（"Media.Resume","<参数json串>"）
功能
写入媒体继续路径及类型。
参数
属性名称
Name媒体路径
Type媒体类型
返回
无
举例
（"Media.Resume","{"name":
"/mnt/hd/逃亡鳄鱼岛.avi","type":
"0"}"）
语法
（"Media.Position","<参数json串>"）
功能
写入媒体播放位置参数。
参数
属性名称
x媒体x坐标
y媒体y坐标
w媒体宽度
h媒体高度
返回
无
举例
（"Media.Position","{"x":
"0","y":
"0","w":
"1280","h":
"720"}"）
语法
（"Media.Position"）
功能
读取媒体播放位置参数。
参数
无
返回
Json串
举例
返回JSON串：
{"x":
"0","y":
"0","w":
"1280","h":
"720"}
语法
iPanel.ioctlWrite（"Media.Stop","<参数json串>"）
功能
写入媒体播放停止路径及类型。
参数
属性名称
Name媒体路径
Type媒体类型
返回
无
举例
（"Media.Stop","{"name":
"/mnt/hd/逃亡鳄鱼岛.avi","type":
"0"}"）
语法
iPanel.ioctlWrite（"Media.Forward","<参数json串>"）
功能
写入媒体播放快进模式及类型。
参数
属性名称
Mode快进模式
Type媒体类型
返回
举例
（"Media.Forward","{"mode":
"8","type":
"0"}"）
语法
iPanel.ioctlWrite（"Media.Rewind","<参数json串>"）
功能
写入媒体播放快退模式及类型。
参数
属性名称
Mode快退模式
Type媒体类型
返回
举例
（"Media.Forward","{"mode":
"8","type":
"0"}"）
语法
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","/mnt/hd/逃亡鳄鱼岛.avi"）
语法
iPanel.ioctlRead（"Media.GetBook,Name"）
功能
读取媒体订购信息。
参数
属性名称
Name媒体名称
Count媒体总份数
Price媒体总资费（元）
返回
Json串
举例
{"name":
"/mnt/hd/逃亡鳄鱼岛.avi","count":
"2","price":
""}
语法
iPanel.ioctlRead（"Media.GetCurrentDownFile"）
功能
读取下载媒体信息。
参数
属性名称
Name媒体名称
Size媒体大小
Speed下载速度
Percent下载百分比
DownedSize已下载大小
Status下载状态
返回
Json串
举例
{"name":
"/mnt/hd/逃亡鳄鱼岛.avi","size":
"6KB","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/逃亡鳄鱼岛","singer":
"刘德华","currentPlayTime":
"00:
00:
32","duration":
"0:
01:
00",
"loopMode":
"全循环","videoOutput":
"sVideo","other":
"16:
9字幕:
无双声道"
};
语法
iPanel.ioctlRead（"Media.GetNextFileInfo,path"）
path当前媒体路径
功能
读取子集中下一个媒体信息，以便播放。
没有子集返回空
参数
属性名称
Name媒体名称
singer演唱者
currentPlayTime当前播放时间
during媒体时长
loopMode循环模式
videoOutput视频输出
other其他信息
返回
Json串
举例
{"name":
"/mnt/hd/逃亡鳄鱼岛","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；2->gif
语法
iPanel.ioctlRead（",MenuIndex,currentFileIndex,usb"）
MenuIndex：
菜单索引如1，2，3，
currentFileIndex：
当前文件索引如1，2，3，
usb：
外置移动硬盘还是内置硬盘
功能
读取指定类型,指定链表位置的文件列表。
参数
属性名称
Name媒体名称
返回
Json串
举例
{"/mnt/hd/逃亡鳄鱼岛.avi","/mnt/hd/逃亡.avi"}
语法
iPanel.ioctlRead（",path"）
path：
文件路径如/mnt/hd/逃亡.avi
功能
获取下载完成的子集我的专区电视剧。
参数
属性名称
path文件路径
返回
json
举例
[{'no':
'1','name':
'/mnt/hd/放牛班的春天'},
{'no':
'2','name':
'/mnt/hd/放牛班的春天'}
];
语法
iPanel.ioctlRead（",MenuIndex,fileLength,usb"）
MenuIndex：
菜单索引如1，2，3
usb：
外置移动硬盘还是内置硬盘
功能
读取指定类型的媒体的总数量。
参数
属性名称
length文件长度
返回
String
举例
12
语法
iPanel.ioctlRead（"local.menuItems"）
功能
读取菜单。
*【电视剧场】1
*【我的影视】2
*【家庭院线】3
*【我的专区】4
*【信息空间】5，
*【热门推荐】6，
*【帮助】7，帮助模块中的3个子模块（下载状态、帮助、设置）可分别控制
*【移动信息】8，
当关闭外置节目播放时，移动信息中不显示外置节目
当关闭外置文件播放时，移动信息中不显示外置文件
当终端未登录服务器时，移动信息中不显示外置文件
*【动听世界】9，
*【自定义模块A】，
*【自定义模块B】，
*【自定义模块C】，
*【自定义模块D】
升级会员 