案卷號接口文檔

日期2011-07-22

研發平臺軟件項目

軟件項目接口文檔

作者：_____________________________

完成日期：____________________

簽收人：________________________________________

簽收日期；________________________________________

修改情況記錄:

版本號修改批準人修改人安裝日期簽收人

目錄

第1章引言錯誤!未定義書簽。

編寫目的錯誤!未定義書簽。

術語錯誤!未定義書簽。

參考文獻錯誤!未定義書簽。

第2章接口定義錯誤!未定義書簽。

同步接口指令錯誤!未定義書簽。

引言

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同步接口指令

媒體播控

媒體類型約定：o-＞電影；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媒體類型

返

回

/I1?l1〃〃[〃1〃〃C〃〃,〃〃八〃]〃\

舉(Media.Forward,{mode:8,type:0))

例

語iPanel.ioctlWrite("Media.Rewind”,〃〈參數json串＞〃)

法

功寫入媒體播放快退模式及類型。

能

參屬性名稱

數Mode快退模式

Type媒體類型

返

回

舉(Media,forward,tmode:8,type:0})

例

語iPanel.ioctlRead("Media,GetVolume")

法

功讀取媒體播放音量。

能

參無

數

返String

回

舉20

例

語iPanel.ioctlRead("getMemoryltem")

法

功獲取記憶的功能導航。

能

參無

數

返String

回

舉20

例

語iPanel.ioctlWrite(/，setMemoryItem?,,index)

法

功設置記憶的功能導航。

能

參無

數

返無

回

舉

例

語iPanel.ioctlRead(Z/Media.GetMute〃)

法

功讀取媒體播放靜音設置。

能

參無

數

返String

回

舉0

例

語iPanel.ioctlWrite(/zMedia.SetBook”,〃〈參數String〉”)

法

功寫入媒體訂購信息。

能

參屬性名稱

數Name媒體名稱

返返回0k或者失敗信息（資費不夠等）

回

舉("Media.SetBook〃，"/mnt/hd/逃亡鱷魚島.avi〃)

例

語iPanel.ioctlRead("Media.GetBook,Namez，)

法

功讀取媒體訂購信息。

能

參屬性名稱

數Name媒體名稱

Count媒體總份數

Price媒體總資費（元）

返Json串

回

舉{“name〃：〃/mnt/hd/逃亡鱷魚島.avi

〃〃」〃〃〃〃〃〃〃

例,count:c2,pri?ce:)]

語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.GetFilelnfo,path")

法path當前媒體路徑

功讀取媒體信息。

能

參屬性名稱

數Name媒體名稱

singer演唱者

currentPlayTime當前播放時間

during媒體時長

loopMode循環模式

videoOutput視頻輸出

other其他信息

返Json串

回

舉{〃name〃：〃/nrnt/hd/逃亡鱷魚島〃，〃singer〃：〃劉德華〃，

例^currentPlayTime^:“00:00:32〃，“duration":"0:01:00”,

“loopMode”:〃全循環〃，"videoOutput":"sVideo〃，

“other〃：〃16:9字幕：無雙聲道〃

)；

語iPanel.ioctlRead(''Media.GetNextFilelnfo,path")

法path當前媒體路徑

功讀取子集中下一個媒體信息，以便播放。沒有子集返回空

能

參屬性名稱

數Name媒體名稱

singer演唱者

currentPlayTime當前播放時間

during媒體時長

loopMode循環模式

videoOutput視頻輸出

other其他信息

返Json串

回

舉{〃name〃：〃/mnt/hd/逃亡鱷魚島〃，"singer〃：〃劉德華〃,

例z，currentPlayTime，z:z，00:00:32z，,“duration":"0:01:00”,

“loopMode”:〃全循環〃，"videoOutput":"sVideo〃，

“other〃：〃16:9字幕：無雙聲道〃

)；

媒體類型約定:0-＞電影；1-＞音樂；2-＞圖片

電影風格類型約定：0-＞劇情片；1-＞喜劇片；2-＞恐怖片；3-＞科幻片

音樂風格類型約定：0-＞流行；1-＞古典；2-＞民歌；3-＞港臺

圖片容器格式約定:0-＞jpg；l-＞png；2-＞gif

語iPanel.ioctlRead(〃，Menulndex,currentFilelndex,usb〃)

法Menuindex：菜單索引如1,2,3,

currentFilelndex：當前文件索引如1,2,3,

usb：外置移動硬盤還是內置硬盤

功讀取指定類型,指定鏈表位置的文件列表。

能

參屬性名稱

數Name媒體名稱

返Json串

回

舉{〃/mnt/hd/逃亡鱷魚島.avi〃，〃/mnt/hd/逃亡.avi”}

例

語iPanel.ioctiRead(〃，path")

法path：文件路徑如/mnt/hd/逃亡.avi

功獲取下載完成的子集我的專區電視劇。

能

參屬性名稱

數path文件路徑

返json

回

舉[{'n。'：T',"網啟：'/mn以hd/放牛班的春天'},

例{‘no':'2','name':'/mnt/hd/放牛班的春天’}

]；

語iPanel.ioctlRead(z/,Menuindex,fileLength,usb〃)

法Menuindex：菜單索引如L2,3

usb：外置移動硬盤還是內置硬盤

功讀取指定類型的媒體的總數量。

能

參屬性名稱

數length文件長度

返String

回

舉12

例

語iPanel.ioctlRead(''local,menuIterns〃)

法

功讀取菜單。

*【電視劇場】

能i

*【我的影視】2

*【家庭院線】3

*【我的專區】4

*【信息空間】5,

*【熱門推薦】6,

*【幫助】7,幫助模塊中的3個子模塊（下載狀態、幫助、設置）可分別控制

*【移動信息】8,

當關閉外置節目播放時，移動信息中不顯示外置節目

當關閉外置文件播放時，移動信息中不顯示外置文件

當終端未登錄服務器時，移動信息中不顯示外置文件

*【動聽世界】9,

*【自定義模塊A】，

*【自定義模塊B】，

*【自定義模塊G,

*【自定義模塊D】，

*【自定義模塊E】

參

數

返json

回

「〃C〃〃、八〃〃1〃〃c〃〃C〃〃4〃〃L〃〃八〃〃“〃〃C〃1

舉L9,10,1,2,3,4,5,6,7,8」

例

SPDIF輸出編碼方式約定:0-＞PCM編碼；1-＞數字編碼

聲道輸出方式約定:0-＞雙聲道；1-＞聲道

視頻高清(HDMI)輸出方式約定:0-＞1080i；l-＞1080p；2-＞720p

視頻標清輸出方式約定:0-＞AV

視頻高清Ypbpr輸出方式約定：0-＞1080i；l-＞1080p；2-＞720p

電視輸出標準約定：0-＞NTSC；1-＞PAL

電視比例約定:0-＞4:3；1-＞16:9

網絡狀態約定：0-＞網絡斷開；1-＞網絡連接；2-＞網絡不存在

磁盤管理方式約定:0-＞本地磁盤格式化；1-＞移動磁盤格式化；2-＞磁盤整

理

下載路徑方式約定:0-＞移動硬盤；內置硬盤

字體大小方式約定：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-＞出廠設置；「〉版本升級；2-＞版本信息；3-＞網

絡狀態查詢；

軟鍵盤開關約定：0-＞打開；1-＞關閉

網絡狀態約定：

varNetWorkStatusMode=[

{ERROR:0,name:'網絡連接異常請檢查連接'，setname:〃網絡連接異

常請檢查連接〃，icon:〃red〃},

{CONNECTING:1,name:'正在連接'，setname:〃與服務器正在連接〃，

icon:〃orange〃},

{SUCCESS:2,name:'連接成功正在登錄’，setname:〃與服務器連接

成功，正在登錄〃，icon:"orange"},

{NORMAL:3,name:'網絡連接正常’，setname:〃網絡連接正常〃，icon:

green),

{WERROR:4,name:'無線網絡連接異常請檢查連接'，setname:〃無線

網絡連接異常請檢查連接〃，icon:"red"),

{WCONNECTING:5,name:'無線正在連接',setname:〃無線與服務器

正在連接〃，icon:"orange"},

{WSUCCESS:6,name:'無線連接成功正在登錄‘，setname:〃無線與

服務器連接成功正在登錄〃，icon:，，orange，/),

(WNORMAL:7,name:'無線網絡連接正常’，setname:〃無線網絡連接

正常〃，icon:"green”}

］；

賬戶登錄模式約定：

varNetworkSetMode={

DYNAMIC:0,

ioctlWrite("System.SetAudioSPDIFOutPut”,〃〈參數

String串＞〃)

功寫入系統音頻SPDIF配置信息。

能

參屬性名稱

數SPDIFspdif輸出

返無

回

舉("System.SetAudioSPDIFOutPut〃，〃0〃)

例

語iPanel.ioctlRead("System.GetAudioSPDIFOutPut，/)

法

功讀取系統音頻SPDIF配置信息。

能

參屬性名稱

數SPDIFspdif輸出

返String

回

舉〃0〃

例

語iPanel.ioctlWrite(''System.SetAudioChanelOutPut，/,/z<

法參數String串〉〃)

功寫入系統音頻Chanel配置信息。

能

參屬性名稱

數Chanel聲道輸出

返無

回

舉("System.SetAudioChanelOutPut〃，〃0〃)

例

語iPanel.ioctlRead("System,GetAudioChanelOutPut，/)

法

功讀取系統音頻Chanel配置信息。

能

參無

數

返String

回

舉〃0〃

例

語iPanel.ioctlWrite("System.SetVideoHDMIOutPut”,〃〈參

法數String〉”)

功寫入系統視頻高清配置信息。

能

參屬性名稱

數video視頻輸出模式

返無

回

舉("System.SetVideoHDMIOutPut〃，〃0〃)

例

語iPanel.ioctlRead("System.GetVideoHDMIOutPut")

法

功讀取系統視頻高清配置信息。

能

參屬性名稱

數video音頻輸出模式

返String

回

舉0

例

語iPanel.ioctlWrite("System.SetVideoSDOutPut",“〈參數

法String〉〃)

功寫入系統視頻標清配置信息。

能

參屬性名稱

數video視頻輸出模式

返無

回

舉("System.SetVideoSDOutPut〃，〃0〃)

例

語iPanel.ioctlRead("System.GetVideoSDOutPut")

法

功讀取系統視頻標清配置信息。

能

參無

數

返String

回

舉0

例

語iPanel.ioctlWrite(''System.SetVideoYpbprOutPut，z,，z<

法參數String>〃)

功寫入系統視頻高清Ypbpr配置信息。

能

參屬性名稱

數video視頻輸出模式

返無

回

舉("System.SetVideoYpbprOutPut”,〃0〃)

例

語iPanel.ioctlRead("System，GetVideoYpbprOutPut，/)

法

功讀取系統視頻高清Ypbpr配置信息。

能

參無

數

返String

回

舉0

例

語iPanel.ioctlWrite(〃〃，〃〈參數String》”)

法

功寫入系統初始電視標準配置信息。

能

參屬性名稱

數System電視標準

返無

回

舉(〃〃,〃0〃)

例

語iPanel.ioctlRead(〃〃)

法

功讀取系統初始電視標準配置信息。

能

參

數

返String

回

舉0

例

語iPanel.ioctlWrite(〃〃，〃〈參數String>")

法

功寫入系統初始電視比例配置信息。

能

參屬性名稱

數Scale電視比例

返無

回

舉(〃-0〃)

例

語iPanel.ioctlRead(〃〃)

法

功寫入系統初始電視比例配置信息。

能

參無

數

返String

回

舉0

例

語iPanel.ioctlWrite(〃〃，〃〈參數String>")

法

功寫入系統初始當前網絡設置模式。

能

參屬性名稱

數Mode設置模式

返無

回

舉("System.SetNetworkMode〃，〃0〃)

例

語iPanel.ioctlRead("System，GetNetworkMode，/)

法

功讀取系統初始網絡設置模式。

能

參無

數

返String

回

舉0

例

語iPanel.ioctlWrite(〃〃，〃〈參數String>")

法

功寫入系統初始當前網絡設置模式。

能

參屬性名稱

數Mode設置模式

返無

回

舉("System.SetSoftWareQueryMode/z,zz0zz)

例

語iPanel.ioctlRead("System，GetSoftWareQueryMode/z)

法

功讀取系統初始網絡動態配置信息。

能

參無

數

返String

回

舉0

例

語iPanel.ioctlWrite(〃〃,〃〃)

法

功寫入系統初始網絡動態配置信息。

能

參無

數

返String（0成功1失敗）

回

(〃〃〃〃)

舉

例

語iPanel.ioctlRead(〃〃)

法

功讀取系統初始網絡動態配置信息。

能

參無

數

返String

回

舉

例

語iPanel.ioctlWrite(〃〃，〃〈參數json串＞〃)

法

功寫入系統初始網絡靜態配置信息。

能

參屬性名稱

數IPip地址

Maskmask地址

Gatewaygateway地址

DnsIPdnsip地址

返無

回

/〃〃〃(?〃?〃〃〃〃1〃〃〃〃〃〃〃

舉(,{ip:,mask:,gateway:,

例dns:1)

語iPanel.ioctlRead(〃〃)

法

功讀取系統初始網絡靜態配置信息。

能

參無

數

返json串

回

「〃?〃〃〃〃1〃〃〃〃.〃〃〃

舉{ip:,mask:,gateway:,

例dns:)

語iPanel.ioctlWrite(〃〃，〃〈參數json串＞〃)

法

功寫入系統初始網絡ADSL賬戶配置信息。

能

參屬性名稱

數Name用戶名

Password密碼

返無

回

舉(〃〃,〃{“name〃:〃tony","password”:〃tu84556〃}〃)

例

語iPanel.ioctlRead(〃〃)

法

功讀取系統初始網絡ADSL賬戶配置信息。

能

參無

數

返json串

回

舉{"name":〃tony〃，“password”:〃tu84556〃}

例

語iPanel.ioctlWrite(〃〃,〃〃)

法

功寫入系統初始軟件恢復出廠配置信息。

能

參無

數

返無

回

(〃〃〃〃)

舉

例

語iPanel.ioctlWrite（"〃,”＜參數String〉”）

法

功寫入版本升級指令。

能

參無

數

返無

回

舉（〃〃,〃一〃）

例

語iPanel.ioctlRead（〃〃）

法

功讀取版本升級指令信息。

能

參無

數

返String

回

〃〃

舉

例

語iPanel.ioctlRead(〃〃)

法

功讀取系統初始軟件版本信息。

能

參無

數

返json串

回

.?〃〃?]〃〃〃〃?

舉tTiinctionver:jxhy,pagpver:jxp2()()4,

例vedioout:svedio,vedioscale:4:3,

“localvolumn〃:〃109GB〃,“localremainvolumn〃:〃20GB〃，

〃mobilevolumn”:〃200GB”,〃mobileremainvolunm〃：〃40GB〃}

語iPanel.ioctiWrite(''System.SetVersion〃，〃〈參數json

法串＞〃)

功讀取系統初始軟件版本信息。

能

參屬性名稱

數FunctionVer功能版本

PageVer爽面版本

VedioOut輸出設置

VedioScale視頻比例

LocalVolumn本地磁盤容量

LocalRemainVolumn本地磁盤剩余容量

MobileVolumn移動磁盤容量

MobileRemainVolumn移動磁盤剩余容量

返無

回

/〃〃〃.?〃〃?1〃〃〃〃?八/〃

舉(,{functionver:jxhy,pagever:jxp2004,

例/Zvedioout1〃:〃sved1io?〃,〃ved[i?oscal1e〃:〃44:C3〃,

，，localvolumn，/:〃109GB”,〃localremainvolunm〃:〃20GB〃，

“niobilevolumn”:〃200GB〃,〃mobilereniainvolunin〃:〃40GB〃}〃)

語iPanel.ioctlRead(〃〃)

法

功讀取系統初始軟件網絡狀態信息。

能

參無

數

返Json串

回

舉{“status”:〃0〃,“method〃:〃1〃,〃macaddress〃：

例〃00-25-5E-FF-27-48〃，〃currentip〃：〃〃}

語iPanel.ioctlWrite（〃〃，〃〈參數Json串＞〃）

法

功寫入系統初始軟件網絡狀態信息。

能

參屬性名稱

數Statuas網絡狀態

method登錄方式

macaddressmac地址

currentip當前ip

返無

回

（〃〃,〃0〃）

舉

例

語iPanel.ioctlWrite（〃〃，〃〈參數String》”）

法

功寫入系統初始磁盤管理配置信息。

能

參屬性名稱

數Mode管理方式

返無

回

舉(〃〃,〃0〃)

例

語iPanel.ioctlRead(〃〃)

法

功讀取系統初始磁盤管理配置信息。

能

參無

數

返String

回

舉0

例

語iPanel.ioctlWrite(〃〃，“〈參數json串＞〃)

法

功寫入系統初始賬號配置信息。

能

參屬性名稱

數Name用戶名

Password密碼

IPIP

返無

回

舉(〃〃,〃{"name":〃tony","password”:〃tu84556〃，

〃?〃〃〃〃.〃〃〃1〃\

例ipname:,ip:1)

語iPanel.ioctlRead(〃〃)

法

功讀取系統初始賬號配置信息。

能

參無

數

返Json串

回

舉{"name":〃tony〃,“password”:〃tu84556〃，

例“inputmode”:〃0〃,〃ipfamilyselected,，:{“ipname〃:〃北京建

新〃，〃ip〃：〃"},"ipfamily〃：[{"ipname〃：〃中國電信

〃，〃ip〃:〃〃},{"ipname":〃中國聯通〃，〃ip〃：〃〃}]}

語iPanel.ioctlWrite(〃〃，〃〈參數String〉”)

法

功寫入系統初始下載路徑配置信息。

能

參屬性名稱

數Mode路徑模式

返無

回

舉(〃〃,〃0〃)

例

語iPanel.ioctlRead(''System.GetDownPath/z)

法

功讀取系統初始下載路徑配置信息。

能

參無

數

返String

回

舉0

例

語iPanel.ioctlWrite(〃〃，〃〈參數String)”)

法

功寫入系統初始字幕大小配置信息。

能

參屬性名稱

數Mode大小方式

返無

回

舉(〃〃,〃0〃)

例

語iPanel.ioctlRead(〃〃)

法

功讀取系統初始字幕大小配置信息。

能

參無

數

返String

回

舉0

例

語iPanel.ioctlWrite(〃〃，〃〈參數String)”)

法

功寫入系統初始字幕顏色配置信息。

能

參屬性名稱

數Mode顏色方式

返無

回

舉(〃〃,〃0〃)

例

語iPanel.ioctlRead(〃〃，〃〈參數String》”)

法

功讀取系統初始字幕顏色配置信息。

能

參無

數

返String

回

舉0

例

語iPanel.ioctlRead(〃〃)

法

功讀取系統主界面導航菜單配置信息。

能

參無

數

返String數組

回

舉/0〃,〃]〃,”〃[

例

語iPanel.ioctlWrite"〈參數String>”)

法

功寫入軟鍵盤開關指令。

能

參屬性