WX-SDK

# API分类

# 接口描述

基础函数：

方式	接口	描述
引用	CR.sdkver	获取SDK版本号
主调	CR.Init	初始化
	CR.UnInit	反初始化
	CR.SetServerAddr	设置服务器地址
	CR.EnableLog2File	设置日志打印及上传

方式	接口	描述
主调	CR.Login	登录
	CR.LoginByToken	Token登录
	CR.UpdateToken	更新Token
	CR.Logout	注销
回调	CR.LoginSuccess	登陆成功
	CR.LoginFail	登录失败
	CR.NotifyTokenWillExpire	Token即将失效的通知,失效前30秒通知
	CR.LineOff	通知自己掉线

队列管理：

方式	接口	描述
主调	CR.InitQueueDat	初始化队列
	CR.GetClientStatusRslt	获取自己的排队、呼叫状态的结果
	CR.GetServingStatusRslt	获取自己服务的队列、呼叫状态的结果
	CR.GetAllQueueInfo	查询队列
	CR.GetQueueStatus	获取队列状态
	CR.GetClientStatus	获取自己的排队、呼叫状态
	CR.GetServingStatus	获取自己服务的队列、呼叫状态
	CR.StartQueuing	客户开始排队
	CR.StopQueuing	客户停止排队
	CR.StartService	坐席开始服务队列
	CR.StopService	坐席停止服务队列
	CR.ReqAssignUser	请求分配一个客户
	CR.AcceptAssignUser	接受分配的客户
	CR.RejectAssignUser	拒绝分配的客户
回调	CR.InitQueueDatRslt	列初始化操作结果
	CR.GetQueueStatusRslt	获取队列状态通知
	CR.QueueStatusChanged	队列状态变化通知
	CR.QueuingInfoChanged	排队信息变化通知
	CR.StartQueuingRslt	开始排队通知
	CR.StopQueuingRslt	停止排队通知
	CR.StartServiceRslt	开始服务队列通知
	CR.StopServiceRslt	停止服务队列通知
	CR.ResponseAssignUserRslt	响应分配客户操作结果
	CR.AutoAssignUser	自动分配用户通知
	CR.ReqAssignUserRslt	请求分配用户结果
	CR.CancelAssignUser	系统取消之前分配的的客户

呼叫：

方式	接口	描述
主调	CR.Call	发起呼叫
	CR.AcceptCall	接受对方发起的呼叫
	CR.RejectCall	拒绝对方发起的呼叫
	CR.HungupCall	挂断呼叫
	CR.SetDNDStatus	设置免打扰状态
	CR.GetUserStatus	获取企业下所有用户在线状态
	CR.StartUserStatusNotify	开启用户的状态推送
	CR.StopUserStatusNotify	关闭用户的状态推送
回调	CR.CallSuccess	发起呼叫操作成功
	CR.CallFail	发起呼叫操作失败
	CR.NotifyCallIn	通知有人呼入
	CR.AcceptCallSuccess	接受他人呼叫操作成功
	CR.AcceptCallFail	接受他人呼叫操作失败
	CR.RejectCallSuccess	拒绝他人的呼叫成功
	CR.RejectCallFail	拒绝他人的呼叫失败
	CR.HungupCallSuccess	挂断他人的呼叫成功
	CR.HungupCallFail	挂断他人的呼叫失败
	CR.NotifyCallAccepted	通知呼叫被对方接受
	CR.NotifyCallRejected	通知呼叫被对方拒绝
	CR.NotifyCallHungup	通知呼叫被对方挂断
	CR.SetDNDStatusSuccess	设置免打扰状态操作成功响应
	CR.SetDNDStatusFail	设置免打扰状态操作失败响应
	CR.GetUserStatusSuccess	获取所有用户在线状态成功响应
	CR.GetUserStatusFail	获取所有用户在线状态失败响应
	CR.StartUserStatusNotifyRslt	开启用户状态推送结果
	CR.StopUserStatusNotifyRslt	关闭用户状态推送结果
	CR.NotifyUserStatus	用户状态变化通知

邀请：

方式	接口	描述
主调	CR.Invite	发送邀请
	CR.AcceptInvite	接受对方发送的邀请
	CR.RejectInvite	拒绝对方发送的邀请
	CR.CancelInvite	取消自己发送的邀请
回调	CR.InviteSuccess	发送邀请成功
	CR.InviteFail	发送邀请失败
	CR.CancelInviteSuccess	取消自己发送的邀请成功
	CR.CancelInviteFail	取消自己发送的邀请失败
	CR.AcceptInviteSuccess	接受对方发送的邀请成功
	CR.AcceptInviteFail	接受对方发送的邀请失败
	CR.RejectInviteSuccess	拒绝对方发送的邀请成功
	CR.RejectInviteFail	拒绝对方发送的邀请失败
	CR.NotifyInviteIn	通知有人邀请
	CR.NotifyInviteAccepted	通知邀请被对方接受
	CR.NotifyInviteRejected	通知邀请被对方拒绝
	CR.NotifyInviteCanceled	通知有邀请被取消

透明通道：

方式	接口	描述
主调	CR.SendCmd	发送小块数据
主调	CR.SendBuffer	发送大块数据
回调	CR.SendCmdRlst	通知发送小块数据结果
	CR.SendBufferRslt	通知发送大块数据结果
	CR.SendProgress	通知发送数据进度
	CR.NotifyCmdData	通知收到小块数据
	CR.NotifyBufferData	通知收到大块数据

房间管理：

方式	接口	描述
主调	CR.CreateMeeting	创建房间
主调	CR.StopMeeting	销毁房间
回调	CR.CreateMeetingSuccess	通知创建房间成功
	CR.CreateMeetingFail	通知创建房间失败
	CR.StopMeetingRslt	通知结束房间的结果

进出房间：

方式	接口	描述
主调	CR.EnterMeeting2	进入房间
主调	CR.ExitMeeting	离开房间
回调	CR.EnterMeetingRslt	进入房间结果
	CR.UserEnterMeeting	有人进入房间通知
	CR.UserLeftMeeting	有人离开房间通知
	CR.MeetingDropped	通知从房间里掉线了
	CR.MeetingStopped	通知房间已被结束

房间和成员管理：

方式	接口	描述
主调	CR.GetAllMembers	获取房间所有成员信息列表
	CR.GetMemberInfo	获取单个成员信息
	CR.SendMeetingCustomMsg	房间内发送广播消息
回调	CR.NotifyNickNameChanged	SDK通知某用户改变了昵称
	CR.SendMeetingCustomMsgRslt	通知发送房间内自定义广播消息结果
	CR.NotifyMeetingCustomMsg	通知接收到房间内用户自定义广播

房间、用户属性：

方式	接口	描述
主调	CR.GetMeetingAttrs	获取房间部份属性
	CR.GetMeetingAllAttrs	获取房间所有属性
	CR.SetMeetingAttrs	重置房间属性集
	CR.AddOrUpdateMeetingAttrs	增加或者更新房间属性
	CR.DelMeetingAttrs	删除房间属性
	CR.ClearMeetingAttrs	清除房间所有属性
	CR.GetUserAttrs	获取指定用户的指定属性
	CR.SetUserAttrs	重置用户属性
	CR.AddOrUpdateUserAttrs	增加或更新用户属性
	CR.DelUserAttrs	删除用户的特定属性
	CR.ClearUserAttrs	清除特定用户的所有属性
	CR.ClearAllUserAttrs	清除所有用户的所有属性
回调	CR.GetMeetingAttrsSuccess	成功获取到房间属性
	CR.GetMeetingAttrsFail	获取房间指定属性失败
	CR.GetMeetingAllAttrsSuccess	成功获取到房间所有属性
	CR.GetMeetingAllAttrsFail	获取房间属性失败
	CR.SetMeetingAttrsRslt	设置用户属性结果
	CR.AddOrUpdateMeetingAttrsRslt	增加或更新房间属性结果
	CR.DelMeetingAttrsRslt	删除房间属性结果
	CR.ClearMeetingAttrsRslt	清除房间属性结果
	CR.GetUserAttrsSuccess	获取房间内用户属性结果
	CR.GetUserAttrsFail	获取房间内用户属性失败
	CR.SetUserAttrsRslt	设置用户属性结果
	CR.AddOrUpdateUserAttrsRslt	增加或者更新用户属性结果
	CR.DelUserAttrsRslt	删除特定用户属性结果
	CR.ClearUserAttrsRslt	清除特定用户属性结果
	CR.ClearAllUserAttrsRslt	清除所有用户属性结果
	CR.NotifyMeetingAttrsChanged	通知房间属性发生改变
	CR.NotifyUserAttrsChanged	通知用户属性发生改变

音频管理：

方式	接口	描述
主调	CR.OpenMic	打开麦克风
主调	CR.CloseMic	关闭麦克风
回调	CR.AudioStatusChanged	通知用户音频状态变化
回调	CR.OpenMicFailRslt	通知麦克风打开失败

视频管理：

方式	接口	描述
主调	CR.OpenVideo	打开摄像头
	CR.CloseVideo	关闭摄像头
	CR.SetDefaultVideo	切换摄像头
	CR.GetDefaultVideo	获取默认摄像头信息
	CR.GetWatchableVideos	房间内可观看摄像头列表
	CR.GetAllVideoInfo	获取摄像头设备列表
回调	CR.VideoStatusChanged	通知用户视频状态变化
	CR.OpenVideoFailRslt	通知摄像头打开失败
	CR.VideoDevChanged	通知用户的视频设备有变化

屏幕共享/影音共享：

方式	接口	描述
主调	CR.GetScreenInfo	查询当前屏幕共享状态
主调	CR.GetMediaInfo	查询当前影音共享状态
回调	CR.GetMediaInfoRslt	通知查询影音共享状态的结果
	CR.NotifyScreenShareStarted	收到他人开启了屏幕共享的通知
	CR.NotifyScreenShareStopped	收到他人停止了屏幕共享的通知
	CR.NotifyMediaStart	收到他人开启了影音共享的通知
	CR.NotifyMediaPause	收到他人暂停了影音共享的通知
	CR.NotifyMediaStop	收到他人停止了影音共享的通知

云端录制/云端推流：

方式	接口	描述
主调	CR.GetSvrMixerState	获取云端录制、云端直播状态
	CR.StartSvrMixer	开启云端录制/开启云端直播
	CR.UpdateSvrMixerContent	更新云端录制、云端直播内容
	CR.StopSvrMixer	停止云端录制、云端直播
回调	CR.SvrRecordStateChanged	通知云端录制、云端直播状态变化
	CR.SvrRecVideosChanged	通知云端录制、云端直播内容变化
	CR.SvrMixerOutputInfo	通知云端录制文件、云端直播信息变化

# 接口详情

CR.sdkver

功能: 获取SDK版本号

CR.Init(CRVideo_InitObj)

功能: SDK初始化
返回值: 错误码（错误码为0表示没有错误）

参数	类型	说明
CRVideo_InitObj	object	初始化参数，详见CRVideo_InitObj

注意: 程序开始时init，程序结束时uninit，整个程序的生命周期中只进行一次初始化和反初始化。

CR.UnInit()

功能: 反初始化
返回值: 无

CR.SetServerAddr(addr)

功能: 设置服务器地址
返回值: 无

参数	类型	说明
addr	string	服务器地址，例如：sdk.cloudroom.com

服务器地址默认使用https协议。开发可使用http协议，开发工具需要勾选不校验地址及在手机中打开调试模式。地址格式为http://sdk.cloudroom.com

CR.EnableLog2File(uploading ,logDebug)

功能: 设置日志打印及上传
返回值: 无

参数	类型	说明
uploading	Boolean	是否上报日志
logDebug	Boolean	是否打印到控制台

若缺省调用，默认打开日志上传和打印

CR.Login(appID ,md5_appSecret ,nickName ,UID ,userAuthCode ,cookie)

功能: 登录
返回值: 无

参数	类型	说明
appID	string	云屋鉴权帐号。用于区分不同的项目，每个项目都有属于自己的唯一的appID，不同appID的项目完全独立，无法相互通信。appID请联系云屋销售获取，并开通相关套餐和功能权限。
md5_appSecret	string	云屋鉴权密码，可登录云屋管理后台修改。
nickName	string	昵称
UID	string	用户ID, 详细介绍见关键词
userAuthCode	string	用户验证信息，可缺省。为空代表不需要sdk验证（一般由业务方先对userID认证完了，再来使用云屋sdk)。如果不为空，云屋SDK服务器将连接提前配好的业务方服务器进行实时验证。
cookie	string	可缺省,详细介绍见关键词

登陆成功则回调 CR.LoginSuccess ,登陆失败则回调 CR.LoginFail

CR.LoginByToken(token ,nickName ,UID ,userAuthCode ,cookie)

功能: Token登录
返回值: 无

参数	类型	说明
token	string	Token鉴权码,详细介绍见关键词
nickName	string	昵称
UID	string	用户ID, 详细介绍见关键词
userAuthCode	string	用户验证信息，可缺省。为空代表不需要sdk验证（一般由业务方先对userID认证完了，再来使用云屋sdk)。如果不为空，云屋SDK服务器将连接提前配好的业务方服务器进行实时验证。
cookie	string	可缺省,详细介绍见关键词

登陆成功则回调 CR.LoginSuccess ,登陆失败则回调 CR.LoginFail

CR.UpdateToken(token)

功能: 更新Token
返回值: 无

参数	类型	说明
token	string	Token鉴权码,详细介绍见关键词

CR.Logout()

功能: 注销登录
返回值: 无

退出程序时，必须注销本次登录，然后再进行SDK反初始化操作

CR.LoginSuccess.callback = function(UID ,cookie){}

功能：登陆成功
参数：

参数	类型	说明
UID	string	用户ID, 详细介绍见关键词
cookie	string	详细介绍见cookie

CR.LoginFail.callback = function(sdkErr ,cookie){}

功能：登录失败
参数：

参数	类型	说明
sdkErr	number	错误码，详细见错误码定义
cookie	string	详细介绍见cookie

CR.NotifyTokenWillExpire.callback = function(){}

功能：Token即将失效的通知,失效前30秒通知
参数：无

CR.LineOff.callback = function(sdkErr){}

功能：通知自己掉线
参数：

参数	类型	说明
sdkErr	number	错误码，详细见错误码定义

CR.InitQueueDat()

功能: 初始化队列
返回值: 无

操作完成回调CR.InitQueueDatRslt,队列初始化成功后才可获取队列队列相关信息

CR.GetClientStatusRslt(sdkErr ,statusObj ,cookie)

功能: 获取自己的排队、呼叫状态的结果
返回值: 无

参数	类型	说明
sdkErr	number	错误码，详细见错误码定义
statusObj	object	客户状态，详见CRVideo_ClientStatus
cookie	string	详细介绍见cookie

CR.GetServingStatusRslt(sdkErr ,statusObj ,cookie)

功能: 获取自己服务的队列、呼叫状态的结果
返回值: 无

参数	类型	说明
sdkErr	number	错误码，详细见错误码定义
statusObj	object	服务状态，详见CRVideo_ServingStatus
cookie	string	详细介绍见cookie

CR.GetAllQueueInfo()

功能: 查询队列
返回值: 所有队列信息（Array ----- CRVideo_QueueInfo）

CR.GetQueueStatus(queID ,cookie)

功能: 获取队列状态
返回值: 无

参数	类型	说明
queID	number	队列ID
cookie	string	可缺省,详细介绍见关键词

操作完成回调CR.GetQueueStatusRslt

CR.GetClientStatus(cookie)

功能: 获取自己的排队、呼叫状态
返回值: 无

参数	类型	说明
cookie	string	可缺省,详细介绍见关键词

操作完成回调CR.GetClientStatusRslt

CR.GetServingStatus(cookie)

功能: 获取自己服务的队列、呼叫状态
返回值: 无

参数	类型	说明
cookie	string	可缺省,详细介绍见关键词

操作完成回调CR.GetServingStatusRslt

CR.StartQueuing(queID ,usrExtDat ,cookie)

功能: 客户开始排队
返回值: 无

参数	类型	说明
queID	number	队列ID
usrExtDat	string	自定义扩展参数
cookie	string	可缺省,详细介绍见关键词

操作完成回调CR.StartQueuingRslt

CR.StopQueuing(queID ,cookie)

功能: 客户停止排队
返回值: 无

参数	类型	说明
queID	number	队列ID
cookie	string	可缺省,详细介绍见关键词

操作完成回调CR.StopQueuingRslt

CR.StartService(queID ,unedfined ,cookie)

功能: 坐席开始服务队列
返回值: 无

参数	类型	说明
queID	number	队列ID
unedfined	any	预留字段，传入undefined
cookie	string	可缺省,详细介绍见关键词

操作完成回调CR.StartServiceRslt

CR.StopService(queID ,cookie)

功能: 坐席停止服务队列
返回值: 无

参数	类型	说明
queID	number	队列ID
cookie	string	可缺省,详细介绍见关键词

操作完成回调CR.StopServiceRslt

CR.ReqAssignUser()

功能: 请求分配一个客户
返回值: 无

当关闭免打扰时，系统将自动分配客户，无需调用此函数；当开启免打扰时，系统不再自动分配客户，座席如需服务客户可使用此函数分配。接口调用回调函数参考CR.ReqAssignUserRslt

CR.AcceptAssignUser(queID ,UID)

功能: 接受分配的客户
返回值: 无

参数	类型	说明
queID	number	队列ID
UID	string	用户ID, 详细介绍见关键词

CR.RejectAssignUser(queID ,UID)

功能: 拒绝分配的客户
返回值: 无

参数	类型	说明
queID	number	队列ID
UID	string	用户ID, 详细介绍见关键词

CR.InitQueueDatRslt.callback = function(sdkErr){}

功能：列初始化操作结果
参数：

参数	类型	说明
sdkErr	number	错误码，详细见错误码定义

CR.GetQueueStatusRslt.callback = function(sdkErr ,queStatus ,cookie){}

功能：获取队列状态通知
参数：

参数	类型	说明
sdkErr	number	错误码，详细见错误码定义
queStatus	object	队列状态, 详细介绍见类型定义
cookie	string	详细介绍见cookie

CR.QueueStatusChanged.callback = function(queStatus){}

功能：队列状态变化通知
参数：

参数	类型	说明
queStatus	object	队列状态, 详细介绍见类型定义

CR.QueuingInfoChanged.callback = function(queuingInfo){}

功能：排队信息变化通知
参数：

参数	类型	说明
queuingInfo	object	排队信息, 详细介绍见类型定义

CR.StartQueuingRslt.callback = function(sdkErr ,position ,cookie){}

功能：开始排队通知
参数：

参数	类型	说明
sdkErr	number	错误码，详细见错误码定义
position	number	当前排队的位置
cookie	string	详细介绍见cookie

CR.StopQueuingRslt.callback = function(sdkErr ,cookie){}

功能：停止排队通知
参数：

参数	类型	说明
sdkErr	number	错误码，详细见错误码定义
cookie	string	详细介绍见cookie

CR.StartServiceRslt.callback = function(sdkErr ,cookie){}

功能：开始服务队列通知
参数：

参数	类型	说明
sdkErr	number	错误码，详细见错误码定义
cookie	string	详细介绍见cookie

CR.StopServiceRslt.callback = function(sdkErr ,cookie){}

功能：停止服务队列通知
参数：

参数	类型	说明
sdkErr	number	错误码，详细见错误码定义
cookie	string	详细介绍见cookie

CR.ResponseAssignUserRslt.callback = function(sdkErr ,cookie){}

功能：响应分配客户操作结果
参数：

参数	类型	说明
sdkErr	number	错误码，详细见错误码定义
cookie	string	详细介绍见cookie

CR.AutoAssignUser.callback = function(queUser){}

功能：自动分配用户通知
参数：

参数	类型	说明
queUser	object	队列用户信息, 详细介绍见类型定义

CR.ReqAssignUserRslt.callback = function(sdkErr ,queUser ,cookie){}

功能：请求分配用户结果
参数：

参数	类型	说明
sdkErr	number	错误码，详细见错误码定义
queUser	object	队列用户信息, 详细介绍见类型定义
cookie	string	详细介绍见cookie

CR.CancelAssignUser.callback = function(queID ,UID){}

系统通过接口CR.AutoAssignUser给队列服务者自动推送客户（或队列服务者通过CR.ReqAssignUser请求分配客户），收到系统分配的客户后，如果队列服务者30秒之内不接受CR.AcceptAssignUser也不拒绝CR.RejectAssignUser推送的客户，系统将通过本接口取消分配，然后将客户分配给其他空闲的服务者。

功能：系统取消之前分配的的客户
参数：

参数	类型	说明
queID	number	队列ID
UID	string	用户ID, 详细介绍见关键词

CR.Call(calledUserID ,MeetInfoObj ,usrExtDat ,cookie)

功能: 发起呼叫
返回值: 返回本次呼叫标识码（呼叫ID）

参数	类型	说明
calledUserID	string	被叫用户的UID
MeetInfoObj	object	房间对象,详细介绍见类型定义
usrExtDat	string	自定义扩展参数
cookie	string	可缺省,详细介绍见关键词

操作成功则回调CR.CallSuccess,失败则回调CR.CallFail。呼叫时，对方收到CR.NotifyCallIn通知，如果对方迟迟不响应，30秒后系统自动结束呼叫

CR.AcceptCall(callID ,MeetInfoObj ,usrExtDat ,cookie)

功能: 接受对方发起的呼叫
返回值: 无

参数	类型	说明
callID	string	呼叫全局标识
MeetInfoObj	object	房间对象,详细介绍见类型定义
usrExtDat	string	自定义扩展参数
cookie	string	可缺省,详细介绍见关键词

操作成功则回调CR.AcceptCallSuccess，失败则回调CR.AcceptCallFail

CR.RejectCall(callID ,usrExtDat ,cookie)

功能: 拒绝对方发起的呼叫
返回值: 无

参数	类型	说明
callID	string	呼叫全局标识
usrExtDat	string	自定义扩展参数
cookie	string	可缺省,详细介绍见关键词

CR.HungupCall(callID ,usrExtDat ,cookie)

功能: 挂断呼叫
返回值: 无

参数	类型	说明
callID	string	呼叫全局标识
usrExtDat	string	自定义扩展参数
cookie	string	可缺省,详细介绍见关键词

操作成功则回调CR.HungupCallSuccess，失败则回调CR.HungupCallFail

CR.SetDNDStatus(DNDStatus ,cookie)

功能: 设置免打扰状态
返回值: 无

参数	类型	说明
DNDStatus	number	0代表关闭免打扰，其它值代表开启免打扰，含义自由定义
cookie	string	可缺省,详细介绍见关键词

操作成功则回调CR.SetDNDStatusSuccess，失败则回调CR.SetDNDStatusFail。如果是使用到了SDK的队列功能，则入会后需调用此接口，设置自己的为免打扰状态，防止系统再次推送自己

CR.GetUserStatus(cookie)

功能: 获取企业下所有用户在线状态
返回值: 无

参数	类型	说明
cookie	string	可缺省,详细介绍见关键词

操作成功则回调CR.GetUserStatusSuccess，失败则回调CR.GetUserStatusFail

CR.StartUserStatusNotify(cookie)

功能: 开启用户的状态推送
返回值: 无

参数	类型	说明
cookie	string	可缺省,详细介绍见关键词

操作完成则回调CR.StartUserStatusNotifyRslt。企业下所有用户状态有变化时包括呼叫房间状态、免打扰状态），都会收到通知开启后，用户量越大消息量越大，所以请按需开启在CR.StartUserStatusNotify前，应该先通过CR.GetUserStatus获取所有用户状态

CR.StopUserStatusNotify(cookie)

功能: 关闭用户的状态推送
返回值: 无

参数	类型	说明
cookie	string	可缺省,详细介绍见关键词

操作完成则回调CR.StopUserStatusNotifyRslt

CR.CallSuccess.callback = function(callID ,cookie){}

功能：发起呼叫操作成功
参数：

参数	类型	说明
callID	string	呼叫全局标识
cookie	string	详细介绍见cookie

CR.CallFail.callback = function(callID ,sdkErr ,cookie){}

功能：发起呼叫操作失败
参数：

参数	类型	说明
callID	string	呼叫全局标识
sdkErr	number	错误码，详细见错误码定义
cookie	string	详细介绍见cookie

CR.NotifyCallIn.callback = function(callID ,MeetInfoObj ,callerID ,usrExtDat){}

需要被呼叫者调用接收呼叫CR.AcceptCall或者拒绝呼叫CR.RejectCall。若30秒没有响应，系统自动拒绝当次响应

功能：通知有人呼入
参数：

参数	类型	说明
callID	string	呼叫全局标识
MeetInfoObj	object	房间对象,详细介绍见类型定义
callerID	string	呼叫人员的UID
usrExtDat	string	自定义扩展参数

CR.AcceptCallSuccess.callback = function(callID ,cookie){}

被呼叫者可以调用CR.EnterMeeting2进入会议

功能：接受他人呼叫操作成功
参数：

参数	类型	说明
callID	string	呼叫全局标识
cookie	string	详细介绍见cookie

CR.AcceptCallFail.callback = function(callID ,sdkErr ,cookie){}

功能：接受他人呼叫操作失败
参数：

参数	类型	说明
callID	string	呼叫全局标识
sdkErr	number	错误码，详细见错误码定义
cookie	string	详细介绍见cookie

CR.RejectCallSuccess.callback = function(callID ,cookie){}

功能：拒绝他人的呼叫成功
参数：

参数	类型	说明
callID	string	呼叫全局标识
cookie	string	详细介绍见cookie

CR.RejectCallFail.callback = function(callID ,sdkErr ,cookie){}

功能：拒绝他人的呼叫失败
参数：

参数	类型	说明
callID	string	呼叫全局标识
sdkErr	number	错误码，详细见错误码定义
cookie	string	详细介绍见cookie

CR.HungupCallSuccess.callback = function(callID ,cookie){}

功能：挂断他人的呼叫成功
参数：

参数	类型	说明
callID	string	呼叫全局标识
cookie	string	详细介绍见cookie

CR.HungupCallFail.callback = function(callID ,sdkErr ,cookie){}

功能：挂断他人的呼叫失败
参数：

参数	类型	说明
callID	string	呼叫全局标识
sdkErr	number	错误码，详细见错误码定义
cookie	string	详细介绍见cookie

CR.NotifyCallAccepted.callback = function(callID ,MeetInfoObj ,usrExtDat){}

功能：通知呼叫被对方接受
参数：

参数	类型	说明
callID	string	呼叫全局标识
MeetInfoObj	object	房间对象,详细介绍见类型定义
usrExtDat	string	自定义扩展参数

CR.NotifyCallRejected.callback = function(callID ,sdkErr ,usrExtDat){}

功能：通知呼叫被对方拒绝
参数：

参数	类型	说明
callID	string	呼叫全局标识
sdkErr	number	错误码，详细见错误码定义
usrExtDat	string	自定义扩展参数

CR.NotifyCallHungup.callback = function(callID ,usrExtDat){}

功能：通知呼叫被对方挂断
参数：

参数	类型	说明
callID	string	呼叫全局标识
usrExtDat	string	自定义扩展参数

CR.SetDNDStatusSuccess.callback = function(cookie){}

功能：设置免打扰状态操作成功响应
参数：

参数	类型	说明
cookie	string	详细介绍见cookie

CR.SetDNDStatusFail.callback = function(sdkErr ,cookie){}

功能：设置免打扰状态操作失败响应
参数：

参数	类型	说明
sdkErr	number	错误码，详细见错误码定义
cookie	string	详细介绍见cookie

CR.GetUserStatusSuccess.callback = function(userStatus ,cookie){}

功能：获取所有用户在线状态成功响应
参数：

参数	类型	说明
userStatus	Array---CRVideo_UserStatus	用户在线状态信息列表
cookie	string	详细介绍见cookie

CR.GetUserStatusFail.callback = function(sdkErr ,cookie){}

功能：获取所有用户在线状态失败响应
参数：

参数	类型	说明
sdkErr	number	错误码，详细见错误码定义
cookie	string	详细介绍见cookie

CR.StartUserStatusNotifyRslt.callback = function(sdkErr ,cookie){}

功能：开启用户状态推送结果
参数：

参数	类型	说明
sdkErr	number	错误码，详细见错误码定义
cookie	string	详细介绍见cookie

CR.StopUserStatusNotifyRslt.callback = function(sdkErr ,cookie){}

功能：关闭用户状态推送结果
参数：

参数	类型	说明
sdkErr	number	错误码，详细见错误码定义
cookie	string	详细介绍见cookie

CR.NotifyUserStatus.callback = function(userStatus ,cookie){}

功能：用户状态变化通知
参数：

参数	类型	说明
userStatus	CRVideo_UserStatus	用户状态信息
cookie	string	详细介绍见cookie

CR.Invite(invitedUserID ,usrExtDat ,cookie)

功能: 发送邀请
返回值: 返回inviteID(每个邀请对应的唯一ID) (string)

参数	类型	说明
invitedUserID	string	受邀者用户ID
usrExtDat	string	自定义扩展参数
cookie	string	可缺省,详细介绍见关键词

操作成功则回调CR.InviteSuccess,失败则回调CR.InviteFail。邀请时，对方收到CR.NotifyInviteIn通知，如果对方迟迟不响应，30秒后系统自动结束本次邀请

CR.AcceptInvite(inviteID ,usrExtDat ,cookie)

功能: 接受对方发送的邀请
返回值: 无

参数	类型	说明
inviteID	string	邀请ID
usrExtDat	string	自定义扩展参数
cookie	string	可缺省,详细介绍见关键词

操作成功则回调CR.AcceptInviteSuccess，失败则回调CR.AcceptInviteFail

CR.RejectInvite(inviteID ,usrExtDat ,cookie)

功能: 拒绝对方发送的邀请
返回值: 无

参数	类型	说明
inviteID	string	邀请ID
usrExtDat	string	自定义扩展参数
cookie	string	可缺省,详细介绍见关键词

操作成功则回调CR.RejectInviteSuccess，失败则回调CR.RejectInviteFail

CR.CancelInvite(inviteID ,usrExtDat ,cookie)

功能: 取消自己发送的邀请
返回值: 无

参数	类型	说明
inviteID	string	邀请ID
usrExtDat	string	自定义扩展参数
cookie	string	可缺省,详细介绍见关键词

操作成功则回调CR.CancelInviteSuccess，失败则回调CR.CancelInviteFail

CR.InviteSuccess.callback = function(inviteID ,cookie){}

功能：发送邀请成功
参数：

参数	类型	说明
inviteID	string	邀请ID
cookie	string	详细介绍见cookie

CR.InviteFail.callback = function(inviteID ,sdkErr ,cookie){}

功能：发送邀请失败
参数：

参数	类型	说明
inviteID	string	邀请ID
sdkErr	number	错误码，详细见错误码定义
cookie	string	详细介绍见cookie

CR.CancelInviteSuccess.callback = function(inviteID ,cookie){}

功能：取消自己发送的邀请成功
参数：

参数	类型	说明
inviteID	string	邀请ID
cookie	string	详细介绍见cookie

CR.CancelInviteFail.callback = function(inviteID ,sdkErr ,cookie){}

功能：取消自己发送的邀请失败
参数：

参数	类型	说明
inviteID	string	邀请ID
sdkErr	number	错误码，详细见错误码定义
cookie	string	详细介绍见cookie

CR.AcceptInviteSuccess.callback = function(inviteID ,cookie){}

功能：接受对方发送的邀请成功
参数：

参数	类型	说明
inviteID	string	邀请ID
cookie	string	详细介绍见cookie

CR.AcceptInviteFail.callback = function(inviteID ,sdkErr ,cookie){}

功能：接受对方发送的邀请失败
参数：

参数	类型	说明
inviteID	string	邀请ID
sdkErr	number	错误码，详细见错误码定义
cookie	string	详细介绍见cookie

CR.RejectInviteSuccess.callback = function(inviteID ,cookie){}

功能：拒绝对方发送的邀请成功
参数：

参数	类型	说明
inviteID	string	邀请ID
cookie	string	详细介绍见cookie

CR.RejectInviteFail.callback = function(inviteID ,sdkErr ,cookie){}

功能：拒绝对方发送的邀请失败
参数：

参数	类型	说明
inviteID	string	邀请ID
sdkErr	number	错误码，详细见错误码定义
cookie	string	详细介绍见cookie

CR.NotifyInviteIn.callback = function(inviteID ,invitedUserID ,usrExtDat){}

功能：通知有人邀请
参数：

参数	类型	说明
inviteID	string	邀请ID
invitedUserID	string	邀请者用户ID
usrExtDat	string	自定义扩展参数

CR.NotifyInviteAccepted.callback = function(inviteID ,usrExtDat){}

功能：通知邀请被对方接受
参数：

参数	类型	说明
inviteID	string	邀请ID
usrExtDat	string	自定义扩展参数

CR.NotifyInviteRejected.callback = function(inviteID ,reason ,usrExtDat){}

功能：通知邀请被对方拒绝
参数：

参数	类型	说明
inviteID	string	邀请ID
reason	number	邀请被拒绝原因，定义见错误码
usrExtDat	string	自定义扩展参数

CR.NotifyInviteCanceled.callback = function(inviteID ,reason ,usrExtDat){}

功能：通知有邀请被取消
参数：

参数	类型	说明
inviteID	string	邀请ID
reason	number	邀请被取消原因，定义见错误码
usrExtDat	string	自定义扩展参数

CR.SendCmd(targetUID ,data)

功能: 发送小块数据
返回值: 分配的任务ID(string)

参数	类型	说明
targetUID	string	目标用户的UID
data	string	发送的数据

一次性发送不会有进度通知,发送结果事件CR.SendCmdRlst

CR.SendBuffer(targetUID ,data ,cookie)

功能: 发送大块数据（分块发送）
返回值: 分配的任务ID(string)

参数	类型	说明
targetUID	string	目标用户的UID
data	string	发送的数据
cookie	string	可缺省,详细介绍见关键词

进度通知事件CR.SendProgress，发送结果事件CR.SendBufferRslt

CR.SendCmdRlst.callback = function(taskID ,sdkErr){}

功能：通知发送小块数据结果
参数：

参数	类型	说明
taskID	string	发送任务id
sdkErr	number	错误码，详细见错误码定义

CR.SendBufferRslt.callback = function(taskID ,sdkErr ,cookie){}

功能：通知发送大块数据结果
参数：

参数	类型	说明
taskID	string	发送任务id
sdkErr	number	错误码，详细见错误码定义
cookie	string	详细介绍见cookie

CR.SendProgress.callback = function(taskID ,sendedLen ,totalLen ,cookie){}

功能：通知发送数据进度
参数：

参数	类型	说明
taskID	string	发送任务id
sendedLen	number	已发送的数据长度
totalLen	number	需要发送的总长度
cookie	string	详细介绍见cookie

CR.NotifyCmdData.callback = function(sourceUID ,data){}

功能：通知收到小块数据
参数：

参数	类型	说明
sourceUID	string	发送数据的用户UID
data	string	数据的内容

CR.NotifyBufferData.callback = function(sourceUID ,data){}

功能：通知收到大块数据
参数：

参数	类型	说明
sourceUID	string	发送数据的用户UID
data	string	数据的内容

CR.CreateMeeting(cookie)

功能: 创建房间
返回值: 无

参数	类型	说明
cookie	string	可缺省,详细介绍见关键词

操作成功则回调CR.CreateMeetingSuccess，失败则回调CR.CreateMeetingFail

CR.StopMeeting(meetID ,cookie)

功能: 销毁房间
返回值: 无

参数	类型	说明
meetID	number	房间号
cookie	string	详细介绍见cookie

回调函数CR.StopMeetingRslt，调用此接口结束房间时，其他会话用户会收到CR.MeetingStopped

CR.CreateMeetingSuccess.callback = function(MeetInfoObj ,cookie){}

功能：通知创建房间成功
参数：

参数	类型	说明
MeetInfoObj	object	房间对象,详细介绍见类型定义
cookie	string	详细介绍见cookie

CR.CreateMeetingFail.callback = function(sdkErr ,cookie){}

功能：通知创建房间失败
参数：

参数	类型	说明
sdkErr	number	错误码，详细见错误码定义
cookie	string	详细介绍见cookie

CR.StopMeetingRslt.callback = function(sdkErr ,cookie){}

功能：通知结束房间的结果
参数：

参数	类型	说明
sdkErr	number	错误码，详细见错误码定义
cookie	string	详细介绍见cookie

CR.EnterMeeting2(meetID ,UID ,nickName ,cookie)

功能: 进入房间
返回值: 无

参数	类型	说明
meetID	number	房间号
UID	string	用户ID, 详细介绍见关键词
nickName	string	用户昵称
cookie	string	可缺省,详细介绍见关键词

操作完成则回调CR.EnterMeetingRslt

CR.ExitMeeting()

功能: 离开房间
返回值: 无

CR.EnterMeetingRslt.callback = function(sdkErr ,cookie){}

功能：进入房间结果
参数：

参数	类型	说明
sdkErr	number	错误码，详细见错误码定义
cookie	string	详细介绍见cookie

CR.UserEnterMeeting.callback = function(UID){}

功能：有人进入房间通知
参数：

参数	类型	说明
UID	string	用户ID, 详细介绍见关键词

CR.UserLeftMeeting.callback = function(UID){}

功能：有人离开房间通知
参数：

参数	类型	说明
UID	string	用户ID, 详细介绍见关键词

CR.MeetingDropped.callback = function(){}

功能：通知从房间里掉线了
参数：无

CR.MeetingStopped.callback = function(){}

功能：通知房间已被结束
参数：无

CR.GetAllMembers()

功能: 获取房间所有成员信息列表
返回值: 返回含多个成员信息（Array ------CRVideo_MemberInfo）

CR.GetMemberInfo(UID)

功能: 获取单个成员信息
返回值: 返回成员信息（CRVideo_MemberInfo）

参数	类型	说明
UID	string	用户ID, 详细介绍见关键词

CR.SendMeetingCustomMsg(msg ,unedfined ,cookie)

功能: 房间内发送广播消息
返回值: 无

参数	类型	说明
msg	string	发送的文本
unedfined	any	预留字段，传入undefined
cookie	string	可缺省,详细介绍见关键词

需要进入会议后才能调用

CR.NotifyNickNameChanged.callback = function(UID ,oldname ,newname){}

改昵称的用户自身不会接收到此通知

功能：SDK通知某用户改变了昵称
参数：

参数	类型	说明
UID	string	用户ID, 详细介绍见关键词
oldname	string	改变之前的昵称
newname	string	改变之后的昵称

CR.SendMeetingCustomMsgRslt.callback = function(sdkErr ,cookie){}

功能：通知发送房间内自定义广播消息结果
参数：

参数	类型	说明
sdkErr	number	错误码，详细见错误码定义
cookie	string	详细介绍见cookie

CR.NotifyMeetingCustomMsg.callback = function(UID ,jsonDat){}

功能：通知接收到房间内用户自定义广播
参数：

参数	类型	说明
UID	string	用户ID, 详细介绍见关键词
jsonDat	string	广播内容

CR.GetMeetingAttrs(keys ,cookie)

功能: 获取房间部份属性
返回值: 无

参数	类型	说明
keys	array	需要查询的房间属性key，如：["key1", "key2"]
cookie	string	可缺省,详细介绍见关键词

获取成功则回调 CR.GetMeetingAttrsSuccess ,获取失败则回调 CR.GetMeetingAttrsFail

CR.GetMeetingAllAttrs(cookie)

功能: 获取房间所有属性
返回值: 无

参数	类型	说明
cookie	string	可缺省,详细介绍见关键词

获取成功则回调 CR.GetMeetingAllAttrsSuccess ,获取失败则回调 CR.GetMeetingAllAttrsFail

CR.SetMeetingAttrs(attrs ,options ,cookie)

功能: 重置房间属性集
返回值: 无

参数	类型	说明
attrs	string	房间属性集,json格式，如：{"key1":"value1", "key2":"value2"} (key最大长度为64B，value最大长度为8KB)
options	string	操作选项,json格式参见CRVideo_MeetingAttrOptions
cookie	string	可缺省,详细介绍见关键词

操作完成则回调CR.SetMeetingAttrsRslt

CR.AddOrUpdateMeetingAttrs(attrs ,options ,cookie)

功能: 增加或者更新房间属性
返回值: 无

参数	类型	说明
attrs	string	房间属性集,json格式，如：{"key1":"value1", "key2":"value2"} (key最大长度为64B，value最大长度为8KB)
options	string	操作选项,json格式参见CRVideo_MeetingAttrOptions
cookie	string	可缺省,详细介绍见关键词

操作完成则回调CR.AddOrUpdateMeetingAttrsRslt

CR.DelMeetingAttrs(keys ,options ,cookie)

功能: 删除房间属性
返回值: 无

参数	类型	说明
keys	array	需要删除的房间属性key，如：["key1", "key2"]
options	string	操作选项,json格式参见CRVideo_MeetingAttrOptions
cookie	string	可缺省,详细介绍见关键词

操作完成则回调CR.DelMeetingAttrsRslt

CR.ClearMeetingAttrs(options ,cookie)

功能: 清除房间所有属性
返回值: 无

参数	类型	说明
options	string	操作选项,json格式参见CRVideo_MeetingAttrOptions
cookie	string	可缺省,详细介绍见关键词

操作完成则回调CR.ClearMeetingAttrsRslt

CR.GetUserAttrs(uids ,keys ,cookie)

功能: 获取指定用户的指定属性
返回值: 无

参数	类型	说明
uids	array	目标用户id列表，一次最多包含50个用，如：["uid1","uid2"]
keys	array	将要获取的用户属性key列表（空串代表获取全部），如：["key1","key2"]
cookie	string	可缺省,详细介绍见关键词

获取成功则回调 CR.GetUserAttrsSuccess ,获取失败则回调 CR.GetUserAttrsFail

CR.SetUserAttrs(UID ,attrs ,options ,cookie)

功能: 重置用户属性
返回值: 无

参数	类型	说明
UID	string	用户ID, 详细介绍见关键词
attrs	string	用户属性集, json格式，如：{"key1":"value1", "key2":"value2"} (key最大长度为64B，value最大长度为8KB)
options	string	操作选项,json格式参见CRVideo_MeetingAttrOptions
cookie	string	可缺省,详细介绍见关键词

操作完成则回调CR.SetUserAttrsRslt

CR.AddOrUpdateUserAttrs(UID ,attrs ,options ,cookie)

功能: 增加或更新用户属性
返回值: 无

参数	类型	说明
UID	string	用户ID, 详细介绍见关键词
attrs	string	用户属性集, json格式，如：{"key1":"value1", "key2":"value2"} (key最大长度为64B，value最大长度为8KB)
options	string	操作选项,json格式参见CRVideo_MeetingAttrOptions
cookie	string	可缺省,详细介绍见关键词

操作完成则回调CR.AddOrUpdateUserAttrsRslt

CR.DelUserAttrs(UID ,keys ,options ,cookie)

功能: 删除用户的特定属性
返回值: 无

参数	类型	说明
UID	string	用户ID, 详细介绍见关键词
keys	array	需要删除的用户属性key列表，json格式，如：["key1","key2"]
options	string	操作选项,json格式参见CRVideo_MeetingAttrOptions
cookie	string	可缺省,详细介绍见关键词

操作完成则回调CR.DelUserAttrsRslt

CR.ClearUserAttrs(uids ,options ,cookie)

功能: 清除特定用户的所有属性
返回值: 无

参数	类型	说明
uids	string \| array	目标用户UID或UID数组
options	string	操作选项,json格式参见CRVideo_MeetingAttrOptions
cookie	string	可缺省,详细介绍见关键词

操作完成则回调CR.ClearUserAttrsRslt

CR.ClearAllUserAttrs(options ,cookie)

功能: 清除所有用户的所有属性
返回值: 无

参数	类型	说明
options	string	操作选项,json格式参见CRVideo_MeetingAttrOptions
cookie	string	可缺省,详细介绍见关键词

操作完成则回调CR.ClearAllUserAttrsRslt

CR.GetMeetingAttrsSuccess.callback = function(attrs ,cookie){}

功能：成功获取到房间属性
参数：

参数	类型	说明
attrs	object	房间属性，结构体请参见CRVideo_MeetingAttrObjs
cookie	string	详细介绍见cookie

CR.GetMeetingAttrsFail.callback = function(sdkErr ,cookie){}

功能：获取房间指定属性失败
参数：

参数	类型	说明
sdkErr	number	错误码，详细见错误码定义
cookie	string	详细介绍见cookie

CR.GetMeetingAllAttrsSuccess.callback = function(attrs ,cookie){}

功能：成功获取到房间所有属性
参数：

参数	类型	说明
attrs	object	房间属性，结构体请参见CRVideo_MeetingAttrObjs
cookie	string	详细介绍见cookie

CR.GetMeetingAllAttrsFail.callback = function(sdkErr ,cookie){}

功能：获取房间属性失败
参数：

参数	类型	说明
sdkErr	number	错误码，详细见错误码定义
cookie	string	详细介绍见cookie

CR.SetMeetingAttrsRslt.callback = function(sdkErr ,cookie){}

功能：设置用户属性结果
参数：

参数	类型	说明
sdkErr	number	错误码，详细见错误码定义
cookie	string	详细介绍见cookie

CR.AddOrUpdateMeetingAttrsRslt.callback = function(sdkErr ,cookie){}

功能：增加或更新房间属性结果
参数：

参数	类型	说明
sdkErr	number	错误码，详细见错误码定义
cookie	string	详细介绍见cookie

CR.DelMeetingAttrsRslt.callback = function(sdkErr ,cookie){}

功能：删除房间属性结果
参数：

参数	类型	说明
sdkErr	number	错误码，详细见错误码定义
cookie	string	详细介绍见cookie

CR.ClearMeetingAttrsRslt.callback = function(sdkErr ,cookie){}

功能：清除房间属性结果
参数：

参数	类型	说明
sdkErr	number	错误码，详细见错误码定义
cookie	string	详细介绍见cookie

CR.GetUserAttrsSuccess.callback = function(attrsMap ,cookie){}

功能：获取房间内用户属性结果
参数：

参数	类型	说明
attrsMap	object	用户属性，结构体请参见CRVideo_UsrMeetingAttrObjs
cookie	string	详细介绍见cookie

CR.GetUserAttrsFail.callback = function(sdkErr ,cookie){}

功能：获取房间内用户属性失败
参数：

参数	类型	说明
sdkErr	number	错误码，详细见错误码定义
cookie	string	详细介绍见cookie

CR.SetUserAttrsRslt.callback = function(sdkErr ,cookie){}

功能：设置用户属性结果
参数：

参数	类型	说明
sdkErr	number	错误码，详细见错误码定义
cookie	string	详细介绍见cookie

CR.AddOrUpdateUserAttrsRslt.callback = function(sdkErr ,cookie){}

功能：增加或者更新用户属性结果
参数：

参数	类型	说明
sdkErr	number	错误码，详细见错误码定义
cookie	string	详细介绍见cookie

CR.DelUserAttrsRslt.callback = function(sdkErr ,cookie){}

功能：删除特定用户属性结果
参数：

参数	类型	说明
sdkErr	number	错误码，详细见错误码定义
cookie	string	详细介绍见cookie

CR.ClearUserAttrsRslt.callback = function(sdkErr ,cookie){}

功能：清除特定用户属性结果
参数：

参数	类型	说明
sdkErr	number	错误码，详细见错误码定义
cookie	string	详细介绍见cookie

CR.ClearAllUserAttrsRslt.callback = function(sdkErr ,cookie){}

功能：清除所有用户属性结果
参数：

参数	类型	说明
sdkErr	number	错误码，详细见错误码定义
cookie	string	详细介绍见cookie

CR.NotifyMeetingAttrsChanged.callback = function(adds ,updates ,delKeys){}

功能：通知房间属性发生改变
参数：

参数	类型	说明
adds	object	增加房间属性集，结构体请参见CRVideo_MeetingAttrOptions
updates	object	变化的房间属性集，结构体请参见CRVideo_MeetingAttrOptions
delKeys	array	被删除的房间属性的数组列表，如:["key1", "key2"]

CR.NotifyUserAttrsChanged.callback = function(UID ,adds ,updates ,delKeys){}

功能：通知用户属性发生改变
参数：

参数	类型	说明
UID	string	用户ID, 详细介绍见关键词
adds	object	增加用户属性集，json结构体请参见CRVideo_MeetingAttrOptions
updates	object	变化的用户属性集，json结构体请参见CRVideo_MeetingAttrOptions
delKeys	array	被删除的用户属性列表，json格式，如:["key1", "key2"]

CR.OpenMic(UID)

功能: 打开麦克风
返回值: 无

参数	类型	说明
UID	string	用户ID, 详细介绍见关键词

打开自已的麦克风时，先会进入到AOPENING状态，等服务器处理后才会进入AOPEN状态，此时说话才能被采集到

CR.CloseMic(UID)

功能: 关闭麦克风
返回值: 无

参数	类型	说明
UID	string	用户ID, 详细介绍见关键词

关麦操作是立即生效的，本地会立即停止采集

CR.AudioStatusChanged.callback = function(UID ,oldStatus ,newStatus){}

功能：通知用户音频状态变化
参数：

参数	类型	说明
UID	string	用户ID, 详细介绍见关键词
oldStatus	number	旧状态,参考麦克风状态
newStatus	number	新状态,参考麦克风状态

CR.OpenMicFailRslt.callback = function(){}

权限不足触发，用户可以跳转到权限设置手动打开

功能：通知麦克风打开失败
参数：无

CR.OpenVideo(UID)

功能: 打开摄像头
返回值: 无

参数	类型	说明
UID	string	用户ID, 详细介绍见关键词

CR.CloseVideo(UID)

功能: 关闭摄像头
返回值: 无

参数	类型	说明
UID	string	用户ID, 详细介绍见关键词

CR.SetDefaultVideo(UID)

功能: 切换摄像头
返回值: 无

参数	类型	说明
UID	string	用户ID, 详细介绍见关键词

CR.GetDefaultVideo(UID)

功能: 获取默认摄像头信息
返回值: 返回摄像头Id(number)

参数	类型	说明
UID	string	用户ID, 详细介绍见关键词

CR.GetWatchableVideos(UID)

功能: 房间内可观看摄像头列表
返回值: 对象VideoIDArray（Array ------ CRVideo_VideoIDsObj）

参数	类型	说明
UID	string	用户的UID，非必传。不传则返回会议内所有成员的可观看摄像头列表

CR.GetAllVideoInfo(UID)

功能: 获取用户的所有摄像头信息(包含未开启的摄像头)
返回值: 用户的所有摄像头信息列表，数据类型为: CRVideo_VideoInfosObj

参数	类型	说明
UID	string	用户的UID

CR.VideoStatusChanged.callback = function(UID ,oldStatus ,newStatus){}

功能：通知用户视频状态变化
参数：

参数	类型	说明
UID	string	用户ID, 详细介绍见关键词
oldStatus	number	旧状态,参考摄像头状态
newStatus	number	新状态,参考摄像头状态

CR.OpenVideoFailRslt.callback = function(){}

权限不足触发，用户可以跳转到权限设置手动打开

功能：通知摄像头打开失败
参数：无

CR.VideoDevChanged.callback = function(UID ,openCamIds){}

功能：通知用户的视频设备有变化
参数：

参数	类型	说明
UID	string	用户ID, 详细介绍见关键词
openCamIds	array	该用户现在可观看的摄像头列表

CR.GetScreenInfo()

功能: 查询当前屏幕共享状态
返回值: 如果会议内存在屏幕共享则返回共享端的UID，如果没有则返回null

CR.GetMediaInfo()

功能: 查询当前影音共享状态
返回值: 无

查询结果在回调事件CR.GetMediaInfoRslt

CR.GetMediaInfoRslt.callback = function(sdkErr ,CRVideo_MediaInfoObj){}

功能：通知查询影音共享状态的结果
参数：

参数	类型	说明
sdkErr	number	错误码，详细见错误码定义
CRVideo_MediaInfoObj	object	影音文件信息（CRVideo_MediaInfoObj）

CR.NotifyScreenShareStarted.callback = function(UID){}

收到该通知即可渲染媒体拉流组件

功能：收到他人开启了屏幕共享的通知
参数：

参数	类型	说明
UID	string	开启屏幕共享用户的UID

CR.NotifyScreenShareStopped.callback = function(UID){}

收到该通知即可销毁媒体拉流组件

功能：收到他人停止了屏幕共享的通知
参数：

参数	类型	说明
UID	string	关闭屏幕共享用户的UID

CR.NotifyMediaStart.callback = function(UID){}

收到该通知即可渲染媒体拉流组件

功能：收到他人开启了影音共享的通知
参数：

参数	类型	说明
UID	string	开启屏幕共享用户的UID

CR.NotifyMediaPause.callback = function(UID ,pause){}

功能：收到他人暂停了影音共享的通知
参数：

参数	类型	说明
UID	string	开启屏幕共享用户的UID
pause	number	是否暂停 1暂停 0播放

CR.NotifyMediaStop.callback = function(UID){}

收到该通知即可销毁媒体拉流组件

功能：收到他人停止了影音共享的通知
参数：

参数	类型	说明
UID	string	开启屏幕共享用户的UID

CR.GetSvrMixerState()

功能: 获取云端录制、云端直播状态
返回值: CRVideo_MIXER_STATE

CR.StartSvrMixer(mutiMixerCfgs ,mutiMixerContents ,mutiMixerOutputs)

功能: 开启云端录制/开启云端直播
返回值: 错误码

参数	类型	说明
mutiMixerCfgs	CRVideo_MutiMixerCfgsObj	服务器混图配置
mutiMixerContents	CRVideo_MutiMixerContentsObj	服务器混图内容
mutiMixerOutputs	CRVideo_MutiMixerOutputsObj	服务器输出

录制开启有状态变化CR.SvrRecordStateChanged

CR.UpdateSvrMixerContent(mutiMixerContents)

功能: 更新云端录制、云端直播内容
返回值: 错误码

参数	类型	说明
mutiMixerContents	CRVideo_MutiMixerContentsObj	服务器混图内容

CR.StopSvrMixer()

功能: 停止云端录制、云端直播
返回值: 无

停止后可以监听云端录制文件状态

CR.SvrRecordStateChanged.callback = function(SvrRecordState){}

功能：通知云端录制、云端直播状态变化
参数：

参数	类型	说明
SvrRecordState	CRVideo_MIXER_STATE	通知云端录制、云端直播状态码变化

CR.SvrRecVideosChanged.callback = function(mutiMixerContents){}

功能：通知云端录制、云端直播内容变化
参数：

参数	类型	说明
mutiMixerContents	CRVideo_MutiMixerContentsObj	服务器混图内容

CR.SvrMixerOutputInfo.callback = function(outputInfo){}

功能：通知云端录制文件、云端直播信息变化
参数：

参数	类型	说明
outputInfo	CRVideo_MixerOutputInfoObj	通知内容

← 实现音视频通话组件 →