API

API概述

接口描述

基础函数

初始化/反初始化

登录/注销/掉线

队列管理

呼叫

邀请

房间管理

进出房间

房间内基础消息

房间、用户属性

房间成员管理

音频管理

视频管理

屏幕共享

影音共享

云端录制/互动直播

可视化UI组件

房间外点对点消息通道

房间内广播消息

接口详情

CRVideo_GetSDKVersion

• 详情：CRVideo_GetSDKVersion()
• 描述：获取当前SDK版本号
• 返回值：当前sdk版本，如："1.8.0.3"
• 回调：无

CRVideo_WriteLog

• 详情：CRVideo_WriteLog(strLog)
• 描述：向日志中写入自定义内容
• 返回值：无
• 回调：无

CRVideo_SetSDKParams

• 详情：CRVideo_SetSDKParams(SDKParams)
• 描述：设置SDK基础配置
• 返回值：无
• 回调：无
• 参数：

  参数	类型	必传	含义
  SDKParams	Object	否	SDK参数对象，详见：CRVideo_SDKParams，不传则为默认值

CRVideo_Init

• 详情：CRVideo_Init(SDKParams).then(res=>{},err=>{})
• 描述：SDK初始化
• 返回值：返回一个promise对象，成功返回resolve，失败返回reject 错误码
• 回调：无
• 参数：

  参数	类型	必传	含义
  SDKParams	Object	否	SDK参数对象，详见：CRVideo_SDKParams，可以不传，则全部为默认值

      // 传一个对象，对象内设置具体参数（只传需要修改的参数，不传的参数为缺省值）
      CRVideo_Init({
          isCallSer: false,
          MSProtocol: 1,
          videoSendBW: 1024,
          //...
      }).then(res => {
          //初始化成功后的处理...
      }, err => {
          //初始化失败后的处理...
      })
  
      //或者不传这个对象，全部为缺省值
      CRVideo_Init().then(res => {
          //初始化成功后的处理...
      }, err => {
          //初始化失败后的处理...
      })

      // 注：.then(callback1,callback2)方法中的参数为两个回调函数
      // 第一个参数为初始化成功的回调函数，第二个参数为初始化失败的回调函数
      // 可以通过错误码判断初始化失败的原因

CRVideo_Uninit

• 详情：CRVideo_Uninit()
• 描述：SDK反初始化
• 返回值：无
• 回调：无

CRVideo_SetServerAddr

• 详情：CRVideo_SetServerAddr(ServerAddr)
• 描述：设置服务器地址
• 返回值：无
• 回调：无
• 参数：

  参数	类型	必传	含义
  ServerAddr	String	是	登录的服务器地址，如：10.8.8.122:2726 或 sdk.cloudroom.com

CRVideo_Login

• 详情：CRVideo_Login(appID,appSecret,nickname,UID,userAuthCode,cookie)
• 描述：登录（帐号密码鉴权）
• 返回值：无
• 回调：登陆成功则回调 CRVideo_LoginSuccess.callback，登陆失败则回调 CRVideo_LoginFail.callback
• 参数：

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

CRVideo_LoginByToken

• 详情：CRVideo_LoginByToken(Token,nickname,UID,userAuthCode,cookie)
• 描述：登录（Token鉴权）
• 返回值：无
• 回调：登陆成功则回调 CRVideo_LoginSuccess.callback，登陆失败则回调 CRVideo_LoginFail.callback
• 参数：

  参数	类型	必传	含义
  Token	String	是	Token鉴权码
  nickname	String	是	昵称
  UID	String	是	用户ID, 详细介绍见 关键词
  userAuthCode	String	否	用户验证信息，为空代表不需要sdk验证（一般由业务方先对UID认证完了，再来使用云屋sdk)。如果不为空，云屋sdk服务器将连接提前配好的业务方服务器进行实时验证。（SDK管理后台-项目管理可以配置）
  cookie	String	否	详细介绍见 关键词，可以传空串

CRVideo_UpdateToken

• 详情：CRVideo_UpdateToken(Token)
• 描述：更新Token
• 返回值：无
• 回调：无
• 参数：

  参数	类型	必传	含义
  Token	String	是	新的Token鉴权码

CRVideo_Logout

• 详情：CRVideo_Logout()
• 描述：注销登录
• 返回值：无
• 回调：无

CRVideo_LoginSuccess

• 详情：CRVideo_LoginSuccess.callback=function(UID,cookie) {}
• 描述：回调，登陆成功
• 回调参数：

  参数	类型	含义
  UID	String	用户ID, 详细介绍见 关键词
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_LoginFail

• 详情：CRVideo_LoginFail.callback=function(sdkErr,cookie) {}
• 描述：回调，登录失败
• 回调参数：

  参数	类型	含义
  sdkErr	Number	错误码，详细见 错误码定义
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_NotifyTokenWillExpire

• 详情：CRVideo_NotifyTokenWillExpire.callback=function(){}
• 描述：通知，Token即将失效

CRVideo_LineOff

• 详情：CRVideo_LineOff.callback=function(sdkErr){}
• 描述：通知，从服务器掉线了
• 回调参数：

  参数	类型	含义
  sdkErr	Number	错误码，详细见 错误码定义

CRVideo_InitQueueDat

• 详情：CRVideo_InitQueueDat(cookie)
• 描述：初始化队列数据
• 返回值：无
• 回调：CRVideo_InitQueueDatRslt.callback
• 参数：

  参数	类型	必传	含义
  cookie	String	否	详细介绍见 关键词，可以传空串

CRVideo_GetAllQueueInfo

• 详情：CRVideo_GetAllQueueInfo()
• 描述：查询所有队列的信息
• 返回值：所有队列的信息集合（数组），其中每个队列信息：CRVideo_QueueInfo
• 回调：无

CRVideo_RefreshAllQueueStatus

• 详情：CRVideo_RefreshAllQueueStatus(nolog)
• 描述：刷新所有队列的状态
• 返回值：无
• 回调：无
• 参数：

  参数	类型	必传	含义
  nolog	Bool	否	是否禁止SDK打印此接口的日志，缺省为空，不禁止。当需要频繁调用此接口时，可以传true，SDK将不会打印此接口的日志。

CRVideo_GetQueueStatus

• 详情：CRVideo_GetQueueStatus(queID,cookie)
• 描述：获取某个队列的状态
• 返回值：无
• 回调：CRVideo_GetQueueStatusRslt.callback
• 参数：

  参数	类型	必传	含义
  queID	Number	是	队列ID
  cookie	String	否	详细介绍见 关键词，可以传空串

CRVideo_GetQueuingInfo

• 详情：CRVideo_GetQueuingInfo()
• 描述：获取我的排队信息
• 返回值：返回排队信息 CRVideo_QueuingInfo
• 回调：无

CRVideo_GetServingQueues

• 详情：CRVideo_GetServingQueues()
• 描述：获取我当前服务的所有队列
• 返回值：返回我当前服务的队列ID列表，Array: 如 [1,2,3]
• 回调：无

CRVideo_GetSessionInfo

• 详情：CRVideo_GetSessionInfo()
• 描述：获取我的会话信息
• 返回值：返回会话信息 CRVideo_SessionInfo
• 回调：无

CRVideo_StartQueuing

• 详情：CRVideo_StartQueuing(queID,usrExtDat,cookie)
• 描述：开始排队
• 返回值：无
• 回调：CRVideo_StartQueuingRslt.callback
• 参数：

  参数	类型	必传	含义
  queID	Number	是	队列ID
  usrExtDat	String	否	用户排队携带的扩展数据, 座席在服务时可获得
  cookie	String	否	详细介绍见 关键词，可以传空串

CRVideo_StopQueuing

• 详情：CRVideo_StopQueuing(cookie)
• 描述：停止排队
• 返回值：无
• 回调：CRVideo_StopQueuingRslt.callback
• 参数：

  参数	类型	必传	含义
  cookie	String	否	详细介绍见 关键词，可以传空串

CRVideo_StartService

• 详情：CRVideo_StartService(queID,priority,cookie)
• 描述：坐席开始服务某个队列
• 返回值：无
• 回调：CRVideo_StartServiceRslt.callback
• 参数：

  参数	类型	必传	含义
  queID	Number	是	队列ID
  priority	Number	是	坐席优先级(缺省为0,取值为0~1000内整数。值越小优先级越高。0为最高优先级)
  cookie	String	否	详细介绍见 关键词，可以传空串

CRVideo_StopService

• 详情：CRVideo_StopService(queID,cookie)
• 描述：坐席停止服务某个队列
• 返回值：无
• 回调：CRVideo_StopServiceRslt.callback
• 参数：

  参数	类型	必传	含义
  queID	Number	是	队列ID
  cookie	String	否	详细介绍见 关键词，可以传空串

CRVideo_ReqAssignUser

• 详情：CRVideo_ReqAssignUser(cookie, queID, UID)
• 描述：坐席请求分配一个客户
• 返回值：无
• 回调：CRVideo_ReqAssignUserRslt.callback
• 参数：

  参数	类型	必传	含义
  cookie	String	否	详细介绍见 关键词，可以传空串
  queID	Number	否	队列ID
  UID	String	否	用户ID, 详细介绍见 关键词

CRVideo_AcceptAssignUser

• 详情：CRVideo_AcceptAssignUser(queID,UID,cookie)
• 描述：坐席接受系统分配的客户
• 返回值：无
• 回调：CRVideo_ResponseAssignUserRslt.callback
• 参数：

  参数	类型	必传	含义
  queID	Number	是	队列ID
  UID	String	是	用户ID, 详细介绍见 关键词
  cookie	String	否	详细介绍见 关键词，可以传空串

CRVideo_RejectAssignUser

• 详情：CRVideo_RejectAssignUser(queID,UID,cookie)
• 描述：坐席拒绝系统分配的客户
• 返回值：无
• 回调：CRVideo_ResponseAssignUserRslt.callback
• 参数：

  参数	类型	必传	含义
  queID	Number	是	队列ID
  UID	String	是	用户ID, 详细介绍见 关键词
  cookie	String	否	详细介绍见 关键词，可以传空串

CRVideo_InitQueueDatRslt

• 详情：CRVideo_InitQueueDatRslt.callback = function(sdkErr,cookie){}
• 描述：回调，队列初始化操作的结果响应
• 回调参数：

  参数	类型	含义
  sdkErr	Number	错误码，详细见 错误码定义
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_QueueStatusChanged

• 详情：CRVideo_QueueStatusChanged.callback = function(QueStatus){}
• 描述：通知，队列状态变化
• 回调参数：

  参数	类型	含义
  QueStatus	Object	用户队列状态，详见：CRVideo_QueStatus

CRVideo_GetQueueStatusRslt

• 详情：CRVideo_GetQueueStatusRslt.callback = function(QueStatus,sdkErr,cookie){}
• 描述：回调，获取某个队列状态的结果响应
• 回调参数：

  参数	类型	含义
  QueStatus	Object	用户队列状态，详见：CRVideo_QueStatus
  sdkErr	Number	错误码，详细见 错误码定义

CRVideo_QueuingInfoChanged

• 详情：CRVideo_QueuingInfoChanged.callback = function(CRVideo_QueuingInfo){}
• 描述：通知，排队信息变化（客户）
• 回调参数：

  参数	类型	含义
  CRVideo_QueuingInfo	Object	排队信息 CRVideo_QueuingInfo

CRVideo_StartQueuingRslt

• 详情：CRVideo_StartQueuingRslt.callback = function(sdkErr,cookie){}
• 描述：回调，开始排队的结果响应（客户）
• 回调参数：

  参数	类型	含义
  sdkErr	Number	错误码，详细见 错误码定义
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_StopQueuingRslt

• 详情：CRVideo_StopQueuingRslt.callback = function(sdkErr,cookie){}
• 描述：回调，停止排队的结果响应（客户）
• 回调参数：

  参数	类型	含义
  sdkErr	Number	错误码，详细见 错误码定义
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_StartServiceRslt

• 详情：CRVideo_StartServiceRslt.callback = function(queID,sdkErr,cookie){}
• 描述：回调，开始服务某个队列的结果响应（坐席）
• 回调参数：

  参数	类型	含义
  queID	Number	队列ID
  sdkErr	Number	错误码，详细见 错误码定义
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_StopServiceRslt

• 详情：CRVideo_StopServiceRslt.callback = function(queID,sdkErr,cookie){}
• 描述：回调，停止服务某个队列的结果响应（坐席）
• 回调参数：

  参数	类型	含义
  queID	Number	队列ID
  sdkErr	Number	错误码，详细见 错误码定义
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_ResponseAssignUserRslt

• 详情：CRVideo_ResponseAssignUserRslt.callback = function(sdkErr,cookie){}
• 描述：回调，响应系统分配客户的结果（坐席）
• 回调参数：

  参数	类型	含义
  sdkErr	Number	错误码，详细见 错误码定义
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_AutoAssignUser

• 详情：CRVideo_AutoAssignUser.callback = function(CRVideo_QueUser){}
• 描述：通知，系统自动分配了客户（坐席）
• 回调参数：

  参数	类型	含义
  CRVideo_QueUser	Object	队列用户信息, 详细介绍见 类型定义

CRVideo_ReqAssignUserRslt

• 详情：CRVideo_ReqAssignUserRslt.callback = function(sdkErr,CRVideo_QueUser,cookie){}
• 描述：回调，请求系统分配客户的结果（坐席）
• 回调参数：

  参数	类型	含义
  sdkErr	Number	错误码，详细见 错误码定义
  CRVideo_QueUser	Object	队列用户信息, 详细介绍见 类型定义
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_CancelAssignUser

• 详情：CRVideo_CancelAssignUser.callback = function(queID,UID){}
• 描述：通知，系统取消分配客户（坐席）
• 回调参数：

  参数	类型	含义
  queID	Number	队列ID
  UID	String	用户ID, 详细介绍见 关键词

CRVideo_Call

• 详情：CRVideo_Call(calledUID,MeetInfoObj,userExtDat,cookie)
• 描述：发起呼叫
• 返回值：无
• 回调：呼叫成功回调 CRVideo_CallSuccess.callback，呼叫失败回调 CRVideo_CallFail.callback
• 参数：

  参数	类型	必传	含义
  calledUID	String	是	被叫用户的 UID
  MeetInfoObj	Object	是	房间信息对象，详见：CRVideo_RoomInfoObj
  userExtDat	String	否	自定义扩展参数，没有则传空串
  cookie	String	否	详细介绍见 关键词，可以传空串

CRVideo_AcceptCall

• 详情：CRVideo_AcceptCall(callID,MeetInfoObj,userExtDat,cookie)
• 描述：接受对方发起的呼叫
• 返回值：无
• 回调：成功回调 CRVideo_AcceptCallSuccess.callback，失败回调 CRVideo_AcceptCallFail.callback
• 参数：

  参数	类型	必传	含义
  callID	String	是	呼叫全局标识ID
  MeetInfoObj	Object	是	房间信息对象，详见：CRVideo_RoomInfoObj
  userExtDat	String	否	自定义扩展参数，没有则传空串
  cookie	String	否	详细介绍见 关键词，可以传空串

CRVideo_RejectCall

• 详情：CRVideo_RejectCall(callID,userExtDat,cookie)
• 描述：拒绝对方发起的呼叫
• 返回值：无
• 回调：成功回调 CRVideo_RejectCallSuccess.callback，失败回调 CRVideo_RejectCallFail.callback
• 参数：

  参数	类型	必传	含义
  callID	String	是	呼叫全局标识ID
  userExtDat	String	否	自定义扩展参数，没有则传空串
  cookie	String	否	详细介绍见 关键词，可以传空串

CRVideo_HangupCall

• 详情：CRVideo_HangupCall(callID,userExtDat,cookie)
• 描述：挂断当前的呼叫
• 返回值：无
• 回调：成功回调 CRVideo_HangupCallSuccess.callback，失败回调 CRVideo_HangupCallFail.callback
• 参数：

  参数	类型	必传	含义
  callID	String	是	呼叫全局标识ID
  userExtDat	String	否	自定义扩展参数，没有则传空串
  cookie	String	否	详细介绍见 关键词，可以传空串

CRVideo_SetDNDStatus

• 详情：CRVideo_SetDNDStatus(DNDStatus,cookie)
• 描述：设置免打扰状态
• 返回值：无
• 回调：操作成功回调 CRVideo_SetDNDStatusSuccess.callback，失败回调 CRVideo_SetDNDStatusFail.callback
• 参数：

  参数	类型	必传	含义
  DNDStatus	Number	是	0代表关闭免打扰， 其它值代表开启免打扰，含义自由定义
  cookie	String	否	详细介绍见 关键词，可以传空串

CRVideo_GetUserStatus

• 详情：CRVideo_GetUserStatus(cookie)
• 描述：获取AppID下所有用户在线状态
• 返回值：无
• 回调：成功回调，CRVideo_GetUserStatusSuccess.callback，失败回调，CRVideo_GetUserStatusFail.callback
• 参数：

  参数	类型	必传	含义
  cookie	String	否	详细介绍见 关键词，可以传空串

CRVideo_GetOneUserStatus

• 详情：CRVideo_GetOneUserStatus(UID,cookie)
• 描述：获取AppID下指定用户的在线状态
• 返回值：无
• 回调：成功回调，CRVideo_GetUserStatusSuccess.callback，失败回调，CRVideo_GetUserStatusFail.callback
• 参数：

  参数	类型	必传	含义
  UID	String	是	用户ID, 详细介绍见 关键词
  cookie	String	否	详细介绍见 关键词，可以传空串

CRVideo_StartUserStatusNotify

• 详情：CRVideo_StartUserStatusNotify(cookie)
• 描述：开启用户的状态推送
• 返回值：无
• 回调：CRVideo_StartUserStatusNotifyRslt.callback
• 参数：

  参数	类型	必传	含义
  cookie	String	否	详细介绍见 关键词，可以传空串

CRVideo_StopUserStatusNotify

• 详情：CRVideo_StopUserStatusNotify(cookie)
• 描述：关闭用户的状态推送
• 返回值：无
• 回调：CRVideo_StopUserStatusNotifyRslt.callback
• 参数：

  参数	类型	必传	含义
  cookie	String	否	详细介绍见 关键词，可以传空串

CRVideo_CallSuccess

• 详情：CRVideo_CallSuccess.callback = function(callID,cookie){}
• 描述：回调，发起呼叫成功
• 回调参数：

  参数	类型	含义
  callID	String	呼叫全局标识ID
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_CallFail

• 详情：CRVideo_CallFail.callback = function(callID,sdkErr,cookie){}
• 描述：回调，发起呼叫失败
• 回调参数：

  参数	类型	含义
  callID	String	呼叫全局标识ID
  sdkErr	Number	错误码，详细见 错误码定义
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_AcceptCallSuccess

• 详情：CRVideo_AcceptCallSuccess.callback = function(callID,cookie){}
• 描述：回调，接受他人的呼叫成功
• 回调参数：

  参数	类型	含义
  callID	String	呼叫全局标识ID
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_AcceptCallFail

• 详情：CRVideo_AcceptCallFail.callback = function(callID,sdkErr,cookie){}
• 描述：回调，接受他人的呼叫失败
• 回调参数：

  参数	类型	含义
  callID	String	呼叫全局标识ID
  sdkErr	Number	错误码，详细见 错误码定义
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_RejectCallSuccess

• 详情：CRVideo_RejectCallSuccess.callback = function(callID,cookie){}
• 描述：回调，拒绝他人的呼叫成功
• 回调参数：

  参数	类型	含义
  callID	String	呼叫全局标识ID
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_RejectCallFail

• 详情：CRVideo_RejectCallFail.callback = function(callID,sdkErr,cookie){}
• 描述：回调，拒绝他人的呼叫失败
• 回调参数：

  参数	类型	含义
  callID	String	呼叫全局标识ID
  sdkErr	Number	错误码，详细见 错误码定义
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_HangupCallSuccess

• 详情：CRVideo_HangupCallSuccess.callback = function(callID,cookie){}
• 描述：回调，挂断呼叫成功
• 回调参数：

  参数	类型	含义
  callID	String	呼叫全局标识ID
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_HangupCallFail

• 详情：CRVideo_HangupCallFail.callback = function(callID,sdkErr,cookie){}
• 描述：回调，挂断呼叫失败
• 回调参数：

  参数	类型	含义
  callID	String	呼叫全局标识ID
  sdkErr	Number	错误码，详细见 错误码定义
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_NotifyCallIn

• 详情：CRVideo_NotifyCallIn.callback = function(callID,MeetInfoObj,callerID,userExtDat){}
• 描述：通知，有人呼叫自己
• 回调参数：

  参数	类型	含义
  callID	String	呼叫全局标识ID
  MeetInfoObj	Object	房间信息对象，详见：CRVideo_RoomInfoObj
  callerID	String	对方呼叫人员的标识ID
  userExtDat	String	自定义扩展参数，没有则传空串

CRVideo_NotifyCallAccepted

• 详情：CRVideo_NotifyCallAccepted.callback = function(callID,MeetInfoObj,userExtDat){}
• 描述：通知，呼叫被对方接受
• 回调参数：

  参数	类型	含义
  callID	String	呼叫全局标识ID
  MeetInfoObj	Object	房间信息对象，详见：CRVideo_RoomInfoObj
  userExtDat	String	自定义扩展参数，没有则传空串

CRVideo_NotifyCallRejected

• 详情：CRVideo_NotifyCallRejected.callback = function(callID,sdkErr,userExtDat){}
• 描述：通知，呼叫被对方拒绝
• 回调参数：

  参数	类型	含义
  callID	String	呼叫全局标识ID
  sdkErr	Number	错误码，详细见 错误码定义
  userExtDat	String	自定义扩展参数，没有则传空串

CRVideo_NotifyCallHangup

• 详情：CRVideo_NotifyCallHangup.callback = function(callID,userExtDat){}
• 描述：通知，呼叫被对方挂断
• 回调参数：

  参数	类型	含义
  callID	String	呼叫全局标识ID
  userExtDat	String	自定义扩展参数，没有则传空串

CRVideo_SetDNDStatusSuccess

• 详情：CRVideo_SetDNDStatusSuccess.callback = function(cookie){}
• 描述：回调，设置免打扰状态成功
• 回调参数：

  参数	类型	含义
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_SetDNDStatusFail

• 详情：CRVideo_SetDNDStatusFail.callback = function(sdkErr,cookie){}
• 描述：回调，设置免打扰状态失败
• 回调参数：

  参数	类型	含义
  sdkErr	Number	错误码，详细见 错误码定义
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_GetUserStatusSuccess

• 详情：CRVideo_GetUserStatusSuccess.callback = function(userStatusArr,cookie){}
• 描述：回调，获取用户在线状态成功
• 回调参数：

  参数	类型	含义
  userStatusArr	Array	用户在线状态信息列表，[CRVideo_UserStatus, ...]
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_GetUserStatusFail

• 详情：CRVideo_GetUserStatusFail.callback = function(sdkErr,cookie){}
• 描述：回调，获取用户在线状态失败
• 回调参数：

  参数	类型	含义
  sdkErr	Number	错误码，详细见 错误码定义
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_StartUserStatusNotifyRslt

• 详情：CRVideo_StartUserStatusNotifyRslt.callback = function(sdkErr,cookie){}
• 描述：回调，开启用户状态推送的结果
• 回调参数：

  参数	类型	含义
  sdkErr	Number	错误码，详细见 错误码定义
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_StopUserStatusNotifyRslt

• 详情：CRVideo_StopUserStatusNotifyRslt.callback = function(sdkErr,cookie){}
• 描述：回调，停止用户状态推送的结果
• 回调参数：

  参数	类型	含义
  sdkErr	Number	错误码，详细见 错误码定义
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_NotifyUserStatus

• 详情：CRVideo_NotifyUserStatus.callback = function(CRVideo_UserStatus){}
• 描述：通知，用户的状态变化
• 回调参数：

  参数	类型	含义
  CRVideo_UserStatus	Object	单个用户在线状态信息，类型定义： CRVideo_UserStatus

CRVideo_Invite

• 详情：CRVideo_Invite(invitedUserID,userExtDat,cookie)
• 描述：发送邀请
• 返回值：返回inviteID(每个邀请对应的唯一ID) (string)
• 回调：成功回调 CRVideo_InviteSuccess.callback，失败回调 CRVideo_InviteFail.callback
• 参数：

  参数	类型	必传	含义
  invitedUserID	String	是	受邀者用户的 UID
  userExtDat	String	否	自定义扩展参数，没有则传空串
  cookie	String	否	详细介绍见 关键词，可以传空串

CRVideo_AcceptInvite

• 详情：CRVideo_AcceptInvite(inviteID,userExtDat,cookie)
• 描述：接受对方发送的邀请
• 返回值：无
• 回调：成功回调 CRVideo_AcceptInviteSuccess.callback，失败回调 CRVideo_AcceptInviteFail.callback
• 参数：

  参数	类型	必传	含义
  inviteID	String	是	邀请ID，在收到邀请时获取
  userExtDat	String	否	自定义扩展参数，没有则传空串
  cookie	String	否	详细介绍见 关键词，可以传空串

CRVideo_RejectInvite

• 详情：CRVideo_RejectInvite(inviteID,userExtDat,cookie)
• 描述：拒绝对方发送的邀请
• 返回值：无
• 回调：成功回调 CRVideo_RejectInviteSuccess.callback，失败回调 CRVideo_RejectInviteFail.callback
• 参数：

  参数	类型	必传	含义
  inviteID	String	是	邀请ID，在收到邀请时获取
  userExtDat	String	否	自定义扩展参数，没有则传空串
  cookie	String	否	详细介绍见 关键词，可以传空串

CRVideo_CancelInvite

• 详情：CRVideo_CancelInvite(inviteID,userExtDat,cookie)
• 描述：取消自己发送的邀请
• 返回值：无
• 回调：成功回调 CRVideo_CancelInviteSuccess.callback，失败回调 CRVideo_CancelInviteFail.callback
• 参数：

  参数	类型	必传	含义
  inviteID	String	是	邀请ID，在发送邀请时接口返回
  userExtDat	String	否	自定义扩展参数，没有则传空串
  cookie	String	否	详细介绍见 关键词，可以传空串

CRVideo_InviteSuccess

• 详情：CRVideo_InviteSuccess.callback = function(inviteID,cookie){}
• 描述：回调，发送邀请成功
• 回调参数：

  参数	类型	含义
  inviteID	String	邀请ID
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_InviteFail

• 详情：CRVideo_InviteFail.callback = function(inviteID,sdkErr,cookie){}
• 描述：回调，发送邀请失败
• 回调参数：

  参数	类型	含义
  inviteID	String	邀请ID
  sdkErr	Number	错误码，详细见 错误码定义
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_AcceptInviteSuccess

• 详情：CRVideo_AcceptInviteSuccess.callback = function(inviteID,cookie){}
• 描述：回调，接受对方发送的邀请成功
• 回调参数：

  参数	类型	含义
  inviteID	String	邀请ID
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_AcceptInviteFail

• 详情：CRVideo_AcceptInviteFail.callback = function(inviteID,sdkErr,cookie){}
• 描述：回调，接受对方发送的邀请失败
• 回调参数：

  参数	类型	含义
  inviteID	String	邀请ID
  sdkErr	Number	错误码，详细见 错误码定义
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_RejectInviteSuccess

• 详情：CRVideo_RejectInviteSuccess.callback = function(inviteID,cookie){}
• 描述：回调，拒绝对方发送的邀请成功
• 回调参数：

  参数	类型	含义
  inviteID	String	邀请ID
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_RejectInviteFail

• 详情：CRVideo_RejectInviteFail.callback = function(inviteID,sdkErr,cookie){}
• 描述：回调，拒绝对方发送的邀请失败
• 回调参数：

  参数	类型	含义
  inviteID	String	邀请ID
  sdkErr	Number	错误码，详细见 错误码定义
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_CancelInviteSuccess

• 详情：CRVideo_CancelInviteSuccess.callback = function(inviteID,cookie){}
• 描述：回调，取消自己发送的邀请成功
• 回调参数：

  参数	类型	含义
  inviteID	String	邀请ID
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_CancelInviteFail

• 详情：CRVideo_CancelInviteFail.callback = function(inviteID,sdkErr,cookie){}
• 描述：回调，取消自己发送的邀请失败
• 回调参数：

  参数	类型	含义
  inviteID	String	邀请ID
  sdkErr	Number	错误码，详细见 错误码定义
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_NotifyInviteIn

• 详情：CRVideo_NotifyInviteIn.callback = function(inviteID,inviterUserID,userExtDat){}
• 描述：通知，收到别人的邀请
• 回调参数：

  参数	类型	含义
  inviteID	String	邀请ID
  inviterUserID	String	发送邀请的用户ID
  userExtDat	String	自定义扩展参数，没有则传空串

CRVideo_NotifyInviteAccepted

• 详情：CRVideo_NotifyInviteAccepted.callback = function(inviteID,userExtDat){}
• 描述：通知，我发送的邀请被对方接受
• 回调参数：

  参数	类型	含义
  inviteID	String	邀请ID
  userExtDat	String	自定义扩展参数，没有则传空串

CRVideo_NotifyInviteRejected

• 详情：CRVideo_NotifyInviteRejected.callback = function(inviteID,reason,userExtDat){}
• 描述：通知，我发送的邀请被对方拒绝
• 回调参数：

  参数	类型	含义
  inviteID	String	邀请ID
  reason	String	邀请被拒绝的原因，详见：错误码
  userExtDat	String	自定义扩展参数，没有则传空串

CRVideo_NotifyInviteCanceled

• 详情：CRVideo_NotifyInviteCanceled.callback = function(inviteID,reason,userExtDat){}
• 描述：通知，邀请已经被取消了
• 回调参数：

  参数	类型	含义
  inviteID	String	邀请ID
  reason	String	邀请被取消的原因，详见：错误码
  userExtDat	String	自定义扩展参数，没有则传空串

CRVideo_CreateMeeting2

• 详情：CRVideo_CreateMeeting2(cookie)
• 描述：创建房间
• 返回值：无
• 回调：成功回调 CRVideo_CreateMeetingSuccess.callback，失败回调 CRVideo_CreateMeetingFail.callback
• 参数：

  参数	类型	必传	含义
  cookie	String	否	详细介绍见 关键词，可以传空串

CRVideo_DestroyMeeting

• 详情：CRVideo_DestroyMeeting(meetID,cookie)
• 描述：销毁房间
• 返回值：无
• 回调：CRVideo_DestroyMeetingRslt.callback
• 参数：

  参数	类型	必传	含义
  meetID	Number	是	房间号
  cookie	String	否	详细介绍见 关键词，可以传空串

CRVideo_CreateMeetingSuccess

• 详情：CRVideo_CreateMeetingSuccess.callback = function(MeetInfoObj,cookie){}
• 描述：回调，创建房间成功
• 回调参数：

  参数	类型	含义
  MeetInfoObj	Object	房间信息对象，详见：CRVideo_RoomInfoObj
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_CreateMeetingFail

• 详情：CRVideo_CreateMeetingFail.callback = function(sdkErr,cookie){}
• 描述：回调，创建房间失败
• 回调参数：

  参数	类型	含义
  sdkErr	Number	错误码，详细见 错误码定义
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_DestroyMeetingRslt

• 详情：CRVideo_DestroyMeetingRslt.callback = function(sdkErr,cookie){}
• 描述：回调，销毁房间的结果
• 回调参数：

  参数	类型	含义
  sdkErr	Number	错误码，详细见 错误码定义
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_MeetingStopped

• 详情：CRVideo_MeetingStopped.callback = function(){}
• 描述：通知，当前房间已被结束

CRVideo_EnterMeeting3

• 详情：CRVideo_EnterMeeting3(meetID,cookie)
• 描述：进入房间
• 返回值：无
• 回调：CRVideo_EnterMeetingRslt.callback
• 参数：

  参数	类型	必传	含义
  meetID	Number	是	房间号
  cookie	String	否	详细介绍见 关键词，可以传空串

CRVideo_ExitMeeting

• 详情：CRVideo_ExitMeeting()
• 描述：离开房间
• 返回值：无
• 回调：无

CRVideo_Kickout

• 详情：CRVideo_Kickout(UID).then(function(resObject){}).catch(function(errObject){})
• 描述：将房间内指定成员踢出房间
• 返回值：返回一个Promise对象，成功返回resolveCallback，失败返回rejectCallback
• 参数：

  参数	类型	必传	含义
  UID	String	是	用户ID, 详细介绍见 关键词

    CRVideo_Kickout(UID).then(resObj =>{
      // 成功
      const errCode = resObj.errCode;
      const userID = resObj.userID;
    }).catch(errObj =>{
      // 失败
      const errCode = errObj.errCode;
      const errDesc = errObj.errDesc;
    })

CRVideo_EnterMeetingRslt

• 详情：CRVideo_EnterMeetingRslt.callback = function(sdkErr,cookie){}
• 描述：回调，进入房间的结果
• 回调参数：

  参数	类型	含义
  sdkErr	Number	错误码，详细见 错误码定义
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_UserEnterMeeting

• 详情：CRVideo_UserEnterMeeting.callback = function(UID){}()
• 描述：通知，有人进入房间
• 回调参数：

  参数	类型	含义
  UID	String	用户ID, 详细介绍见 关键词

CRVideo_UserLeftMeeting

• 详情：CRVideo_UserLeftMeeting.callback = function(UID){}()
• 描述：通知，有人离开房间
• 回调参数：

  参数	类型	含义
  UID	String	用户ID, 详细介绍见 关键词

CRVideo_MeetingDropped

• 详情：CRVideo_MeetingDropped.callback = function(){}()
• 描述：通知，从房间中掉线了

CRVideo_GetMainVideo

• 详情：CRVideo_GetMainVideo()
• 描述：获取当前哪个用户为主视频
• 返回值：当前主视频用户ID
• 回调：无

CRVideo_SetMainVideo

• 详情：CRVideo_SetMainVideo(UID)
• 描述：设置哪个用户为主视频
• 返回值：无
• 回调：无
• 参数：

  参数	类型	必传	含义
  UID	String	是	用户ID, 详细介绍见 关键词

CRVideo_SetMainVideoMode

• 详情：CRVideo_SetMainVideoMode(mode,UID)
• 描述：设置主视频模式
• 返回值：无
• 回调：无
• 参数：

  参数	类型	必传	含义
  mode	Number	是	主视频模式，详见 CRVideo_MAIN_VIDEO_MODE
  UID	String	是	用户ID, 详细介绍见 关键词

CRVideo_GetMainVideoMode

• 详情：CRVideo_GetMainVideoMode()
• 描述：获取当前主视频模式
• 返回值：返回当前房间的主视频模式，详见 CRVideo_MAIN_VIDEO_MODE

CRVideo_SwitchToPage

• 详情：CRVideo_SwitchToPage(mainPage,subPage).then(function(resObject){}).catch(function(errObject){})
• 描述：功能区切换
• 返回值：返回一个Promise对象，成功返回resolveCallback，失败返回rejectCallback
• 参数：

  参数	类型	必传	含义
  mainPage	Number	是	功能区类型，详见 CRVideo_MAIN_PAGE_TYPE
  subPage	String	否	子页面标识（如创建白板时返回的boardID："2.58"），非必传

CRVideo_GetCurrentMainPage

• 详情：CRVideo_GetCurrentMainPage()
• 描述：获取当前主功能区
• 返回值：返回当前的主功能区。功能区类型详见 CRVideo_MAIN_PAGE_TYPE

CRVideo_GetCurrentSubPage

• 详情：CRVideo_GetCurrentSubPage()
• 描述：获取当前子页面
• 返回值：返回当前的子页面标识，如白板的boardID。没有子页面标识的功能区，则返回 0.0

CRVideo_NotifyMainVideoChanged

• 详情：CRVideo_NotifyMainVideoChanged.callback = function(UID){}
• 描述：通知，会话内主视频变化
• 回调参数：

  参数	类型	含义
  UID	String	用户ID, 详细介绍见 关键词

CRVideo_NotifyMainVideoModeChanged

• 详情：CRVideo_NotifyMainVideoModeChanged.callback = function(mode){}
• 描述：通知，会话内主视频模式变化
• 回调参数：

  参数	类型	含义
  mode	Number	主视频模式，详见 CRVideo_MAIN_VIDEO_MODE

CRVideo_NotifySwitchToPage

• 详情：CRVideo_NotifySwitchToPage.callback = function(mainPage,subPage){}
• 描述：通知，会话内功能区变化
• 回调参数：

  参数	类型	含义
  mainPage	Number	功能区类型，详见 CRVideo_MAIN_PAGE_TYPE
  subPage	String	子页面标识（如创建白板时返回的boardID："2.58"），非必传。没有子页面标识的功能区，则为 "0.0"

CRVideo_PeerConnectionError

• 详情：CRVideo_PeerConnectionError.callback = function(errObject){}
• 描述：通知，媒体流连接错误
• 回调参数：

  参数	类型	含义
  errObject	Object	错误对象，详见：CRVideo_PeerConnectionErrorObject

CRVideo_NetStateChanged

• 详情：CRVideo_NetStateChanged.callback = function(score){}
• 描述：通知，网络状态变化
• 回调参数：

  参数	类型	含义
  score	Number	网络评分，0~10，10为最佳

CRVideo_GetMeetingAttrs

• 详情：CRVideo_GetMeetingAttrs(keys, cookie)
• 描述：获取房间部份属性
• 返回值：无
• 回调：成功回调 CRVideo_GetMeetingAttrsSuccess.callback，失败回调 CRVideo_GetMeetingAttrsFail.callback
• 参数：

  参数	类型	必传	含义
  keys	Array	是	需要查询的房间属性key，如：["key1", "key2"]
  cookie	String	否	详细介绍见 关键词，可以传空串

CRVideo_GetMeetingAllAttrs

• 详情：CRVideo_GetMeetingAllAttrs(cookie)
• 描述：获取房间所有属性
• 返回值：无
• 回调：成功回调 CRVideo_GetMeetingAllAttrsSuccess.callback，失败回调 CRVideo_GetMeetingAllAttrsFail.callback
• 参数：

  参数	类型	必传	含义
  cookie	String	否	详细介绍见 关键词，可以传空串

CRVideo_SetMeetingAttrs

• 详情：CRVideo_SetMeetingAttrs(attrs ,options ,cookie)
• 描述：重置房间属性集
• 返回值：无
• 回调： 操作完成则回调CRVideo_SetMeetingAttrsRslt.callback
• 参数：

  参数	类型	必传	含义
  attrs	String	是	房间属性集,json格式，如：{"key1":"value1", "key2":"value2"} (key最大长度为64B，value最大长度为8KB)
  options	String	否	操作选项,json格式参见CRVideo_MeetingAttrOptions
  cookie	String	否	详细介绍见 关键词，可以传空串

CRVideo_AddOrUpdateMeetingAttrs

• 详情：CRVideo_AddOrUpdateMeetingAttrs(attrs ,options ,cookie)
• 描述：增加或者更新房间属性
• 返回值：无
• 回调：操作完成则回调CRVideo_AddOrUpdateMeetingAttrsRslt.callback
• 参数：

  参数	类型	必传	含义
  attrs	String	是	房间属性集,json格式，如：{"key1":"value1", "key2":"value2"} (key最大长度为64B，value最大长度为8KB)
  options	String	否	操作选项,json格式参见CRVideo_MeetingAttrOptions
  cookie	String	否	详细介绍见 关键词，可以传空串

CRVideo_DelMeetingAttrs

• 详情：CRVideo_DelMeetingAttrs(keys ,options ,cookie)
• 描述：删除房间属性
• 返回值：无
• 回调：操作完成则回调CRVideo_DelMeetingAttrsRslt.callback
• 参数：

  参数	类型	必传	含义
  keys	Array	是	需要删除的房间属性key，如：["key1", "key2"]
  options	String	否	操作选项,json格式参见CRVideo_MeetingAttrOptions
  cookie	String	否	详细介绍见 关键词，可以传空串

CRVideo_ClearMeetingAttrs

• 详情：CRVideo_ClearMeetingAttrs(options ,cookie)
• 描述：清除房间所有属性
• 返回值：无
• 回调：操作完成则回调CRVideo_ClearMeetingAttrsRslt.callback
• 参数：

  参数	类型	必传	含义
  options	String	否	操作选项,json格式参见CRVideo_MeetingAttrOptions
  cookie	String	否	详细介绍见 关键词，可以传空串

CRVideo_GetUserAttrs

• 详情：CRVideo_GetUserAttrs(uids ,keys ,cookie)
• 描述：获取指定用户的指定属性
• 返回值：无
• 回调：成功回调 CRVideo_GetUserAttrsSuccess.callback，失败回调 CRVideo_GetUserAttrsFail.callback
• 参数：

  参数	类型	必传	含义
  uids	Array	是	目标用户id列表，一次最多包含50个用， 如：["uid1","uid2"]
  keys	Array	否	将要获取的用户属性key列表（空数组或者不传表获取全部），如：["key1","key2"]
  cookie	String	否	详细介绍见 关键词，可以传空串

CRVideo_SetUserAttrs

• 详情：CRVideo_SetUserAttrs(UID ,attrs ,options ,cookie)
• 描述：重置用户属性
• 返回值：无
• 回调：操作完成则回调CRVideo_SetUserAttrsRslt.callback
• 参数：

  参数	类型	必传	含义
  UID	String	是	用户ID, 详细介绍见 关键词
  attrs	String	是	用户属性集, json格式，如：{"key1":"value1", "key2":"value2"} (key最大长度为64B，value最大长度为8KB)
  options	String	否	操作选项,json格式参见CRVideo_MeetingAttrOptions
  cookie	String	否	详细介绍见 关键词，可以传空串

CRVideo_AddOrUpdateUserAttrs

• 详情：CRVideo_AddOrUpdateUserAttrs(UID ,attrs ,options ,cookie)
• 描述：增加或更新用户属性
• 返回值：无
• 回调：操作完成则回调CRVideo_AddOrUpdateUserAttrsRslt.callback
• 参数：

  参数	类型	必传	含义
  UID	String	是	用户ID, 详细介绍见 关键词
  attrs	String	是	用户属性集, json格式，如：{"key1":"value1", "key2":"value2"} (key最大长度为64B，value最大长度为8KB)
  options	String	否	操作选项,json格式参见CRVideo_MeetingAttrOptions
  cookie	String	否	详细介绍见 关键词，可以传空串

CRVideo_DelUserAttrs

• 详情：CRVideo_DelUserAttrs(UID ,keys ,options ,cookie)
• 描述：删除用户的特定属性
• 返回值：无
• 回调：操作完成则回调CRVideo_DelUserAttrsRslt.callback
• 参数：

  参数	类型	必传	含义
  UID	String	是	用户ID, 详细介绍见 关键词
  keys	Array	是	需要删除的用户属性key列表，json格式，如：["key1","key2"]
  options	String	否	操作选项,json格式参见CRVideo_MeetingAttrOptions
  cookie	String	否	详细介绍见 关键词，可以传空串

CRVideo_ClearUserAttrs

• 详情：CRVideo_ClearUserAttrs(uids ,options ,cookie)
• 描述：清除特定用户的所有属性
• 返回值：无
• 回调：操作完成则回调CRVideo_ClearUserAttrsRslt.callback
• 参数：

  参数	类型	必传	含义
  uids	Array | String	是	目标用户UID或UID数组
  options	String	否	操作选项,json格式参见CRVideo_MeetingAttrOptions
  cookie	String	否	详细介绍见 关键词，可以传空串

CRVideo_ClearAllUserAttrs

• 详情：CRVideo_ClearAllUserAttrs(options ,cookie)
• 描述：清除所有用户的所有属性
• 返回值：无
• 回调：操作完成则回调CRVideo_ClearAllUserAttrsRslt.callback
• 参数：

  参数	类型	必传	含义
  options	String	否	操作选项,json格式参见CRVideo_MeetingAttrOptions
  cookie	String	否	详细介绍见 关键词，可以传空串

CRVideo_GetMeetingAttrsSuccess

• 详情：CRVideo_GetMeetingAttrsSuccess.callback = function(attr, cookie){}
• 描述：回调，成功获取到房间指定属性
• 回调参数：

  参数	类型	含义
  attrs	Object	房间属性，结构体请参见CRVideo_MeetingAttrObjs
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_GetMeetingAttrsFail

• 详情：CRVideo_GetMeetingAttrsFail.callback = function(sdkErr, cookie){}
• 描述：回调，获取房间指定属性失败
• 回调参数：

  参数	类型	含义
  sdkErr	Number	错误码，详细见 错误码定义
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_GetMeetingAllAttrsSuccess

• 详情：CRVideo_GetMeetingAllAttrsSuccess.callback = function(attr, cookie){}
• 描述：回调，成功获取到房间所有属性
• 回调参数：

  参数	类型	含义
  attrs	Object	房间属性，结构体请参见CRVideo_MeetingAttrObjs
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_GetMeetingAllAttrsFail

• 详情：CRVideo_GetMeetingAllAttrsFail.callback = function(sdkErr, cookie){}
• 描述：回调，获取房间属性失败
• 回调参数：

  参数	类型	含义
  sdkErr	Number	错误码，详细见 错误码定义
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_SetMeetingAttrsRslt

• 详情：CRVideo_SetMeetingAttrsRslt.callback = function(sdkErr, cookie){}
• 描述：回调，设置用户属性结果
• 回调参数：

  参数	类型	含义
  sdkErr	Number	错误码，详细见 错误码定义
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_AddOrUpdateMeetingAttrsRslt

• 详情：CRVideo_AddOrUpdateMeetingAttrsRslt.callback = function(sdkErr, cookie){}
• 描述：回调，增加或更新房间属性结果
• 回调参数：

  参数	类型	含义
  sdkErr	Number	错误码，详细见 错误码定义
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_DelMeetingAttrsRslt

• 详情：CRVideo_DelMeetingAttrsRslt.callback = function(sdkErr, cookie){}
• 描述：回调，删除房间属性结果
• 回调参数：

  参数	类型	含义
  sdkErr	Number	错误码，详细见 错误码定义
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_ClearMeetingAttrsRslt

• 详情：CRVideo_ClearMeetingAttrsRslt.callback = function(sdkErr, cookie){}
• 描述：回调，清除房间属性结果
• 回调参数：

  参数	类型	含义
  sdkErr	Number	错误码，详细见 错误码定义
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_GetUserAttrsSuccess

• 详情：CRVideo_GetUserAttrsSuccess.callback = function(attrsMap, cookie){}
• 描述：回调，获取房间内用户属性成功
• 回调参数：

  参数	类型	含义
  attrsMap	Object	用户属性，结构体请参见CRVideo_UsrMeetingAttrObjs
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_GetUserAttrsFail

• 详情：CRVideo_GetUserAttrsFail.callback = function(sdkErr, cookie){}
• 描述：回调，获取房间内用户属性失败
• 回调参数：

  参数	类型	含义
  sdkErr	Number	错误码，详细见 错误码定义
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_SetUserAttrsRslt

• 详情：CRVideo_SetUserAttrsRslt.callback = function(sdkErr, cookie){}
• 描述：回调，设置用户属性结果
• 回调参数：

  参数	类型	含义
  sdkErr	Number	错误码，详细见 错误码定义
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_AddOrUpdateUserAttrsRslt

• 详情：CRVideo_AddOrUpdateUserAttrsRslt.callback = function(sdkErr, cookie){}
• 描述：回调，增加或者更新用户属性结果
• 回调参数：

  参数	类型	含义
  sdkErr	Number	错误码，详细见 错误码定义
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_DelUserAttrsRslt

• 详情：CRVideo_DelUserAttrsRslt.callback = function(sdkErr, cookie){}
• 描述：回调，删除特定用户属性结果
• 回调参数：

  参数	类型	含义
  sdkErr	Number	错误码，详细见 错误码定义
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_ClearUserAttrsRslt

• 详情：CRVideo_ClearUserAttrsRslt.callback = function(sdkErr, cookie){}
• 描述：回调，清除特定用户属性结果
• 回调参数：

  参数	类型	含义
  sdkErr	Number	错误码，详细见 错误码定义
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_ClearAllUserAttrsRslt

• 详情：CRVideo_ClearAllUserAttrsRslt.callback = function(sdkErr, cookie){}
• 描述：回调，清除所有用户属性结果
• 回调参数：

  参数	类型	含义
  sdkErr	Number	错误码，详细见 错误码定义
  cookie	String	详细介绍见 关键词，可以传空串

CRVideo_NotifyMeetingAttrsChanged

• 详情：CRVideo_NotifyMeetingAttrsChanged.callback = function(adds ,updates ,delKeys){}
• 描述：通知，房间属性发生改变
• 回调参数：

  参数	类型	含义
  adds	Object	增加房间属性集，结构体请参见CRVideo_MeetingAttrObjs
  updates	Object	变化的房间属性集，结构体请参见CRVideo_MeetingAttrObjs
  delKeys	Array	被删除的房间属性的数组列表，如:["key1", "key2"]

CRVideo_NotifyUserAttrsChanged

• 详情：CRVideo_NotifyUserAttrsChanged.callback = function(UID ,adds ,updates ,delKeys){}
• 描述：通知，某个用户属性发生改变
• 回调参数：

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

CRVideo_GetAllMembers

• 详情：CRVideo_GetAllMembers()
• 描述：获取房间内所有成员的信息
• 返回值：返回包含多个成员信息 CRVideo_MemberInfo 的列表数组：[memberInfo1, memberInfo2, ...]
• 回调：无

CRVideo_GetMemberInfo

• 详情：CRVideo_GetMemberInfo(UID)
• 描述：获取房间内指定成员的信息
• 返回值：返回房间内指定成员的信息 CRVideo_MemberInfo
• 回调：无
• 参数：

  参数	类型	必传	含义
  UID	String	是	用户ID, 详细介绍见 关键词

CRVideo_GetMemberNickName

• 详情：CRVideo_GetMemberNickName(UID)
• 描述：获取房间内指定成员的昵称
• 返回值：返回该成员的昵称 (String)
• 回调：无
• 参数：

  参数	类型	必传	含义
  UID	String	是	用户ID, 详细介绍见 关键词

CRVideo_IsUserInMeeting

• 详情：CRVideo_IsUserInMeeting(UID)
• 描述：判断某个用户是否在房间中
• 返回值：在房间中则返回 true，否则返回 false (Bool)
• 回调：无
• 参数：

  参数	类型	必传	含义
  UID	String	是	用户ID, 详细介绍见 关键词

CRVideo_SetNickName

• 详情：CRVideo_SetNickName(UID,newName).then(function(resObject){}).catch(function(errObject){})
• 描述：设置房间内某个成员的昵称
• 返回值：返回一个Promise对象，成功返回resolveCallback，失败返回rejectCallback
• 参数：

  参数	类型	必传	含义
  UID	String	是	用户ID, 详细介绍见 关键词
  newName	String	是	新昵称

CRVideo_NotifyNickNameChanged

• 详情：CRVideo_NotifyNickNameChanged.callback = function(UID,oldName,newName){}
• 描述：通知，房间内某个成员昵称变化
• 回调参数：

  参数	类型	含义
  UID	String	用户ID, 详细介绍见 关键词
  oldName	String	旧昵称
  newName	String	新昵称

CRVideo_GetAudioMicNames

• 详情：CRVideo_GetAudioMicNames()
• 描述：获取本地麦克风设备列表
• 返回值：返回麦克风设备列表Array，如：[MicInfoObj1, MicInfoObj2, ...]，详见：CRVideo_MicInfoObj
• 回调：无

CRVideo_GetAudioSpkNames

• 详情：CRVideo_GetAudioSpkNames()
• 描述：获取本地扬声器设备列表
• 返回值：返回扬声器设备列表Array，如：[SpeakerInfoObj1, SpeakerInfoObj2, ...]，详见：CRVideo_SpeakerInfoObj
• 回调：无

CRVideo_SetAudioCfg

• 详情：CRVideo_SetAudioCfg(AudioCfg)
• 描述：设置本地音频参数
• 返回值：无
• 回调：无
• 参数：

  参数	类型	必传	含义
  AudioCfg	Object	是	本地音频配置，详细介绍见类型定义：CRVideo_AudioCfg

CRVideo_GetAudioCfg

• 详情：CRVideo_GetAudioCfg()
• 描述：获取本地音频参数
• 返回值：返回本地音频参数对象：CRVideo_AudioCfg
• 回调：无

CRVideo_GetMicEnergy

• 详情：CRVideo_GetMicEnergy(UID)
• 描述：获取指定成员的麦克风声音大小
• 返回值：返回该成员当前麦克风声音大小，0-10
• 回调：无
• 参数：

  参数	类型	必传	含义

CRVideo_OpenMic

• 详情：CRVideo_OpenMic(UID)
• 描述：打开指定成员的麦克风
• 返回值：无
• 回调：无
• 参数：

  参数	类型	必传	含义
  UID	String	是	用户ID, 详细介绍见 关键词

CRVideo_CloseMic

• 详情：CRVideo_CloseMic(UID)
• 描述：关闭指定成员的麦克风
• 返回值：无
• 回调：无
• 参数：

  参数	类型	必传	含义
  UID	String	是	用户ID, 详细介绍见 关键词

CRVideo_GetAudioStatus

• 详情：CRVideo_GetAudioStatus(UID)
• 描述：获取指定成员的麦克风状态
• 返回值：返回该成员当前的麦克风状态：CRVideo_ASTATUS
• 回调：无
• 参数：

  参数	类型	必传	含义
  UID	String	是	用户ID, 详细介绍见 关键词

CRVideo_SetAllAudioClose

• 详情：CRVideo_SetAllAudioClose()
• 描述：关闭房间内所有人麦克风
• 返回值：无
• 回调：无

CRVideo_PauseSpeaker

• 详情：CRVideo_PauseSpeaker()
• 描述：暂停播放房间内通话声音（静音）
• 返回值：无
• 回调：无

CRVideo_PlaySpeaker

• 详情：CRVideo_PlaySpeaker()
• 描述：恢复播放房间内通话声音
• 返回值：无
• 回调：无

CRVideo_StartGetAudioPCM

• 详情：CRVideo_StartGetAudioPCM(aSide, getType, jsonParam)
• 描述：开始获取语音PCM数据
• 返回值：返回结果，0表示开启成功，其他数值表示相关 错误码
• 回调：getType为1时，回调：CRVideo_NotifyAudioPCMDat.callback
• 参数：

  参数	类型	必传	含义
  aSide	Number	是	PCM数据的来源，0：麦克风，1：扬声器
  getType	Number	是	PCM数据的获取方式，0：回调方式,1：文件下载方式
  jsonParam	Object	是	详见：CRVideo_PCMJSONParams

CRVideo_StopGetAudioPCM

• 详情：CRVideo_StopGetAudioPCM(aSide)
• 描述：停止获取语音PCM数据
• 返回值：无
• 回调：无
• 参数：

  参数	类型	必传	含义
  aSide	Number	是	PCM数据的来源，0：麦克风，1：扬声器

CRVideo_SetVoiceChange

• 详情：CRVideo_SetVoiceChange(UID,type).then(function(resObject){}).catch(function(errObject){})
• 描述：设置用户变声类型
• 返回值：返回一个Promise对象，成功返回resolveCallback，失败返回rejectCallback
• 参数：

  参数	类型	必传	含义
  UID	String	是	用户ID, 详细介绍见 关键词
  type	Number	是	变声类型，详见：CRVideo_VOICECHANGE_TYPE

CRVideo_GetVoiceChangeType

• 详情：CRVideo_GetVoiceChangeType(UID)
• 描述：获取用户当前的变声类型
• 返回值：返回用户变声类型（Number），详见：CRVideo_VOICECHANGE_TYPE
• 回调：无
• 参数：

  参数	类型	必传	含义
  UID	String	是	用户ID, 详细介绍见 关键词

CRVideo_AudioStatusChanged

• 详情：CRVideo_AudioStatusChanged.callback = function(UID,oldStatus,newStatus){}
• 描述：通知，成员麦克风状态变化
• 回调参数：

  参数	类型	含义
  UID	String	用户ID, 详细介绍见 关键词
  oldStatus	Number	旧的麦克风状态，详见：CRVideo_ASTATUS
  newStatus	Number	新的麦克风状态，详见：CRVideo_ASTATUS

CRVideo_MicEnergyUpdate

• 详情：CRVideo_MicEnergyUpdate.callback = function(UID,oldLevel,newLevel){}
• 描述：通知，成员麦克风声音能量变化
• 回调参数：

  参数	类型	含义
  UID	String	用户ID, 详细介绍见 关键词
  oldLevel	Number	原来的说话声音强度等级，0-10
  newLevel	Number	现在的说话声音强度等级，0-10

CRVideo_NotifyAudioStream

• 详情：CRVideo_NotifyAudioStream.callback = function(aSide, stream){}
• 描述：通知，获取到webRTC语音流
• 回调参数：

  参数	类型	含义
  aSide	Number	是哪一端的语音流，0：本端；1：远端
  stream	Object	webRTC语音流stream

CRVideo_OpenMicFailed

• 详情：CRVideo_OpenMicFailed.callback = function(errDesc){}
• 描述：通知，打开本地麦克风失败
• 回调参数：

  参数	类型	含义
  errDesc	String	错误描述

CRVideo_NotifyAudioPCMDat

• 详情：CRVideo_NotifyAudioPCMDat.callback = function(aSide, PCMDat){}
• 描述：通知，获取到语音PCM数据
• 回调参数：

  参数	类型	含义
  aSide	Number	数据来源，0：麦克风，1：扬声器
  PCMDat	ArrayBuffer	语音PCM数据

CRVideo_NotifySetVoiceChange

• 详情：CRVideo_NotifySetVoiceChange.callback = function(UID, type){}
• 描述：通知，用户的变声类型发生变化
• 回调参数：

  参数	类型	含义
  UID	String	用户ID, 详细介绍见 关键词
  type	Number	变声类型，详见：CRVideo_VOICECHANGE_TYPE

CRVideo_NotifyAudioPlaying

• 详情：CRVideo_NotifyAudioPlaying.callback = function(){}
• 描述：通知，本地设备开始播放房间内声音
• 回调参数：

  参数	类型	含义

CRVideo_NotifyAudioPlayFailed

• 详情：CRVideo_NotifyAudioPlayFailed.callback = function(){}
• 描述：通知，本地设备自动播放房间内声音失败
• 回调参数：

  参数	类型	含义

CRVideo_CreatVideoObj

• 详情：CRVideo_CreatVideoObj(CreateUIParams)
• 描述：创建成员视频UI显示对象
• 返回值：返回成员视频UI显示对象 CRVideo_VideoObj
• 回调：无
• 参数：

  参数	类型	必传	含义
  CreateUIParams	Object	否	详细介绍见：CRVideo_CreateUIParams

    // 创建对象
    const user1VideoObj = CRVideo_CreatVideoObj();
    // 设置对象属性
    const userVideoDOM = user1VideoObj.handler(); // 获取组件DOM
    $('#userVideo').append(userVideoDOM); // 将组件DOM放到页面上
    const nicknameStyle = {
      left: "10px",
      top: "10px",
      backgroundColor: "rgba(0, 0, 0, .7)",
      padding: "0 10px",
      borderRadius: "15px",
      display: "block"
    }
    user1VideoObj.setNickNameStyle(nicknameStyle); // 设置昵称样式
    user1VideoObj.setVisibleNickName(true); // 设置是否显示昵称
    user1VideoObj.setVideo(UID); // 设置显示成员摄像头画面

CRVideo_GetVideoCfg

• 详情：CRVideo_GetVideoCfg()
• 描述：获取当前视频参数
• 返回值：返回当前视频配置参数对象，详见：CRVideo_VideoCfg
• 回调：无

CRVideo_SetVideoCfg

• 详情：CRVideo_SetVideoCfg(VideoCfg)
• 描述：设置视频参数
• 返回值：无
• 回调：无
• 参数：

  参数	类型	必传	含义
  VideoCfg	Object	是	详细介绍见：CRVideo_VideoCfg

CRVideo_GetVideoStatus

• 详情：CRVideo_GetVideoStatus(UID)
• 描述：获取指定成员的视频状态
• 返回值：返回该用户的视频状态，详见：CRVideo_VSTATUS
• 回调：无
• 参数：

  参数	类型	必传	含义
  UID	String	是	用户ID, 详细介绍见 关键词

CRVideo_GetDefaultVideo

• 详情：CRVideo_GetDefaultVideo(UID)
• 描述：获取指定成员的默认摄像头
• 返回值：返回该成员的默认摄像头ID（Number），如：1
• 回调：无
• 参数：

  参数	类型	必传	含义
  UID	String	是	用户ID, 详细介绍见 关键词