McuClient API.md 7.4 KB

McuClient API参考说明


##创建McuClient对象 ## 只创建一次

示例代码

window.onload=function(){
    //创建client
    const client=MCUClientEngine.createMcuClient();
    //获取事件监听消息定义
    const MessageTypes=MCUClientEngine.MessageTypes;
}

McuClient方法

初始化

client.init(configInfo)

client创建完成之后第一步需要初始化。

示例代码

var paramInfo={ 
    "meetingNumber":123456,
    "portal":"127.0.0.1:80",
    "usertRole":"normal",
    "userID":0,
};
//初始化
client.init(paramInfo,onSuccess,onFailure);

function onSuccess(callbackData){
    //初始化成功回调
    //{"siteId":"h5test","passwordRequired":true,"md5":"de399d5540b3da2fbc1eb0a770d4fd66","code":0,"msType":1}
};
function onFailure(callbackData){
    //初始化失败回调
};

参数名称

类型

该对象包含以下属性

paramInfo

对象

  • meetingNumber:(必选)Number 课堂号
  • portal:(必选)String IP地址
  • usertRole:(可选) String 用户的身份,5种类型,默认是normal ;host(主持人/老师)、presenter(主讲人)、assistant(助教)、normal(普通角色/学生),record(暂时没用)
  • userId:(可选) String 第三方用户id,默认是0

onSuccess

Function

(必选) Function 初始化成功回调函数,返回值:{"siteId":"h5test","passwordRequired":true,"md5":"de399d5540b3da2fbc1eb0a770d4fd66","code":0,"msType":1}

onFailure

Function

(必选) Function 初始化失败回调函数

加入会议

client.joinClass(paramInfo)

client初始化成功之后,加入会议。

示例代码

var paramInfo={
    "userName":"大名",//自己的名字,在列表中显示
    "password":"123321",//课堂密码,如果设置了密码需要验证
};

//加入会议
client.joinClass(paramInfo,onSuccess,onFailure);

function onSuccess(callbackData){
    //加入会议成功回调
    //{"siteId":"h5test","passwordRequired":true,"md5":"de399d5540b3da2fbc1eb0a770d4fd66","code":0,"msType":1}
};
function onFailure(callbackData){
    //加入会议失败回调
        //MessageTypes.ERROR_PARAM 传入的参数错误 
        //MessageTypes.ERROR_CLASS_PASSWORD_WRONG 传入的参数错误 
        //MessageTypes.ERROR_CLASS_JOIN_FULL 课堂人数已满  
        //MessageTypes.ERROR_CLASS_PROTOCOL_WRONG 协议异常      
        //MessageTypes.ERROR_CLASS_MD5_WRONG MD5验证失败 
};

参数名称

类型

该对象包含以下属性

paramInfo

对象

  • userName:(必选)String 进入课堂的名字
  • password:(可选)String 进入课堂的密码,如果课堂不设置密码就不需要,设置了密码的情况下,进入课堂需要输入密码,根据初始化回调的参数passwordRequired来判断

onSuccess

Function

(必选) Function 成功回调函数

onFailure

Function

(必选) Function 失败回调函数,返回值: //MessageTypes.ERROR_PARAM 传入的参数错误 //MessageTypes.ERROR_CLASS_PASSWORD_WRONG 传入的参数错误 //MessageTypes.ERROR_CLASS_JOIN_FULL 课堂人数已满 //MessageTypes.ERROR_CLASS_PROTOCOL_WRONG 协议异常 //MessageTypes.ERROR_CLASS_MD5_WRONG MD5验证失败

离开会议

client.leaveClass()

离开会议

发送消息

client.sendChatMsg(paramInfo)

发送聊天消息

示例代码

var paramInfo={
    "message":"需要发送的内容",
    "to":0

};
client.sendChatMsg(paramInfo);

参数名称

类型

该对象包含以下属性

paramInfo

对象

  • message:(必选)String 消息内容
  • to:(可选) Number 接收消息的人的ID,默认值是0(所有人都)

client回调事件

显示日志信息 事件回调

示例代码

client.on(MessageTypes.CLASS_SHOW_DETAIL, function(callbackData){
    //.....
});

会议人数查询 事件回调

示例代码

 client.on(MessageTypes.CLASS_SHOW_ROSTER_NUM,function(callbackData){
    //.....
});

关闭会议 事件回调

示例代码

client.on(MessageTypes.CLASS_EXIT, function(callbackData){
    //.....
});

收到聊天消息 事件回调

示例代码

client.on(MessageTypes.CHAT_RECEIVE, function(callbackData){
    //{"fromNodeID":1484207995,"toNodeID":0,"message":"消息内容","fromName":"发送消息人的名字","fromRole":0}
});

视频显示 事件回调

示例代码

client.on(MessageTypes.VIDEO_SHOW, function(callbackData){
    //.....
});

文档 事件回调

示例代码

client.on(MessageTypes.DOC_SHOW, function(callbackData){
    //.....
});

文档笔记 事件回调

示例代码

client.on(MessageTypes.DOC_ANNO,function(callbackData){
    //.....
});

删除文档 事件回调

示例代码

 client.on(MessageTypes.DOC_DEL,function(callbackData){
    //.....
});

网络错误 事件回调

示例代码

client.on(MessageTypes.NET_ERROR,function(callbackData){
    //.....
});