音视频通话

API

更新时间: 2024/06/20 14:30:12

API概述

房间外接口 基础函数
初始化/反初始化
登录/注销/掉线
队列管理
呼叫
邀请
房间管理
房间内接口 进出房间
房间内基础消息
房间、用户属性
成员管理
音频管理
视频管理
屏幕共享
影音共享
云端录制/互动直播
可视化UI组件
消息接口 消息通道(房间外)
广播消息(房间内)

接口描述

基础函数

类型
接口
描述
主调 CRVideo_GetSDKVersion 获取当前SDK版本号
CRVideo_WriteLog 向日志中写入自定义内容
CRVideo_SetSDKParams 设置SDK基础配置

初始化/反初始化

类型
接口
描述
主调 CRVideo_Init SDK初始化
CRVideo_Uninit SDK反初始化

登录/注销/掉线

类型
接口
描述
主调 CRVideo_SetServerAddr 设置服务器地址
CRVideo_Login 登录(帐号密码鉴权)
CRVideo_LoginByToken 登录(Token鉴权)
CRVideo_UpdateToken 更新Token
CRVideo_Logout 注销登录
回调 CRVideo_LoginSuccess 回调,登陆成功
CRVideo_LoginFail 回调,登录失败
CRVideo_NotifyTokenWillExpire 通知,Token即将失效
CRVideo_LineOff 通知,从服务器掉线了

队列管理

类型
接口
描述
主调 CRVideo_InitQueueDat 初始化队列数据
CRVideo_GetAllQueueInfo 查询所有队列的信息
CRVideo_RefreshAllQueueStatus 刷新所有队列的状态
CRVideo_GetQueueStatus 获取某个队列的状态
CRVideo_GetQueuingInfo 获取我的排队信息
CRVideo_GetServingQueues 获取我当前服务的所有队列
CRVideo_GetSessionInfo 获取我的会话信息
CRVideo_StartQueuing 开始排队
CRVideo_StopQueuing 停止排队
CRVideo_StartService 坐席开始服务某个队列
CRVideo_StopService 坐席停止服务某个队列
CRVideo_GetQueueUsers 坐席查询服务队列中正在排队的用户列表
CRVideo_ReqAssignUser 坐席请求分配一个客户
CRVideo_AcceptAssignUser 坐席接受系统分配的客户
CRVideo_RejectAssignUser 坐席拒绝系统分配的客户
回调 CRVideo_InitQueueDatRslt 回调,队列初始化操作的结果响应
CRVideo_QueueStatusChanged 通知,队列状态变化
CRVideo_GetQueueStatusRslt 回调,获取某个队列状态的结果响应
CRVideo_QueuingInfoChanged 通知,排队信息变化(客户)
CRVideo_StartQueuingRslt 回调,开始排队的结果响应(客户)
CRVideo_StopQueuingRslt 回调,停止排队的结果响应(客户)
CRVideo_StartServiceRslt 回调,开始服务某个队列的结果响应(坐席)
CRVideo_StopServiceRslt 回调,停止服务某个队列的结果响应(坐席)
CRVideo_GetQueueUsersRslt 回调,获取到队列中正在排队的用户列表(坐席)
CRVideo_ResponseAssignUserRslt 回调,响应系统分配客户的结果(坐席)
CRVideo_AutoAssignUser 通知,系统自动分配了客户(坐席)
CRVideo_ReqAssignUserRslt 回调,请求系统分配客户的结果(坐席)
CRVideo_CancelAssignUser 通知,系统取消分配客户(坐席)
CRVideo_NotifyUserEnter 通知,有新客户进入队列排队(坐席)
CRVideo_NotifyUserLeave 通知,有客户离开队列(坐席)

呼叫

类型
接口
描述
主调 CRVideo_Call 发起呼叫
CRVideo_AcceptCall 接受对方发起的呼叫
CRVideo_RejectCall 拒绝对方发起的呼叫
CRVideo_HangupCall 挂断当前的呼叫
CRVideo_SetDNDStatus 设置免打扰状态
CRVideo_GetUserStatus 获取AppID下所有用户在线状态
CRVideo_GetOneUserStatus 获取AppID下指定用户的在线状态
CRVideo_StartUserStatusNotify 开启用户的状态推送
CRVideo_StopUserStatusNotify 关闭用户的状态推送
回调 CRVideo_CallSuccess 回调,发起呼叫成功
CRVideo_CallFail 回调,发起呼叫失败
CRVideo_AcceptCallSuccess 回调,接受他人的呼叫成功
CRVideo_AcceptCallFail 回调,接受他人的呼叫失败
CRVideo_RejectCallSuccess 回调,拒绝他人的呼叫成功
CRVideo_RejectCallFail 回调,拒绝他人的呼叫失败
CRVideo_HangupCallSuccess 回调,挂断呼叫成功
CRVideo_HangupCallFail 回调,挂断呼叫失败
CRVideo_NotifyCallIn 通知,有人呼叫自己
CRVideo_NotifyCallAccepted 通知,呼叫被对方接受
CRVideo_NotifyCallRejected 通知,呼叫被对方拒绝
CRVideo_NotifyCallHangup 通知,呼叫被对方挂断
CRVideo_SetDNDStatusSuccess 回调,设置免打扰状态成功
CRVideo_SetDNDStatusFail 回调,设置免打扰状态失败
CRVideo_GetUserStatusSuccess 回调,获取用户在线状态成功
CRVideo_GetUserStatusFail 回调,获取用户在线状态失败
CRVideo_StartUserStatusNotifyRslt 回调,开启用户状态推送的结果
CRVideo_StopUserStatusNotifyRslt 回调,停止用户状态推送的结果
CRVideo_NotifyUserStatus 通知,用户的状态变化

邀请

类型
接口
描述
主调 CRVideo_Invite 发送邀请
CRVideo_AcceptInvite 接受对方发送的邀请
CRVideo_RejectInvite 拒绝对方发送的邀请
CRVideo_CancelInvite 取消自己发送的邀请
回调 CRVideo_InviteSuccess 回调,发送邀请成功
CRVideo_InviteFail 回调,发送邀请失败
CRVideo_AcceptInviteSuccess 回调,接受对方发送的邀请成功
CRVideo_AcceptInviteFail 回调,接受对方发送的邀请失败
CRVideo_RejectInviteSuccess 回调,拒绝对方发送的邀请成功
CRVideo_RejectInviteFail 回调,拒绝对方发送的邀请失败
CRVideo_CancelInviteSuccess 回调,取消自己发送的邀请成功
CRVideo_CancelInviteFail 回调,取消自己发送的邀请失败
CRVideo_NotifyInviteIn 通知,收到别人的邀请
CRVideo_NotifyInviteAccepted 通知,我发送的邀请被对方接受
CRVideo_NotifyInviteRejected 通知,我发送的邀请被对方拒绝
CRVideo_NotifyInviteCanceled 通知,邀请已经被取消了

房间管理

类型
接口
描述
主调 CRVideo_CreateMeeting2 创建房间
CRVideo_DestroyMeeting 销毁房间
回调 CRVideo_CreateMeetingSuccess 回调,创建房间成功
CRVideo_CreateMeetingFail 回调,创建房间失败
CRVideo_DestroyMeetingRslt 回调,销毁房间的结果
CRVideo_MeetingStopped 通知,当前房间已被结束

进出房间

类型
接口
描述
主调 CRVideo_EnterMeeting3 进入房间
CRVideo_ExitMeeting 离开房间
CRVideo_Kickout 将房间内指定成员踢出房间
回调 CRVideo_EnterMeetingRslt 回调,进入房间的结果
CRVideo_UserEnterMeeting 通知,有人进入房间
CRVideo_UserLeftMeeting 通知,有人离开房间
CRVideo_MeetingDropped 通知,从房间中掉线了

房间内基础消息

类型
接口
描述
主调 CRVideo_GetMainVideo 获取当前哪个用户为主视频
CRVideo_SetMainVideo 设置哪个用户为主视频
CRVideo_SetMainVideoMode 设置主视频模式
CRVideo_GetMainVideoMode 获取当前主视频模式
CRVideo_SwitchToPage 功能区切换
CRVideo_GetCurrentMainPage 获取当前主功能区
CRVideo_GetCurrentSubPage 获取当前子页面
回调 CRVideo_NotifyMainVideoChanged 通知,会话内主视频变化
CRVideo_NotifyMainVideoModeChanged 通知,会话内主视频模式变化
CRVideo_NotifySwitchToPage 通知,会话内功能区变化
CRVideo_PeerConnectionError 通知,媒体流连接错误
CRVideo_NetStateChanged 通知,网络状态变化

房间、用户属性

类型
接口
描述
主调 CRVideo_GetMeetingAttrs 获取房间部份属性
CRVideo_GetMeetingAllAttrs 获取房间所有属性
CRVideo_SetMeetingAttrs 重置房间属性集
CRVideo_AddOrUpdateMeetingAttrs 增加或者更新房间属性
CRVideo_DelMeetingAttrs 删除房间属性
CRVideo_ClearMeetingAttrs 清除房间所有属性
CRVideo_GetUserAttrs 获取指定用户的指定属性
CRVideo_SetUserAttrs 重置用户属性
CRVideo_AddOrUpdateUserAttrs 增加或更新用户属性
CRVideo_DelUserAttrs 删除用户的特定属性
CRVideo_ClearUserAttrs 清除特定用户的所有属性
CRVideo_ClearAllUserAttrs 清除所有用户的所有属性
回调 CRVideo_GetMeetingAttrsSuccess 回调,成功获取到房间指定属性
CRVideo_GetMeetingAttrsFail 回调,获取房间指定属性失败
CRVideo_GetMeetingAllAttrsSuccess 回调,成功获取到房间所有属性
CRVideo_GetMeetingAllAttrsFail 回调,获取房间属性失败
CRVideo_SetMeetingAttrsRslt 回调,设置用户属性结果
CRVideo_AddOrUpdateMeetingAttrsRslt 回调,增加或更新房间属性结果
CRVideo_DelMeetingAttrsRslt 回调,删除房间属性结果
CRVideo_ClearMeetingAttrsRslt 回调,清除房间属性结果
CRVideo_GetUserAttrsSuccess 回调,获取房间内用户属性成功
CRVideo_GetUserAttrsFail 回调,获取房间内用户属性失败
CRVideo_SetUserAttrsRslt 回调,设置用户属性结果
CRVideo_AddOrUpdateUserAttrsRslt 回调,增加或者更新用户属性结果
CRVideo_DelUserAttrsRslt 回调,删除特定用户属性结果
CRVideo_ClearUserAttrsRslt 回调,清除特定用户属性结果
CRVideo_ClearAllUserAttrsRslt 回调,清除所有用户属性结果
CRVideo_NotifyMeetingAttrsChanged 通知,房间属性发生改变
CRVideo_NotifyUserAttrsChanged 通知,某个用户属性发生改变

房间成员管理

类型
接口
描述
主调 CRVideo_GetAllMembers 获取房间内所有成员的信息
CRVideo_GetMemberInfo 获取房间内指定成员的信息
CRVideo_GetMemberNickName 获取房间内指定成员的昵称
CRVideo_IsUserInMeeting 判断某个用户是否在房间中
CRVideo_SetNickName 设置房间内某个成员的昵称
回调 CRVideo_NotifyNickNameChanged 通知,房间内某个成员昵称变化

音频管理

类型
接口
描述
主调 CRVideo_GetAudioMicNames 获取本地麦克风设备列表
CRVideo_GetAudioSpkNames 获取本地扬声器设备列表
CRVideo_SetAudioCfg 设置本地音频参数
CRVideo_GetAudioCfg 获取本地音频参数
CRVideo_GetMicEnergy 获取指定成员的麦克风声音大小
CRVideo_OpenMic 打开指定成员的麦克风
CRVideo_CloseMic 关闭指定成员的麦克风
CRVideo_GetAudioStatus 获取指定成员的麦克风状态
CRVideo_SetAllAudioClose 关闭房间内所有人麦克风
CRVideo_PauseSpeaker 暂停播放房间内通话声音(静音)
CRVideo_PlaySpeaker 恢复播放房间内通话声音
CRVideo_StartGetAudioPCM 开始获取语音PCM数据
CRVideo_StopGetAudioPCM 停止获取语音PCM数据
CRVideo_SetVoiceChange 设置用户变声类型
CRVideo_GetVoiceChangeType 获取用户当前的变声类型
回调 CRVideo_AudioStatusChanged 通知,成员麦克风状态变化
CRVideo_MicEnergyUpdate 通知,成员麦克风声音能量变化
CRVideo_NotifyAudioStream 通知,获取到webRTC语音流
CRVideo_OpenMicFailed 通知,打开本地麦克风失败
CRVideo_NotifyAudioPCMDat 通知,获取到语音PCM数据
CRVideo_NotifySetVoiceChange 通知,用户的变声类型发生变化

视频管理

类型
接口
描述
主调 CRVideo_CreatVideoObj 创建成员视频UI显示对象
CRVideo_GetVideoCfg 获取当前视频参数
CRVideo_SetVideoCfg 设置视频参数
CRVideo_GetVideoStatus 获取指定成员的视频状态
CRVideo_GetDefaultVideo 获取指定成员的默认摄像头
CRVideo_SetDefaultVideo 设置指定成员的默认摄像头
CRVideo_GetAllVideoInfo 获取指定成员的所有摄像头信息
CRVideo_GetOpenedVideoIDs 获取指定成员当前打开的摄像头ID列表
CRVideo_OpenVideo 打开指定成员的摄像头
CRVideo_CloseVideo 关闭指定成员的摄像头
CRVideo_SetEnableMutiVideo 设置是否启用多摄像头
CRVideo_GetEnableMutiVideo 获取当前是否启用多摄像头
CRVideo_DisableCamera 禁用某个摄像头
CRVideo_SetLocVideoAttributes 视频设备私有参数配置
CRVideo_GetLocVideoAttributes 获取某个摄像头私有参数
CRVideo_GetVideoTrackCapabilities 获取摄像头支持性
CRVideo_GetVideoTrackSettings 获取摄像头轨道的当前设置
CRVideo_SetVideoPanTiltZoom 设置云台摄像头配置参数
CRVideo_AddStreamCam 添加WebRTC媒体流摄像头
CRVideo_RemoveStreamVideo 移除WebRTC媒体流摄像头
CRVideo_AddCanvasVCam 添加canvas虚拟摄像头
CRVideo_RemoveCanvasVCam 移除canvas摄像头
CRVideo_SetVirtualBackground 设置虚拟背景
回调 CRVideo_VideoDevChanged 通知,某个成员的摄像头设备发生了变化
CRVideo_DefVideoChanged 通知,某个成员的默认摄像头发生了变化
CRVideo_VideoStatusChanged 通知,某个成员的视频状态发生了变化
CRVideo_NotifyVideoStream 通知,获取到某个成员的WebRTC视频流
CRVideo_OpenVideoFailed 通知,打开本地摄像头失败
CRVideo_OpenVideoTimeout 通知,获取本地摄像头视频流超时

屏幕共享

类型
接口
描述
主调 CRVideo_CreatScreenShareObj 创建屏幕共享显示UI组件
CRVideo_SetScreenShareCfg 配置屏幕共享参数
CRVideo_GetScreenShareCfg 获取屏幕共享参数
CRVideo_StartScreenShare 开启本地屏幕共享
CRVideo_StopScreenShare 结束本地屏幕共享
CRVideo_StartScreenMark 开启房间内屏幕共享标注
CRVideo_StopScreenMark 停止房间内屏幕共享标注
回调 CRVideo_StartScreenShareRslt 回调,开启屏幕共享的结果
CRVideo_StopScreenShareRslt 回调,停止屏幕共享的结果
CRVideo_StartScreenMarkRslt 回调,开启房间内屏幕共享标注的结果
CRVideo_StopScreenMarkRslt 回调,停止房间内屏幕共享标注的结果
CRVideo_NotifyScreenShareStarted 通知,他人开启了屏幕共享
CRVideo_NotifyScreenShareStopped 通知,他人停止了屏幕共享
CRVideo_NotifyScreenMarkStarted 通知,房间内开启了屏幕共享标注
CRVideo_NotifyScreenMarkStopped 通知,房间内停止了屏幕共享标注

影音共享

类型
接口
描述
主调 CRVideo_CreatMediaObj 创建影音共享显示UI组件
CRVideo_SetMediaCfg 配置影音共享参数
CRVideo_GetMediaCfg 获取影音共享参数
CRVideo_StartPlayMedia 开始播放影音
CRVideo_PausePlayMedia 暂停或恢复播放影音
CRVideo_StopPlayMedia 停止播放影音及共享
CRVideo_SetMediaplaypos 设置播放进度
CRVideo_SetMediaVolume 设置本地媒体音量
CRVideo_GetMediaInfo 获取影音播放信息
CRVideo_GetMediaImg 获取影音图像数据
回调 CRVideo_NotifyMediaOpened 通知,影音文件已打开
CRVideo_NotifyMediaStart 通知,影音开始播放
CRVideo_NotifyMediaStop 通知,影音播放停止
CRVideo_NotifyMediaPause 通知,影音播放暂停/取消暂停
CRVideo_NotifyPlayPosSetted 通知,影音播放位置更新

云端录制/互动直播

类型
接口
描述
主调 CRVideo_CreateCloudMixer 创建云端混图器
CRVideo_UpdateCloudMixerContent 更新云端混图器
CRVideo_DestroyCloudMixer 消毁云端混图器
CRVideo_GetAllCloudMixerInfo 得到所有云端混图器信息
CRVideo_GetCloudMixerInfo 得到云端混图器信息
回调 CRVideo_CreateCloudMixerFailed 通知,启动云端录制、云端直播失败
CRVideo_CloudMixerStateChanged 通知,云端录制、云端直播状态变化
CRVideo_CloudMixerOutputInfoChanged 通知,云端录制文件、云端直播输出变化
CRVideo_CloudMixerInfoChanged 通知,云端录制、云端直播配置变化

可视化UI组件

类型
接口
描述
CRVideo_VideoObj、CRVideo_ScreenShareObj、CRVideo_MediaObj 公共方法 id 设置/查询组件的独立ID
height 设置/查询组件的高度
width 设置/查询组件的宽度
left 设置/查询组件在父元素中的left位置
top 设置/查询组件在父元素中的top位置
show 显示组件
hide 隐藏组件
handler 获取该组件的DOM对象
setVideo 设置组件上要显示的视频画面,订阅视频
clear 清除组件中的图像
isPicEmpty 检查组件当前图像是否为空
setNickNameStyle 设置组件上昵称的显示样式
setNickNameContent 设置组件上昵称的显示内容
setVisibleNickName 设置组件上是否显示昵称
getVisibleNickName 获取组件当前是否显示昵称
dblClickFullScreen 设置/查询组件是否支持双击全屏
savePic 保存组件当前显示的一帧画面为图片文件
savePicToBase64 保存组件当前显示的一帧画面为base64数据
setVideoProp 动态设置UI组件中video标签的属性
onplay 通知:组件准备播放
onplaying 通知:组件正在播放
onpause 通知:组件暂停播放
onended 通知:组件停止播放
onerror 通知:组件播放出错
CRVideo_VideoObj setVideo 订阅成员摄像头画面
getVideoID 查询组件当前订阅的摄像头ID
destroy 销毁组件,退订视频
CRVideo_ScreenShareObj setVideo 设置组件显示的屏幕内容(谁的屏幕)
setMark 设置屏幕共享标注样式
CRVideo_MediaObj setVideo 设置组件显示的影音内容(谁的影音)

房间外点对点消息通道

类型
接口
描述
主调 CRVideo_SendCmd 发送点对点消息
CRVideo_SendBuffer 发送大块数据
CRVideo_SendFile 发送文件数据
CRVideo_CancelSend 取消发送
回调 CRVideo_SendCmdRslt 回调,发送点对点消息的结果
CRVideo_SendBufferRslt 回调,发送大块数据的结果
CRVideo_SendFileRslt 回调,发送文件的结果
CRVideo_SendProgress 通知,当前发送进度
CRVideo_NotifyCmdData 通知,收到点对点消息
CRVideo_NotifyBufferData 通知,收到大块数据
CRVideo_NotifyFileData 通知,收到文件数据

房间内广播消息

类型
接口
描述
主调 CRVideo_SendMeetingCustomMsg 发送房间内广播消息
回调 CRVideo_SendMeetingCustomMsgRslt 回调,发送房间内广播消息的结果
CRVideo_NotifyMeetingCustomMsg 通知,收到房间内广播消息

接口详情

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)方法中的参数为两个回调函数
      // 第一个参数为初始化成功的回调函数,第二个参数为初始化失败的回调函数
      // 可以通过错误码判断初始化失败的原因

注意:
程序开始时init,程序结束时uninit,整个程序的生命周期中只进行一次初始化和反初始化。
webRTC默认不支持http协议(chrome78+已支持file:///协议),只能通过配置127.0.0.1或locallhost访问,或通过配置Chrome调试模式绕过此限制。

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()
  • 描述:注销登录
  • 返回值:
  • 回调:

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

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即将失效

此回调将在token失效前30s通知,此时应重新获取新的Token后调用 CRVideo_UpdateToken 接口及时更新Token,否则将被强制下线

CRVideo_LineOff

  • 详情:CRVideo_LineOff.callback=function(sdkErr){}
  • 描述:通知,从服务器掉线了
  • 回调参数:
    参数
    类型
    含义
    sdkErr Number 错误码,详细见 错误码定义

从服务器掉线后,应再次调用登录接口重新登录服务器,可以用 cookie 来区分是掉线后的重登还是第一次登录,需要注意的是,登录服务器和登录房间是不同的接口,掉线后的通知也是不同的回调,重新登录也应该分别做不同的处理。

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_GetQueueStatusRslt.callback 回调,从该回调中获取每个队列的状态

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_QueuingInfoChanged.callback

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_AutoAssignUser.callback
如果开启免打扰,系统就不会自动分配客户,如果需要手动分配客户,可调用 CRVideo_ReqAssignUser
坐席优先级描述:
1.座席优先级只在服务的队列内部有效;
2.客户优先分配给服务此队列优先级最高的,且空闲的座席;
3.优先级相同时,则分配给最先空闲的座席;
4.优先级高的座席变空闲时,不抢夺已分配的客户;

CRVideo_StopService

  • 详情:CRVideo_StopService(queID,cookie)
  • 描述:坐席停止服务某个队列
  • 返回值:
  • 回调:CRVideo_StopServiceRslt.callback
  • 参数:
    参数
    类型
    必传
    含义
    queID Number 队列ID
    cookie String 详细介绍见 关键词,可以传空串

CRVideo_GetQueueUsers

  • 详情:CRVideo_GetQueueUsers(queID,cookie)
  • 描述:坐席查询服务队列中正在排队的用户列表
  • 返回值:
  • 回调:CRVideo_GetQueueUsersRslt.callback
  • 参数:
    参数
    类型
    必传
    含义
    queID Number 队列ID
    cookie String 详细介绍见 关键词,可以传空串

CRVideo_ReqAssignUser

  • 详情:CRVideo_ReqAssignUser(cookie, queID, UID)
  • 描述:坐席请求分配一个客户
  • 返回值:
  • 回调:CRVideo_ReqAssignUserRslt.callback
  • 参数:
    参数
    类型
    必传
    含义
    cookie String 详细介绍见 关键词,可以传空串
    queID Number 队列ID
    UID String 用户ID, 详细介绍见 关键词

当坐席关闭免打扰时,系统将自动分配客户,无需调用此函数; 当开启免打扰时,系统不再自动分配客户,座席如需服务客户可调用此接口请求系统分配
不传队列ID和UID时,系统将自动分配一个用户,只有当坐席需要指定系统分配某个用户时,才需要这两个参数

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_GetQueueUsersRslt

  • 详情:CRVideo_GetQueueUsersRslt.callback = function(sdkErr,queUserList,cookie){}
  • 描述:回调,获取到队列中正在排队的用户列表(坐席)
  • 回调参数:
    参数
    类型
    含义
    sdkErr Number 错误码,详细见 错误码定义
    queUserList Array 正在排队的用户列表[CRVideo_QueUser,...]
    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_SetDNDStatus 设置为免打扰状态

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_AutoAssignUser 给队列服务者自动推送客户(或队列服务者通过 CRVideo_ReqAssignUser 请求分配客户),收到系统分配的客户后,如果队列服务者30秒之内不接受 (CRVideo_AcceptAssignUser) 也不拒绝 (CRVideo_RejectAssignUser) 推送的客户,系统将通过本接口取消分配,然后将客户分配给其他空闲的服务者。

CRVideo_NotifyUserEnter

  • 详情:CRVideo_NotifyUserEnter.callback = function(queID,CRVideo_QueUser){}
  • 描述:通知,有新客户进入队列排队(坐席)
  • 回调参数:
    参数
    类型
    含义
    queID Number 队列ID
    CRVideo_QueUser Object 队列用户信息, 详细介绍见 类型定义

当坐席通过CRVideo_GetQueueUsers接口查询过某个队列的排队用户列表后,如果该队列的排队用户发生变化,坐席将收到此通知。如果坐席未查询过排队用户列表,将不会收到此通知

CRVideo_NotifyUserLeave

  • 详情:CRVideo_NotifyUserLeave.callback = function(queID,UID,inService){}
  • 描述:通知,有客户离开队列(坐席)
  • 回调参数:
    参数
    类型
    含义
    queID Number 队列ID
    UID String 用户ID, 详细介绍见 关键词
    inService Bool 该用户是否已开始服务(用户开始服务后,也会同时离开队列)

当坐席通过CRVideo_GetQueueUsers接口查询过某个队列的排队用户列表后,如果该队列的排队用户发生变化,坐席将收到此通知。如果坐席未查询过排队用户列表,将不会收到此通知

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_CreateMeetingSuccess.callback 获得
userExtDat参数为自定义参数,对方在收到呼叫时可以拿到此参数的数据

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 详细介绍见 关键词,可以传空串

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

CRVideo_GetUserStatus

CRVideo_GetOneUserStatus

CRVideo_StartUserStatusNotify

AppID下所有用户状态有变化时(包括在线状态、空闲状态、免打扰状态),都会收到 CRVideo_NotifyUserStatus.callback 通知。开启后,用户量越大消息量越大,所以请按需开启。在 CRVideo_StartUserStatusNotify 前,应该先通过 CRVideo_GetUserStatus 获取所有用户状态。

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 详细介绍见 关键词,可以传空串

需要邀请对方加入房间时,userExtDat可以是房间信息 CRVideo_RoomInfoObj
如果邀请监控设备SIP/H323设备进入房间, usrExtDat必须为:
{meeting: { ID: 房间号 },devInfo: {userID: "该设备在房间中的UID", nickName: "该设备在房间中的昵称"}};
如果邀请SIP/H323设备不需要自定义UID和昵称,usrExtDat则可以不传devInfo参数;

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_DestroyMeeting

  • 详情:CRVideo_DestroyMeeting(meetID,cookie)
  • 描述:销毁房间
  • 返回值:
  • 回调:CRVideo_DestroyMeetingRslt.callback
  • 参数:
    参数
    类型
    必传
    含义
    meetID Number 房间号
    cookie String 详细介绍见 关键词,可以传空串

SDK创建的房间为固定房间,固定房间不会自动销毁,当该房间今后不再使用时,应当调用此接口销毁该房间
调用此接口后,房间内成员将收到 CRVideo_MeetingStopped.callback 通知

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_EnterMeeting3 接口重新进入房间,并可通过传cookie参数在进入房间成功的回调中来区分是第一次进入房间还是重新进入房间,以此来做不同的处理,详见Demo。
如果是Token鉴权登录,当Token过期时,也会强制从房间中退出并收到此通知,此时应先更新Token,再重新进入房间。

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为最佳

网络评分>8为优秀,通话基本不受影响;5~8为一般,可能会出现卡顿或延迟,5>为差,可能无法正常通话或出现流媒体错误、掉线等。

CRVideo_GetMeetingAttrs

CRVideo_GetMeetingAllAttrs

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_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_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, 详细介绍见 关键词

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

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

getType为0时,jsonParam参数对象中eachTime和eachSize二选一必传,否则会开启失败
getType为1时,jsonParam参数对象中fileName必传,否则会开启失败
getType为1时,无回调,停止获取时,会自动下载PCM格式的文件
可以同时开启aSide为0和aSide为1的两个录制,但每种aSide不能重复开启

CRVideo_StopGetAudioPCM

  • 详情:CRVideo_StopGetAudioPCM(aSide)
  • 描述:停止获取语音PCM数据
  • 返回值:
  • 回调:
  • 参数:
    参数
    类型
    必传
    含义
    aSide Number PCM数据的来源,0:麦克风,1:扬声器

getType为1时,调用此接口停止获取,会自动下载PCM格式的文件,文件保存位置为浏览器默认下载目录
若同时启动了aSide为0和aSide为1的两个录制,则需要分别停止

CRVideo_SetVoiceChange

  • 详情:CRVideo_SetVoiceChange(UID,type).then(function(resObject){}).catch(function(errObject){})
  • 描述:设置用户变声类型
  • 返回值:返回一个Promise对象,成功返回resolveCallback,失败返回rejectCallback
  • 参数:
    参数
    类型
    必传
    含义
    UID String 用户ID, 详细介绍见 关键词
    type Number 变声类型,0:原声;1:低沉;2:尖锐

CRVideo_GetVoiceChangeType

  • 详情:CRVideo_GetVoiceChangeType(UID)
  • 描述:获取用户当前的变声类型
  • 返回值:返回用户变声类型,0:原声;1:低沉;2:尖锐
  • 回调:
  • 参数:
    参数
    类型
    必传
    含义
    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

webRTC语音流stream,可以通过设置audio标签的srcObject属性来播放,也可以通过web audio api来进行二次处理

CRVideo_OpenMicFailed

  • 详情:CRVideo_OpenMicFailed.callback = function(errDesc){}
  • 描述:通知,打开本地麦克风失败
  • 回调参数:
    参数
    类型
    含义
    errDesc String 错误描述

打开麦克风是异步的,所以SDK将以通知的方式通知业务层失败的情形
打开麦克风失败可能的原因有:设备被占用、用户未授权访问、硬件设备发生错误等

CRVideo_NotifyAudioPCMDat

  • 详情:CRVideo_NotifyAudioPCMDat.callback = function(aSide, PCMDat){}
  • 描述:通知,获取到语音PCM数据
  • 回调参数:
    参数
    类型
    含义
    aSide Number 数据来源,0:麦克风,1:扬声器
    PCMDat ArrayBuffer 语音PCM数据

当使用回调方式获取语音PCM时,会触发此回调接口
此接口将根据开启录制时设置的eachSize或eachTime自动触发
业务层从此接口获取的pcm数据,可以自行添加到数组中。将数组转成blob数据后,可使用audio标签进行播放或下载

CRVideo_NotifySetVoiceChange

  • 详情:CRVideo_NotifySetVoiceChange.callback = function(UID, type){}
  • 描述:通知,用户的变声类型发生变化
  • 回调参数:
    参数
    类型
    含义
    UID String 用户ID, 详细介绍见 关键词
    type Number 变声类型,0:原声;1:低沉;2:尖锐

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); // 设置显示成员摄像头画面

必须创建成员视频UI对象才能在网页上显示成员的摄像头画面

CRVideo_GetVideoCfg

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

CRVideo_SetVideoCfg

  • 详情:CRVideo_SetVideoCfg(VideoCfg)
  • 描述:设置视频参数
  • 返回值:
  • 回调:
  • 参数:
    参数
    类型
    必传
    含义
    VideoCfg Object 详细介绍见:CRVideo_VideoCfg

设置视频参数会根据浏览器支持的能力自适应,相关属性不一定能设置成功,超出浏览器能力时浏览器会选择适合的值。例如:设置fps:35,在chrome上不支持,最终结果是30fps,而在safari上最终结果是31fps

CRVideo_GetVideoStatus

  • 详情:CRVideo_GetVideoStatus(UID)
  • 描述:获取指定成员的视频状态
  • 返回值:返回该用户的视频状态,详见:CRVideo_VSTATUS
  • 回调:
  • 参数:
    参数
    类型
    必传
    含义
    UID String 用户ID, 详细介绍见 关键词

CRVideo_GetDefaultVideo

  • 详情:CRVideo_GetDefaultVideo(UID)
  • 描述:获取指定成员的默认摄像头
  • 返回值:返回该成员的默认摄像头ID(Number),如:1
  • 回调:
  • 参数:
    参数
    类型
    必传
    含义
    UID String 用户ID, 详细介绍见 关键词

CRVideo_SetDefaultVideo

  • 详情:CRVideo_SetDefaultVideo(UID, videoID)
  • 描述:设置指定成员的默认摄像头
  • 返回值:
  • 回调:
  • 参数:
    参数
    类型
    必传
    含义
    UID String 用户ID, 详细介绍见 关键词
    videoID Number 摄像头ID

如果用户只有一个摄像头,可以不设置默认摄像头
如果用户有多个摄像头,但是只想用其中一个,需要把这个摄像头设置为默认摄像头(切换摄像头)
可以通过调用 CRVideo_GetAllVideoInfo 接口获取用户的摄像头列表
如果调用此接口设置了新的默认摄像头,房间内用户将会收到 CRVideo_DefVideoChanged.callback 接口通知

CRVideo_GetAllVideoInfo

  • 详情:CRVideo_GetAllVideoInfo(UID)
  • 描述:获取指定成员的所有摄像头信息
  • 返回值:返回该用户摄像头信息列表Array,如:[VideoInfoObj1,VideoInfoObj2,...],详见:CRVideo_VideoInfoObj
  • 回调:
  • 参数:
    参数
    类型
    必传
    含义
    UID String 用户ID, 详细介绍见 关键词

CRVideo_GetOpenedVideoIDs

  • 详情:CRVideo_GetOpenedVideoIDs(UID)
  • 描述:获取指定成员当前打开的摄像头ID列表
  • 返回值:返回该用户当前打开的摄像头ID列表集合,如:[1, 2, 3, ...]
  • 回调:
  • 参数:
    参数
    类型
    必传
    含义
    UID String 用户ID, 详细介绍见 关键词

CRVideo_OpenVideo

  • 详情:CRVideo_OpenVideo(UID)
  • 描述:打开指定成员的摄像头
  • 返回值:
  • 回调:
  • 参数:
    参数
    类型
    必传
    含义
    UID String 用户ID, 详细介绍见 关键词

打开指定成员的摄像头,以便本地和远端显示视频图像
调用此接口后,如果获取到对应的视频流,将会收到CRVideo_NotifyVideoStream.callback(#CRVideo_NotifyVideoStream) 接口通知

CRVideo_CloseVideo

  • 详情:CRVideo_CloseVideo(UID)
  • 描述:关闭指定成员的摄像头
  • 返回值:
  • 回调:
  • 参数:
    参数
    类型
    必传
    含义
    UID String 用户ID, 详细介绍见 关键词

CRVideo_SetEnableMutiVideo

  • 详情:CRVideo_SetEnableMutiVideo(UID, bool)
  • 描述:设置是否启用多摄像头
  • 返回值:
  • 回调:
  • 参数:
    参数
    类型
    必传
    含义
    UID String 用户ID, 详细介绍见 关键词
    bool Bool 是否启用多摄像头

CRVideo_GetEnableMutiVideo

  • 详情:CRVideo_GetEnableMutiVideo(UID)
  • 描述:获取当前是否启用多摄像头
  • 返回值:返回当前是否启用了多摄像头
  • 参数:
    参数
    类型
    必传
    含义
    UID String 用户ID, 详细介绍见 关键词

CRVideo_DisableCamera

  • 详情:CRVideo_DisableCamera(videoID, isDisable)
  • 描述:禁用某个摄像头
  • 返回值:
  • 参数:
    参数
    类型
    必传
    含义
    videoID Number 需要禁用/解除禁用的摄像头ID
    isDisable Bool 是否禁用,true禁用,false解除禁用

CRVideo_SetLocVideoAttributes

  • 详情:CRVideo_SetLocVideoAttributes(videoID, attrs)
  • 描述:视频设备私有参数配置
  • 返回值:
  • 参数:
    参数
    类型
    必传
    含义
    videoID Number 摄像头ID
    attrs Object 私有参数配置对象,参见CRVideo_LocVideoAttributes

CRVideo_GetLocVideoAttributes

  • 详情:CRVideo_GetLocVideoAttributes(videoID)
  • 描述:获取某个摄像头私有参数
  • 返回值:私有参数配置对象,参见CRVideo_LocVideoAttributes
  • 参数:
    参数
    类型
    必传
    含义
    videoID Number 摄像头ID

CRVideo_GetVideoTrackCapabilities

  • 详情:CRVideo_GetVideoTrackCapabilities(videoID)
  • 描述:获取摄像头支持性
  • 返回值:参见MediaTrackCapabilities
  • 参数:
    参数
    类型
    必传
    含义
    videoID Number 摄像头ID

CRVideo_GetVideoTrackSettings

  • 详情:CRVideo_GetVideoTrackSettings(videoID)
  • 描述:获取摄像头轨道的当前设置
  • 返回值:参见MediaTrackSettings
  • 参数:
    参数
    类型
    必传
    含义
    videoID Number 摄像头ID

CRVideo_SetVideoPanTiltZoom

  • 详情:CRVideo_SetVideoPanTiltZoom(videoID, cloudVideoCfg)
  • 描述:设置云台摄像头配置参数
  • 返回值:
  • 参数:
    参数
    类型
    必传
    含义
    videoID Number 摄像头ID
    cloudVideoCfg Object 参见CRVideo_CloudVideoCfg

CRVideo_AddStreamCam

  • 详情:CRVideo_AddStreamCam(videoStream, videoName)
  • 描述:添加WebRTC媒体流摄像头
  • 返回值:返回摄像头ID
  • 参数:
    参数
    类型
    必传
    含义
    videoStream MediaStream WebRTC媒体流,详见:MediaStream
    videoName String 自定义摄像头名称,如:“媒体流摄像头1”

添加媒体流摄像头后,可以调用 CRVideo_GetAllVideoInfo 接口来获取该摄像头对应的videoID,打开此摄像头时需要传入videoID

CRVideo_RemoveStreamVideo

  • 详情:CRVideo_RemoveStreamVideo(videoID)
  • 描述:移除WebRTC媒体流摄像头
  • 返回值:
  • 回调:
  • 参数:
    参数
    类型
    必传
    含义
    videoID Number 需要移除的媒体流摄像头的ID

CRVideo_AddCanvasVCam

  • 详情:CRVideo_AddCanvasVCam(canvas, videoName, options)
  • 描述:添加canvas虚拟摄像头
  • 返回值:返回摄像头ID
  • 参数:
    参数
    类型
    必传
    含义
    canvas Object canvas element, Dom对象
    videoName String 自定义摄像头名称,如:“canvas摄像头1”
    options Object 保留参数

添加canvas摄像头后,可以调用 CRVideo_GetAllVideoInfo 接口来获取该摄像头对应的videoID,打开此摄像头时需要传入videoID

CRVideo_RemoveCanvasVCam

  • 详情:CRVideo_RemoveCanvasVCam(videoID)
  • 描述:移除canvas摄像头
  • 返回值:
  • 回调:
  • 参数:
    参数
    类型
    必传
    含义
    videoID Number 需要移除的canvas摄像头的ID

CRVideo_SetVirtualBackground

  • 详情:CRVideo_SetVirtualBackground(virtualBgCfg)
  • 描述:设置虚拟背景
  • 返回值:返回结果,0表示开启成功,其他数值表示相关 错误码
  • 参数:
    参数
    类型
    必传
    含义
    virtualBgCfg Object 虚拟背景配置对象,结构体请参见CRVideo_VirtualBgCfg

必须先通过 CRVideo_SetSDKParams 接口配置虚拟背景人像分割模型资源路径,才能启动虚拟背景

CRVideo_VideoDevChanged

  • 详情:CRVideo_VideoDevChanged.callback = function(UID){}
  • 描述:通知,某个成员的摄像头设备发生了变化
  • 回调参数:
    参数
    类型
    含义
    UID String 用户ID, 详细介绍见 关键词

CRVideo_DefVideoChanged

  • 详情:CRVideo_DefVideoChanged.callback = function(UID, videoID){}
  • 描述:通知,某个成员的默认摄像头发生了变化
  • 回调参数:
    参数
    类型
    含义
    UID String 用户ID, 详细介绍见 关键词
    videoID Number 摄像头ID

CRVideo_VideoStatusChanged

  • 详情:CRVideo_VideoStatusChanged.callback = function(UID, oldStatus, newStatus){}
  • 描述:通知,某个成员的视频状态发生了变化
  • 回调参数:
    参数
    类型
    含义
    UID String 用户ID, 详细介绍见 关键词
    oldStatus Number 旧的视频状态,详见:CRVideo_VSTATUS
    newStatus Number 新的视频状态,详见:CRVideo_VSTATUS

CRVideo_NotifyVideoStream

  • 详情:CRVideo_NotifyVideoStream.callback = function(UID, videoStream){}
  • 描述:通知,获取到某个成员的WebRTC视频流
  • 回调参数:
    参数
    类型
    含义
    UID String 用户ID, 详细介绍见 关键词
    videoStream MediaStream 该成员的WebRTC视频流,详见:MediaStream

获取到成员的视频流后,可以给界面上的<video>标签设置srcObject属性显示此视频流的画面,一般不建议这样使用,可以直接通过创建该成员的视频UI组件 CRVideo_CreatVideoObj 来显示他的画面

CRVideo_OpenVideoFailed

  • 详情:CRVideo_OpenVideoFailed.callback = function(videoID, errDesc){}
  • 描述:通知,打开本地摄像头失败
  • 回调参数:
    参数
    类型
    含义
    videoID Number 失败的摄像头ID
    errDesc String 错误描述

打开摄像头是异步的,所以SDK将以通知的方式通知业务层失败的情形。
打开摄像头失败可能的原因有:设备被占用、用户未授权访问、硬件设备发生错误等

CRVideo_OpenVideoTimeout

  • 详情:CRVideo_OpenVideoTimeout.callback = function(){}
  • 描述:通知,获取本地摄像头视频流超时

谷歌浏览器偶发获取摄像头视频流超时(等待时间大于10秒)
获取本地摄像头视频流超时,将导致无法正确建立本地视频上送连接
收到此通知,业务层应提示用户尝试重新开关摄像头以重新获取视频流

CRVideo_CreatScreenShareObj

  • 详情:CRVideo_CreatScreenShareObj(CreatParams)
  • 描述:创建屏幕共享显示UI组件
  • 返回值:返回屏幕共享UI显示对象 CRVideo_ScreenShareObj
  • 回调:
  • 参数:
    参数
    类型
    必传
    含义
    CreateUIParams Object 详细介绍见:CRVideo_CreateUIParams

CRVideo_SetScreenShareCfg

  • 详情:CRVideo_SetScreenShareCfg(CRVideo_ScreenShareCfg)
  • 描述:配置屏幕共享参数
  • 返回值:
  • 回调:
  • 参数:
    参数
    类型
    必传
    含义
    CRVideo_ScreenShareCfg Object 屏幕共享配置参数对象,详细介绍见:CRVideo_ScreenShareCfg

CRVideo_GetScreenShareCfg

  • 详情:CRVideo_GetScreenShareCfg()
  • 描述:获取屏幕共享参数
  • 返回值:返回屏幕共享配置参数对象,详细介绍见:CRVideo_ScreenShareCfg
  • 回调:

CRVideo_StartScreenShare

CRVideo_StopScreenShare

CRVideo_StartScreenMark

CRVideo_StopScreenMark

CRVideo_StartScreenShareRslt

  • 详情:CRVideo_StartScreenShareRslt.callback = function(sdkErr){}
  • 描述:回调,开启屏幕共享的结果
  • 回调参数:
    参数
    类型
    含义
    sdkErr Number 错误码,详细见 错误码定义

CRVideo_StopScreenShareRslt

  • 详情:CRVideo_StopScreenShareRslt.callback = function(sdkErr){}
  • 描述:回调,停止屏幕共享的结果
  • 回调参数:
    参数
    类型
    含义
    sdkErr Number 错误码,详细见 错误码定义

CRVideo_StartScreenMarkRslt

  • 详情:CRVideo_StartScreenMarkRslt.callback = function(sdkErr){}
  • 描述:回调,开启房间内屏幕共享标注的结果
  • 回调参数:
    参数
    类型
    含义
    sdkErr Number 错误码,详细见 错误码定义

CRVideo_StopScreenMarkRslt

  • 详情:CRVideo_StopScreenMarkRslt.callback = function(sdkErr){}
  • 描述:回调,停止房间内屏幕共享标注的结果
  • 回调参数:
    参数
    类型
    含义
    sdkErr Number 错误码,详细见 错误码定义

CRVideo_NotifyScreenShareStarted

  • 详情:CRVideo_NotifyScreenShareStarted.callback = function(UID){}
  • 描述:通知,他人开启了屏幕共享
  • 回调参数:
    参数
    类型
    含义
    UID String 用户ID, 详细介绍见 关键词

CRVideo_NotifyScreenShareStopped

  • 详情:CRVideo_NotifyScreenShareStopped.callback = function(UID){}
  • 描述:通知,他人停止了屏幕共享
  • 回调参数:
    参数
    类型
    含义
    UID String 用户ID, 详细介绍见 关键词

CRVideo_NotifyScreenMarkStarted

  • 详情:CRVideo_NotifyScreenMarkStarted.callback = function(UID){}
  • 描述:通知,房间内开启了屏幕共享标注
  • 回调参数:
    参数
    类型
    含义
    UID String 用户ID, 详细介绍见 关键词

CRVideo_NotifyScreenMarkStopped

  • 详情:CRVideo_NotifyScreenMarkStopped.callback = function(UID){}
  • 描述:通知,房间内停止了屏幕共享标注
  • 回调参数:
    参数
    类型
    含义
    UID String 用户ID, 详细介绍见 关键词

CRVideo_CreatMediaObj

  • 详情:CRVideo_CreatMediaObj(CreatParams)
  • 描述:创建影音共享显示UI组件
  • 返回值:返回影音共享UI显示对象 CRVideo_MediaObj
  • 回调:
  • 参数:
    参数
    类型
    必传
    含义
    CreateUIParams Object 详细介绍见:CRVideo_CreateUIParams

无论是共享自己的影音还是收看别人共享的影音,都需要创建此对象

CRVideo_SetMediaCfg

  • 详情:CRVideo_SetMediaCfg(CRVideo_MediaCfg)
  • 描述:配置影音共享参数
  • 返回值:
  • 回调:
  • 参数:
    参数
    类型
    必传
    含义
    CRVideo_MediaCfg Object 影音共享配置参数对象,详细介绍见:CRVideo_MediaCfg

CRVideo_GetMediaCfg

  • 详情:CRVideo_GetMediaCfg()
  • 描述:获取影音共享参数
  • 返回值:返回影音共享配置参数对象,详细介绍见:CRVideo_MediaCfg
  • 回调:

CRVideo_StartPlayMedia

  • 详情:CRVideo_StartPlayMedia(mediaObj,source,locPlay,bPauseWhenFinished)
  • 描述:开始播放影音
  • 返回值:返回播放状态,0未在播放,1播放中
  • 回调:
  • 参数:
    参数
    类型
    必传
    含义
    mediaObj MediaContainerObj 封装好的videoUI对象,即需要播放的视频容器
    source File(String) 支持 File类型 文件,也支持 同源 播放地址URL(String)
    locPlay Number 是否仅仅本地播放(0:房间内播放,1:本地播放)缺省为0
    bPauseWhenFinished Number 是否播放完毕自动结束共享(0:播放完自动结束共享,1:播放完暂停在最后一帧,2:自动循环播放)缺省为0

MediaContainerObj 通过调用 CRVideo_CreatMediaObj 接口创建
当播放类型为线上URL时,url需是和网页同源的地址,非同源(跨域)地址将无法访问

CRVideo_PausePlayMedia

  • 详情:CRVideo_PausePlayMedia(bPause)
  • 描述:暂停或恢复播放影音
  • 返回值:
  • 回调:
  • 参数:
    参数
    类型
    必传
    含义
    bPause Bool ture为暂停,false为播放

CRVideo_StopPlayMedia

  • 详情:CRVideo_StopPlayMedia()
  • 描述:停止播放影音及共享
  • 返回值:
  • 回调:

房间内其他人将会收到 CRVideo_NotifyMediaStop 通知

CRVideo_SetMediaplaypos

  • 详情:CRVideo_SetMediaplaypos(setPTS)
  • 描述:设置播放进度
  • 返回值:
  • 回调:
  • 参数:
    参数
    类型
    必传
    含义
    setPTS Number 设置播放位置,单位:毫秒

CRVideo_SetMediaVolume

  • 详情:CRVideo_SetMediaVolume(level)
  • 描述:设置本地媒体音量
  • 返回值:
  • 回调:
  • 参数:
    参数
    类型
    必传
    含义
    level Number 本地音量 0-100

CRVideo_GetMediaInfo

  • 详情:CRVideo_GetMediaInfo()
  • 描述:获取影音播放信息
  • 返回值:返回影音信息,详见:CRVideo_MediaInfoObj

CRVideo_GetMediaImg

  • 详情:CRVideo_Getmediaimg(UID,format)
  • 描述:获取影音图像数据
  • 返回值:当前播放的一帧图片
  • 回调:
  • 参数:
    参数
    类型
    必传
    含义
    UID String 用户ID, 详细介绍见 关键词
    format String 图片格式,缺省为jpg

CRVideo_NotifyMediaOpened

  • 详情:CRVideo_NotifyMediaOpened.callback = function(){}
  • 描述:通知,影音文件已打开

CRVideo_NotifyMediaStart

  • 详情:CRVideo_NotifyMediaStart.callback = function(UID){}
  • 描述:通知,影音开始播放
  • 回调参数:
    参数
    类型
    含义
    UID String 用户ID, 详细介绍见 关键词

CRVideo_NotifyMediaStop

  • 详情:CRVideo_NotifyMediaStop.callback = function(){}
  • 描述:通知,影音播放停止

CRVideo_NotifyMediaPause

  • 详情:CRVideo_NotifyMediaPause.callback = function(UID,status){}
  • 描述:通知,影音播放暂停/取消暂停
  • 回调参数:
    参数
    类型
    含义
    UID String 用户ID, 详细介绍见 关键词
    status Number 是否暂停, 0:播放中 1:暂停中

CRVideo_NotifyPlayPosSetted

  • 详情:CRVideo_NotifyPlayPosSetted.callback = function(setPTS){}
  • 描述:通知,影音播放位置更新
  • 回调参数:
    参数
    类型
    含义
    setPTS Number 新的播放位置,单位:毫秒

CRVideo_CreateCloudMixer

  • 详情:CRVideo_CreateCloudMixer(cfg)
  • 描述:创建云端混图器
  • 返回值:云端混图器ID
  • 参数:
    参数
    类型
    必传
    含义
    cfg Object 云端混图器配置,josn格式,参见CRVideo_CloudMixerCfgObj

可以开启多个云端混图器,具体个数和企业购买的授权相关;
开启云端混图器后,房间内所有人都将收到CRVideo_CloudMixerStateChanged通知状态值为1;
云端混图器部署有少量耗时,如果在部署过程遇到异常,将收到CRVideo_CreateCloudMixerFailed回调;
云端混图器启动完成并进入录制或推流状态时,将收到CRVideo_CloudMixerStateChanged通知状态值为2;
开启云端混图器在进入工作中的状态后,可以通过CRVideo_UpdateCloudMixerContent更新内容;
混图器如果在工作中遇到异常而停止时,将收到CRVideo_CloudMixerStateChanged通知,状态值为0,并携带错误原因;

CRVideo_UpdateCloudMixerContent

  • 详情:CRVideo_UpdateCloudMixerContent(mixerID, cfg).then(function(resObject){}).catch(function(errObject){})
  • 描述:更新云端混图器
  • 返回值:返回一个Promise对象,成功返回resolveCallback,失败返回rejectCallback
  • 参数:
    参数
    类型
    必传
    含义
    mixerID String 混图器ID, 参见CRVideo_CreateCloudMixer
    cfg Object 混图器内容配置,参见CRVideo_CloudMixerCfgObj

更新混图器内容时,只能更新内容和布局,不能更改混图器规格、输出目标;
更新混图器内容时,房间内所有人都将收到CRVideo_CloudMixerInfoChanged通知;

CRVideo_DestroyCloudMixer

  • 详情:CRVideo_DestroyCloudMixer(mixerID).then(function(resObject){}).catch(function(errObject){})
  • 描述:消毁云端混图器
  • 返回值:返回一个Promise对象,成功返回resolveCallback,失败返回rejectCallback
  • 参数:
    参数
    类型
    必传
    含义
    mixerID String 混图器ID, 参见CRVideo_CreateCloudMixer

消毁云端混图器时,房间内所有人都将收到CRVideo_CloudMixerStateChanged通知,状态状态值为0
正常情况下房间内所有人也会收到CRVideo_CloudMixerOutputInfoChanged通知

CRVideo_GetAllCloudMixerInfo

  • 详情:CRVideo_GetAllCloudMixerInfo()
  • 描述:得到所有云端混图器信息
  • 返回值:CRVideo_CloudMixerInfo[]
  • 回调:

CRVideo_GetCloudMixerInfo

CRVideo_CreateCloudMixerFailed

  • 详情:CRVideo_CreateCloudMixerFailed.callback = function(mixerID, sdkErr){}
  • 描述:通知,启动云端录制、云端直播失败
  • 回调参数:
    参数
    类型
    含义
    mixerID String 混图器ID, 参见CRVideo_CreateCloudMixer
    sdkErr Number 错误码,详细见 错误码定义

CRVideo_CloudMixerStateChanged

  • 详情:CRVideo_CloudMixerStateChanged.callback = function(mixerID, state, exParam, operUserID){}
  • 描述:通知,云端录制、云端直播状态变化
  • 回调参数:
    参数
    类型
    含义
    mixerID String 混图器ID, 参见CRVideo_CreateCloudMixer
    state Number 录制状态
    exParam Object state为0时,包含err字段(取值为ERR_DEF), errDesc字段;
    state为2时,内容参见CRVideo_CloudMixerCfgObj
    operUserID String 操作者用户ID

CRVideo_CloudMixerOutputInfoChanged

  • 详情:CRVideo_CloudMixerOutputInfoChanged.callback = function(mixerID, outputInfo){}
  • 描述:通知,云端录制文件、云端直播输出变化
  • 回调参数:
    参数
    类型
    含义
    mixerID String 混图器ID, 参见CRVideo_CreateCloudMixer
    outputInfo Object 请参见CRVideo_CloudMixerOutputInfo

CRVideo_CloudMixerInfoChanged

  • 详情:CRVideo_CloudMixerInfoChanged.callback = function(mixerID){}
  • 描述:通知,云端录制、云端直播配置变化
  • 回调参数:
    参数
    类型
    含义
    mixerID String 混图器ID, 参见CRVideo_CreateCloudMixer

可调用:CRVideo_GetCloudMixerInfo获取相关信息

VideoObj_id

  • 详情:VideoObj.id(ID)
  • 描述:设置/查询组件的独立ID
  • 返回值:不传参时返回改组件的独立ID,默认为空
  • 参数:
    参数
    类型
    必传
    含义
    ID String 组件独立ID

非必须调用的方法。不调用此方法设置时,组件没有独立ID,所有调用 CRVideo_CreatVideoObj 方法创建的组件独立ID均为""

VideoObj_height

  • 详情:VideoObj.height(height)
  • 描述:设置/查询组件的高度
  • 返回值:不传参时返回组件的高度,单位px
  • 参数:
    参数
    类型
    必传
    含义
    height String 组件高度,单位px
示例代码:
        VideoObj.height('720px');
        // 或者
        const domHeight = VideoObj.height();

非必须调用的方法。不调用此方法设置时,默认为父元素高度的100%

VideoObj_width

  • 详情:VideoObj.width(width)
  • 描述:设置/查询组件的宽度
  • 返回值:不传参时返回组件的宽度,单位px
  • 参数:
    参数
    类型
    必传
    含义
    width String 组件宽度,单位px
示例代码:
        VideoObj.width('1280px');
        // 或者
        const domWidth = VideoObj.width();

非必须调用的方法。不调用此方法设置时,默认为父元素宽度的100%

VideoObj_left

  • 详情:VideoObj.left(left)
  • 描述:设置/查询组件在父元素中的left位置
  • 返回值:不传参时返回组件在父元素中的left位置,单位px
  • 参数:
    参数
    类型
    必传
    含义
    left String 组件在父元素中的left位置,单位px
示例代码:
        VideoObj.left('100px');
        // 或者
        const domLeftPos = VideoObj.left();

非必须调用的方法。不调用此方法设置时,默认为0

VideoObj_top

  • 详情:VideoObj.top(top)
  • 描述:设置/查询组件在父元素中的top位置
  • 返回值:不传参时返回组件在父元素中的top位置,单位px
  • 参数:
    参数
    类型
    必传
    含义
    top String 组件在父元素中的top位置,单位px
示例代码:
        VideoObj.top('100px');
        // 或者
        const domTopPos = VideoObj.top();

非必须调用的方法。不调用此方法设置时,默认为0

VideoObj_show

  • 详情:VideoObj.show()
  • 描述:显示组件
  • 返回值:

组件默认是显示状态,在组件隐藏后调用此方法重新显示组件。SDK此时会重新订阅该组件所对应的视频流

VideoObj_hide

  • 详情:VideoObj.hide()
  • 描述:隐藏组件
  • 返回值:

组件默认是显示状态,调用此方法隐藏组件时,SDK会退订组件对应的视频流以节省带宽

VideoObj_handler

  • 详情:VideoObj.handler()
  • 描述:获取该组件的DOM对象
  • 返回值:返回该组件的DOM对象
示例代码:
        $('#userVideo').append(CRVideo_VideoObj.handler());
        // 或者
        $('#userScreen).append(CRVideo_ScreenShareObj.handler());

VideoObj_setVideo

  • 详情:VideoObj.setVideo(UID,camID)
  • 描述:设置组件上要显示的视频画面,订阅视频
  • 返回值:
  • 参数:
    参数
    类型
    必传
    含义
    UID String 用户ID, 详细介绍见 关键词
    camID Number 要显示画面的摄像头ID,-1为默认摄像头。可以不传,缺省为-1(仅组件类型为CRVideo_VideoObj时才需要传此参数)
示例代码:
        VideoObj.setVideo('Victor');

组件类型为 CRVideo_VideoObj 时,可以传camID参数,为其它类型时不需要此参数

VideoObj_clear

  • 详情:VideoObj.clear()
  • 描述:清除组件中的图像
  • 返回值:

若需要再次显示图像,需重新调用 setVideo() 方法

VideoObj_isPicEmpty

  • 详情:VideoObj.isPicEmpty()
  • 描述:检查组件当前图像是否为空
  • 返回值:返回组件当前图像是否为空,0为空,1为非空

VideoObj_setNickNameStyle

  • 详情:VideoObj.setNickNameStyle(style)
  • 描述:设置组件上昵称的显示样式
  • 返回值:
  • 参数:
    参数
    类型
    必传
    含义
    style Object 昵称显示css样式
示例代码:
    const style = {
        left: "10px",
        top: "10px",
        backgroundColor: "rgba(0, 0, 0, .7)",
        padding: "0 10px",
        borderRadius: "15px",
        display: "block"
    }
    VideoObj.setNickNameStyle(style);

VideoObj_setNickNameContent

  • 详情:VideoObj.setNickNameContent(content)
  • 描述:设置组件上昵称的显示内容
  • 返回值:
  • 参数:
    参数
    类型
    必传
    含义
    content String 要显示的昵称内容
示例代码:
    VideoObj.setNickNameContent("主持人的屏幕");

当组件类型为 CRVideo_VideoObj 时,昵称内容默认为该用户的昵称;
当组件类型为 CRVideo_ScreenShareObj 时,昵称内容默认为 xxx's screenShare;
当组件类型为 CRVideo_MeidaObj 时,昵称内容默认为 xxx's media;
若需要显示其他内容,可调用此接口修改

VideoObj_setVisibleNickName

  • 详情:VideoObj.setVisibleNickName(isVisible)
  • 描述:设置组件上是否显示昵称
  • 返回值:
  • 参数:
    参数
    类型
    必传
    含义
    isVisible Bool 是否显示昵称,true:显示昵称,false:隐藏昵称
示例代码:
    VideoObj.setVisibleNickName(true);

VideoObj_getVisibleNickName

  • 详情:VideoObj.getVisibleNickName()
  • 描述:获取组件当前是否显示昵称
  • 返回值:返回组件当前是否显示昵称,true:显示昵称,false:隐藏昵称

VideoObj_dblClickFullScreen

  • 详情:VideoObj.dblClickFullScreen(bool)
  • 描述:设置/查询组件是否支持双击全屏
  • 返回值:不传参时返回组件是否支持双击全屏
  • 参数:
    参数
    类型
    必传
    含义
    bool Bool 是否显示支持双击全屏,true:支持,false:不支持

VideoObj_savePic

  • 详情:VideoObj.savePic(fileName)
  • 描述:保存组件当前显示的一帧画面为图片文件
  • 返回值:
  • 参数:
    参数
    类型
    必传
    含义
    fileName String 保存的图片文件名,如:123.png
示例代码:
        VideoObj.savePic('123.png');

调用此接口后,会自动触发浏览器的下载,图片将以下载的方式保存到本地,下载路径由用户行为决定,无法指定
支持常见的图片格式,如:jpg、jpeg、png、bmp、gif 等
组件上有视频画面时才可以调用此方法,否则SDK不会有任何响应

VideoObj_savePicToBase64

  • 详情:VideoObj.savePicToBase64(format)
  • 描述:保存组件当前显示的一帧画面为base64数据
  • 返回值:返回当前一帧画面的base64数据
  • 参数:
    参数
    类型
    必传
    含义
    format String 图片格式,缺省为png
示例代码:
        const picBase64 = VideoObj.savePicToBase64('png');

返回的base64数据带有mimeType头,比如:"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA....",如不需要可将 "data:image/png;base64," 去掉,只保留后面的数据
支持常见的图片格式,如:jpg、jpeg、png、bmp、gif 等
组件上有视频画面时才可以调用此方法,否则SDK不会有任何响应

VideoObj_setVideoProp

  • 详情:VideoObj.setVideoProp(videoPropObj)
  • 描述:动态设置UI组件中video标签的属性
  • 返回值:
  • 参数:
    参数
    类型
    必传
    含义
    videoPropObj Object video标签属性,详细介绍见:CRVideo_CreateUIParams
示例代码:
        
        VideoObj.setVideoProp({
            // css样式
            style: { 
                filter: 'blur(50px)' // 设置视频模糊显示
                objectFit: 'cover'; // 设置视频裁剪显示
            },
            // 其它属性
            controls: true, // 设置视频是否显示工具条
            autoplay: true, // 设置视频是否自动播放
            ...
        });

video标签的属性是W3C标准参数,属性名需要驼峰命名。具体可以参考 MDN

VideoObj_onplay

  • 详情:VideoObj.onplay = ()=>{}
  • 描述:通知:组件准备播放
  • 返回值:

VideoObj_onplaying

  • 详情:VideoObj.onplaying = ()=>{}
  • 描述:通知:组件正在播放
  • 返回值:

VideoObj_onpause

  • 详情:VideoObj.onpause= ()=>{}
  • 描述:通知:组件暂停播放
  • 返回值:

VideoObj_onended

  • 详情:VideoObj.onended= ()=>{}
  • 描述:通知:组件停止播放
  • 返回值:

VideoObj_onerror

  • 详情:VideoObj.onerror= ()=>{}
  • 描述:通知:组件播放出错
  • 返回值:

CRVideo_VideoObj_setVideo

  • 详情:CRVideo_VideoObj.setVideo(UID, camID)
  • 描述:订阅成员摄像头画面
  • 返回值:
  • 参数:
    参数
    类型
    必传
    含义
    UID String 用户ID, 详细介绍见 关键词
    camID Number 成员的摄像头ID,非必传。不传或传-1则订阅该成员默认摄像头。传0则为退订

若要退订某个UI组件上的视频,则调用:CRVideo_VideoObj.setVideo('',0) 即可
每个组件可以反复订阅不同成员的不同摄像头ID,订阅新的摄像头之后,此前订阅的摄像头则会自动退订
组件setVideo之后,若不退订或不进行销毁,则无论该组件是否显示,都会持续传输其所订阅的摄像头视频流,并占用资源

CRVideo_VideoObj_getVideoID

  • 详情:CRVideo_VideoObj.getVideoID()
  • 描述:查询组件当前订阅的摄像头ID
  • 返回值:返回组件当前订阅的摄像头ID

CRVideo_VideoObj_destroy

  • 详情:CRVideo_VideoObj.destroy()
  • 描述:销毁组件,退订视频
  • 返回值:

调用此方法彻底销毁UI组件,组件销毁后,SDK会退订相关视频流,以节省带宽

CRVideo_ScreenShareObj_setVideo

  • 详情:CRVideo_ScreenShareObj.setVideo(UID)
  • 描述:设置组件显示的屏幕内容(谁的屏幕)
  • 返回值:
  • 参数:
    参数
    类型
    必传
    含义
    UID String 用户ID, 详细介绍见 关键词

CRVideo_ScreenShareObj_setMark

  • 详情:CRVideo_ScreenShareObj.setMark(CRVideo_MarkOptions)
  • 描述:设置屏幕共享标注样式
  • 返回值:
  • 参数:
    参数
    类型
    必传
    含义
    CRVideo_MarkOptions Object 屏幕共享标注样式参数对象, 详见:CRVideo_MarkOptions

CRVideo_MediaObj_setVideo

  • 详情:CRVideo_MediaObj.setVideo(UID)
  • 描述:设置组件显示的影音内容(谁的影音)
  • 返回值:
  • 参数:
    参数
    类型
    必传
    含义
    UID String 用户ID, 详细介绍见 关键词

CRVideo_SendCmd

  • 详情:CRVideo_SendCmd(UID,data,cookie)
  • 描述:发送点对点消息
  • 返回值:uuid,本次发送任务的ID
  • 回调:CRVideo_SendCmdRslt.callback
  • 参数:
    参数
    类型
    必传
    含义
    UID String 发送目标用户ID
    data String 要发送的数据,字符串(最大64KB)
    cookie String 详细介绍见 关键词,可以传空串

发送点对点消息不需要进入房间,但是需要登录呼叫系统,即 init 时 isCallSer 参数的值不能为false
可以通过此接口发送自定义的json格式消息来实现一些自定义功能

CRVideo_SendBuffer

  • 详情:CRVideo_SendBuffer(UID,data,cookie)
  • 描述:发送大块数据
  • 返回值:uuid,本次发送任务的ID
  • 回调:CRVideo_SendBufferRslt.callback
  • 参数:
    参数
    类型
    必传
    含义
    UID String 发送目标用户ID
    data String 要发送的数据(最大100MB)
    cookie String 详细介绍见 关键词,可以传空串

发送进度通知 CRVideo_SendProgress.callback
发送结果回调 CRVideo_SendBufferRslt.callback

CRVideo_SendFile

  • 详情:CRVideo_SendFile(UID,File,cookie)
  • 描述:发送文件数据
  • 返回值:uuid,本次发送任务的ID
  • 回调:CRVideo_SendFileRslt.callback
  • 参数:
    参数
    类型
    必传
    含义
    UID String 发送目标用户ID
    File File 要发送的文件对象
    cookie String 详细介绍见 关键词,可以传空串

发送进度通知 CRVideo_SendProgress.callback
发送结果回调 CRVideo_SendFileRslt.callback

CRVideo_CancelSend

  • 详情:CRVideo_CancelSend(taskID)
  • 描述:取消发送
  • 返回值:
  • 回调:
  • 参数:
    参数
    类型
    必传
    含义
    taskID Number 要取消发送的任务ID

CRVideo_SendCmdRslt

  • 详情:CRVideo_SendCmdRslt.callback = function(taskID,sdkErr,cookie){}
  • 描述:回调,发送点对点消息的结果
  • 回调参数:
    参数
    类型
    含义
    taskID String 发送任务id
    sdkErr Number 错误码,详细见 错误码定义
    cookie String 详细介绍见 关键词,可以传空串

CRVideo_SendBufferRslt

  • 详情:CRVideo_SendBufferRslt.callback = function(taskID,sdkErr,cookie){}
  • 描述:回调,发送大块数据的结果
  • 回调参数:
    参数
    类型
    含义
    taskID String 发送任务id
    sdkErr Number 错误码,详细见 错误码定义
    cookie String 详细介绍见 关键词,可以传空串

CRVideo_SendFileRslt

  • 详情:CRVideo_SendFileRslt.callback = function(taskID,sdkErr,cookie){}
  • 描述:回调,发送文件的结果
  • 回调参数:
    参数
    类型
    含义
    taskID String 发送任务id
    sdkErr Number 错误码,详细见 错误码定义
    cookie String 详细介绍见 关键词,可以传空串

CRVideo_SendProgress

  • 详情:CRVideo_SendProgress.callback = function(taskID,sendedLenth,totalLenth,cookie){}
  • 描述:通知,当前发送进度
  • 回调参数:
    参数
    类型
    含义
    taskID String 发送任务id
    sendedLenth Number 已发送的数据长度
    totalLenth Number 需要发送的总长度
    cookie String 详细介绍见 关键词,可以传空串

CRVideo_NotifyCmdData

  • 详情:CRVideo_NotifyCmdData.callback = function(UID,data){}
  • 描述:通知,收到点对点消息
  • 回调参数:
    参数
    类型
    含义
    UID String 消息来源用户ID
    data String 收到的数据

CRVideo_NotifyBufferData

  • 详情:CRVideo_NotifyBufferData.callback = function(UID,data){}
  • 描述:通知,收到大块数据
  • 回调参数:
    参数
    类型
    含义
    UID String 数据来源用户ID
    data String 收到的数据

CRVideo_NotifyFileData

  • 详情:CRVideo_NotifyFileData.callback = function(UID,fileBuffer,fileName){}
  • 描述:通知,收到文件数据
  • 回调参数:
    参数
    类型
    含义
    UID String 文件来源用户ID
    fileBuffer ArrayBuffer 收到的文件数据, ArrayBuffer
    fileName String 收到的文件文件名
示例代码:
    // 将ArrayBuffer转成url并借助a标签自动下载
    const blob = new Blob([fileBuffer]);
    const url = window.URL.createObjectURL(blob);
    const a = document.createElement('a');
    a.style.display = 'none';
    a.href = url;
    a.download = fileName;
    document.body.appendChild(a);
    a.click();

收到的文件数据为ArrayBuffer格式,需要业务层根据需要转成url下载

CRVideo_SendMeetingCustomMsg

  • 详情:CRVideo_SendMeetingCustomMsg(stringMsg,cookie)
  • 描述:发送房间内广播消息
  • 返回值:
  • 回调:CRVideo_SendMeetingCustomMsgRslt.callback
  • 参数:
    参数
    类型
    必传
    含义
    stringMsg String 要发送的消息数据
    cookie String 详细介绍见 关键词,可以传空串

CRVideo_SendMeetingCustomMsgRslt

  • 详情:CRVideo_SendMeetingCustomMsgRslt.callback = function(sdkErr,cookie){}
  • 描述:回调,发送房间内广播消息的结果
  • 回调参数:
    参数
    类型
    含义
    sdkErr Number 错误码,详细见 错误码定义
    cookie String 详细介绍见 关键词,可以传空串

CRVideo_NotifyMeetingCustomMsg

  • 详情:CRVideo_NotifyMeetingCustomMsg.callback = function(UID,stringMsg){}
  • 描述:通知,收到房间内广播消息
  • 回调参数:
    参数
    类型
    含义
    UID String 消息来源用户ID
    stringMsg String 收到的消息数据