軟件接口文檔

1、案卷號(hào)接口文檔日期2011-07-22研發(fā)平臺(tái)軟件項(xiàng)目軟件項(xiàng)目接口文檔作者：完成日期：簽收人：簽收日期：修改情況記錄：錯(cuò)誤!未定義書(shū)簽。錯(cuò)誤錯(cuò)誤!未定義書(shū)簽。錯(cuò)誤!未定義書(shū)簽。錯(cuò)誤!未定義書(shū)簽。錯(cuò)誤!未定義書(shū)簽。錯(cuò)誤!未定義書(shū)簽。錯(cuò)誤!未定義書(shū)簽。目錄第1章引言編寫(xiě)目的術(shù)語(yǔ)參考文獻(xiàn)第2章接口定義同步接口指令引言編寫(xiě)目的說(shuō)明對(duì)程序系統(tǒng)的接口設(shè)計(jì)、數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)等，為開(kāi)發(fā)編碼奠定基礎(chǔ)。本文檔描述本地UI軟件的JavaScript代碼和STB瀏覽器組件庫(kù)iPanel之間的交互接口，包括請(qǐng)求的格式，請(qǐng)求結(jié)果的格式，相關(guān)錯(cuò)誤的定義，以及請(qǐng)求和結(jié)果返回的交互流程。本文的主要讀者為需要系統(tǒng)前端開(kāi)發(fā)人員、STB

2、開(kāi)發(fā)人員，以及需要了解本前端與STB接口的相關(guān)人員。術(shù)語(yǔ)術(shù)語(yǔ)或縮寫(xiě)詞說(shuō)明性定義IPTV交互式網(wǎng)絡(luò)電視STB機(jī)頂盒HTML超文本置標(biāo)語(yǔ)言JavaScript一種應(yīng)用于客戶端Web開(kāi)發(fā)的腳本語(yǔ)言CSS層疊樣式表DOM文檔對(duì)象模型JSON專門為瀏覽器中的網(wǎng)頁(yè)上運(yùn)行的JavaScript代碼而設(shè)計(jì)的一種數(shù)據(jù)格式XML可擴(kuò)展置標(biāo)語(yǔ)言iPanelIPTV終端瀏覽器參考文獻(xiàn)序號(hào)資料名文件編號(hào)發(fā)表日期出版單位第2章接口定義本軟件頁(yè)面與底層交互采用iPanel擴(kuò)展的ioctlRead/Write方式進(jìn)行，數(shù)據(jù)交換采用json字符串/String方式。2.1同步接口指令媒體播控媒體類型約定:0-電影；1-音樂(lè)；2

3、-圖片；3-文本靜音模式約定:0-關(guān)閉（off）；1-打開(kāi)（on）視頻類型約定:0-高清；1-標(biāo)清；2-普通；3-片花；語(yǔ)法（,參數(shù)飛?？诖┕δ軐?xiě)入媒體播放路徑及類型。參數(shù)屬性名稱Name媒體路徑Type媒體類型返回?zé)o舉例（,name:/mnt/hd/逃亡鱷魚(yú)島.avi,type:0）語(yǔ)法(Media.Pause,(參數(shù)json串)功能寫(xiě)入媒體暫停路徑及類型。參數(shù)屬性名稱Name媒體路徑Type媒體類型返回?zé)o舉例(Media.Pause,rtr二4-.八島.avi,type:0name-/mnt/hd/逃亡鱷魚(yú))語(yǔ)法(Media.Resume,(參數(shù)json串)功能寫(xiě)入媒體繼續(xù)路徑及類型。參

4、數(shù)屬性名稱Name媒體路徑Type媒體類型返回?zé)o舉(Media.Resume,nameJ,/mnt/hd/逃亡鱷魚(yú)例島.avi,type:0J)語(yǔ)法(Media.Position,(參數(shù)json串)功能寫(xiě)入媒體播放位置參數(shù)。參數(shù)屬性名稱x媒體x坐標(biāo)y媒體y坐標(biāo)w媒體寬度h媒體高度返回?zé)o舉例(Media.Position,x:0,y:0,w:1280,h:720)語(yǔ)法(Media.Position)功能讀取媒體播放位置參數(shù)。參數(shù)無(wú)返回Json串舉例返回JSON串：彳：x：0，y：0，w：1280，h：720語(yǔ)法iPanel.ioctlWrite(Media.Stop”,“(參數(shù)json串)功能寫(xiě)

5、入媒體播放停止路徑及類型。參數(shù)屬性名稱Name媒體路徑Type媒體類型返回?zé)o舉例(Media.Stop,rtr-二4-八.八島.avi,type:0name：/mnt/hd/逃亡鱷魚(yú))語(yǔ)法iPanel.ioctlWrite(Media.Forward”,“(參數(shù)json串”)功能寫(xiě)入媒體播放快進(jìn)模式及類型。參屬性名稱數(shù)Mode快進(jìn)模式Type媒體類型返回舉例(Media.Forward,，1Q,八Lmode:8,type:0jJ)語(yǔ)法iPanel.ioctlWrite(Media.Rewind,“(參數(shù)json串)功能寫(xiě)入媒體播放快退模式及類型。參數(shù)屬性名稱Mode快退模式Type媒體類型返回

6、舉例(Media.Forward,，1Q,八Lmode:8,type:0jJ)語(yǔ)法iPanel.ioctlRead(Media.GetVolume)功讀取媒體播放音量。能參數(shù)無(wú)返回String舉例20語(yǔ)法iPanel.ioctlRead(getMemoryltem”)功能獲取記憶的功能導(dǎo)航。參數(shù)無(wú)返回String舉例20語(yǔ)法iPanel.ioctlWrite(setMemoryItem”，index)功設(shè)置記憶的功能導(dǎo)航。能參數(shù)無(wú)返回?zé)o舉例語(yǔ)法iPanel.ioctlRead(Media.GetMute)功能讀取媒體播放靜音設(shè)置。參數(shù)無(wú)返回String舉例0語(yǔ)法iPanel.ioctlWrit

7、e(Media.SetBook,(參數(shù)String)功寫(xiě)入媒體訂購(gòu)信息。能參數(shù)屬性名稱Name媒體名稱返回返回仙或者失敗信息（資費(fèi)不夠等）舉例(Media.SetBook,/mnt/hd/逃亡鱷魚(yú)島.avi)語(yǔ)法iPanel.ioctlRead(Media.GetBook,Name)功能讀取媒體訂購(gòu)信息。參數(shù)屬性名稱Name媒體名稱Count媒體總份數(shù)Price媒體總資費(fèi)（元）返回Json串舉例name:/mnt/hd/逃亡鱷魚(yú)島.avi,count:2,price:語(yǔ)iPanel.ioctlRead(Media.GetCurrentDownFile)法功能讀取下載媒體信息。參數(shù)屬性NameS

8、izeSpeedPercentDownedSizeStatus名稱媒體名稱媒體大小下載速度下載百分比已下載大小下載狀態(tài)返回Json串舉例name:/mnt/hd/逃亡鱷魚(yú)島.avi,size:6KB,speed:538KB/S,downedsize:34567KB,status,percent:15%:正在下載語(yǔ)法iPanel.ioctlRead(Media.path當(dāng)前媒體路徑GetFileInfo,path)功能讀取媒體信息。參數(shù)屬性Name名稱媒體名稱singer演唱者currentPlayTime當(dāng)前播放時(shí)間during媒體時(shí)長(zhǎng)loopMode循環(huán)模式videoOutput視頻輸出ot

9、her其他信息返回Json串舉例name:/mnt/hd/逃亡鱷魚(yú)島，singer:劉德華，currentPlayTime:00:00:32,duration:0:01:00,loopMode:全循環(huán),videoOutput:sVideo,other:16:9字幕:無(wú)雙聲道;語(yǔ)法iPanel.ioctlRead(Media.GetNextFileInfo,path)path當(dāng)前媒體路徑功能讀取子集中下一個(gè)媒體信息，以便播放。沒(méi)有子集返回空參數(shù)屬性名稱Name媒體名稱singer演唱者currentPlayTime當(dāng)前播放時(shí)間during媒體時(shí)長(zhǎng)loopMode循環(huán)模式videoOutput視頻

10、輸出other其他信息返回Json串舉例name:/mnt/hd/逃亡鱷魚(yú)島，singer:劉德華，currentPlayTime:00:00:32,duration:0:01:00,loopMode:全循環(huán),videoOutput:sVideo,other:16:9字幕:無(wú)雙聲道;媒體類型約定：0-電影；1-音樂(lè)；2-圖片電影風(fēng)格類型約定：0-劇情片；1-喜劇片；2-恐怖片；3-科幻片音樂(lè)風(fēng)格類型約定：0-流行；1-古典；2-民歌；3-港臺(tái)圖片容器格式約定：0-jpg；1-png；2-gif語(yǔ)法iPanel.ioctlRead(,MenuIndex,currentFileIndex,usb)

11、MenuIndex：菜單索引如1，2，3,currentFileIndex：當(dāng)前文件索引如1，2，3，usb：外置移動(dòng)硬盤還是內(nèi)置硬盤功能讀取指定類型，指定鏈表位置的文件列表。參數(shù)屬性名稱Name媒體名稱返回Json串舉例/mnt/hd/逃亡鱷魚(yú)島.avi,/mnt/hd/逃亡.avi“語(yǔ)法iPanel.ioctlRead(,path)path：文件路徑如/mnt/hd/逃亡.avi功能獲取下載完成的子集我的專區(qū)電視劇。參數(shù)屬性名稱path文件路徑返回json舉例no:1,name:/mnt/hd/放牛班的春天,no:2,name:/mnt/hd/放牛班的春天；語(yǔ)iPanel.ioctlRea

12、d(,MenuIndex,fileLength,usb)法Menuindex：菜單索引如1,2,3usb：外置移動(dòng)硬盤還是內(nèi)置硬盤功能讀取指定類型的媒體的總數(shù)量。參數(shù)屬性名稱length文件長(zhǎng)度返回String舉例12語(yǔ)法iPanel.ioctlRead(local.menuitems)功能讀取菜單?！倦娨晞?chǎng)】i【我的影視】2【家庭院線】3【我的專區(qū)】4【信息空間】5,【熱門推薦】6,【幫助】7,幫助模塊中的3個(gè)子模塊（下載狀態(tài)、幫助、設(shè)置）可分別控制【移動(dòng)信息】8,當(dāng)關(guān)閉外置節(jié)目播放時(shí)，移動(dòng)信息中不顯示外置節(jié)目當(dāng)關(guān)閉外置文件播放時(shí)，移動(dòng)信息中不顯示外置文件當(dāng)終端未登錄服務(wù)器時(shí)，移動(dòng)信息中不

13、顯示外置文件【動(dòng)聽(tīng)世界】9,【自定義模塊A】，【自定義模塊B】，*【自定義模塊C】，*【自定義模塊D】，*【自定義模塊E】參數(shù)返回json舉例9,10,1,2,3,4,5,6,7,8SPDIF輸出編碼方式約定:0-PCM編碼；1-數(shù)字編碼聲道輸出方式約定：0-雙聲道；1-聲道視頻高清（HDMI）輸出方式約定：0-1080i;1-1080p；2-720p視頻標(biāo)清輸出方式約定:0-AV視頻高清Ypbpr輸出方式約定：0-1080i；1-1080p；2-720p電視輸出標(biāo)準(zhǔn)約定:0-NTSC；1-PAL電視比例約定：0-4:3；1-16:9網(wǎng)絡(luò)狀態(tài)約定:0-網(wǎng)絡(luò)斷開(kāi)；1-網(wǎng)絡(luò)連接；2-網(wǎng)絡(luò)不存在磁盤

14、管理方式約定:0-本地磁盤格式化；1-移動(dòng)磁盤格式化；2-磁盤整理下載路徑方式約定:0-移動(dòng)硬盤；1-內(nèi)置硬盤字體大小方式約定:0-大字體；1-中字體；2-小字體；字體顏色方式約定：0-紅；1-橙；2-黃；3-綠；4-青；5-藍(lán)；6-紫；7-白；網(wǎng)絡(luò)設(shè)置模式方式約定：0-WIFI搜索；1WIFI靜態(tài)配置；2WIFI動(dòng)態(tài)配置；3動(dòng)態(tài);4-靜態(tài);5-adsl賬戶;6-adsl登錄;7-adsl離線；軟件查詢模式方式約定：0-出廠設(shè)置；1-版本升級(jí)；2-版本信息；3-網(wǎng)絡(luò)狀態(tài)查詢；軟鍵盤開(kāi)關(guān)約定：0-打開(kāi)；1-關(guān)閉網(wǎng)絡(luò)狀態(tài)約定：varNetWorkStatusMode=ERROR:0,name:網(wǎng)絡(luò)

15、連接異常請(qǐng)檢查連接，setname:網(wǎng)絡(luò)連接異常請(qǐng)檢查連接，icon:red,CONNECTING:1,name:正在連接，setname:與服務(wù)器正在連接，icon:orange,SUCCESS:2,name:連接成功正在登錄，setname:與服務(wù)器連接成功,正在登錄，icon:orange,NORMAL:3,name:網(wǎng)絡(luò)連接正常，setname:網(wǎng)絡(luò)連接正常，icon:green,W_ERROR:4,name:無(wú)線網(wǎng)絡(luò)連接異常請(qǐng)檢查連接，setname:無(wú)線網(wǎng)絡(luò)連接異常請(qǐng)檢查連接，icon:red,W_CONNECTING:5,name:無(wú)線正在連接，setname:無(wú)線與服務(wù)器正在連

16、接，icon:orange,W_SUCCESS:6,name:無(wú)線連接成功正在登錄，setname:無(wú)線與服務(wù)器連接成功正在登錄，icon:orange,W_NORMAL:7,name:無(wú)線網(wǎng)絡(luò)連接正常，setname:無(wú)線網(wǎng)絡(luò)連接正?！?，icon:green;賬戶登錄模式約定：varNetworkSetMode=DYNAMIC:0,ioctlWrite(System.SetAudioSPDIFOutPut,(參數(shù)String串)功能寫(xiě)入系統(tǒng)音頻SPDIF配置信息。參數(shù)屬性名稱SPDIFspdif輸出返回?zé)o舉例(System.SetAudioSPDIFOutPut,0)語(yǔ)法iPanel.ioc

17、tlRead(System.GetAudioSPDIFOutPut)功能讀取系統(tǒng)音頻SPDIF配置信息。參數(shù)屬性名稱SPDIFspdif輸出返回String舉例“0語(yǔ)法iPanel.ioctlWrite(System.SetAudioChanelOutPut,)功能寫(xiě)入系統(tǒng)音頻Chanel配置信息。參數(shù)屬性名稱Chanel聲道輸出返回?zé)o舉例(System.SetAudioChanelOutPut,0)語(yǔ)法iPanel.ioctlRead(System.GetAudioChanelOutPut)功能讀取系統(tǒng)音頻Chanel配置信息。參數(shù)無(wú)返回String舉例“0語(yǔ)法iPanel.ioctlWri

18、te(System.SetVideoHDMIOutPut,#數(shù)String)功能寫(xiě)入系統(tǒng)視頻高青配置信息。參數(shù)屬性名稱video視頻輸出模式返回?zé)o舉例(System.SetVideoHDMIOutPut,0)語(yǔ)法iPanel.ioctlRead(System.GetVideoHDMIOutPut)功能讀取系統(tǒng)視頻高清配置信息。參數(shù)屬性名稱video音頻輸出模式返回String舉例0語(yǔ)法iPanel.ioctlWrite(System.SetVideoSDOutPut”,“(參數(shù)String)功能寫(xiě)入系統(tǒng)視頻標(biāo)清配置信息。參數(shù)屬性名稱video視頻輸出模式返回?zé)o舉例(System.SetVide

19、oSDOutPut,0)語(yǔ)法iPanel.ioctlRead(System.GetVideoSDOutPut)功能讀取系統(tǒng)視頻標(biāo)清配置信息。參數(shù)無(wú)返回String舉例0語(yǔ)法iPanel.ioctlWrite(System.SetVideoYpbprOutPut,參數(shù)String)功能寫(xiě)入系統(tǒng)視頻高清Ypbpr配置信息。參數(shù)屬性名稱video視頻輸出模式返回?zé)o舉例(System.SetVideoYpbprOutPut,0)語(yǔ)法iPanel.ioctlRead(System.GetVideoYpbprOutPut)功能讀取系統(tǒng)視頻高清Ypbpr配置信息。參數(shù)無(wú)返回String舉例0語(yǔ)法iPanel.ioctlWrite(,(參數(shù)String)功能寫(xiě)入系統(tǒng)初始電視標(biāo)準(zhǔn)配置信息