軟件接口文檔v

``Word文檔Word文檔`Word文檔 案卷號案卷號接口文檔-V2.0日期2011-07-22研發(fā)平臺軟件項目軟件項目接口文檔作者：完成日期：簽收人：簽收日期：修改情況記錄：版本號版本號修改批準(zhǔn)人修改人安裝日期簽收人2.0``Word文檔Word文檔`Word文檔目錄第1章引言3TOC\o"1-1"\h\z\u\h1.1編寫目的 3\h1.2術(shù)語 3\h1.3參考文獻(xiàn) 3\h第2章接口定義 4\h2.1同步接口指令 4

引言1.1編寫目的說明對程序系統(tǒng)的接口設(shè)計、數(shù)據(jù)結(jié)構(gòu)設(shè)計等，為開發(fā)編碼奠定基礎(chǔ)。本文檔描述本地UI軟件的JavaScript代碼和STB瀏覽器組件庫iPanel之間的交互接口，包括請求的格式，請求結(jié)果的格式，相關(guān)錯誤的定義，以及請求和結(jié)果返回的交互流程。本文的主要讀者為需要系統(tǒng)前端開發(fā)人員、STB開發(fā)人員，以及需要了解本前端與STB接口的相關(guān)人員。1.2術(shù)語序號序號資料名文件編號發(fā)表日期出版單位IPTV交互式網(wǎng)絡(luò)電視STB機(jī)頂盒HTML超文本置標(biāo)語言JavaScript一種應(yīng)用于客戶端Web開發(fā)的腳本語言CSS層疊樣式表DOM文檔對象模型JSON專門為瀏覽器中的網(wǎng)頁上運行的JavaScript代碼而設(shè)計的一種數(shù)據(jù)格式XML可擴(kuò)展置標(biāo)語言iPanelIPTV終端瀏覽器1.3參考文獻(xiàn)第2章接口定義本軟件頁面與底層交互采用iPanel擴(kuò)展的ioctlRead/Write方式進(jìn)行，數(shù)據(jù)交換采用json字符串/String方式。2.1同步接口指令功能功能獲取記憶的功能導(dǎo)航。參數(shù)無返回String舉例20語法iPanel.ioctlWrite("setMemoryItem”,index)功能設(shè)置記憶的功能導(dǎo)航。參數(shù)無返回?zé)o舉例語法iPanel.ioctlRead("Media.GetMute")功能讀取媒體播放靜音設(shè)置。參數(shù)無返回String舉例0語法iPanel.ioctlWrite("Media.SetBook","<參數(shù)String>")功能寫入媒體訂購信息。參數(shù)屬性名稱Name媒體名稱返回返回ok或者失敗信息（資費不夠等）

]];語法iPanel.ioctlRead("FSO.GetFiles,MenuIndex,fileLength,usb")MenuIndex：菜單索引如1，2，3usb：外置移動硬盤還是置硬盤功能讀取指定類型的媒體的總數(shù)量。參數(shù)屬性名稱length文件長度返回String舉例12語法iPanel.ioctlRead("local.menuItems")功能讀取菜單。*【電視劇場】1*【我的影視】2*【家庭院線】3*【我的專區(qū)】4*【信息空間】5，*【熱門推薦】6，*【幫助】7，幫助模塊中的3個子模塊（下載狀態(tài)、幫助、設(shè)置）可分別控制*【移動信息】8，當(dāng)關(guān)閉外置節(jié)目播放時，移動信息中不顯示外置節(jié)目當(dāng)關(guān)閉外置文件播放時，移動信息中不顯示外置文件當(dāng)終端未登錄服務(wù)器時，移動信息中不顯示外置文件*【動聽世界】9，*【自定義模塊A】，*【自定義模塊B】，**【自定義模塊C】，*【自定義模塊D】，*【自定義模塊E】參數(shù)返回json舉例["9","10","1","2","3","4","5","6","7","8"]SPDIF輸出編碼方式約定:0->PCM編碼；1->數(shù)字編碼聲道輸出方式約定:0->雙聲道；1->5.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ò)斷開；1->網(wǎng)絡(luò)連接；2->網(wǎng)絡(luò)不存在磁盤管理方式約定:0->本地磁盤格式化；1->移動磁盤格式化；2->磁盤整理下載路徑方式約定:0->移動硬盤；1->置硬盤字體大小方式約定:0->大字體；1->中字體；2->小字體；字體顏色方式約定:0->紅；1->橙；2->黃；3->綠；4->青；5->藍(lán)；6->紫；7->白；網(wǎng)絡(luò)設(shè)置模式方式約定:0->WIFI搜索；1->WIFI靜態(tài)配置；2->WIFI動態(tài)配置；3->動態(tài)；4->靜態(tài)；5->adsl賬戶；6->adsl登錄；7->adsl離線；離線；軟件查詢模式方式約定:0->出廠設(shè)置；1->版本升級；2->版本信息；3->網(wǎng)絡(luò)狀態(tài)查詢；軟鍵盤開關(guān)約定:0->打開；1->關(guān)閉網(wǎng)絡(luò)狀態(tài)約定:varNetWorkStatusMode=[{ERROR:0,name:'網(wǎng)絡(luò)連接異常請檢查連接',setname:"網(wǎng)絡(luò)連接異常請檢查連接",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ǎng)絡(luò)連接異常請檢查連接',setname:"無線網(wǎng)絡(luò)連接異常請檢查連接",icon:"red"},{W_CONNECTING:5,name:'無線正在連接',setname:"無線與服務(wù)器正在連接",icon:"orange"},{W_SUCCESS:6,name:'無線連接成功正在登錄',setname:"無線與服務(wù)器連接成功正在登錄",icon:"orange"},{W_NORMAL:7,name:'無線網(wǎng)絡(luò)連接正常',setname:"無線網(wǎng)絡(luò)連接正常",icon:"green"}]];賬戶登錄模式約定:varNetworkSetMode={DYNAMIC:0,//動態(tài)配置STATIC:1,//靜態(tài)IPADSL_ACCOUNT:2,//ADSL賬戶ADSL_LOGIN:3,//ADSL登錄ADSL_OFFLINE:4,//ADSL離線WIFI_SEARCH:5,//無線網(wǎng)絡(luò)搜索WIFI_DYNAMIC:6,//無線網(wǎng)絡(luò)動態(tài)WIFI_STATIC:7//無線網(wǎng)絡(luò)靜態(tài)};語法iPanel.ioctlWrite("System.SetAudioSPDIFOutPut","<參數(shù)String串>")功能寫入系統(tǒng)音頻SPDIF配置信息。參數(shù)屬性名稱SPDIFspdif輸出返回?zé)o舉例iPanel.ioctlWrite("System.SetAudioSPDIFOutPut","0")語法語法iPanel.ioctlRead("System.GetVideoSDOutPut")功能讀取系統(tǒng)視頻標(biāo)清配置信息。參數(shù)無返回String舉例0語法iPanel.ioctlWrite("System.SetVideoYpbprOutPut","<參數(shù)String>")功能寫入系統(tǒng)視頻高清Ypbpr配置信息。參數(shù)屬性名稱video視頻輸出模式返回?zé)o舉例iPanel.ioctlWrite("System.SetVideoYpbprOutPut","0")語法iPanel.ioctlRead("System.GetVideoYpbprOutPut")功能讀取系統(tǒng)視頻高清Ypbpr配置信息。參數(shù)無返回String舉例0語法iPanel.ioctlWrite("System.SetTVSystem","<參數(shù)String>")功能寫入系統(tǒng)初始電視標(biāo)準(zhǔn)配置信息。舉例舉例iPanel.ioctlWrite("System.SetSoftWareQueryMode","0")語法iPanel.ioctlRead("System.GetSoftWareQueryMode")功能讀取系統(tǒng)初始網(wǎng)絡(luò)動態(tài)配置信息。參數(shù)無返回String舉例0語法iPanel.ioctlWrite("System.SetNetworkDynamic","")功能寫入系統(tǒng)初始網(wǎng)絡(luò)動態(tài)配置信息。參數(shù)無返回String（0成功1失?。┡e例iPanel.ioctlWrite("System.SetNetworkDynamic","")語法iPanel.ioctlRead("System.GetNetworkDynamic")功能讀取系統(tǒng)初始網(wǎng)絡(luò)動態(tài)配置信息。參數(shù)無返回String舉例192.168.0.1語法iPanel.ioctlWrite("System.SetNetworkStatic","<參數(shù)json串>")NameName用戶名Password密碼返回?zé)o舉例iPanel.ioctlWrite("System.SetNetworkADSLAccount","{"name":"tony","password":"tu84556"}")語法iPanel.ioctlRead("System.GetNetworkADSLAccount")功能讀取系統(tǒng)初始網(wǎng)絡(luò)ADSL賬戶配置信息。參數(shù)無返回json串舉例{"name":"tony","password":"tu84556"}語法iPanel.ioctlWrite("System.SetFactory","")功能寫入系統(tǒng)初始軟件恢復(fù)出廠配置信息。參數(shù)無返回?zé)o舉例iPanel.ioctlWrite("System.SetFactory","")語法iPanel.ioctlWrite("System.SetUpgrade","<參數(shù)String>")功能寫入版本升級指令。參數(shù)無返回?zé)o舉例舉例iPanel.ioctlWrite("System.SetUpgrade","-1")語法iPanel.ioctlRead("System.GetUpgrade")功能讀取版本升級指令信息。參數(shù)無返回String舉例""語法iPanel.ioctlRead("System.GetVersion")功能讀取系統(tǒng)初始軟件版本信息。參數(shù)無返回json串舉例{"functionver":"jxhy20080344","pagever":"jxp2004","vedioout":"svedio","vedioscale":"4:3","localvolumn":"109GB","localremainvolumn":"20GB","mobilevolumn":"200GB","mobileremainvolumn":"40GB"}語法iPanel.ioctlWrite("System.SetVersion","<參數(shù)json串>")功能讀取系統(tǒng)初始軟件版本信息。參數(shù)屬性名稱FunctionVer功能版本PageVer頁面版本舉例舉例0語法iPanel.ioctlWrite("System.SetFontColor","<參數(shù)String>")功能寫入系統(tǒng)初始字幕顏色配置信息。參數(shù)屬性名稱Mode顏色方式返回?zé)o舉例iPanel.ioctlWrite("System.SetFontColor","0")語法iPanel.ioctlRead("System.GetFontColor","<參數(shù)String>")功能讀取系統(tǒng)初始字幕顏色配置信息。參數(shù)無返回String舉例0語法iPanel.ioctlRead("System.GetNaviMenu")功能讀取系統(tǒng)主界面導(dǎo)航菜單配置信息。參數(shù)無返回String數(shù)組舉例["0","1","2"]語法iPanel.ioctlWrite("System.SetSoftKeyWord","<參數(shù)String>")功能功能寫入軟鍵盤開關(guān)指令。參數(shù)屬性名稱Mode開關(guān)模式返回?zé)o舉例iPanel.ioctlWrite("System.SetSoftKeyWord","0")語法iPanel.ioctlWrite("System.SetNetworkADSLLogin","<參數(shù)String>")功能寫入ADSL登錄指令。參數(shù)String返回String舉例iPanel.ioctlWrite("System.SetNetworkADSLLogin","0")語法iPanel.ioctlRead("System.GetNetworkADSLLogin")功能讀取ADSL登錄指令。參數(shù)無返回String舉例"0"語法iPanel.ioctlWrite("System.SetNetworkADSLLogout","<參數(shù)String>")功能寫入ADSL退出指令。參數(shù)參數(shù)String返回?zé)o舉例iPanel.ioctlWrite("System.SetNetworkADSLLogout","0")語法iPanel.ioctlRead("System.GetNetworkADSLLogout")功能讀取ADSL退出指令。參數(shù)無返回String舉例"0"語法iPanel.ioctlRead("System.GetWiFiStatus")功能讀取無線網(wǎng)絡(luò)設(shè)備狀態(tài)。參數(shù)無返回String舉例"0"語法iPanel.ioctlRead("Syste