# API

# 接口描述

基础函数：

初始化/反初始化：

登录/注销/掉线：

队列管理

透明通道/呼叫排队

邀请

房间管理

Http文件管理组件

进出房间

房间内基础消息

房间成员管理：

房间和成员自定义属性：

音频管理

视频管理

屏幕共享

影音共享

本地录制/本地直播

云端录制/互动直播

电子白板/文档共享

可视化组件：

# 接口详情

CRVideo_GetSDKJsVersion()

• 功能: 获取Web js版本号

• 返回值:云屋SDK js的版本号(string)

CRVideo_PluginVersion()

• 功能: 获取Plugin版本号

• 返回值:Plugin版本号(string)

CRVideo_SdkPath()

• 功能: 获取sdk所在的目录

• 返回值:返回sdk所在的目录(string)

CRVideo_EnableLog2File(bEnable)

• 功能: 设置是否开启日志

• 返回值:无

SDK中日志功能默认是打开的,这个接口在CRVideo_Init2之前可调用

CRVideo_EnableLogReport(bEnable)

• 功能: 设置是否开启日志上报

• 返回值:无

SDK中日志上报默认是打开的,这个接口在CRVideo_Init2之前可调用

CRVideo_SetSDKParams(jsonVal)

• 功能: 设置SDK参数

• 返回值:无

• 参数:json格式,具体可用参数如下：

//使用格式如下：
{"NoQueue":	0}

这个接口在init之前调用有效

CRVideo_SetFileUploadRate(maxbps)

• 功能: 文件上传的流量控制(SDK默认不开启流控,目前对文件上传控制的功能有：录制文件上传、网盘文件上传。)

• 返回值:无

CRVideo_SetFileDownloadRate(maxBytePerSec)

• 功能: 文件下载的流量控制

• 返回值:无

CRVideo_SetAliyunOssAccountInfo(accessKey,accessSecret)

• 功能: 设置阿里云OSS信息

• 返回值:无

参考阿里云的用户签名验证相关文档 ：https://help.aliyun.com/document_detail/31950.html?spm=a2c4g.11186623.6.707.44c0734ctzHsOa

CRVideo_WriteLog(level, log)

• 功能: 向日志文件中写入内容

• 返回值:无

CRVideo_Init2(sdkFilePath, isCallSer, isMediaSer, isHttp)

• 功能: 登录

• 返回值:返回错误码（错误码为CRVideo_NOERR表示没有错误）(number)

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

• 注意目录的读写权限，如果目录只读，则无法在此目录下生成其他文件和文件夹

CRVideo_Init2等价于CRVideo_Init，功能一致；CRVideo_Init2为新增的接口，比CRVideo_Init少了一个oemID参数。两个方法是完全兼容，新版本均使用CRVideo_Init2方法

CRVideo_Uninit()

• 功能: SDK反初始化

• 返回值:无

• 参数:无

CRVideo_SetServerAddr(serverList)

• 功能: 设置服务器地址

• 返回值:无

CRVideo_SetNetworkProxy(proxy)

• 功能: 设置网络代理

• 返回值:无

CRVideo_Login(appID, md5_appSecret, nickName, UID, userAuthCode, cookie)

• 功能: 登录
• 返回值:无

登陆成功则回调CRVideo_LoginSuccess,登陆失败则回调CRVideo_LoginFail

CRVideo_LoginByToken(token,nickName,userID,userAuthCode,cookie)

• 功能: Token登录
• 返回值:无

登陆成功则回调CRVideo_LoginSuccess,登陆失败则回调CRVideo_LoginFail

CRVideo_UpdateToken(token)

• 功能: Token登录
• 返回值:无

CRVideo_LoginSuccess.callback = function(UID,cookie){}

• 功能: 登录成功回调
• 返回值:无

CRVideo_LoginFail.callback = function(sdkErr,cookie){}

• 功能: 登录失败回调,登录出错，可以弹出错误提示，或调用登录接口再次重试登录

CRVideo_NotifyTokenWillExpire.callback = function(){}

• 功能: Token即将失效的通知

CRVideo_Logout

• 功能: 注销

/**
* 注销本次登陆
* @access public
*/
CRVideo_Logout()

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

CRVideo_GetAllMembers()

• 功能: 房间成员列表

• 返回值:返回含多个成员信息（Array ------CRVideo_MemberInfo）

CRVideo_GetMemberInfo(UID)

• 功能: 房间成员信息

• 返回值:返回用户UID的成员信息（CRVideo_MemberInfo）

CRVideo_GetMemberNickName(UID)

• 功能: 房间成员昵称

• 返回值:用户UID的昵称(string)

CRVideo_IsUserInMeeting(UID)

• 功能: 用户是否在房间中

• 返回值:如果用户存在则返回true，否则返回false(bool)

CRVideo_SetNickName(userid,strNickName)

• 功能: 设置某个用户的昵称

• 返回值: 无

回调函数 CRVideo_SetNickNameRsp 调用此接口如果设置成功，其他会话用户会收到 CRVideo_NotifyNickNameChanged

CRVideo_GetMeetingAllAttrs( cookie)

• 功能:获取房间属性

• 返回值:无

• 参数：

CRVideo_GetMeetingAttrs( keys, cookie)

• 功能:获取房间部分属性

• 返回值:无

• 参数：

keys示例：["name","time"]

CRVideo_SetMeetingAttrs( attrs, options, cookie)

• 功能:设置房间属性

• 返回值:无

• 参数：

CRVideo_AddOrUpdateMeetingAttrs( attrs, options, cookie)

• 功能:增加或者更新房间属性

• 返回值:无

• 参数：

CRVideo_DelMeetingAttrs( keys, options, cookie)

• 功能:删除房间属性

• 返回值:无

• 参数：

keys示例：["name","time"]

CRVideo_ClearMeetingAttrs(options, cookie)

• 功能:清除房间所有属性

• 返回值:无

• 参数：

CRVideo_GetUserAttrs( uids, keys, cookie)

• 功能:获取用户属性

• 返回值:无

• 参数：

例如想要查询lucy和Drake的是否允许聊天、用户身份等信息，uids:["lucy","Drake"...], keys:["","",...]

CRVideo_SetUserAttrs( uid, attrs, options, cookie)

• 功能:设置用户属性

• 返回值: 无

• 参数：

CRVideo_AddOrUpdateUserAttrs( uid, attrs,options, cookie)

• 功能:增加或更新用户属性

• 返回值:无

• 参数：

CRVideo_DelUserAttrs( uid, keys, options,cookie)

• 功能:删除用户的特定属性

• 返回值:无

• 参数：

CRVideo_ClearAllUserAttrs(options, cookie)

• 功能:清除所有用户的所有属性

• 返回值:无

• 参数：

CRVideo_ClearUserAttrs( uid, options, cookie)

• 功能:清除特定用户属性

• 返回值:无

• 参数：

CRVideo_GetQueueUsers(queID)

• 功能: 获取指定队列的客户

• 返回值:返回排队的客户列表(类型：json字符串，需要JSON.parse解析后使用)

CRVideo_ReqAssignUser2(queID, userID, cookie)

• 功能: 请求分配一个指定的客户

• 返回值:无

回调函数：CRVideo_ReqAssignUserRslt 当关闭免打扰时，系统将自动分配客户，无需调用此函数； 当开启免打扰时，系统不再自动分配客户，座席如需服务指定的客户可使用此函数分配

CRVideo_GetMeetingAttrsSuccess.callback = function( attrs, cookie){}

• 功能:成功获取到房间指定属性

• 参数：

CRVideo_GetMeetingAttrsFail.callback = function( err, cookie){}

• 功能:获取房间指定属性失败

• 参数：

CRVideo_GetMeetingAllAttrsSuccess.callback = function( attrs, cookie){}

• 功能:成功获取到所有房间属性

• 参数：

CRVideo_GetMeetingAllAttrsFail.callback = function( err, cookie){}

• 功能:获取所有房间属性失败

• 参数：

CRVideo_SetMeetingAttrsRslt.callback = function( err, cookie) {}

• 功能:设置房间属性结果

• 参数：

CRVideo_AddOrUpdateMeetingAttrsRslt.callback = function( err, cookie){}

• 功能:增加或更新房间属性结果

• 参数：

CRVideo_DelMeetingAttrsRslt.callback = function( err, cookie){}

• 功能:删除房间属性结果

• 参数：

CRVideo_ClearMeetingAttrsRslt.callback = function( err, cookie) {}

• 功能:清除房间属性结果

• 参数：

CRVideo_GetUserAttrsSuccess.callback = function( attrsMap, cookie){}

• 功能:获取房间内用户属性结果

• 参数：

CRVideo_GetUserAttrsFail.callback = function( err, cookie) {}

• 功能:获取房间内用户属性失败

• 参数：

CRVideo_SetUserAttrsRslt.callback = function( err, cookie) {}

• 功能:设置用户属性结果

• 参数：

CRVideo_AddOrUpdateUserAttrsRslt.callback = function( err, cookie){}

• 功能:增加或者更新用户属性结果

• 参数：

CRVideo_DelUserAttrsRslt.callback = function( err, cookie){}

• 功能:删除特定用户属性结果

• 参数：

CRVideo_ClearAllUserAttrsRslt.callback = function( err, cookie){}

• 功能:删除所有用户属性结果

• 参数：

CRVideo_ClearUserAttrsRslt.callback = function(err, cookie){}

• 功能:删除特定用户属性结果

• 参数：

CRVideo_NotifyMeetingAttrsChanged.callback = function(attrs) {}

• 功能:通知房间属性发生改变

• 参数：

CRVideo_NotifyUserAttrsChanged.callback = function(uid, adds, updates, delKeys)

• 功能:通知用户属性发生改变

• 参数：

CRVideo_GetScreenShareCfg()

• 功能: 获取屏幕共享配置

• 返回值:屏幕共享配置（CRVideo_ScreenShareCfgObj）

CRVideo_SetScreenShareCfg(jsonCfg)

• 功能: 设置屏幕共享配置

• 返回值:无

CRVideo_StartScreenShare()

• 功能: 开启屏幕共享

• 返回值:无

CRVideo_StopScreenShare()

• 功能: 停止屏幕共享

• 返回值:无

CRVideo_RejectShareRequestion(requesterId,param)

• 功能: 拒绝分享请求

CRVideo_SetCustomizeScreenImg(format, width, heigh, dat)

• 功能: 自定义的抓屏图像数据

• 返回值:无

CRVideo_GiveCtrlRight(UID)

• 功能: 赋予控制权限

• 返回值:无

CRVideo_ReleaseCtrlRight(UID)

• 功能: 收回控制权限

• 返回值:无

CRVideo_SendMouseCtrlMsg(msgType, mouseMsgType, x, y)

• 功能: 发送鼠标控制消息

• 返回值:无

CRVideo_SendKeyCtrlMsg(keyMsgType, vk, bExtendedKey)

• 功能: 发送键盘控制消息

• 返回值:无

CRVideo_GetShareScreenDecodeImg()

• 功能: 屏幕共享图像数据

• 返回值😦CRVideo_VideoImgObj)

CRVideo_StartScreenShareRslt.callback = function(sdkEr){}

• 功能: 开启屏幕共享的响应事件

• 参数：
  • sdkEr ----- 操作失败代码，定义见CRVideo_ERR_DEF

CRVideo_StopScreenShareRslt.callback = function(sdkEr){}

• 功能停止屏幕共享的响应事件

• 参数：
  • sdkEr ----- 操作失败代码，定义见CRVideo_ERR_DEF

CRVideo_NotifyRequestShare.callback = function(sharerId,requesterId, param){}

• 功能：SDK通知请求屏幕共享

• 参数：
  • sharerId ----- 共享者ID
  • requesterId ----- 请求者ID
  • param ----- 自定义参数

CRVideo_NotifyCancelShareRequestion.callback = function(sharerId,requesterId){}

• 功能：SDK通知取消屏幕共享请求

• 参数：
  • sharerId ----- 共享者ID
  • requesterId ----- 请求者ID

CRVideo_NotifyRejectShareRequestion.callback = function(requesterId,sharerId, param){}

• 功能：SDK通知拒绝屏幕共享请求

• 参数：
  • requesterId ----- 请求者ID
  • sharerId ----- 共享者ID
  • param ----- 自定义参数

CRVideo_RequestShare(sharerId,param)

• 功能: 请求某人开启屏幕共享

• 返回值: 无

CRVideo_CancelShareRequestion(sharerId)

• 功能: 取消屏幕共享请求

• 返回值: 无

CRVideo_RejectShareRequestion(requesterId,param)

• 功能: 拒绝分享请求

• 返回值: 无

CRVideo_NotifyScreenShareStarted.callback = function(userID){}

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

• 参数：
  • userID ----- 开启共享者的用户ID

CRVideo_NotifyScreenShareStopped.callback = function(){}

• 功能: 收到他人停止了屏幕共享的通知

CRVideo_NotifyScreenShareData.callback = function(UID,rect){}

• 功能：通知对端屏幕图像有变化

• 参数：
  • UID ----- 用户ID
  • rect ----- 变化的区域；（可以只重绘这块区域）

CRVideo_NotifyGiveCtrlRight.callback = function(operId,targetId){}

• 功能：SDK通知远程控制权限给予了他人

• 参数：
  • operId ----- 操作的用户ID
  • targetId ----- 控制权限给予了谁

CRVideo_NotifyReleaseCtrlRight.callback = function(operId,targetId){}

• 功能：SDK通知他人收回屏幕共享操作权限

• 参数：
  • operId ----- 操作的用户ID
  • targetId ----- 收回了谁的控制权限

CRVideo_NotifyShareRectChanged.callback = function(w,h){}

• 功能：通知屏幕共享大小改变

• 参数：
  • w ----- 宽度
  • h ----- 高度

CRVideo_CreateLocMixer(mixerID, mixerCfg, mixerContent)

• 功能: 创建本地混图器

• 返回值: 错误码

CRVideo_UpdateLocMixerContent(mixerID,mixerContent)

• 功能: 更新本地混图器内容

• 返回值: 错误码

CRVideo_DestroyLocMixer(mixerID)

• 功能: 消毁本地混图器

• 返回值: 无

CRVideo_GetLocMixerState(mixerID)

• 功能: 获取本地混图器状态

• 返回值: CRVideo_MIXER_STATE

CRVideo_AddLocMixerOutput(mixerID, mixerOutput)

• 功能: 开启本地录制、直播推流

• 返回值: 错误码

• 注意事项:

  • 可以一次添加多个输出，也可以依据业务需要稍后再添加新的输出；
  • 多个输出不能同名、或同一url；
  • 每个输出，有独立的信息通知，请见事件CRVideo_LocMixerOutputInfo.如果输出异常时，将自动停止；

CRVideo_RmLocMixerOutput(mixerID,nameOrUrl)

• 功能: 停止本地录制、直播推流

• 返回值: 无

注意事项：所有输出停止后并不会消毁混图器，如果混图器不再需要请手工消毁；

CRVideo_GetAllRecordFiles()

• 功能: 录制文件列表

• 返回值:返回含多个录制文件信息(Array-CRVideo_RecordFileInfo)

CRVideo_CancelUploadRecordFile(filename)

• 功能: 取消上传录像文件

• 返回值:无

CRVideo_UploadRecordFile(filename)

• 功能: 上传录像文件

• 返回值:无

上传文件在默认位置

CRVideo_UploadRecordFile2(fileName,svrPathFileName)

• 功能: 上传录像文件

• 返回值:无

上传文件到服务器指定位置

CRVideo_PlaybackRecordFile(filename)

• 功能: 回放录制文件

• 返回值:无

CRVideo_LocMixerStateChanged.callback = function(mixerID,state){}

• 功能：SDK通知本地录制、本地直播状态变化

• 参数：
  • mixerID ----- 混图器唯一标识
  • state ----- 见 CRVideo_MIXER_STATE

CRVideo_LocMixerOutputInfo.callback = function(mixerID,nameOrUrl,outputInfo){}

• 功能：SDK通知本地录制文件、本地直播信息通知

• 参数：
  • mixerID ----- 混图器唯一标识
  • nameOrUrl ----- 录像名称、或直播url
  • outputInfo ----- json结构的字符串,请参见CRVideo_MixerOutputInfoObj

CRVideo_NotifyRecordFileStateChanged.callback = function(fileName,state){}

• 功能：SDK通知录制文件状态更改

• 参数：
  • fileName ----- 本地文件路径
  • state ----- 状态： 0未上传 1上传中 2已上传

CRVideo_NotifyRecordFileUploadProgress.callback = function(fileName,percent){}

• 功能：SDK通知上传录制文件进度

• 参数：
  • fileName ----- 文件名
  • percent ----- 进度0-100

CRVideo_UploadRecordFileErr.callback = function(fileName,sdkEr){}

• 功能：上传录制文件错误通知

• 参数：
  • fileName ----- 本地文件路径
  • sdkEr ----- 操作失败代码，定义见CRVideo_ERR_DEF

CRVideo_StartSvrMixer(mutiMixerCfgs, mutiMixerContents,mutiMixerOutputs)

• 功能: 开始云端录制、云端直播

• 返回值: 错误码

注意事项 : 启动云端功能有一定耗时，请关注混图器的状态变化事件CRVideo_SvrMixerStateChanged 每个输出有私有的状态变化事件CRVideo_SvrMixerOutputInfo

CRVideo_UpdateSvrMixerContent(mutiMixerContents)

• 功能: 更新云端录制、云端直播内容

• 返回值: 错误码

CRVideo_StopSvrMixer()

• 功能: 停止云端录制、云端直播

• 返回值: 无

注意事项 : 停止有有一定耗时，请关注混图器的状态变化事件svrMixerStateChanged 每个输出有私有的状态变化事件svrMixerOutputInfo

CRVideo_GetSvrMixerState()

• 功能: 获取云端录制、云端直播状态

• 返回值: CRVideo_MIXER_STATE

CRVideo_SvrMixerStateChanged.callback = function(state, err,operatorID){}

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

• 参数：
  • state ----- 状态值请参考CRVideo_MIXER_STATE
  • err ----- 错误值请参考CRVideo_ERR_DEF
  • operatorID ----- 引起变化的用户id

CRVideo_SvrMixerCfgChanged.callback = function(){}

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

CRVideo_SvrMixerOutputInfo.callback = function(outputInfo){}

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

• 参数：
  • outputInfo ----- 通知内容，json结构,请参见CRVideo_MixerOutputInfoObj

CRVideo_Createboard(title, width, height, pageCount)

• 功能: 创建白板

• 返回值:白板 boardID

其他参会者会收到：CRVideo_NotifyCreateBoard事件;同时后台会记录下白板数据，新入会者会收到：CRVideo_NotifyInitBoards事件.注意：创建完白板后，一定要及尽快调用CRVideo_InitBoardPageDat初始化各页数据

CRVideo_Closeboard(boardID)

• 功能: 关闭白板

• 返回值:无

其他参会者将收到CRVideo_NotifyCloseBoard事件；同时后台会移除对应白板的所有信息

CRVideo_InitBoardPageDat(boardID, boardPageNo, imgID, elemets)

• 功能: 初始化白板图元数据

• 返回值:无

1. imgID非空时, 代表背景的图片ID。 img来源请参见CRVideo_GetNetDiskDocFilePageInfo

2. 其他参会者将收到CRVideo_NotifyInitBoardPageDat事件；

3. 后台会记录下白板的页数据，在新用户入会时，也会收到CRVideo_NotifyInitBoardPageDat事件

CRVideo_CreateElementID()

• 功能: 生成白板图元ID

• 返回值:图元id

本地操作；所有白板图元id，必须由此接口创建；（历史文件存储的图元id，在房间内不能再使用，应重新创建）

CRVideo_Addboardelement(boardID, boardPageNo, element)

• 功能: 添加图元信息

• 返回值:elementID ----- 图元标识

其他参会者会收到：CRVideo_NotifyAddBoardElement事件;同时后台会保存图元，新入会者会在CRVideo_NotifyInitBoardPageDat中得到这些图元

CRVideo_ModifyBoardElement(boardID, boardPageNo, element)

• 功能: 修改图元信息

• 返回值:elementID图元标识(string)

说明：其他参会者会收到：CRVideo_NotifyModifyBoardElement事件;同时后台会覆盖对应图元的数据，新入会者会在CRVideo_NotifyInitBoardPageDat中得到这些图元

CRVideo_Delboardelement(boardID, boardPageNo, elementIDs)

• 功能: 删除图元

• 返回值:无

说明：其他参会者会收到：CRVideo_NotifyDelBoardElement事件；同时后台会移除这些图元，新入会者会在CRVideo_NotifyInitBoardPageDat中将不包含这些图元

CRVideo_Setmousehotspot(boardID, boardPageNo, x, y)

• 功能: 设置白板鼠标热点

• 返回值:无

CRVideo_SetBoardCurPageNo(boardID, boardPageNo, pagePos1, pagePos2)

• 功能: 白板翻页

• 返回值:无

CRVideo_ListNetDiskDocFile(dir)

• 功能: 查询文档列表

• 返回值:无 .查询结果请参见CRVideo_ListNetDiskDocFileRslt

查询服务器指定目录下的内容（子目录名、上传的文档源文件及文档转换状态）

CRVideo_UploadDocFileToNetDisk(svrPathFileName,locPathFileName)

• 功能: 上传文档并转换

• 返回值:无

上传进度请参见CRVideo_NotifyNetDiskDocFileTrsfProgress, 转换结果请调用CRVideo_ListNetDiskDocFile或者CRVideo_GetNetDiskDocFilePageInfo

说明:支持的文件格式有：doc，docx, ppt, pptx, pps, ppsx, xls, xlsx, et, ett, wps, wpt, dps, pdf, txt, log, ini, bmp, png, jpg, jpeg；

CRVideo_DownloadDocSrcFile(svrPathFileName, locPathFileName)

• 功能: 下载源始文档

• 返回值:无

下载进度请参见CRVideo_NotifyNetDiskDocFileTrsfProgress

CRVideo_CancelTransforNetDiskDocFile(svrPathFileName)

• 功能: 取消文档传输

• 返回值:无

CRVideo_DeleteNetDiskDocFile(svrPathFileName)

• 功能: 删除文档

• 返回值:无, 删除结果请参见CRVideo_DeleteNetDiskDocFileRslt

CRVideo_GetNetDiskDocFilePageInfo(svrPathFileName)

• 功能: 获取文档的转换信息

• 返回值:无， 结果请参见CRVideo_GetNetDiskDocFilePageInfoRslt

说明:获取到的文档转换后的信息后， 就可以创建白板CRVideo_Createboard, 然后为白板初始化文档内容CRVideo_InitBoardPageDat

CRVideo_DownloadNetDiskDocFilePage(pagePathFileName, locPathFileName)

• 功能: 下载文档转换后的页文件

• 返回值:无， 下载进度请参见CRVideo_NotifyNetDiskDocFileTrsfProgress

说明:页文件格式： 6字节保留，4字节图像格式（2:jpg, 4:png），4字节图像内容长度，图像内容

CRVideo_SetPicResource(resourceid, picJsonVal)

• 功能: (为本地录制的录像文件)添加图片资源

• 返回值:无

CRVideo_NotifyInitBoards.callback = function(BoardObjs){}

• 功能：SDK入会后通知房间中已经存在的白板列表

• 参数：
  • BoardObjs ----- 已经创建好的白板列表， json结构体请参见CRVideo_BoardObjs说明

CRVideo_NotifyInitBoardPageDat.callback = function(boardID,boardPageNo,imgID,elementDatas,operatorID){}

• 功能：通知初始化白板内图元数据

• 参数：
  • boardID ----- 白板标识
  • boardPageNo ----- 白板页序号
  • imgID ----- 页背景文件ID（空代表无背景）
  • elementDatas ----- 此页的所有图元， 详见json结构之CRVideo_BoardElementObjs
  • operatorID ----- 初始化用户（为空时，代表入会时后台事件）

CRVideo_NotifyCreateBoard.callback = function(jsonBoard,operatorID){}

• 功能：SDK通知创建白板

• 参数：
  • jsonBoard ----- 白板信息，详见json格式之CRVideo_BoardObj
  • operatorID ----- 创建白板的用户ID

CRVideo_NotifyCloseBoard.callback = function(boardID,operatorID){}

• 功能：SDK通知关闭白板

• 参数：
  • boardID ----- 白板标识
  • operatorID ----- 关闭白板的用户ID

CRVideo_NotifyBoardBkImage.callback = function(subPage,imgFileID,operatorID){}

• 功能：SDK通知白板背景

• 参数：
  • subPage ----- 白板信息
  • imgFileID ----- 背景图片文件，通过downloadNetDiskFile可下载到本地显示
  • operatorID ----- 操作用户ID

CRVideo_NotifyAddBoardElement.callback = function(boardID,boardPageNo,element,operatorID){}

• 功能：SDK通知添加图元信息

• 参数：
  • boardID ----- 白板标识
  • boardPageNo ----- 白板页序号
  • element ----- 此页的所有图元， 详见json结构之CRVideo_BoardElementObj
  • operatorID ----- 添加图元的用户ID

CRVideo_NotifyModifyBoardElement.callback = function(boardID,boardPageNo,element,operatorID){}

• 功能：SDK通知图元信息被修改

• 参数：
  • boardID ----- 白板标识
  • boardPageNo ----- 白板页序号
  • element ----- 此页的所有图元, 详见json结构之CRVideo_BoardElementObj
  • operatorID ----- 添加图元的用户ID

应从页内找到旧的图元并替换；

CRVideo_NotifyDelBoardElement.callback = function(boardID,boardPageNo,elementIDs,operatorID){}

• 功能：SDK通知删除图元

• 参数：
  • boardID ----- 白板标识
  • boardPageNo ----- 白板页序号
  • elementIDs ----- 图元id列表，以 “；”分隔
  • operatorID ----- 删除图元的用户ID

CRVideo_NotifyMouseHotSpot.callback = function(boardID,x,y,operatorID){}

• 功能：SDK通知设置鼠标热点消息

• 参数：
  • boardID ----- 白板标识
  • x ----- 屏幕横坐标
  • y ----- 屏幕纵坐标
  • operatorID ----- 操作者的用户ID

CRVideo_NotifyBoardCurPageNo.callback = function(boardID, pageNo, pagePos1, pagePos2, operatorID){}

• 功能：SDK通知通知白板翻页

• 参数：
  • boardID ----- 白板标识
  • pageNo ----- 翻到第几页
  • pagePos1 ----- 扩展参数1
  • pagePos2 ----- 扩展参数2
  • operatorID ----- 操作者的用户ID

CRVideo_UndoEnableChange.callback = function(isEnable){}

• 功能：SDK通知白板的“撤消”功能是否可用

• 参数：
  • isEnable ----- 撤消功能是否可用(bool)

CRVideo_RedoEnableChange.callback = function(isEnable){}

• 功能：SDK通知白板的“恢复”功能是否可用

• 参数：
  • isEnable ----- 恢复功能是否可用(bool)

CRVideo_ListNetDiskDocFileRslt.callback = function(dir, sdkErr, rslt){}

• 功能 通知查询文档列表结果

• 参数：
  • dir ----- 查询的目录
  • sdkErr ----- 0代表成功，非0参见CRVideo_ERR_DEF
  • rslt ----- 成功时的查询的结果，参见json格式之CRVideo_ListDocFileRslt

CRVideo_GetNetDiskDocFilePageInfoRslt.callback = function(svrPathFileName, sdkErr,rslt) {}

• 功能 通知查询文档转换结果

• 参数
  • svrPathFileName ----- 查询的文档名
  • sdkErr ----- 0代表成功，非0参见CRVideo_ERR_DEF
  • rslt ----- 成功时的查询的结果，参见json格式之CRVideo_GetDocPageInfoRslt

CRVideo_DeleteNetDiskDocFileRslt.callback = function(svrPathFileName, sdkERR) {}

• 功能: 通知删除文档结果

• 参数:
  • svrPathFileName ----- 查询的文档名
  • sdkERR ----- 删除结果，0代表删除成功, 错误码取值参考CRVideo_ERR_DEF

CRVideo_NotifyNetDiskDocFileTrsfProgress.callback = function(svrPathFileName, percent){}

• 功能 通知文档传输进度

• 参数
  • svrPathFileName ----- 传输的文档，或页文件名
  • percent ----- 传输进度（等于100代表传输完成）

CRVideo_NotifyNetDiskIsFull.callback = function(fileList){}

• 功能：SDK通知网盘空间已满，容量不足

• 参数：
  • fileList ----- 文件列表

CRVideo_GetOpenFileName(title,directory,filter)

• 功能：获取用户打开的全路径文件名

• 返回值: 结果，空串表示用户取消， 否则返回用户选择的文件路径文件名

CRVideo_GetSaveFileName(title,directory,filter)

• 功能：获取用户保存的全路径文件名

• 返回值: 结果，空串表示用户取消， 否则返回用户保存的文件路径文件名

CRVideo_SendCmd(targetUserId, data)

• 功能：发送小块数据

• 返回值:分配的任务ID(string)

一次性发送不会有进度通知，发送结果事件CRVideo_SendCmdRlst，CRVideo_SendCmd不能被CRVideo_CancelSend

CRVideo_SendBuffer(targetUserId, data)

• 功能：发送大块数据（分块发送）

• 返回值:分配的任务ID(string)

进度通知事件CRVideo_SendProgress，发送结果事件CRVideo_SendBufferRlst，取消发送CRVideo_CancelSend

CRVideo_SendFile(targetUserId, fileName)

• 功能：发送文件（分块发送 ）

• 返回值:分配的任务ID(string)

进度通知事件CRVideo_SendProgress，发送结果事件CRVideo_SendFileRlst，取消发送CRVideo_CancelSend)

CRVideo_CancelSend(taskID)

• 功能： 取消数据发送

• 返回值:无

取消数据发送 操作完成则回调CRVideo_CancelSendRlst

CRVideo_Invite(invitedUserID, usrExtDat, cookie)

• 功能: 发送邀请

• 返回值: 返回inviteID(每个邀请对应的唯一ID) (string)

邀请成功则触发回调CRVideo_InviteSuccess，失败则触发回调CRVideo_InviteFail。

CRVideo_AcceptInvite(inviteID, usrExtDat, cookie)

• 功能: 接受对方的邀请

• 返回值: 无

操作成功则回调CRVideo_AcceptInviteSuccess,失败则回调CRVideo_AcceptInviteFail。另外，对方（主动邀请者）会收到回调CRVideo_NotifyInviteAccepted。

CRVideo_RejectInvite(inviteID, usrExtDat, cookie)

• 功能: 拒绝对方的邀请

• 返回值: 无

操作成功则触发回调CRVideo_RejectInviteSuccess,失败则触发回调CRVideo_RejectInviteFail。另外，对方（主动邀请者）会收到回调CRVideo_NotifyInviteRejected。

CRVideo_CancelInvite(inviteID, usrExtDat, cookie)

• 功能: 取消自己发送的邀请

• 返回值: 无

操作成功则触发回调CRVideo_CancelInviteSuccess,失败则触发回调CRVideo_CancelInviteFail。另外，对方（被邀请者） 收到回调CRVideo_NotifyInviteCanceled。

CRVideo_InviteSuccess.callback = function(inviteID,cookie){}

• 功能: 发送邀请成功

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

• 功能: 发送邀请失败

CRVideo_CancelInviteSuccess.callback = function(inviteID,cookie){}

• 功能: 取消自己发送的邀请成功

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

• 功能: 取消自己发送的邀请失败

CRVideo_AcceptInviteSuccess.callback = function(inviteID,cookie){}

• 功能: 接受对方的邀请成功

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

• 功能: 接受对方的邀请失败

CRVideo_RejectInviteSuccess.callback = function(inviteID,cookie){}

• 功能: 拒绝对方的邀请成功

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

• 功能: 拒绝对方的邀请失败

CRVideo_NotifyInviteIn.callback = function(inviteID,inviterUsrID,usrExtDat){}

• 功能: 通知有人邀请

CRVideo_NotifyInviteAccepted.callback = function(inviteID,usrExtDat){}

• 功能: 通知邀请被接受

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

• 功能: 通知邀请被拒绝

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

• 功能: 通知邀请被取消

CRVideo_InitQueueDat(cookie)

• 功能: 初始化队列

• 返回值:无

操作完成回调CRVideo_InitQueueDatRslt，队列初始化成功后才可获取队列队列相关信息

CRVideo_RefreshAllQueueStatus()

• 功能: 刷新所有队列状态

• 返回值:无

操作完成则触发CRVideo_QueueStatusChanged（当前排队的队列，或服务的队列，sdk自动有状态变化回调）

CRVideo_GetAllQueueInfo()

• 功能: 查询队列

• 返回值:返回所有队列信息（Array ----- CRVideo_QueueInfo）

CRVideo_GetQueueStatus(queID)

• 功能: 获取队列状态

• 返回值:返回队列状态（CRVideo_QueueStatusObj）

CRVideo_GetQueuingInfo()

• 功能: 获取我的排队信息

• 返回值:返回排队信息（CRVideo_QueuingInfo）

CRVideo_GetServingQueues()

• 功能: 获取我服务的所有队列

• 返回值:返回我服务的队列列表（Array）

CRVideo_GetSessionInfo()

• 功能: 获取我的房间信息

• 返回值: 返回房间信息（CRVideo_SessionInfo）

CRVideo_StartQueuing2(queID,usrExtDat,cookie)

• 功能: 开始排队

• 返回值:无

带自定义扩展参数。 操作完成回调CRVideo_StartQueuingRslt

CRVideo_StopQueuing(cookie)

• 功能: 停止排队

• 返回值:无

操作完成回调CRVideo_StopQueuingRslt

CRVideo_StartService2(queID,priority,cookie)

• 功能: 开始服务队列

• 返回值:无

可以多次调用，开启对多个队列的服务。操作回调CRVideo_StartServiceRslt 开启成功后： a. 如果没有开启免打挽，那么系统会自动分配客户：CRVideo_AutoAssignUser； b. 如果开启免打挽，系统就不会分配客户，如需服务客户可调用：CRVideo_ReqAssignUser 座席优先级描述：

1. 座席优先级只在服务的队列内部有效；
2. 客户优先分配给服务此队列优先级最高的，且空闲的座席；
3. 优先级相同时，则分配给最先空闲的座席；
4. 优先级高的座席变空闲时，不抢夺已分配的客户；

CRVideo_StopService(queID, cookie)

• 功能: 停止服务队列

• 返回值:无

操作完成回调CRVideo_StopServiceRslt

CRVideo_ReqAssignUser(cookie)

• 功能: 请求分配一个客户

• 返回值:无

回调函数：CRVideo_ReqAssignUserRslt

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

CRVideo_AcceptAssignUser(queID, UID, cookie)

• 功能: 接受分配的客户

CRVideo_RejectAssignUser(queID, UID, cookie)

• 功能: 拒绝分配的客户

• 返回值:无

CRVideo_InitQueueDatRslt.callback = function(sdkEr,cookie){}

• 功能：队列初始化操作结果

• 参数：
  • sdkEr ----- 操作失败代码，定义见CRVideo_ERR_DEF
  • cookie ----- 详细介绍见关键词

CRVideo_QueueStatusChanged.callback = function(queStatus){}

• 功能：队列状态变化通知

• 参数：
  • queStatus ----- 队列状态

CRVideo_QueuingInfoChanged.callback = function(queuingInfo){}

• 功能：排队信息变化通知

• 参数：
  • queuingInfo ----- 排队信息

CRVideo_StartQueuingRslt.callback = function(sdkEr,cookie){}

• 功能：开始排队操作结果

• 参数：
  • sdkEr ----- 操作失败代码，定义见CRVideo_ERR_DEF
  • cookie ----- 详细介绍见关键词

CRVideo_StopQueuingRslt.callback = function(sdkEr,cookie){}

• 功能：停止排队操作结果

• 参数：
  • sdkEr ----- 操作失败代码，定义见CRVideo_ERR_DEF
  • cookie ----- 详细介绍见关键词

CRVideo_StartServiceRslt.callback = function(queID,sdkEr,cookie){}

• 功能：开始服务队列操作结果

• 参数：
  • queID ----- 服务的队列ID
  • sdkEr ----- 操作失败代码,定义见CRVideo_ERR_DEF
  • cookie ----- 详细介绍见关键词

CRVideo_StopServiceRslt.callback = function(queID,sdkEr,cookie){}

• 功能：停止服务队列操作结果

• 参数：
  • queID ----- 服务的队列ID
  • sdkEr ----- 操作失败代码,定义见CRVideo_ERR_DEF
  • cookie ----- 详细介绍见关键词

CRVideo_ResponseAssignUserRslt.callback = function(sdkEr,cookie){}

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

• 参数：
  • sdkEr ----- 操作失败代码,定义见CRVideo_ERR_DEF
  • cookie ----- 详细介绍见关键词

CRVideo_AutoAssignUser.callback = function(user){}

• 功能：系统自动安排客户

• 参数：
  • user ----- 队列用户信息，详见CRVideo_QueUser。如果想停止系统的自动分配，请通CRVideo_SetDNDStatus设置免打扰功能

CRVideo_ReqAssignUserRslt.callback = function(sdkEr,user,cookie){}

• 功能：请求分配客户操作结果

• 参数：
  • sdkEr ----- 操作失败代码,定义见CRVideo_ERR_DEF
  • user ----- 队列用户信息，详见CRVideo_QueUser
  • cookie ----- 详细介绍见关键词

CRVideo_CancelAssignUser.callback = function(queID,userid){}

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

• 参数：
  • queID ----- 服务的队列
  • userid ----- 用户id

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

CRVideo_UserEnter(queID, jsonUsr)

• 功能：客户进入通知

• 参数：

CRVideo_UserLeave(queID, usrID, inService)

• 功能：客户离开通知

• 参数：

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

CRVideo_Call(calledUserID, meetObj, usrExtDat, cookie)

• 功能: 发起呼叫

• 返回值:返回本次呼叫标识码（呼叫ID）

操作成功则触发回调CRVideo_CallSuccess,失败则触发回调CRVideo_CallFail。 呼叫时，对方迟迟不响应，30秒后系统自动结束呼叫

CRVideo_AcceptCall(callID, meetObj, usrExtDat, cookie)

• 功能: 接受对方发起的呼叫

开始进入视频房间。操作成功则回调CRVideo_AcceptCallSuccess，失败则回调CRVideo_AcceptCallFail

CRVideo_RejectCall(callID, usrExtDat, cookie)

• 功能: 拒绝对方发起的呼叫

• 返回值:无

操作成功则回调CRVideo_RejectCallSuccess，失败则回调CRVideo_RejectCallFail

CRVideo_HungupCall(callID, usrExtDat, cookie)

• 功能: 挂断呼叫

• 返回值:无

操作成功则回调CRVideo_HangupCallSuccess，失败则回调CRVideo_HangupCallFail

CRVideo_CallSuccess.callback = function(callID ,cookie){}

• 功能：呼叫他人操作成功响应

• 参数：
  • callID ----- 呼叫全局标识
  • cookie ----- 详细介绍见关键词

CRVideo_CallFail.callback = function(callID,sdkEr,cookie){}

• 功能：呼叫他人操作失败响应

• 参数：
  • callID ----- 呼叫全局标识
  • sdkEr ----- 操作失败代码，定义见CRVideo_ERR_DEF
  • cookie ----- 详细介绍见关键词

CRVideo_AcceptCallSuccess.callback = function(callID,cookie){}

• 功能：接受他人呼叫操作成功响应

• 参数：
  • callID ----- 呼叫全局标识
  • cookie ----- 详细介绍见关键词

CRVideo_AcceptCallFail.callback = function(callID,sdkEr,cookie){}

• 功能：接受他人呼叫操作失败响应

• 参数：
  • callID ----- 呼叫全局标识
  • sdkEr ----- 操作失败代码，定义见CRVideo_ERR_DEF
  • cookie ----- 详细介绍见关键词

CRVideo_RejectCallSuccess.callback = function(callID,cookie){}

• 功能：拒绝他人的呼叫成功响应

• 参数：
  • callID ----- 呼叫全局标识
  • cookie ----- 详细介绍见关键词

CRVideo_RejectCallFail.callback = function(callID,sdkEr,cookie){}

• 功能：拒绝他人的呼叫失败响应

• 参数：
  • callID ----- 呼叫全局标识
  • sdkEr ----- 操作失败代码,定义见CRVideo_ERR_DEF
  • cookie ----- 详细介绍见关键词

CRVideo_HangupCallSuccess.callback = function(callID,cookie){}

• 功能：挂断他人的呼叫成功响应

• 参数：
  • callID ----- 呼叫全局标识
  • cookie ----- 详细介绍见关键词

CRVideo_HangupCallFail.callback = function(callID,sdkEr,cookie){}

• 功能：挂断呼叫操作失败响应

• 参数：
  • callID ----- 呼叫全局标识
  • sdkEr ----- 操作失败代码，定义见CRVideo_ERR_DEF
  • cookie ----- 详细介绍见关键词

CRVideo_NotifyCallIn.callback = function(callID,meetObj,callerID,usrExtDat){}

• 功能：SDK通知自己被呼叫

• 参数：
  • callID ----- 呼叫全局标识
  • meetObj ----- 房间信息
  • callerID ----- 呼叫人员的标识ID
  • usrExtDat ----- 自定义扩展参数

CRVideo_NotifyCallAccepted.callback = function(callID,meetObj,usrExtDat){}

• 功能：SDK通知自己视频呼叫被对方接受

• 参数：
  • callID ----- 呼叫全局标识
  • meetObj ----- 房间信息
  • usrExtDat ----- 自定义扩展参数

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

• 功能：SDK通知自己呼叫被对方拒绝

• 参数：
  • callID ----- 呼叫全局标识
  • sdkErr ----- 操作失败代码，定义见CRVideo_ERR_DEF
  • usrExtDat ----- 自定义扩展参数

CRVideo_NotifyCallHungup.callback = function(callID,usrExtDat){}

• 功能：SDK通知自己呼叫被挂断

• 参数：
  • callID ----- 呼叫全局标识
  • usrExtDat ----- 自定义扩展参数

CRVideo_SendCmdRlst.callback = function(taskID,sdkEr,cookie){}

• 功能：发送小块数据时，SDK通知发送结果

• 参数：
  • taskID ----- 发送任务id
  • sdkEr ----- 操作失败代码，定义见CRVideo_ERR_DEF
  • cookie ----- 详细介绍见关键词

CRVideo_SendBufferRlst.callback = function(taskID,sdkEr,cookie){}

• 功能：发送大块数据时，SDK通知发送结果

• 参数：
  • taskID ----- 发送任务id
  • sdkEr ----- 操作失败代码，定义见CRVideo_ERR_DEF
  • cookie ----- 详细介绍见关键词

CRVideo_SendFileRlst.callback = function(taskID,fileName,sdkEr,cookie){}

• 功能：发送文件时，SDK通知发送结果

• 参数：
  • taskID ----- 发送任务id
  • fileName ----- 文件名
  • sdkEr ----- 操作失败代码，定义见CRVideo_ERR_DEF
  • cookie ----- 详细介绍见关键词

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

• 功能：发送数据时，SDK通知发送进度

• 参数：
  • taskID ----- 发送任务id
  • sendedLen ----- 已发送的数据长度
  • totalLen ----- 需要发送的总长度
  • cookie ----- 详细介绍见关键词

CRVideo_CancelSendRlst.callback = function(taskID,sdkEr,cookie){}

• 功能：取消发送响应

• 参数：
  • taskID ----- 发送任务id
  • sdkEr ----- 操作失败代码，定义见CRVideo_ERR_DEF
  • cookie ----- 详细介绍见关键词

CRVideo_NotifyCmdData.callback = function(sourceUserId,data){}

• 功能：SDK通知收到小块数据

• 参数：
  • sourceUserId ----- 发送数据的用户id
  • data ----- 数据的内容（string）

CRVideo_NotifyBufferData.callback = function(sourceUserId,data){}

• 功能：SDK通知收到大块数据

• 参数：
  • sourceUserId ----- 发送数据的用户id
  • data ----- 数据的内容（string）

CRVideo_NotifyFileData.callback = function(sourceUserId,tmpFile,orgFileName){}

• 功能：SDK通知收到文件数据（收到的文件生成在系统临时目录下，请尽快移走对应文件）

• 参数：
  • sourceUserId ----- 发送数据的用户id
  • tmpFile ----- 临时文件，不需要时，请移除或删除对应文件
  • orgFileName ----- 源始文件名

CRVideo_NotifyCancelSend.callback = function(taskID){}

• 功能：SDK通知取消发送文件数据

• 参数：
  • taskID ----- 取消的任务id

CRVideo_GetVideoWallMode2()

• 功能: 获取视频墙当前分屏模式

• 返回值:分屏模式(业务层自由定义)

CRVideo_SetVideoWallMode2(videoWallMode)

• 功能: 设置视频墙分屏模式

• 返回值:无

CRVideo_GetVideoCfg()

• 功能: 获取视频参数

• 返回值:获取视频参数（CRVideo_VideoCfg）

CRVideo_SetVideoCfg(cfg)

• 功能: 视频设置

• 返回值: 设置成功与否，true/false

CRVideo_GetVideoStatus(UID)

• 功能: 视频状态

• 返回值:麦克风摄像头状态（CRVideo_VSTATUS）

CRVideo_GetDefaultVideo(UID)

• 功能: 获取默认视频

• 返回值:返回摄像头ID （number）

CRVideo_SetDefaultVideo(UID, videoID)

• 功能: 设置默认视频

• 返回值:无

注意：
1、如果用户只有一个摄像头，可以不设置默认摄像头；
2、如果用户有多个摄像头，但是只想用其中一个，需要把这个设置为默认摄像头；
3、如果用户有多个摄像头，全都要用到，就不需要设置默认摄像头，打开摄像头时会全部打开；
4、如果用户有多个摄像头，想用到其中部分几个摄像头，不用设置默认摄像头，但是要先启用多摄像头,然后调用CRVideo_SetLocVideoAttributes把不想用的禁用了，之后打开的时候就只打开没禁用的那几个；

CRVideo_GetAllVideoInfo(userID)

• 功能: 获取用户的所有摄像头信息

• 返回值:用户的所有摄像头信息列表，数据类型为：CRVideo_VideoInfosObj。

CRVideo_SetVideoDenoise(bDenoise)

• 功能: 开启或关闭摄像头降噪处理

• 返回值:无

CRVideo_GetVideoDenoise()

• 功能: 获取是否开启摄像头降噪

• 返回值:true:降噪已开启，false:降噪未开启

CRVideo_CreateScreenCamDev(camName,monitor)

• 功能: 创建桌面摄像头(sdk最大支持5个)

• 返回值:<0, 失败, >=0, 为videoID(摄像头ID) (number)

添加成功后与本地摄像头处理一致；getAllVideoInfo接口可以识别摄像头类型。

CRVideo_UpdateScreenCamDev(videoID,monitor)

• 功能: 更新桌面摄像头

• 返回值:false失败, true成功 (bool)

CRVideo_DestroyScreenCamDev(videoID)

• 功能: 消毁桌面摄像头

• 返回值:无

CRVideo_CreateCustomVideoDev(camName,pixFmt,width,height,extParams)

• 功能: 创建自定义摄像头(sdk最大支持5个)

• 返回值: <0 ,失败; >=0, 为videoID(摄像头ID) (number)

添加成功后与本地摄像头处理一致；getAllVideoInfo接口可以识别摄像头类型。

CRVideo_DestroyCustomVideoDev(videoID)

• 功能: 消毁自定义摄像头

• 返回值: 无

CRVideo_InputCustomVideoDat(videoID,base64Dat,timeStamp)

• 功能: 输入摄像头图像数据

• 返回值: 无

CRVideo_GetWatchableVideos()

• 功能: 房间内可观看摄像头列表

• 返回值:对象VideoIDArray（Array ------ CRVideo_VideoIDsObj）

只有摄像头打开才能被获取到，能获取到自已的和房间里其他人的

CRVideo_OpenVideo(UID)

• 功能: 打开用户的摄像头

• 返回值:无

打开用户的摄像头，以便本地、远端显示视频图像

CRVideo_CloseVideo(UID)

• 功能: 关闭用户的摄像头

• 返回值:无

CRVideo_GetEnableMutiVideo(UID)

• 功能: 获取是否启用多摄像头

• 返回值:用户是否多摄像头（bool）

CRVideo_GetVideoImg()

• 功能: 摄像头图像数据

• 返回值:返回frame视频数据（CRVideo_VideoImgObj）

CRVideo_ShowVideoAdvCfgDlg(videoID, hParenWnd)

• 功能: 调出摄像头驱动的高级配置（只对真实物理摄像头有效）

• 返回值:true/false

CRVideo_SetLocVideoAttributes(videoID, jsonAttributes)

• 功能: 视频设备私有参数配置

• 返回值:无

注：未设置的参数，使用全局参数

CRVideo_GetLocVideoAttributes(videoID)

• 功能: 获取某个摄像头私有参数

• 返回值:私有参数, json格式，详见（VideoAttributesObj）

CRVideo_SetEnableMutiVideo(UID,enable)

• 功能: 设置用户是否启用多摄像头

如果只想开启某几个摄像头（不是所有）， 那么需要：CRVideo_SetEnableMutiVideo(myUserID, true), 然后调用CRVideo_SetLocVideoAttributes将不需要的摄像头disable掉。

CRVideo_AddIPCam(url)

• 功能: 添加网络摄像头（sdk最大支持5个）

• 返回值:sdkErr 操作结果码, 0代成功, 非0代表入会失败，定义见CRVideo_ERR_DEF

添加成功后与本地摄像头处理一致；CRVideo_GetAllVideoInfo接口可以识别哪些是网络摄像头。

CRVideo_DelIPCam(url)

• 功能: 移除网络摄像头

• 返回值:无

CRVideo_BSupportVirtualBackground(type)

• 功能: 检查是否支持对应虚拟背景功能

• 返回值: true:支持，false:不支持

CRVideo_SetVirtualBackground(cfg)

• 功能: 配置虚拟背景参数

• 返回值: true:成功，false:失败

CRVideo_GetVirtualBackground()

• 功能: 获取虚拟背景参数

• 返回值: json格式，参见：CRVideo_VirtualBkCfg

CRVideo_OpenVideoDevRslt.callback = function(videoID,isSucceed){}

• 功能：SDK通知打开摄像头结果

• 参数：
  • videoID ----- 摄像头索引 (number)
  • isSucceed ----- 是否打开成功 （bool）

CRVideo_VideoDevChanged.callback = function(UID){}

• 功能：SDK通知用户的视频设备有变化

• 参数：
  • UID ----- 设备变化的用户ID

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

• 功能：SDK通知打开本地视频状态变化

• 参数：
  • UID ----- 房间中设备的所有者ID
  • oldStatus ----- 旧状态
  • newStatus ----- 新状态

CRVideo_Switchtopage(mainPage, pageID)

• 功能: 功能切换

• 返回值:无

CRVideo_Getcurrentmainpage()

• 功能: 获取当前主功能区

• 返回值:功能区(CRVideo_MAIN_PAGE_TYPE)

CRVideo_Getcurrentsubpage()

• 功能: 获取当前子页面

• 返回值:返回pageID(如：创建白板时返回的boardID）

CRVideo_GetMainVideo()

• 功能: 获取当前哪个用户为主视频

• 返回值:用户ID (string)

CRVideo_SetMainVideo(UID)

• 功能: 设置当前哪个用户为主视频

• 返回值:无

CRVideo_SetDNDStatus(DNDStatus, cookie)

• 功能: 设置免打扰状态

• 返回值:无

操作成功则回调CRVideo_SetDNDStatusSuccess，失败则回调CRVideo_SetDNDStatusFail

• 如果是使用到了SDK的队列功能，则入会后需调用此接口，设置自己的为免打扰状态，防止系统再次推送自己.

CRVideo_GetUserStatus(cookie)

• 功能: 获取企业下所有用户在线状态

• 返回值:无

操作成功则回调CRVideo_GetUserStatusSuccess，失败则回调CRVideo_GetUserStatusFail

CRVideo_GetOneUserStatus(usrID,cookie)

• 功能: 获取企业下指定用户的在线状态

• 返回值:无

操作成功则回调CRVideo_GetUserStatusSuccess，失败则回调CRVideo_GetUserStatusFail

CRVideo_StartUserStatusNotify(cookie)

• 功能: 开启用户的状态推送

• 返回值:无

回调函数： CRVideo_StartUserStatusNotifyRslt

企业下所有用户状态有变化时包括呼叫房间状态、免打扰状态），都会收到通知开启后，用户量越大消息量越大，所以请按需开启在CRVideo_StartUserStatusNotify前，应该先通过CRVideo_GetUserStatus获取所有用户状态

CRVideo_StopUserStatusNotify(cookie)

• 功能: 关闭用户的状态推送

• 返回值:无

回调函数： CRVideo_StopUserStatusNotifyRslt

CRVideo_CreateMeeting(meetSubject, needPswd, cookie)

CRVideo_CreateMeeting2(json, cookie)

• 功能: 创建房间

• 返回值:无

操作成功则回调CRVideo_CreateMeetingSuccess，失败则回调CRVideo_CreateMeetingFail

CRVideo_DestroyMeeting(meetID, cookie)

• 功能: 销毁房间

• 返回值:无

回调函数CRVideo_DestroyMeetingRslt

另外，会话中其他用户会收到CRVideo_MeetingStopped通知

CRVideo_GetMeetings(cookie)

CRVideo_GetMeetings2(json,cookie)

• 功能: 获取房间列表

• 返回值:无

响应事件CRVideo_GetMeetingsSuccess，房间被他人结束的回调事件CRVideo_GetMeetingsFail

CRVideo_SetNickNameRsp.callback = function(sdkErr,userid,newname){}

• 功能：SDK通知设置房间成员昵称的结果

• 参数：
  • sdkErr ----- 操作结果码, 0代表设置成功, 非0代表设置失败
  • userid ----- 用户id
  • newname ----- 新的昵称

CRVideo_NotifyNickNameChanged.callback = function(userid,oldname,newname){}

• 功能：SDK通知某用户改变了昵称(改昵称的用户自身不会接收到此通知)

• 参数：
  • userid ----- 用户id
  • oldname ----- 改变昵称的某用户昵称(改变之前的昵称)
  • newname ----- 改变昵称的某用户昵称(改变之后的昵称)

CRVideo_NotifyVideoWallMode2.callback = function(model){}

• 功能：SDK通知视频分屏模式切换

• 参数：
  • model ----- 分屏模式

CRVideo_NotifyMainVideoChanged.callback = function(operId,targetId){}

• 功能：SDK通知主视频更改

CRVideo_NotifySwitchToPage.callback = function(mainPage,pageID){}

• 功能：SDK通知功能切换

• 参数：
  • mainPage ----- 功能类型
  • pageID ----- 子页面标识

CRVideo_DefVideoChanged.callback = function(UID,videoID){}

• 功能：SDK通知用户的视频默认设备有变化

• 参数：
  • UID ----- 设备变化的用户ID
  • videoID ----- 默认设备id

CRVideo_NetStateChanged.callback = function(level){}

• 功能：SDK通知我的网络变化

• 参数：
  • level ----- 网络状况等级（0~10，10分为最佳网络）

CRVideo_EnterMeeting(meetID, pswd, UID, nickName, reserve)

• 功能: 进入房间

• 返回值:无

双方开始进入房间 操作完成则回调CRVideo_EnterMeetingRslt

CRVideo_ExitMeeting()

• 功能: 离开房间

• 返回值:无

CRVideo_EnterMeetingRslt.callback = function(sdkEr){}

• 功能：进入房间完成响应

• 参数：
  • sdkEr ----- 操作失败代码，定义见CRVideo_ERR_DEF

CRVideo_StopMeetingRslt.callback = function(sdkEr){}

• 功能：通知结束视频房间结果

• 参数：
  • sdkEr ----- 操作失败代码，定义见CRVideo_ERR_DEF

CRVideo_KickoutRslt(sdkErr, userID)

• 功能：踢人结果

• 参数：

CRVideo_UserEnterMeeting.callback = function(usrID){}

• 功能某用户进入了房间

• 参数：
  • usrID ----- 进入房间的用户ID

CRVideo_UserLeftMeeting.callback = function(id){}

• 功能：某用户离开了房间

• 参数：
  • id ----- 离开房间的用户ID

CRVideo_MeetingDropped.callback = function(reason){}

• 功能：SDK通知从房间里掉线了

• 参数：
  • reason ----- 断线原因，定义见CRVideo_MEETING_DROPPED_REASON

CRVideo_MeetingStopped.callback = function(){}

• 功能：房间已被结束

他人离开房间的回调事件CRVideo_UserLeftMeeting

CRVideo_StopMeeting(meetID,reserve)

• 功能: 停止房间

• 返回值:无

回调函数CRVideo_StopMeetingRslt，调用此接口结束房间时，其他会话用户会收到CRVideo_MeetingStopped

CRVideo_SetDNDStatusSuccess.callback = function(cookie){}

• 功能：客户端设置免打扰状态操作成功响应

• 参数：
  • cookie ----- 详细介绍见关键词

CRVideo_SetDNDStatusFail.callback = function(sdkEr,cookie){}

• 功能：客户端设置免打扰状态操作失败响应

• 参数：
  • sdkEr ----- 操作失败代码,定义见CRVideo_ERR_DEF
  • cookie ----- 详细介绍见关键词

CRVideo_GetUserStatusSuccess.callback = function(userStatus,cookie){}

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

• 参数：
  • userStatus ----- 用户在线状态信息列表，定义见userStatus
  • cookie ----- 详细介绍见关键词

CRVideo_GetUserStatusFail.callback = function(sdkEr ,cookie){}

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

• 参数：
  • sdkEr ----- 操作失败代码，定义见CRVideo_ERR_DEF
  • cookie ----- 详细介绍见关键词

CRVideo_StartUserStatusNotifyRslt.callback = function(sdkEr ,cookie){}

• 功能：启动用户状态推送响应

• 参数：
  • sdkEr ----- 操作失败代码，定义见CRVideo_ERR_DEF
  • cookie ----- 详细介绍见关键词

CRVideo_StopUserStatusNotifyRslt.callback = function(sdkEr ,cookie){}

• 功能：结束用户状态推送响应

• 参数：
  • sdkEr ----- 操作失败代码，定义见CRVideo_ERR_DEF
  • cookie ----- 详细介绍见关键词

CRVideo_NotifyUserStatus.callback = function(userStatus ,cookie){}

• 功能：某个用户状态变化通知

• 参数：
  • userStatus ----- userStatus单个用户在线状态信息
  • cookie ----- 详细介绍见关键词

CRVideo_LineOff.callback = function(sdkEr){}

• 功能：SDK通知自己掉线

• 参数：
  • sdkEr ----- 掉线原因，定义见CRVideo_ERR_DEF

CRVideo_CreateMeetingSuccess.callback = function(meetObj,cookie){}

• 功能：创建房间成功响应

• 参数：
  • meetObj ----- 房间信息
  • cookie ----- 详细介绍见关键词

CRVideo_CreateMeetingFail.callback = function(sdkEr ,cookie){}

• 功能：创建房间失败响应

• 参数：
  • sdkEr ----- 操作失败代码，定义见CRVideo_ERR_DEF
  • cookie ----- 详细介绍见关键词

CRVideo_DestroyMeetingRslt.callback = function(sdkEr ,cookie){}

• 功能：销毁房间响应

• 参数：
  • sdkEr ----- 操作失败代码，定义见CRVideo_ERR_DEF
  • cookie ----- 详细介绍见关键词

CRVideo_GetMeetingsSuccess.callback = function(jsonMeetings,cookie){}

• 功能：获取房间列表成功响应

• 参数：
  • jsonMeetings ------ 房间列表信息
  • cookie ----- 详细介绍见关键词

CRVideo_GetMeetingsFail.callback = function(sdkEr,cookie){}

• 功能：获取房间列表失败响应

• 参数：
  • sdkEr ----- 操作失败代码，定义见CRVideo_ERR_DEF
  • cookie ----- 详细介绍见关键词

CRVideo_SetMediacfg(jsonCfg)

• 功能: 配置远程影音共享时，图像质量参数

• 返回值:无

CRVideo_GetMediacfg()

• 功能: 获取影音共享时的图像质量参数

• 返回值:json格式的音频参数,详见CRVideo_VideoCfg说明

CRVideo_GetAudioMicNames()

• 功能: 麦克风设备列表

• 返回值:返回麦克风设备名称的字符串数组（Array）

类似：["audiomic1","audiomic2"……,"audiomicN"]

CRVideo_GetAudioSpkNames()

• 功能: 扬声器设备列表

• 返回值:扬声器设备名称的字符串数组（Array）

类似：["AudioSpkName1","AudioSpkName2"……,"AudioSpkNameN"]

CRVideo_SetAudioCfg(cfg)

• 功能: 设置系统音频参数

• 返回值:无

CRVideo_GetAudioCfg()

• 功能: 获取系统音频参数

• 返回值:cfg对象（CRVideo_AudioCfg）

CRVideo_GetMicEnergy(UID)

• 功能: 麦克风声音大小

• 返回值:返回音量（0~10）(number)

CRVideo_OpenMic(UID)

• 功能: 打开麦克风

• 返回值:无

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

CRVideo_CloseMic(UID)

• 功能: 关闭麦克风

• 返回值:无

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

CRVideo_GetAudioStatus(UID)

• 功能: 麦克风状态

• 返回值:返回麦克风状态(CRVideo_ASTATUS)

双方开始进入本次视频会话。操作完成则回调CRVideo_EnterMeetingRslt

CRVideo_GetMicVolume()

• 功能: 获取麦克风音量

• 返回值:返回麦克风音量（0~255）（number）

CRVideo_SetMicVolume(level)

• 功能: 设置麦克风音量

• 返回值:设置成功则返回true,否则返回false（bool）

CRVideo_GetSpeakerVolume()

• 功能: 获取扬声器音量

• 返回值:返回扬声器音量（0~255）（number）

CRVideo_SetSpeakerVolume(level)

• 功能: 设置扬声器音量

• 返回值:设置成功则返回true,否则返回false（bool）

CRVideo_GetSpeakerMute()

• 功能: 获取扬声器是否静音

• 返回值:扬声器是否静音， 1,静音，0，不静音

CRVideo_SetSpeakerMute(value)

• 功能: 设置扬声器是否静音

• 返回值:设置成功则返回true,否则返回false（bool）

CRVideo_SetAllAudioClose()

• 功能: 关闭所有人麦克风

• 返回值:无

CRVideo_AudioDevChanged.callback = function(){}

• 功能: 麦克风设备变化

• 功能：SDK通知本地音频设备有变化

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

• 功能：SDK通知打开本地音频状态变化

• 参数：
  • UID ----- 会话中设备的所有者ID
  • oldStatus ----- 旧状态
  • newStatus ----- 新状态

CRVideo_MicEnergyUpdate.callback = function(UID,oldLevel,newLevel){}

• 功能：SDK通知用户的说话声音强度更新

• 参数：
  • UID ----- 用户ID
  • oldLevel ----- 原来的说话声音强度
  • newLevel ----- 现在的说话声音强度

CRVideo_StartPlayMedia(filename, locPlay, bPauseWhenFinished)

• 功能: 开始播放影音

• 返回值:返回值 整形数值，1：正常，0：失败(number)

如果播放成功，其他人收到CRVideo_NotifyMediaStart，如果播放失败，请关注通知事件CRVideo_NotifyMediaStop

CRVideo_PausePlayMedia(bPause)

• 功能: 暂停或恢复播放影音

• 返回值:无

CRVideo_StopPlayMedia()

• 功能: 停止播放影音

• 返回值:无

其他人收到CRVideo_NotifyMediaStop

CRVideo_SetMediaplaypos(pos)

• 功能: 设置播放进度

• 返回值:无

CRVideo_GetAllFilesInMediaPath()

• 功能: 取得影音文件夹下的所有可播放文件

• 返回值:文件名列表数组（Array）

影音文件夹位于方法CRVideo_Init2的第一个参数sdkFilePath，sdk会在此文件中建立media的子文件夹，即为影音文件夹

CRVideo_Getmediainfo(UID)

• 功能: 影音播放信息

• 返回值:影音文件信息（CRVideo_MediaInfoObj）

CRVideo_Getmediaimg(UID)

• 功能: 获取影音图像数据

• 返回值:帧信息(CRVideo_VideoImgObj)

CRVideo_StartGetAudioPCM(aSide, getType, jsonParam)

• 功能: 开始获取语音pcm数据

• 返回值:返回值 整形数值，1：正常，0：失败(number)

CRVideo_StopGetAudioPCM(aSide)

• 功能: 停止获取语音pcm数据

• 返回值:无

CRVideo_NotifyMediaOpened.callback = function(totalTime,w,h){}

• 功能SDK通知影音文件打开

• 参数：
  • totalTime ----- 影音时长（秒）
  • w ----- 宽度
  • h ----- 高度

CRVideo_NotifyMediaStart.callback = function(userid){}

• 功能：SDK通知影音开始播放

• 参数：
  • userid ----- 操作者的用户id

CRVideo_NotifyMediaStop.callback = function(userid,reason){}

• 功能：SDK通知影音播放停止

• 参数：
  • userid ----- 操作者的用户id
  • reason ----- 播放停止原因，详见CRVideo_MEDIA_STOP_REASON

CRVideo_NotifyMediaPause.callback = function(userid,pause){}

• 功能：SDK通知影音播放是否暂停

• 参数：
  • userid ----- 操作者的用户id
  • pause ----- 是否暂停 1暂停 0播放

CRVideo_NotifyPlayPosSetted.callback = function(setPTS){}

• 功能：SDK通知播放进度已设置完成

• 参数：
  • setPTS ----- 播放进度

CRVideo_NotifyAudioPCMDat.callback = function(aSide,base64PcmDat){}

• 功能：SDK通知语音PCM数据

• 参数：
  • aSide ----- 声道类型
  • base64PcmDat ----- PCM数据（base64格式）

UI显示组件公用接口

CRVideo.Container()

# Methods

• handler() ------ object对象
• height() ------ 容器的高度
• id() ------ id
• style() ------ 容器的样式
• width() ------ 容器的宽度
• shows() ------ 容器的显示
• hidden() ------ 容器的消失