接口参考_湖南轩利_为用户提供一站式的云服务及音视频整体解决方案

入门使用

组件初始化

更新时间：2019-11-20

接口名称	接口描述
createClient	创建Client对象，在调用其他接口之前必须先调用createClient接口创建Client对象。
configure	初始化系统配置，如日志级别，企业域名等。
getVersion	获取版本号。
setDisplayName	设置显示名称。

createClient

接口描述

创建Client对象，在调用其他接口之前必须先调用createClient接口创建Client对象。

注意事项

请在根页面引入CloudEC库，并确保在其他业务页面能取到创建的Client对象。

方法定义

createClient(listeners: any)

									 

参数说明

参数	是否必须	类型	描述
listeners	是	监听回调函数对象集合	设置监听回调函数，监听的事件根据需要选择，其中onError事件为必选项，请参考事件通知小节。

返回值

类型	描述
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);

									 

configure

接口描述

初始化系统配置，如日志级别，企业域名等。

注意事项

该接口可选调用，使用默认值。

方法定义

configure(options: any)

									 

参数说明

参数	是否必须	类型	描述
domain	否	string	企业域名，用于本地websocket加密，最大长度127字节。企业可以连接外网的话，可使用默认值：localhost.cloudec.huaweicloud.com。
logLevel	否	number	日志级别，默认值为3。 0：错误级别 1：警告级别 2：信息级别（一般级别） 3：调试级别
logPath	否	string	日志路径，默认值为CloudLinkMeetingDeamon的安装路径下的terminal_sdk_log目录。
logFileCount	否	number	日志文件最大个数。最大值为所能取到的最大值，建议为4。
logFileSize	否	number	日志文件单个大小。单位: KB，最大10*1024 KB。
isTlsSupport	否	number	是否启用TLS，默认值为0。 0：否 1：是
IsSupportIm	否	number	是否启用im，默认值为0。 0：否 1：是
isWSS	否	number	是否启用加密websocket，默认值为1。 0：否 1：是
confCtrlProtocol	否	number	会控协议，默认值为0。 0：rest 1：iDo
IsSupportSvcConference	否	number	是否支持多流会议，默认值为1。 0：只单流会议 1：支持多流会议
uiPluginResourcesPath	否	string	资源路径，最大长度511字节。
uiPluginUserFilesPath	否	string	用户文件路径，最大长度511字节。
uiPluginHasFrameInfo	否	number	是否设置UI Plugin窗口信息。 0：否 1：是
uiPluginFrameInfoX	否	number	左上角x坐标（uiPluginHasFrameInfo = 1有效）
uiPluginFrameInfoY	否	number	左上角y坐标（uiPluginHasFrameInfo = 1有效）
uiPluginFrameInfoWidth	否	number	宽。仅当uiPluginHasFrameInfo = 1有效。
uiPluginFrameInfoHeight	否	number	高。仅当uiPluginHasFrameInfo = 1有效。
uiPluginHasParentInfo	否	number	是否有父窗口。仅当uiPluginHasFrameInfo = 1有效。 0：否 1：是
uiPluginParentInfoIsNeedAttach	否	number	是否联动（uiPluginHasParentInfo= 1有效） 0：否 1：是
uiPluginParentInfoXOffset	否	number	联动时相对于父Frame x轴偏移率。仅当uiPluginHasParentInfo= 1有效。取值范围0-100
uiPluginParentInfoYOffset	否	number	联动时相对于父Frame y轴偏移率。仅当uiPluginHasParentInfo= 1有效。取值范围0-100
uiPluginHideTopToolBar	否	number	视频窗口是否显示上边栏。 0：否 1：是
uiPluginHideBottomToolBar	否	number	视频窗口是否显示下边栏。 0：否 1：是
uiPluginHideInviteButton	否	number	视频窗口是否显示邀请按钮。 0：否 1：是
uiPluginHideAttendeesButton	否	number	视频窗口是否显示与会者按钮。 0：否 1：是
uiPluginHideShareButton	否	number	视频窗口是否显示共享按钮。 0：否 1：是
uiPluginDataHideInviteButton	否	number	桌面共享窗口是否显示邀请按钮。 0：否 1：是
uiPluginDataHideAttendeesButton	否	number	桌面共享窗口是否显示与会者按钮。 0：否 1：是
uiPluginDataHideRequestRemotecontrolButton	否	number	桌面共享窗口是否显示请求远程控制的菜单按钮。 0：否 1：是
uiPluginHideConfTime	否	number	会议中是否隐藏会议时长。 0：否 1：是
uiPluginHideConfChairmanPwd	否	number	会议中是否隐藏会议主席密码。 0：否 1：是
uiPluginHideConfGuestPwd	否	number	会议中是否隐藏会议来宾密码。 0：否 1：是
uiPluginHideShareTypeSelection	否	number	会议中是否隐藏共享类型选择框。 0：否 1：是
pageTitle	否	string	页面标题，用于联动时，最大长度127字节。

返回值

无。

代码示例

"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

接口描述

获取版本号。

注意事项

无。

方法定义

getVersion(): string

									 

参数描述

无。

返回值

类型	描述
string	版本号和发布时间。

代码示例

function getVersion() {
     var version = CloudEC.getVersion();
}

									 

setDisplayName

接口描述

设置在呼叫或会议中显示的与会人的名字。

注意事项

无。

方法定义

setDisplayName(displayName:string): void

									 

参数描述

参数	是否必须	类型	描述
displayName	是	string	显示名称，最大长度127字节。

返回值

无。

代码示例

								function setDisplayName(name){
    client.setDisplayName(name);
}
							