更新時間:2019-11-20
接口名稱 |
接口描述 |
---|---|
創(chuàng)建Client對象,在調(diào)用其他接口之前必須先調(diào)用createClient接口創(chuàng)建Client對象。 |
|
初始化系統(tǒng)配置,如日志級別,企業(yè)域名等。 |
|
獲取版本號。 |
|
設(shè)置顯示名稱。 |
接口描述
創(chuàng)建Client對象,在調(diào)用其他接口之前必須先調(diào)用createClient接口創(chuàng)建Client對象。
注意事項
請在根頁面引入CloudEC庫,并確保在其他業(yè)務(wù)頁面能取到創(chuàng)建的Client對象。
方法定義
createClient(listeners: any) |
參數(shù)說明
參數(shù) |
是否必須 |
類型 |
描述 |
---|---|---|---|
listeners |
是 |
監(jiān)聽回調(diào)函數(shù)對象集合 |
設(shè)置監(jiān)聽回調(diào)函數(shù),監(jiān)聽的事件根據(jù)需要選擇,其中onError事件為必選項,請參考事件通知小節(jié)。 |
返回值
類型 |
描述 |
---|---|
any |
Client對象。 |
代碼示例
"use strict"; (function (root) { var listeners = { onForceUnReg: (ret) => { alert("you have be kickouted") document.getElementById("login").style.display = "block"; document.getElementById("main").style.display = "none"; }, onConfIncoming: (ret) => { let con_ret = confirm("you have a incoming conference, accept?"); if (con_ret === true) { ret.info.answerConference(true) } else { ret.info.answerConference(false) } }, onConfConnected: (ret) => { alert("the conference is connected") }, onError: (ret) => { alert("wowo,error is coming!" + ret) }, } root.client = CloudEC.createClient(listeners); })(this); |
接口描述
初始化系統(tǒng)配置,如日志級別,企業(yè)域名等。
注意事項
該接口可選調(diào)用,使用默認(rèn)值。
方法定義
configure(options: any) |
參數(shù)說明
參數(shù) |
是否必須 |
類型 |
描述 |
---|---|---|---|
domain |
否 |
string |
企業(yè)域名,用于本地websocket加密,最大長度127字節(jié)。 企業(yè)可以連接外網(wǎng)的話,可使用默認(rèn)值:localhost.cloudec.huaweicloud.com。 |
logLevel |
否 |
number |
日志級別,默認(rèn)值為3。
|
logPath |
否 |
string |
日志路徑,默認(rèn)值為CloudLinkMeetingDeamon的安裝路徑下的terminal_sdk_log目錄。 |
logFileCount |
否 |
number |
日志文件最大個數(shù)。最大值為所能取到的最大值,建議為4。 |
logFileSize |
否 |
number |
日志文件單個大小。單位: KB,最大10*1024 KB。 |
isTlsSupport |
否 |
number |
是否啟用TLS,默認(rèn)值為0。
|
IsSupportIm |
否 |
number |
是否啟用im,默認(rèn)值為0。
|
isWSS |
否 |
number |
是否啟用加密websocket,默認(rèn)值為1。
|
confCtrlProtocol |
否 |
number |
會控協(xié)議,默認(rèn)值為0。
|
IsSupportSvcConference |
否 |
number |
是否支持多流會議,默認(rèn)值為1。
|
uiPluginResourcesPath |
否 |
string |
資源路徑,最大長度511字節(jié)。 |
uiPluginUserFilesPath |
否 |
string |
用戶文件路徑,最大長度511字節(jié)。 |
uiPluginHasFrameInfo |
否 |
number |
是否設(shè)置UI Plugin窗口信息。
|
uiPluginFrameInfoX |
否 |
number |
左上角x坐標(biāo)(uiPluginHasFrameInfo = 1有效) |
uiPluginFrameInfoY |
否 |
number |
左上角y坐標(biāo)(uiPluginHasFrameInfo = 1有效) |
uiPluginFrameInfoWidth |
否 |
number |
寬。僅當(dāng)uiPluginHasFrameInfo = 1有效。 |
uiPluginFrameInfoHeight |
否 |
number |
高。僅當(dāng)uiPluginHasFrameInfo = 1有效。 |
uiPluginHasParentInfo |
否 |
number |
是否有父窗口。僅當(dāng)uiPluginHasFrameInfo = 1有效。
|
uiPluginParentInfoIsNeedAttach |
否 |
number |
是否聯(lián)動(uiPluginHasParentInfo= 1有效)
|
uiPluginParentInfoXOffset |
否 |
number |
聯(lián)動時相對于父Frame x軸偏移率。僅當(dāng)uiPluginHasParentInfo= 1有效。 取值范圍0-100 |
uiPluginParentInfoYOffset |
否 |
number |
聯(lián)動時相對于父Frame y軸偏移率。僅當(dāng)uiPluginHasParentInfo= 1有效。 取值范圍0-100 |
uiPluginHideTopToolBar |
否 |
number |
視頻窗口是否顯示上邊欄。
|
uiPluginHideBottomToolBar |
否 |
number |
視頻窗口是否顯示下邊欄。
|
uiPluginHideInviteButton |
否 |
number |
視頻窗口是否顯示邀請按鈕。
|
uiPluginHideAttendeesButton |
否 |
number |
視頻窗口是否顯示與會者按鈕。
|
uiPluginHideShareButton |
否 |
number |
視頻窗口是否顯示共享按鈕。
|
uiPluginDataHideInviteButton |
否 |
number |
桌面共享窗口是否顯示邀請按鈕。
|
uiPluginDataHideAttendeesButton |
否 |
number |
桌面共享窗口是否顯示與會者按鈕。
|
uiPluginDataHideRequestRemotecontrolButton |
否 |
number |
桌面共享窗口是否顯示請求遠程控制的菜單按鈕。
|
uiPluginHideConfTime |
否 |
number |
會議中是否隱藏會議時長。
|
uiPluginHideConfChairmanPwd |
否 |
number |
會議中是否隱藏會議主席密碼。
|
uiPluginHideConfGuestPwd |
否 |
number |
會議中是否隱藏會議來賓密碼。
|
uiPluginHideShareTypeSelection |
否 |
number |
會議中是否隱藏共享類型選擇框。
|
pageTitle |
否 |
string |
頁面標(biāo)題,用于聯(lián)動時,最大長度127字節(jié)。 |
返回值
無。
代碼示例
"use strict"; (function(root) { var options = { domain: "localhost.cloudec.huaweicloud.com", isWSS: 1, confCtrlProtocol: 1, isTlsSupport: 0, uiPluginAppDisplayName : "eSDK-Desktop", uiPluginlLanguage : 0, uiPluginResourcesPath: "", uiPluginUserFilesPath:"", uiPluginHasFrameInfo:0, uiPluginFrameInfoX:0, uiPluginFrameInfoY:0, uiPluginFrameInfoWidth:1280, uiPluginFrameInfoHeight:720, uiPluginHasParentInfo:0, uiPluginParentInfoIsNeedAttach:0, uiPluginParentInfoXOffsetRate:0, uiPluginParentInfoYOffsetRate:0, uiPluginHideTopToolBar:0, uiPluginHideBottomToolBar:0, uiPluginHideInviteButton:1, uiPluginHideAttendeesButton:1, uiPluginHideShareButton:1, uiPluginDataHideInviteButton:1, uiPluginDataHideAttendeesButton:1, uiPluginDataHideRequestRemotecontrolButton:1, } cloudEC.configure(options); })(this); |
接口描述
獲取版本號。
注意事項
無。
方法定義
getVersion(): string |
參數(shù)描述
無。
返回值
類型 |
描述 |
---|---|
string |
版本號和發(fā)布時間。 |
代碼示例
function getVersion() { var version = CloudEC.getVersion(); } |
接口描述
設(shè)置在呼叫或會議中顯示的與會人的名字。
注意事項
無。
方法定義
setDisplayName(displayName:string): void |
參數(shù)描述
參數(shù) |
是否必須 |
類型 |
描述 |
---|---|---|---|
displayName |
是 |
string |
顯示名稱,最大長度127字節(jié)。 |
返回值
無。
代碼示例
function setDisplayName(name){ client.setDisplayName(name); } |